matitaB/matita/matitaScript.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 exception NoUnfinishedProof
  27 exception ActionCancelled of string
  28
  29 class type script =
  30 object
  31
  32   method locked_mark : Gtk.text_mark
  33   method locked_tag : GText.tag
  34   method error_tag : GText.tag
  35
  36     (** @return current status *)
  37   method status: GrafiteTypes.status
  38
  39   (** {2 Observers} *)
  40
  41   method addObserver : (GrafiteTypes.status -> unit) -> unit
  42
  43   (** {2 Unicode handling} *)
  44   method nextSimilarSymbol: unit
  45
  46   (** {2 Undo/redo} *)
  47
  48   method safe_undo: unit
  49   method safe_redo: unit
  50
  51   (** {2 History} *)
  52
  53   method activate : unit
  54   method advance : ?statement:string -> unit -> unit
  55   method retract : unit -> unit
  56   method goto: [`Top | `Bottom | `Cursor] -> unit -> unit
  57   method reset: unit -> unit
  58   method template: unit -> unit
  59
  60     (** {2 Selections / clipboards handling} *)
  61
  62   method markupSelected: bool
  63   method canCopy: bool
  64   method canCut: bool
  65   method canDelete: bool
  66   (*CSC: WRONG CODE: we should look in the clipboard instead! *)
  67   method canPaste: bool
  68   method canPastePattern: bool
  69
  70   method copy:         unit -> unit
  71   method cut:          unit -> unit
  72   method delete:       unit -> unit
  73   method paste:        unit -> unit
  74   method pastePattern: unit -> unit
  75
  76   (** {2 Load/save} *)
  77
  78   method has_name: bool
  79   (* alwais return a name, use has_name to check if it is the default one *)
  80   method filename: string
  81   method buri_of_current_file: string
  82   method include_paths: string list
  83   method assignFileName : string option -> unit (* to the current active file *)
  84   method loadFromFile : string -> unit
  85   method saveToFile : unit -> unit
  86
  87   (** end of script, true if the whole script has been executed *)
  88   method eos: bool
  89   method bos: bool
  90
  91   (** misc *)
  92   method clean_dirty_lock: unit
  93   method set_star: bool -> unit
  94   method source_view: GSourceView2.source_view
  95   method has_parent: GObj.widget -> bool
  96
  97   (* debug *)
  98   method dump : unit -> unit
  99   method expandAllVirtuals : unit
 100
 101 end
 102
 103 val script:
 104  parent:GBin.scrolled_window -> tab_label:GMisc.label -> unit -> script
 105
 106 val destroy: int -> unit
 107 val current: unit -> script
 108 val at_page: int -> script
 109
 110 val iter_scripts: (script -> unit) -> unit