helm/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   (** multi selection gtkMathView which handle mactions and hyperlinks. Mactions
  27   * are handled internally. Hyperlinks are handled by calling an user provided
  28   * callback *)
  29 class type clickableMathView =
  30   object
  31     inherit GMathViewAux.multi_selection_math_view
  32
  33       (** set hyperlink callback. None disable hyperlink handling *)
  34     method set_href_callback: (string -> unit) option -> unit
  35
  36     method update_font_size: unit
  37   end
  38
  39 class type sequentViewer =
  40   object
  41     inherit clickableMathView
  42
  43       (** @return the list of selected terms. Selections which are not terms are
  44       * ignored *)
  45     method get_selected_terms: Cic.term list
  46
  47       (** @return the list of selected hypothese. Selections which are not
  48       * hypotheses are ignored *)
  49     method get_selected_hypotheses: Cic.hypothesis list
  50
  51       (** load a sequent and render it into parent widget *)
  52     method load_sequent: Cic.metasenv -> int -> unit
  53   end
  54
  55 class type sequentsViewer =
  56   object
  57     method reset: unit
  58     method load_sequents: ProofEngineTypes.status -> unit
  59     method goto_sequent: int -> unit  (* to be called _after_ load_sequents *)
  60   end
  61
  62 exception Browser_failure of string
  63
  64 class type cicBrowser =
  65 object
  66   method load: MatitaTypes.mathViewer_entry -> unit
  67   (* method loadList: string list -> MatitaTypes.mathViewer_entry -> unit *)
  68   method loadInput: string -> unit
  69 end
  70
  71 (** {2 Constructors} *)
  72
  73   (** meta constructor *)
  74 type 'widget constructor =
  75   ?hadjustment:GData.adjustment ->
  76   ?vadjustment:GData.adjustment ->
  77   ?font_size:int ->
  78   ?log_verbosity:int ->
  79   ?width:int ->
  80   ?height:int ->
  81   ?packing:(GObj.widget -> unit) ->
  82   ?show:bool ->
  83   unit ->
  84     'widget
  85
  86 val clickableMathView:  clickableMathView constructor
  87
  88 val sequentViewer:       sequentViewer constructor
  89
  90 val sequentsViewer:
  91   notebook:GPack.notebook ->
  92   sequentViewer:sequentViewer ->
  93   unit ->
  94     sequentsViewer
  95
  96 val cicBrowser: unit -> cicBrowser
  97
  98 (** mathview wide functions *)
  99
 100 val increase_font_size: unit -> unit
 101 val decrease_font_size: unit -> unit
 102 val reset_font_size: unit -> unit
 103
 104 val refresh_all_browsers: unit -> unit  (** act on all cicBrowsers *)
 105 val update_font_sizes: unit -> unit
 106
 107 (** {2 singleton instances} *)
 108
 109 val sequentViewer_instance: unit -> sequentViewer
 110 val sequentsViewer_instance: unit -> sequentsViewer
 111
 112 val mathViewer: unit -> MatitaTypes.mathViewer
 113