1 (* Copyright (C) 2004-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: MatitaLog.log_callback
37 class type browserWin =
39 inherit MatitaGeneratedGui.browserWin
40 method browserUri: GEdit.combo_box_entry
43 (** @param fname name of the Glade file describing the GUI *)
47 method setQuitCallback : (unit -> unit) -> unit
49 (** {2 Access to singleton instances of lower-level GTK widgets} *)
51 method fileSel : MatitaGeneratedGui.fileSelectionWin
52 method main : MatitaGeneratedGui.mainWin
53 method findRepl : MatitaGeneratedGui.findReplWin
54 method develList: MatitaGeneratedGui.develListWin
55 method newDevel: MatitaGeneratedGui.newDevelopmentWin
56 (* method toolbar : MatitaGeneratedGui.toolBarWin *)
58 method console: console
59 method sourceView: GSourceView.source_view
61 (** {2 Dialogs instantiation}
62 * methods below create a new window on each invocation. You should
63 * remember to destroy windows after use *)
65 method newBrowserWin: unit -> browserWin
66 method newUriDialog: unit -> MatitaGeneratedGui.uriChoiceDialog
67 method newInterpDialog: unit -> MatitaGeneratedGui.interpChoiceDialog
68 method newConfirmationDialog: unit -> MatitaGeneratedGui.confirmationDialog
69 method newEmptyDialog: unit -> MatitaGeneratedGui.emptyDialog
71 (** {2 Utility methods} *)
73 (** ask the used to choose a file with the file chooser
74 * @param ok_not_exists if set to true returns also non existent files
75 * (useful for save). Defaults to false *)
76 method chooseFile: ?ok_not_exists:bool -> unit -> string option
77 method createDevelopment: containing:string option -> unit
79 (** prompt the user for a (multiline) text entry *)
80 method askText: ?title:string -> ?msg:string -> unit -> string option
82 method loadScript: string -> unit
83 method setStar: string -> bool -> unit
86 method increaseFontSize: unit -> unit
87 method decreaseFontSize: unit -> unit
88 method resetFontSize: unit -> unit
92 (** singleton instance of the gui *)
93 val instance: unit -> gui
95 (** {2 Disambiguation callbacks}
96 * Use singleton gui instance. *)
98 (** @param selection_mode selection mode in uri list, default to `MULTIPLE
99 * @param title window title, defaults to ""
100 * @param msg message for the user, defaults to ""
101 * @param nonvars_button enable button to exclude vars?, defaults to false
102 * @raise MatitaTypes.Cancel *)
103 val interactive_uri_choice:
104 ?selection_mode:([`SINGLE|`MULTIPLE]) -> ?title:string ->
105 ?msg:string -> ?nonvars_button:bool ->
106 ?hide_uri_entry:bool -> ?hide_try:bool -> ?ok_label:string ->
107 ?ok_action:[`AUTO|`SELECT] ->
108 ?copy_cb:(string -> unit) -> unit ->
109 MatitaDisambiguator.choose_uris_callback
111 (** @raise MatitaTypes.Cancel *)
112 val interactive_interp_choice:
114 MatitaDisambiguator.choose_interp_callback