matita/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  ?auto_indent:bool ->
  35  ?highlight_current_line:bool ->
  36  ?indent_on_tab:bool ->
  37  ?indent_width:int ->
  38  ?insert_spaces_instead_of_tabs:bool ->
  39  ?right_margin_position:int ->
  40  ?show_line_marks:bool ->
  41  ?show_line_numbers:bool ->
  42  ?show_right_margin:bool ->
  43  ?smart_home_end:SourceView2Enums.source_smart_home_end_type ->
  44  ?tab_width:int ->
  45  ?editable:bool ->
  46  ?cursor_visible:bool ->
  47  ?justification:GtkEnums.justification ->
  48  ?wrap_mode:GtkEnums.wrap_mode ->
  49  ?accepts_tab:bool ->
  50  ?border_width:int ->
  51  ?width:int ->
  52  ?height:int ->
  53  ?packing:(GObj.widget -> unit) ->
  54  ?show:bool -> unit ->
  55   'widget
  56
  57 val clickableMathView:  MatitaGuiTypes.clickableMathView constructor
  58
  59 val cicMathView:        MatitaGuiTypes.cicMathView constructor
  60
  61 val sequentsViewer:
  62   notebook:GPack.notebook ->
  63   cicMathView:MatitaGuiTypes.cicMathView ->
  64   unit ->
  65     MatitaGuiTypes.sequentsViewer
  66
  67 val cicBrowser: unit -> MatitaGuiTypes.cicBrowser
  68
  69 (** {2 MathView wide functions} *)
  70 (* TODO ZACK consider exporting here a single function which return a list of
  71  * MatitaGuiTypes.clickableMathView and act on them externally ... *)
  72
  73 val increase_font_size:   unit -> unit
  74 val decrease_font_size:   unit -> unit
  75 val reset_font_size:      unit -> unit
  76
  77 val refresh_all_browsers: unit -> unit  (** act on all cicBrowsers *)
  78 val update_font_sizes:    unit -> unit
  79
  80   (** {3 Clipboard & Selection handling} *)
  81
  82 val has_selection: unit -> bool
  83
  84   (** fills the clipboard with the current selection
  85    * @raise Failure "no selection" *)
  86 val copy_selection: unit -> unit
  87 val has_clipboard: unit -> bool (** clipboard is not empty *)
  88 val empty_clipboard: unit -> unit (** empty the clipboard *)
  89
  90   (** @raise Failure "empty clipboard" *)
  91 val paste_clipboard: MatitaGuiTypes.paste_kind -> string
  92
  93 (** {2 Singleton instances} *)
  94
  95 val cicMathView_instance: unit -> MatitaGuiTypes.cicMathView
  96 val sequentsViewer_instance:  unit -> MatitaGuiTypes.sequentsViewer
  97
  98 val mathViewer:               unit -> MatitaTypes.mathViewer
  99
 100 (** {2 Initialization} *)
 101
 102 val set_gui: MatitaGuiTypes.gui -> unit
 103