helm/matita/matitaGtkMisc.mli

   1 (* Copyright (C) 2004-2005, 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_window_visibility:
  31   window:GWindow.window -> check:GMenu.check_menu_item -> unit
  32
  33   (** given a window and a check menu item it links the two so that the former
  34    * is only hidden on delete and the latter toggle show/hide of the former *)
  35 val toggle_widget_visibility:
  36   widget:GObj.widget -> check:GMenu.check_menu_item -> unit
  37
  38 val toggle_win:
  39   ?check:GMenu.check_menu_item -> GWindow.window -> unit -> unit
  40
  41 val add_key_binding: Gdk.keysym -> (unit -> 'a) -> GBin.event_box -> unit
  42
  43 (** Connect a callback to the clicked signal of a button, ignoring its return
  44   * value *)
  45 val connect_button: #GButton.button -> (unit -> unit) -> unit
  46
  47
  48 (** Connect a callback to the toggled signal of a button, ignoring its return
  49   * value *)
  50 val connect_toggle_button: #GButton.toggle_button -> (unit -> unit) -> unit
  51
  52 (** Like connect_button above, but connects a callback to the activate signal of
  53   * a menu item *)
  54 val connect_menu_item: #GMenu.menu_item -> (unit -> unit) -> unit
  55
  56   (** connect a unit -> unit callback to a particular key press event. Event can
  57   * be specified using its keysym and a list of modifiers which must be in
  58   * effect for the callback to be executed. Further signal processing of other
  59   * key press events remains unchanged; further signal processing of the
  60   * specified key press depends on the stop parameter *)
  61 val connect_key:
  62   GObj.event_ops ->
  63   ?modifiers:Gdk.Tags.modifier list ->
  64   ?stop:bool ->     (* stop signal handling when the given key has been pressed?
  65                      * Defaults to false *)
  66   Gdk.keysym ->     (* (= int) the key, see GdkKeysyms.ml *)
  67   (unit -> unit) -> (* callback *)
  68     unit
  69
  70   (** single string column list *)
  71 class stringListModel:
  72   GTree.view ->
  73   object
  74     method list_store: GTree.list_store (** list_store forwarding *)
  75
  76     method easy_append:     string -> unit        (** append + set *)
  77     method easy_insert:     int -> string -> unit (** insert + set *)
  78     method easy_selection:  unit -> string list
  79   end
  80
  81   (** as above with Pixbuf associated to each row. Each time an insert is
  82    * performed a string tag should be specified, the corresponding pixbuf in the
  83    * tags associative list will be shown on the left of the inserted row *)
  84 class taggedStringListModel:
  85   tags:((string * GdkPixbuf.pixbuf) list) ->
  86   GTree.view ->
  87   object
  88     method list_store: GTree.list_store (** list_store forwarding *)
  89
  90     method easy_append:     tag:string -> string -> unit
  91     method easy_insert:     int -> tag:string -> string -> unit
  92     method easy_selection:  unit -> string list
  93   end
  94
  95 (** {2 Matita GUI components} *)
  96
  97 class type gui =
  98   object  (* minimal gui object requirements *)
  99     method newUriDialog:          unit -> MatitaGeneratedGui.uriChoiceDialog
 100     method newInterpDialog:       unit -> MatitaGeneratedGui.interpChoiceDialog
 101     method newConfirmationDialog: unit -> MatitaGeneratedGui.confirmationDialog
 102     method newEmptyDialog:        unit -> MatitaGeneratedGui.emptyDialog
 103   end
 104
 105   (** {3 Dialogs} *)
 106
 107   (** @return true if user hit "ok" button, false if user hit "cancel" button
 108   * @param cancel if set to true a cancel button is shown to the user, otherwise
 109   *   it is not (and indeed the function will return true). Defaults to true *)
 110 val ask_confirmation:
 111   gui:#gui ->
 112   ?cancel:bool -> ?title:string -> ?msg:string -> unit ->
 113     bool
 114
 115   (** @param multiline (default: false) if true a TextView widget will be used
 116   * for prompting the user otherwise a TextEntry widget will be
 117   * @return the string given by the user *)
 118 val ask_text:
 119   gui:#gui -> ?title:string -> ?msg:string -> ?multiline:bool -> unit -> string
 120