matita/matitaGuiTypes.mli

   1 (* Copyright (C) 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: HLog.log_callback
  35 end
  36
  37 class type browserWin =
  38 object
  39   inherit MatitaGeneratedGui.browserWin
  40   method browserUri: GEdit.combo_box_entry
  41 end
  42
  43 class type gui =
  44 object
  45   method setQuitCallback    : (unit -> unit) -> unit
  46
  47     (** {2 Access to singleton instances of lower-level GTK widgets} *)
  48
  49   method fileSel :      MatitaGeneratedGui.fileSelectionWin
  50   method main :         MatitaGeneratedGui.mainWin
  51   method findRepl :     MatitaGeneratedGui.findReplWin
  52   method newRoot:      MatitaGeneratedGui.newRootWin
  53 (*   method toolbar :      MatitaGeneratedGui.toolBarWin *)
  54
  55   method console:       console
  56   method sourceView:    GSourceView.source_view
  57
  58     (** {2 Dialogs instantiation}
  59      * methods below create a new window on each invocation. You should
  60      * remember to destroy windows after use *)
  61
  62   method newBrowserWin:         unit -> browserWin
  63   method newUriDialog:          unit -> MatitaGeneratedGui.uriChoiceDialog
  64   method newConfirmationDialog: unit -> MatitaGeneratedGui.confirmationDialog
  65   method newEmptyDialog:        unit -> MatitaGeneratedGui.emptyDialog
  66
  67     (** {2 Selections / clipboards handling} *)
  68
  69   method canCopy:         bool
  70   method canCut:          bool
  71   method canDelete:       bool
  72   method canPaste:        bool
  73   method canPastePattern: bool
  74
  75   method markupSelected:  bool
  76
  77   method copy:         unit -> unit
  78   method cut:          unit -> unit
  79   method delete:       unit -> unit
  80   method paste:        unit -> unit
  81   method pastePattern: unit -> unit
  82
  83     (** {2 Utility methods} *)
  84
  85     (** ask the used to choose a file with the file chooser
  86     * @param ok_not_exists if set to true returns also non existent files
  87     * (useful for save). Defaults to false *)
  88   method chooseFile: ?ok_not_exists:bool -> unit -> string option
  89   method createRoot: containing:string option -> unit
  90
  91     (** prompt the user for a (multiline) text entry *)
  92   method askText: ?title:string -> ?msg:string -> unit -> string option
  93
  94   method loadScript: string -> unit
  95   method setStar: bool -> unit
  96
  97     (** {3 Fonts} *)
  98   method increaseFontSize: unit -> unit
  99   method decreaseFontSize: unit -> unit
 100   method resetFontSize: unit -> unit
 101 end
 102
 103 type paste_kind = [ `Term | `Pattern ]
 104
 105   (** multi selection gtkMathView which handle mactions and hyperlinks. Mactions
 106   * are handled internally. Hyperlinks are handled by calling an user provided
 107   * callback *)
 108 class type clickableMathView =
 109 object
 110   inherit GMathViewAux.multi_selection_math_view
 111
 112     (** set hyperlink callback. None disable hyperlink handling *)
 113   method set_href_callback: (string -> unit) option -> unit
 114
 115   method has_selection: bool
 116
 117     (** @raise Failure "no selection" *)
 118   method strings_of_selection: (paste_kind * string) list
 119
 120   method update_font_size: unit
 121 end
 122
 123 class type cicMathView =
 124 object
 125   inherit clickableMathView
 126
 127     (** load a sequent and render it into parent widget *)
 128   method load_sequent: Cic.metasenv -> int -> unit
 129
 130   method load_object: Cic.obj -> unit
 131 end
 132
 133 class type sequentsViewer =
 134 object
 135   method reset: unit
 136   method load_logo: unit
 137   method load_logo_with_qed: unit
 138   method load_sequents: GrafiteTypes.incomplete_proof -> unit
 139   method goto_sequent: int -> unit  (* to be called _after_ load_sequents *)
 140
 141   method cicMathView: cicMathView
 142 end
 143
 144 class type cicBrowser =
 145 object
 146   method load: MatitaTypes.mathViewer_entry -> unit
 147   (* method loadList: string list -> MatitaTypes.mathViewer_entry -> unit *)
 148   method loadInput: string -> unit
 149   method mathView: clickableMathView
 150 end
 151