version 0.7.1

[helm.git] / helm / matita / matitaGtkMisc.mli

diff --git a/helm/matita/matitaGtkMisc.mli b/helm/matita/matitaGtkMisc.mli
index 03847ac870b4d506c0ad7a6952787f49794ca0c5..7d4e289551cce5435cea4d1e7f6bcf8d9fedbc38 100644 (file)
--- a/helm/matita/matitaGtkMisc.mli
+++ b/helm/matita/matitaGtkMisc.mli
@@ -1,4 +1,4 @@
-(* Copyright (C) 2004, HELM Team.
+(* Copyright (C) 2004-2005, HELM Team.
  * 
  * This file is part of HELM, an Hypertextual, Electronic
  * Library of Mathematics, developed at the Computer Science
@@ -27,14 +27,49 @@
 
   (** given a window and a check menu item it links the two so that the former
    * is only hidden on delete and the latter toggle show/hide of the former *)
-val toggle_visibility:
-  win:GWindow.window -> check:GMenu.check_menu_item -> unit
+val toggle_window_visibility:
+  window:GWindow.window -> check:GMenu.check_menu_item -> unit
+  
+  (** given a window and a check menu item it links the two so that the former
+   * is only hidden on delete and the latter toggle show/hide of the former *)
+val toggle_widget_visibility:
+  widget:GObj.widget -> check:GMenu.check_menu_item -> unit
 
+val toggle_callback:
+  callback:(bool -> unit) -> check:GMenu.check_menu_item -> unit
+  
 val toggle_win:
-  ?check:GMenu.check_menu_item -> GWindow.window -> (unit -> unit)
+  ?check:GMenu.check_menu_item -> GWindow.window -> unit -> unit
 
 val add_key_binding: Gdk.keysym -> (unit -> 'a) -> GBin.event_box -> unit
 
+(** Connect a callback to the clicked signal of a button, ignoring its return
+  * value *)
+val connect_button: #GButton.button -> (unit -> unit) -> unit
+
+
+(** Connect a callback to the toggled signal of a button, ignoring its return
+  * value *)
+val connect_toggle_button: #GButton.toggle_button -> (unit -> unit) -> unit
+
+(** Like connect_button above, but connects a callback to the activate signal of
+  * a menu item *)
+val connect_menu_item: #GMenu.menu_item -> (unit -> unit) -> unit
+
+  (** connect a unit -> unit callback to a particular key press event. Event can
+  * be specified using its keysym and a list of modifiers which must be in
+  * effect for the callback to be executed. Further signal processing of other
+  * key press events remains unchanged; further signal processing of the
+  * specified key press depends on the stop parameter *)
+val connect_key:
+  GObj.event_ops ->
+  ?modifiers:Gdk.Tags.modifier list ->
+  ?stop:bool ->     (* stop signal handling when the given key has been pressed?
+                     * Defaults to false *)
+  Gdk.keysym ->     (* (= int) the key, see GdkKeysyms.ml *)
+  (unit -> unit) -> (* callback *)
+    unit
+
   (** single string column list *)
 class stringListModel:
   GTree.view ->
@@ -46,3 +81,48 @@ class stringListModel:
     method easy_selection:  unit -> string list
   end
 
+  (** as above with Pixbuf associated to each row. Each time an insert is
+   * performed a string tag should be specified, the corresponding pixbuf in the
+   * tags associative list will be shown on the left of the inserted row *)
+class taggedStringListModel:
+  tags:((string * GdkPixbuf.pixbuf) list) ->
+  GTree.view ->
+  object
+    method list_store: GTree.list_store (** list_store forwarding *)
+
+    method easy_append:     tag:string -> string -> unit
+    method easy_insert:     int -> tag:string -> string -> unit
+    method easy_selection:  unit -> string list
+  end
+
+(** {2 Matita GUI components} *)
+
+class type gui =
+  object  (* minimal gui object requirements *)
+    method newUriDialog:          unit -> MatitaGeneratedGui.uriChoiceDialog
+    method newInterpDialog:       unit -> MatitaGeneratedGui.interpChoiceDialog
+    method newConfirmationDialog: unit -> MatitaGeneratedGui.confirmationDialog
+    method newEmptyDialog:        unit -> MatitaGeneratedGui.emptyDialog
+  end
+
+  (** {3 Dialogs} *)
+
+  (* @param parent to center the window on it *)
+val ask_confirmation:
+  title:string -> 
+  message:string -> 
+  ?parent:#GWindow.window_skel ->
+    unit -> [`YES | `NO | `CANCEL]
+
+val report_error:
+  title:string -> 
+  message:string -> 
+  ?parent:#GWindow.window_skel ->
+    unit -> unit
+
+  (** @param multiline (default: false) if true a TextView widget will be used
+  * for prompting the user otherwise a TextEntry widget will be
+  * @return the string given by the user *)
+val ask_text:
+  gui:#gui -> ?title:string -> ?msg:string -> ?multiline:bool -> unit -> string
+