helm/matita/matitaGui.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 class type console =
  27 object
  28   method message: string -> unit
  29   method error: string -> unit
  30   method warning: string -> unit
  31   method debug: string -> unit
  32   method clear: unit -> unit
  33
  34   method log_callback: MatitaLog.log_callback
  35 end
  36
  37   (** @param fname name of the Glade file describing the GUI *)
  38 class type gui =
  39 object
  40
  41   method setQuitCallback    : (unit -> unit) -> unit
  42
  43     (** {2 Access to singleton instances of lower-level GTK widgets} *)
  44
  45   method about :        MatitaGeneratedGui.aboutWin
  46   method fileSel :      MatitaGeneratedGui.fileSelectionWin
  47   method main :         MatitaGeneratedGui.mainWin
  48 (*   method toolbar :      MatitaGeneratedGui.toolBarWin *)
  49
  50   method console:       console
  51
  52     (** {2 Dialogs instantiation}
  53      * methods below create a new window on each invocation. You should
  54      * remember to destroy windows after use *)
  55
  56   method newBrowserWin:         unit -> MatitaGeneratedGui.browserWin
  57   method newUriDialog:          unit -> MatitaGeneratedGui.uriChoiceDialog
  58   method newInterpDialog:       unit -> MatitaGeneratedGui.interpChoiceDialog
  59   method newConfirmationDialog: unit -> MatitaGeneratedGui.confirmationDialog
  60   method newEmptyDialog:        unit -> MatitaGeneratedGui.emptyDialog
  61
  62     (** {2 Utility methods} *)
  63
  64     (** ask the used to choose a file with the file chooser
  65     * @param ok_not_exists if set to true returns also non existent files
  66     * (useful for save). Defaults to false *)
  67   method chooseFile: ?ok_not_exists:bool -> unit -> string option
  68
  69     (** prompt the user for a (multiline) text entry *)
  70   method askText: ?title:string -> ?msg:string -> unit -> string option
  71
  72   method loadScript: string -> unit
  73
  74 end
  75
  76   (** singleton instance of the gui *)
  77 val instance: unit -> gui
  78
  79   (** {2 Disambiguation callbacks}
  80   * Use singleton gui instance. *)
  81
  82   (** @param selection_mode selection mode in uri list, default to `MULTIPLE
  83     * @param title window title, defaults to ""
  84     * @param msg message for the user, defaults to ""
  85     * @param nonvars_button enable button to exclude vars?, defaults to false
  86     * @raise MatitaTypes.Cancel *)
  87 val interactive_uri_choice:
  88   ?selection_mode:([`SINGLE|`MULTIPLE]) -> ?title:string ->
  89   ?msg:string -> ?nonvars_button:bool ->
  90   ?hide_uri_entry:bool -> ?hide_try:bool -> ?ok_label:string ->
  91   ?ok_action:[`AUTO|`SELECT] ->
  92   ?copy_cb:(string -> unit) -> unit ->
  93     MatitaDisambiguator.choose_uris_callback
  94
  95   (** @raise MatitaTypes.Cancel *)
  96 val interactive_interp_choice:
  97   unit ->
  98     MatitaDisambiguator.choose_interp_callback
  99