1 (* Copyright (C) 2005, HELM Team.
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.
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.
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.
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,
22 * For details, see the HELM World-Wide-Web page,
23 * http://helm.cs.unibo.it/
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
34 method log_callback: HLog.log_callback
37 class type browserWin =
39 inherit MatitaGeneratedGui.browserWin
40 method browserUri: GEdit.entry
45 method setQuitCallback : (unit -> unit) -> unit
47 (** {2 Access to singleton instances of lower-level GTK widgets} *)
49 method fileSel : MatitaGeneratedGui.fileSelectionWin
50 method main : MatitaGeneratedGui.mainWin
51 method findRepl : MatitaGeneratedGui.findReplWin
52 (* method toolbar : MatitaGeneratedGui.toolBarWin *)
54 method console: console
55 method sourceView: GSourceView2.source_view
57 (** {2 Dialogs instantiation}
58 * methods below create a new window on each invocation. You should
59 * remember to destroy windows after use *)
61 method newBrowserWin: unit -> browserWin
62 method newUriDialog: unit -> MatitaGeneratedGui.uriChoiceDialog
63 method newConfirmationDialog: unit -> MatitaGeneratedGui.confirmationDialog
64 method newEmptyDialog: unit -> MatitaGeneratedGui.emptyDialog
66 (** {2 Selections / clipboards handling} *)
70 method canDelete: bool
72 method canPastePattern: bool
74 method markupSelected: bool
76 method copy: unit -> unit
77 method cut: unit -> unit
78 method delete: unit -> unit
79 method paste: unit -> unit
80 method pastePattern: unit -> unit
82 (** {2 Utility methods} *)
84 (** ask the used to choose a file with the file chooser
85 * @param ok_not_exists if set to true returns also non existent files
86 * (useful for save). Defaults to false *)
87 method chooseFile: ?ok_not_exists:bool -> unit -> string option
89 (** prompt the user for a (multiline) text entry *)
90 method askText: ?title:string -> ?msg:string -> unit -> string option
92 method loadScript: string -> unit
93 method setStar: bool -> unit
96 method increaseFontSize: unit -> unit
97 method decreaseFontSize: unit -> unit
98 method resetFontSize: unit -> unit
101 type paste_kind = [ `Term | `Pattern ]
103 (** multi selection gtkMathView which handle mactions and hyperlinks. Mactions
104 * are handled internally. Hyperlinks are handled by calling an user provided
106 class type clickableMathView =
108 inherit GSourceView2.source_view
110 method load_root : root:string -> unit
111 method remove_selections: unit
112 method set_selection: unit option -> unit
113 method get_selections: unit list
114 method set_font_size: int -> unit
117 (** set hyperlink callback. None disable hyperlink handling *)
118 method set_href_callback: (string -> unit) option -> unit
120 method has_selection: bool
122 (** @raise Failure "no selection" *)
123 method strings_of_selection: (paste_kind * string) list
125 method update_font_size: unit
128 class type cicMathView =
130 inherit clickableMathView
132 (** load a sequent and render it into parent widget *)
133 method nload_sequent:
134 #ApplyTransformation.status -> NCic.metasenv -> NCic.substitution -> int -> unit
136 method load_nobject: #ApplyTransformation.status -> NCic.obj -> unit
139 class type sequentsViewer =
142 method load_logo: unit
143 method load_logo_with_qed: unit
144 method nload_sequents: #NTacStatus.tac_status -> unit
146 #ApplyTransformation.status -> int -> unit (* to be called _after_ load_sequents *)
148 method cicMathView: cicMathView
151 class type cicBrowser =
153 method load: MatitaTypes.mathViewer_entry -> unit
154 (* method loadList: string list -> MatitaTypes.mathViewer_entry -> unit *)
155 method loadInput: string -> unit
156 method mathView: clickableMathView
157 method win: browserWin