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