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   end
  36
  37 class type sequentViewer =
  38   object
  39     inherit clickableMathView
  40
  41       (** @return the list of selected terms. Selections which are not terms are
  42       * ignored *)
  43     method get_selected_terms: Cic.term list
  44
  45       (** @return the list of selected hypothese. Selections which are not
  46       * hypotheses are ignored *)
  47     method get_selected_hypotheses: Cic.hypothesis list
  48
  49       (** load a sequent and render it into parent widget *)
  50     method load_sequent: Cic.metasenv -> int -> unit
  51   end
  52
  53 class type sequentsViewer =
  54   object
  55     method reset: unit
  56     method load_sequents: ProofEngineTypes.status -> unit
  57     method goto_sequent: int -> unit  (* to be called _after_ load_sequents *)
  58   end
  59
  60 exception Browser_failure of string
  61
  62
  63 class type cicBrowser =
  64 object
  65   method load: MatitaTypes.mathViewer_entry -> unit
  66   (* method loadList: string list -> MatitaTypes.mathViewer_entry -> unit *)
  67   method loadInput: string -> unit
  68 end
  69
  70 (** {2 Constructors} *)
  71
  72   (** meta constructor *)
  73 type 'widget constructor =
  74   ?hadjustment:GData.adjustment ->
  75   ?vadjustment:GData.adjustment ->
  76   ?font_size:int ->
  77   ?log_verbosity:int ->
  78   ?width:int ->
  79   ?height:int ->
  80   ?packing:(GObj.widget -> unit) ->
  81   ?show:bool ->
  82   unit ->
  83     'widget
  84
  85 val clickableMathView:  clickableMathView constructor
  86
  87 val sequentViewer:       sequentViewer constructor
  88
  89 val sequentsViewer:
  90   notebook:GPack.notebook ->
  91   sequentViewer:sequentViewer ->
  92   unit ->
  93     sequentsViewer
  94
  95 val cicBrowser: unit -> cicBrowser
  96
  97 val refresh_all_browsers: unit -> unit
  98
  99 (** {2 singleton instances} *)
 100
 101 val sequentViewer_instance: unit -> sequentViewer
 102 val sequentsViewer_instance: unit -> sequentsViewer
 103
 104 val mathViewer: unit -> MatitaTypes.mathViewer
 105