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   (** single string column list *)
  39 class stringListModel:
  40   GTree.view ->
  41   object
  42     method list_store: GTree.list_store (** list_store forwarding *)
  43
  44     method easy_append:     string -> unit        (** append + set *)
  45     method easy_insert:     int -> string -> unit (** insert + set *)
  46     method easy_selection:  unit -> string list
  47   end
  48
  49 (** {2 Matita GUI components} *)
  50
  51 class type gui =
  52   object  (* minimal gui object requirements *)
  53     method newUriDialog: unit -> MatitaGeneratedGui.uriChoiceDialog
  54     method newConfirmationDialog: unit -> MatitaGeneratedGui.confirmationDialog
  55     method newEmptyDialog: unit -> MatitaGeneratedGui.emptyDialog
  56   end
  57
  58   (** {3 Dialogs} *)
  59
  60 exception Cancel  (* raised when no answer is given by the user *)
  61
  62   (** @raise Cancel *)
  63 val interactive_user_uri_choice: gui:#gui -> MatitaTypes.choose_uris_callback
  64
  65   (** @raise Cancel *)
  66 val interactive_interp_choice: gui:#gui -> MatitaTypes.choose_interp_callback
  67
  68   (** @return true if user hit "ok" button, false if user hit "cancel" button *)
  69 val ask_confirmation: gui:#gui -> ?title:string -> ?msg:string -> unit -> bool
  70
  71   (** @param multiline (default: false) if true a TextView widget will be used
  72   * for prompting the user otherwise a TextEntry widget will be
  73   * @return the string given by the user *)
  74 val ask_text:
  75   gui:#gui -> ?title:string -> ?msg:string -> ?multiline:bool -> unit -> string
  76