helm/matita/matitaGtkMisc.mli

   1 (* Copyright (C) 2004, HELM Team.
   2  *
   3  * This file is part of HELM, an Hypertextual, Electronic
   4  * Library of Mathematics, developed at the Computer Science
   5  * Department, University of Bologna, Italy.
   6  *
   7  * HELM is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation; either version 2
  10  * of the License, or (at your option) any later version.
  11  *
  12  * HELM is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with HELM; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston,
  20  * MA  02111-1307, USA.
  21  *
  22  * For details, see the HELM World-Wide-Web page,
  23  * http://helm.cs.unibo.it/
  24  *)
  25
  26 (** {2 Gtk helpers} *)
  27
  28   (** given a window and a check menu item it links the two so that the former
  29    * is only hidden on delete and the latter toggle show/hide of the former *)
  30 val toggle_visibility:
  31   win:GWindow.window -> check:GMenu.check_menu_item -> unit
  32
  33 val toggle_win:
  34   ?check:GMenu.check_menu_item -> GWindow.window -> unit -> unit
  35
  36 val add_key_binding: Gdk.keysym -> (unit -> 'a) -> GBin.event_box -> unit
  37
  38 val connect_button: GButton.button -> (unit -> unit) -> unit
  39
  40   (** connect a unit -> unit callback to a particular key press event. Event can
  41   * be specified using its keysym and a list of modifiers which must be in
  42   * effect for the callback to be executed. Further signal processing of other
  43   * key press events remains unchanged; further signal processing of the
  44   * specified key press depends on the stop parameter *)
  45 val connect_key:
  46   GObj.event_ops ->
  47   ?modifiers:Gdk.Tags.modifier list ->
  48   ?stop:bool ->     (* stop signal handling when the given key has been pressed?
  49                      * Defaults to false *)
  50   Gdk.keysym ->     (* (= int) the key, see GdkKeysyms.ml *)
  51   (unit -> unit) -> (* callback *)
  52     unit
  53
  54   (** single string column list *)
  55 class stringListModel:
  56   GTree.view ->
  57   object
  58     method list_store: GTree.list_store (** list_store forwarding *)
  59
  60     method easy_append:     string -> unit        (** append + set *)
  61     method easy_insert:     int -> string -> unit (** insert + set *)
  62     method easy_selection:  unit -> string list
  63   end
  64
  65 (** {2 Matita GUI components} *)
  66
  67 class type gui =
  68   object  (* minimal gui object requirements *)
  69     method newUriDialog:          unit -> MatitaGeneratedGui.uriChoiceDialog
  70     method newInterpDialog:       unit -> MatitaGeneratedGui.interpChoiceDialog
  71     method newConfirmationDialog: unit -> MatitaGeneratedGui.confirmationDialog
  72     method newEmptyDialog:        unit -> MatitaGeneratedGui.emptyDialog
  73   end
  74
  75   (** {3 Dialogs} *)
  76
  77   (** @raise MatitaTypes.Cancel *)
  78 val interactive_user_uri_choice: gui:#gui -> MatitaTypes.choose_uris_callback
  79
  80   (** @raise MatitaTypes.Cancel *)
  81 val interactive_interp_choice: gui:#gui -> MatitaTypes.choose_interp_callback
  82
  83   (** @return true if user hit "ok" button, false if user hit "cancel" button
  84   * @param cancel if set to true a cancel button is shown to the user, otherwise
  85   *   it is not (and indeed the function will return true). Defaults to true *)
  86 val ask_confirmation:
  87   gui:#gui ->
  88   ?cancel:bool -> ?title:string -> ?msg:string -> unit ->
  89     bool
  90
  91   (** @param multiline (default: false) if true a TextView widget will be used
  92   * for prompting the user otherwise a TextEntry widget will be
  93   * @return the string given by the user *)
  94 val ask_text:
  95   gui:#gui -> ?title:string -> ?msg:string -> ?multiline:bool -> unit -> string
  96