Frama-C:
Plug-ins:
Libraries:

Frama-C API - text

inherit Frama_c_gui.Widget.widget
method clear : unit
method fmt : Stdlib.Format.formatter

The formatter used by printf method.

method hrule : unit

Print an horizontal rule. Consecutive rules are collapsed.

method printf : 'a. ?scroll:bool -> ('a, Stdlib.Format.formatter, unit) Stdlib.format -> 'a

Append material to the text buffer, optionally scrolling it to the beginning of the message (defaults to autoscrolling setting).

The underlying formatter (method fmt) recognizes the following default tags:

  • "bf" bold face
  • "it" italic style
  • "ul" underlined
  • "st" striked through
  • "blue", "red", "orange", "green" predefined foreground color
  • "hover" background green (default for highlighter)
  • "link" underlined blue
  • "fg:<color name>" foreground color
  • "bg:<color name>" background color
  • "link:<name>" add a link marker

Properties for any tag (except parametric and mark) can be modified with method set_tag_style.

t#printf is a shortcut for Format.fprintf t#fmt followed by flushing and optional scrolling.

method set_monospace : unit

Set a monospace font

method set_font : string -> unit

Set the font used to display the text.

method set_css : (string * GText.tag_property list) list -> unit

Override properties for the given tag name. Must be used before the tag is used.

method set_style : string -> int -> int -> unit
method remove_style : string -> int -> int -> unit
method remove_all : string list -> unit
method offset : int
method lines : int
method set_width : int -> unit
method set_indent : int -> unit
method wrap : (int -> int -> unit) -> (Stdlib.Format.formatter -> unit) -> Stdlib.Format.formatter -> unit

Print with a callback to the actual bounds of the printed material after boxing.

method marker : 'a. 'a marker

Short cut to links#on_click (callback without range).

method set_autoscroll : bool -> unit

Automatically scroll to lastly inserted text (console behavior).

method scroll : ?line:int -> unit -> unit

Default line is last one.

method select : ?scroll:bool -> int -> int -> unit

When scroll:false (default), only minimal scrolling is performed to make the selection visible. Otherwise, the window is scrolled to center the selection at screen.

method get_view : GText.view

Returns the viewer object (and the buffer it contains).