otherlibs/labltk/frx/frx_text.mli

   1 (***********************************************************************)
   2 (*                                                                     *)
   3 (*                 MLTk, Tcl/Tk interface of Objective Caml            *)
   4 (*                                                                     *)
   5 (*    Francois Rouaix, Francois Pessaux, Jun Furuse and Pierre Weis    *)
   6 (*               projet Cristal, INRIA Rocquencourt                    *)
   7 (*            Jacques Garrigue, Kyoto University RIMS                  *)
   8 (*                                                                     *)
   9 (*  Copyright 2002 Institut National de Recherche en Informatique et   *)
  10 (*  en Automatique and Kyoto University.  All rights reserved.         *)
  11 (*  This file is distributed under the terms of the GNU Library        *)
  12 (*  General Public License, with the special exception on linking      *)
  13 (*  described in file LICENSE found in the Objective Caml source tree. *)
  14 (*                                                                     *)
  15 (***********************************************************************)
  16 open Camltk
  17
  18 val abs_index : int -> textIndex
  19   (* [abs_index offs] returns the corresponding TextIndex *)
  20
  21 val insertMark : textIndex
  22 val currentMark : textIndex
  23 val textEnd : textIndex
  24 val textBegin : textIndex
  25   (* shortcuts for various positions in a text widget *)
  26
  27 val scroll_link : Widget.widget -> Widget.widget -> unit
  28   (* [scroll_link scrollbar text] links a scrollbar and a text widget
  29      as expected
  30    *)
  31
  32 val new_scrollable_text :
  33   Widget.widget -> options list -> bool -> Widget.widget * Widget.widget
  34   (* [new_scrollable_text parent opts nav_keys] makes a scrollable text
  35      widget with optional navigation keys. Returns frame and text widget.
  36    *)
  37 val addsearch : Widget.widget -> unit
  38   (* [addsearch textw] adds a search dialog bound on [Control-s]
  39      on the text widget
  40    *)
  41
  42 val navigation_keys : Widget.widget -> unit
  43   (* [navigation_keys textw] adds common navigations functions to [textw] *)
  44
  45 val init : unit -> unit
  46   (* [init ()] must be called before any of the above features is used *)