helm/matita/matitaMathView.mli

   1 (* Copyright (C) 2004, 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 clickable_math_view =
  30   object
  31     inherit GMathViewAux.multi_selection_math_view
  32
  33       (** set hyperlink callback. None disable hyperlink handling *)
  34     method set_href_callback: (UriManager.uri -> unit) option -> unit
  35   end
  36
  37 class type proof_viewer =
  38   object
  39     inherit clickable_math_view
  40
  41     method load_proof: StatefulProofEngine.proof_status -> unit
  42   end
  43
  44 class type sequent_viewer =
  45   object
  46     inherit clickable_math_view
  47
  48       (** @return the list of selected terms. Selections which are not terms are
  49       * ignored *)
  50     method get_selected_terms: Cic.term list
  51
  52       (** @return the list of selected hypothese. Selections which are not
  53       * hypotheses are ignored *)
  54     method get_selected_hypotheses: Cic.hypothesis list
  55
  56       (** load a sequent and render it into parent widget *)
  57     method load_sequent: Cic.metasenv -> int -> unit
  58   end
  59
  60 class type sequents_viewer =
  61   object
  62     method reset: unit
  63     method load_sequents: Cic.metasenv -> unit
  64     method goto_sequent: int -> unit  (* to be called _after_ load_sequents *)
  65   end
  66
  67 class type cicBrowser =
  68   object
  69     method load_uri: UriManager.uri -> unit
  70   end
  71
  72 (** {2 Constructors} *)
  73
  74 val proof_viewer:
  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     proof_viewer
  85
  86 val sequent_viewer:
  87   ?hadjustment:GData.adjustment ->
  88   ?vadjustment:GData.adjustment ->
  89   ?font_size:int ->
  90   ?log_verbosity:int ->
  91   ?width:int ->
  92   ?height:int ->
  93   ?packing:(GObj.widget -> unit) ->
  94   ?show:bool ->
  95   unit ->
  96     sequent_viewer
  97
  98 val sequents_viewer:
  99   notebook:GPack.notebook ->
 100   sequent_viewer:sequent_viewer ->
 101   set_goal:(int -> unit) ->
 102   unit ->
 103     sequents_viewer
 104
 105 val cicBrowser: unit -> cicBrowser
 106
 107 val mathViewer: unit -> MatitaTypes.mathViewer
 108
 109 (** {2 Singletons} *)
 110
 111   (** singleton proof_viewer instance.
 112   * Uses singleton GUI instance *)
 113 val proof_viewer_instance: unit -> proof_viewer
 114