]> matita.cs.unibo.it Git - helm.git/blob - helm/matita/matitaConsole.mli
- passes subst to FreshNameGenerator
[helm.git] / helm / matita / matitaConsole.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 evbox event box to which keyboard shortcuts are registered; no
27   * shortcut will be registered if evbox is not given *)
28 class console:
29   ?prompt:string -> ?phrase_sep:string -> ?callback:(string -> bool) ->
30   ?evbox:GBin.event_box -> paned:GPack.paned -> Gtk.text_view Gtk.obj ->
31   object
32     inherit GText.view
33
34     method echo_prompt    : unit -> unit
35     method echo_message   : string -> unit
36     method echo_error     : string -> unit
37     method clear          : unit -> unit
38
39       (* console visibility handling inside VPaned *)
40
41       (** @param msg if given, show the console with a prefeed input, cursor
42       * just after it; defaults to the empty string *)
43     method show           : ?msg:string -> unit -> unit
44     method hide           : unit -> unit
45     method toggle         : unit -> unit
46
47     method prompt         : string
48     method set_prompt     : string -> unit
49
50     method phrase_sep     : string
51     method set_phrase_sep : string -> unit
52
53       (** override previous callback definition *)
54     method set_callback   : (string -> bool) -> unit
55
56     method ignore_insert_text_signal: bool -> unit
57
58       (** execute a unit -> unit function, if it raises exceptions shows them as
59       * errors in the console.
60       * @return true if no exception has been raised, false otherwise *)
61     method wrap_exn       : (unit -> unit) -> bool
62   end
63
64   (** @param prompt user prompt (default "# ")
65    * @param phrase_sep phrase separator (default ".")
66    * @param callback callback invoked upon reading of a phrase. Callback
67    * may be invoked more than once if multiple phrases have been inserted before
68    * hitting return (default: do nothing) *)
69 val console :
70   ?prompt:string ->
71   ?phrase_sep:string ->
72   ?callback:(string -> bool) ->
73   ?evbox:GBin.event_box ->
74   paned:GPack.paned ->
75
76   ?buffer:GText.buffer ->
77   ?editable:bool ->
78   ?cursor_visible:bool ->
79   ?justification:Gtk.Tags.justification ->
80   ?wrap_mode:Gtk.Tags.wrap_mode ->
81   ?border_width:int ->
82   ?width:int ->
83   ?height:int ->
84   ?packing:(GObj.widget -> unit) -> ?show:bool -> unit -> console
85