]> matita.cs.unibo.it Git - helm.git/blob - helm/software/matita/matitaMathView.mli
...
[helm.git] / helm / software / matita / matitaMathView.mli
1 (* Copyright (C) 2004-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 (** {2 Constructors} *)
27
28   (** meta constructor *)
29 type 'widget constructor =
30   ?hadjustment:GData.adjustment ->
31   ?vadjustment:GData.adjustment ->
32   ?font_size:int ->
33   ?log_verbosity:int ->
34   ?width:int ->
35   ?height:int ->
36   ?packing:(GObj.widget -> unit) ->
37   ?show:bool ->
38   unit ->
39     'widget
40
41 val clickableMathView:  MatitaGuiTypes.clickableMathView constructor
42
43 val cicMathView:        MatitaGuiTypes.cicMathView constructor
44
45 val sequentsViewer:
46   notebook:GPack.notebook ->
47   cicMathView:MatitaGuiTypes.cicMathView ->
48   unit ->
49     MatitaGuiTypes.sequentsViewer
50
51 val cicBrowser: unit -> MatitaGuiTypes.cicBrowser
52
53 (** {2 MathView wide functions} *)
54 (* TODO ZACK consider exporting here a single function which return a list of
55  * MatitaGuiTypes.clickableMathView and act on them externally ... *)
56
57 val increase_font_size:   unit -> unit
58 val decrease_font_size:   unit -> unit
59 val reset_font_size:      unit -> unit
60
61 val refresh_all_browsers: unit -> unit  (** act on all cicBrowsers *)
62 val update_font_sizes:    unit -> unit
63
64   (** {3 Clipboard & Selection handling} *)
65
66 val has_selection: unit -> bool
67
68   (** fills the clipboard with the current selection
69    * @raise Failure "no selection" *)
70 val copy_selection: unit -> unit
71 val has_clipboard: unit -> bool (** clipboard is not empty *)
72 val empty_clipboard: unit -> unit (** empty the clipboard *)
73
74   (** @raise Failure "empty clipboard" *)
75 val paste_clipboard: MatitaGuiTypes.paste_kind -> string
76
77 (** {2 Singleton instances} *)
78
79 val cicMathView_instance: unit -> MatitaGuiTypes.cicMathView
80 val sequentsViewer_instance:  unit -> MatitaGuiTypes.sequentsViewer
81
82 val mathViewer:               unit -> MatitaTypes.mathViewer
83
84 (** {2 Initialization} *)
85
86 val set_gui: MatitaGuiTypes.gui -> unit
87