helm/matita/matitaGui.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   (** @param fname name of the Glade file describing the GUI *)
  27 class gui :
  28   string ->
  29   object
  30
  31     method setQuitCallback    : (unit -> unit) -> unit
  32     method setPhraseCallback  : (string -> MatitaTypes.command_outcome) -> unit
  33
  34       (** {2 Access to lower-level GTK widgets} *)
  35
  36     method about :        MatitaGeneratedGui.aboutWin
  37     method browser :      MatitaGeneratedGui.browserWin
  38     method check :        MatitaGeneratedGui.checkWin
  39     method fileSel :      MatitaGeneratedGui.fileSelectionWin
  40     method main :         MatitaGeneratedGui.mainWin
  41     method proof :        MatitaGeneratedGui.proofWin
  42     method script:        MatitaGeneratedGui.scriptWin
  43     method toolbar :      MatitaGeneratedGui.toolBarWin
  44
  45       (** {2 Access to GUI useful components} *)
  46
  47     method console:       MatitaConsole.console
  48
  49       (** {2 Dialogs instantiation}
  50        * methods below create a new window on each invocation. You should
  51        * remember to destroy windows after use *)
  52
  53     method newUriDialog:          unit -> MatitaGeneratedGui.uriChoiceDialog
  54     method newInterpDialog:       unit -> MatitaGeneratedGui.interpChoiceDialog
  55     method newConfirmationDialog: unit -> MatitaGeneratedGui.confirmationDialog
  56     method newEmptyDialog:        unit -> MatitaGeneratedGui.emptyDialog
  57
  58       (** {2 Utility methods} *)
  59
  60       (** ask the used to choose a file with the file chooser *)
  61     method chooseFile: unit -> string option
  62
  63       (** prompt the user for a (multiline) text entry *)
  64     method askText: ?title:string -> ?msg:string -> unit -> string option
  65
  66       (** lock script text view from the beginning to the given offset (in UTF-8
  67       * characters) *)
  68     method lockScript: int -> unit
  69
  70   end
  71
  72   (** singleton instance of the gui *)
  73 val instance: unit -> gui
  74