package lambda-term
Install
Dune Dependency
Authors
Maintainers
Sources
sha256=1cab780d63024b1c39a95a425897e195b62d168e383c06372ceea2d3f3673edd
md5=4602aa4355705909e406513322b4b27e
doc/lambda-term/LTerm_draw/index.html
Module LTerm_draw
Source
Drawing
type elem = {
char : Zed_char.t;
(*The Zed_char.t character.
*)bold : bool;
(*Whether the character is in bold or not.
*)underline : bool;
(*Whether the character is underlined or not.
*)blink : bool;
(*Whether the character is blinking or not.
*)reverse : bool;
(*Whether the character is in reverse video mode or not.
*)foreground : LTerm_style.color;
(*The foreground color.
*)background : LTerm_style.color;
(*The background color.
*)
}
Type of a element in a matrix of styled characters.
Type of a matrix of points. The matrix is indexed by lines then columns, i.e. to access the point at line l
and column c
in matrix m
you should use m.(l).(c)
.
matrix size
creates a matrix of the given size containing only blank characters.
set_style point style
sets fields of point
according to fields of style
. For example:
set_style point { LTerm_style.none with LTerm_style.bold = Some true }
will have the following effect:
point.bold <- true
Type of contexts. A context is used for drawing.
context m s
creates a context from a matrix m
of size s
. It raises Invalid_argument
if s
is not the size of m
.
Exception raised when trying to access a point that is outside the bounds of a context.
size ctx
returns the size of the given context.
sub ctx rect
creates a sub-context from the given context. It raises Out_of_bounds
if the rectangle is not contained in the given context.
clear ctx
clears the given context. It resets all styles to their default and sets characters to spaces.
fill ctx ch
fills the given context with ch
.
fill_style style
fills the given context with style
.
point ctx row column
returns the point at given position in ctx
. It raises Out_of_bounds
if the coordinates are outside the given context.
draw_char_matrix matrix row column ?style ch
sets the character at given coordinates to ch
. It does nothing if the given coordinates are outside the bounds of the context.
draw_char ctx row column ?style ch
sets the character at given coordinates to ch
. It does nothing if the given coordinates are outside the bounds of the context.
draw_string ctx row column ?style str
draws the given string at given coordinates. This does not affect styles. str
may contains newlines.
draw_styled ctx row column ?style text
draws the given styled text at given coordinates.
val draw_string_aligned :
context ->
int ->
LTerm_geom.horz_alignment ->
?style:LTerm_style.t ->
Zed_string.t ->
unit
Draws a string with the given alignment.
val draw_styled_aligned :
context ->
int ->
LTerm_geom.horz_alignment ->
?style:LTerm_style.t ->
LTerm_text.t ->
unit
Draws a styled string with the given aglienment.
Type of an connection in a piece that can be connected to other pieces.
Type of a piece, given by its four connection.
Draws a piece. It may modify pieces around it.
draw_hline ctx row column length connection
draws an horizontal line.
draw_hline ctx row column length connection
draws a vertical line.
Draws a rectangle.
val draw_frame_labelled :
context ->
LTerm_geom.rect ->
?style:LTerm_style.t ->
?alignment:LTerm_geom.horz_alignment ->
Zed_string.t ->
connection ->
unit
Draws a rectangle with a label on the top row.