Added $Id$ to every .ml file.

[helm.git] / helm / matita / matitaMathView.mli

diff --git a/helm/matita/matitaMathView.mli b/helm/matita/matitaMathView.mli
index 51a1743f6c07225c28c29a818f93b292b16090af..ea0c077d842ef2c7ca9731df7f4d4395b79fb277 100644 (file)
--- a/helm/matita/matitaMathView.mli
+++ b/helm/matita/matitaMathView.mli
@@ -1,4 +1,4 @@
-(* Copyright (C) 2004, HELM Team.
+(* Copyright (C) 2004-2005, HELM Team.
  * 
  * This file is part of HELM, an Hypertextual, Electronic
  * Library of Mathematics, developed at the Computer Science
@@ -23,15 +23,65 @@
  * http://helm.cs.unibo.it/
  *)
 
-val sequent_viewer :
-  mml_of_cic_sequent:MatitaTypes.mml_of_cic_sequent ->
-  ?packing:(GObj.widget -> unit) -> ?show:bool ->
+(** {2 Constructors} *)
+
+  (** meta constructor *)
+type 'widget constructor =
+  ?hadjustment:GData.adjustment ->
+  ?vadjustment:GData.adjustment ->
+  ?font_size:int ->
+  ?log_verbosity:int ->
+  ?width:int ->
+  ?height:int ->
+  ?packing:(GObj.widget -> unit) ->
+  ?show:bool ->
   unit ->
-    MatitaTypes.sequent_viewer
+    'widget
+
+val clickableMathView:  MatitaGuiTypes.clickableMathView constructor
 
-val proof_viewer :
-  mml_of_cic_object:MatitaTypes.mml_of_cic_object ->
-  ?packing:(GObj.widget -> unit) -> ?show:bool ->
+val cicMathView:        MatitaGuiTypes.cicMathView constructor
+
+val sequentsViewer:
+  notebook:GPack.notebook ->
+  cicMathView:MatitaGuiTypes.cicMathView ->
   unit ->
-    MatitaTypes.proof_viewer
+    MatitaGuiTypes.sequentsViewer
+
+val cicBrowser: unit -> MatitaGuiTypes.cicBrowser
+
+(** {2 MathView wide functions} *)
+(* TODO ZACK consider exporting here a single function which return a list of
+ * MatitaGuiTypes.clickableMathView and act on them externally ... *)
+
+val increase_font_size:   unit -> unit
+val decrease_font_size:   unit -> unit
+val reset_font_size:      unit -> unit
+
+val refresh_all_browsers: unit -> unit  (** act on all cicBrowsers *)
+val update_font_sizes:    unit -> unit
+
+  (** {3 Clipboard & Selection handling} *)
+
+val has_selection: unit -> bool
+
+  (** fills the clipboard with the current selection
+   * @raise Failure "no selection" *)
+val copy_selection: unit -> unit
+val has_clipboard: unit -> bool (** clipboard is not empty *)
+val empty_clipboard: unit -> unit (** empty the clipboard *)
+
+  (** @raise Failure "empty clipboard" *)
+val paste_clipboard: MatitaGuiTypes.paste_kind -> string
+
+(** {2 Singleton instances} *)
+
+val cicMathView_instance: unit -> MatitaGuiTypes.cicMathView
+val sequentsViewer_instance:  unit -> MatitaGuiTypes.sequentsViewer
+
+val mathViewer:               unit -> MatitaTypes.mathViewer
+
+(** {2 Initialization} *)
+
+val set_gui: MatitaGuiTypes.gui -> unit