A | |
action_of_name [LTerm_read_line] | action_of_name str converts the given action name into an
action.
|
action_of_name [LTerm_edit] | action_of_name str converts the given action name into an
action.
|
actions [LTerm_read_line] |
List of actions with their names, except
Edit .
|
actions [LTerm_edit] |
List of actions with their names, except
Zed .
|
add [LTerm_history] | add history ?skip_empty ?skip_dup entry adds entry to the
top of the history.
|
add [LTerm_resources] | add pattern value returns the new set of resources with the
binding pattern -> value at the end.
|
B | |
background [LTerm_style] | |
bind [LTerm_read_line] | bind seq actions associates actions to the given
sequence.
|
bind [LTerm_edit] | bind seq actions associates actions to the given
sequence.
|
bindings [LTerm_read_line] |
Bindings.
|
bindings [LTerm_edit] |
Bindings.
|
black [LTerm_style] | |
blink [LTerm_style] | |
blue [LTerm_style] | |
bold [LTerm_style] | |
button [LTerm_mouse] | |
C | |
clear [LTerm_draw] | clear ctx clears the given context.
|
clear_line [LTerm] | clear_line term erases the current line.
|
clear_line_next [LTerm] | clear_line_next term erases the current line from the cursor
to the end of the line.
|
clear_line_prev [LTerm] | clear_line_prev term erases the current line from the cursor
to the beginning of the line.
|
clear_screen [LTerm] | clear_screen term clears the entire screen.
|
clear_screen_next [LTerm] | clear_screen_next term clears the screen from the cursor to
the bottom of the screen.
|
clear_screen_prev [LTerm] | clear_screen_prev term clears the screen from the cursor to
the top of the screen.
|
clipboard [LTerm_edit] |
The global clipboard.
|
code [LTerm_key] | |
col [LTerm_mouse] | |
col [LTerm_geom] | |
col1 [LTerm_geom] | |
colors [LTerm] |
Number of colors of the terminal.
|
cols [LTerm_geom] | |
common_prefix [LTerm_read_line] |
Returns the common prefix of a list of words.
|
compare [LTerm_mouse] |
Same as
Pervasives.compare .
|
compare [LTerm_key] |
Same as
Pervasives.compare .
|
contents [LTerm_history] |
Returns all the entries of the history.
|
context [LTerm_draw] | context m s creates a context from a matrix m of size
s .
|
context_oc [LTerm] |
Returns the output channel used by the given context.
|
context_term [LTerm] |
Returns the terminal used by the given context.
|
control [LTerm_mouse] | |
control [LTerm_key] | |
create [LTerm_history] | create ?max_size ?max_lines init creates a new history.
|
create [LTerm_ui] | create term ?save_state draw creates a new user
interface.
|
create [LTerm] | create ?windows ?model ?incoming_encoding ?outgoing_encoding
input_fd input_channel outout_fd output_channel creates a new
terminal using input_fd and input_channel for inputs and
output_fd and output_channel for outputs.
|
cursor_position [LTerm_ui] | cursor_position ui returns the position of the cursor inside
the UI.
|
cursor_visible [LTerm_ui] | cursor_visible ui returns true if the cursor is displayed in
the UI.
|
cyan [LTerm_style] | |
D | |
default [LTerm_inputrc] |
The name of the default key bindings file,
i.e.
|
default [LTerm_style] | |
disable_mouse [LTerm] |
Disable mouse events reporting.
|
doc_of_action [LTerm_read_line] | doc_of_action action returns a short description of the
action.
|
doc_of_action [LTerm_edit] | doc_of_action action returns a short description of the
action.
|
draw [LTerm_ui] | draw ui enqueue a draw operation for the given UI.
|
draw_char [LTerm_draw] | draw_char ctx row column ?style ch sets the character at given
coordinates to ch .
|
draw_frame [LTerm_draw] |
Draws a rectangle.
|
draw_hline [LTerm_draw] | draw_hline ctx row column length connection draws an
horizontal line.
|
draw_piece [LTerm_draw] |
Draws a piece.
|
draw_string [LTerm_draw] | draw_string ctx row column ?style str draws the given string
at given coordinates.
|
draw_string_aligned [LTerm_draw] |
Draws a string with the given alignment.
|
draw_styled [LTerm_draw] | draw_styled ctx row column ?style text draws the given styled
text at given coordinates.
|
draw_styled_aligned [LTerm_draw] |
Draws a styled string with the given aglienment.
|
draw_vline [LTerm_draw] | draw_hline ctx row column length connection draws a vertical
line.
|
E | |
empty [LTerm_resources] |
The empty set of resources.
|
enable_mouse [LTerm] |
Enable mouse events reporting.
|
encode_char [LTerm] | encode_char term ch encodes an unicode character using the
terminal encoding.
|
encode_string [LTerm] | encode_string term str encodes an UTF-8 string using the
terminal encoding.
|
enter_raw_mode [LTerm] | enter_raw_mode term puts the terminal in ``raw mode''.
|
entry_size [LTerm_history] | entry_size entry returns the size taken by an entry in the
history file in bytes.
|
eprint [LTerm] | |
eprintf [LTerm] | |
eprintl [LTerm] | |
eprintlf [LTerm] | |
eprintls [LTerm] | |
eprints [LTerm] | |
equal [LTerm_style] | equal s1 s2 returns true iff s1 and s2 are equal after
having replaced all None fields by Some false or Some
Default .
|
escape_time [LTerm] |
Time waited before returning the escape key.
|
eval [LTerm_text] | eval makrup evaluates a markup strings as a styled string.
|
exec_callbacks [LTerm_widget] | apply_callbacks callbacks x
|
exec_filters [LTerm_widget] | |
F | |
fill [LTerm_draw] | fill ctx ch fills the given context with ch .
|
fill_console_output_character [LTerm_windows] | fill_console_output_character fd char count coord writes
count times char starting at coord on the given
console.
|
fill_style [LTerm_draw] | fill_style style fills the given context with style .
|
flush [LTerm] |
Flushes the underlying output channel used by the terminal.
|
foreground [LTerm_style] | |
fprint [LTerm] | |
fprintf [LTerm] | |
fprintl [LTerm] | |
fprintlf [LTerm] | |
fprintls [LTerm] | |
fprints [LTerm] | |
G | |
get [LTerm_resources] | get key resources returns the key associated to the last
pattern that matches key in resources , or the empty string
if no pattern matches key .
|
get_acp [LTerm_windows] |
Returns the current ANSI codepage.
|
get_bool [LTerm_resources] | get_bool name resources reads the boolean encoded in
resources .
|
get_color [LTerm_resources] | get_color name resources reads the color encoded in
resources .
|
get_connection [LTerm_resources] | get_connection name resources
|
get_console_cp [LTerm_windows] |
Returns the input codepage used by the console attached to the
current process.
|
get_console_cursor_info [LTerm_windows] |
Returns the size and visible status of the cursor on the given
console.
|
get_console_mode [LTerm_windows] |
Returns the mode of the given console.
|
get_console_output_cp [LTerm_windows] |
Returns the output codepage used by the console attached to the
current process.
|
get_console_screen_buffer_info [LTerm_windows] | get_console_screen_buffer_info fd returns the current
informations about the given console.
|
get_size_from_fd [LTerm] | get_size_from_fd fd returns the size of the terminal accessible via
the given file descriptor.
|
get_style [LTerm_resources] | get_style prefix resources reads the style encoded in
resources .
|
goto [LTerm] | goto term coord moves the cursor to the given coordinates.
|
green [LTerm_style] | |
H | |
hide_cursor [LTerm] |
Make the cursor invisible.
|
home [LTerm_resources] |
The home directory.
|
I | |
incoming_is_a_tty [LTerm] | incoming_is_a_tty term whether the input of term is a tty
device.
|
index [LTerm_style] | |
is_a_tty [LTerm] | is_a_tty term whether the intput and output of the given
terminal are connected to a tty device.
|
L | |
lblack [LTerm_style] | |
lblue [LTerm_style] | |
lcyan [LTerm_style] | |
leave_raw_mode [LTerm] | leave_raw_mode term mode leaves the raw mode by restoring the
given mode.
|
length [LTerm_history] |
Returns the number of entries in the history.
|
lgreen [LTerm_style] | |
lmagenta [LTerm_style] | |
load [LTerm_history] | load history ?log ?skip_empty ?skip_dup filename loads entries
from filename to history .
|
load [LTerm_inputrc] | load ?file () loads key bindings from file , which defaults
to ~/.lambda-term-inputrc, if it exists.
|
load [LTerm_resources] |
Same as
LTerm_resources.parse but parses the contents of a file.
|
load_state [LTerm] |
Load the previously saved state of the terminal.
|
lookup [LTerm_read_line] | lookup word words lookup for completion of word into
words .
|
lookup_assoc [LTerm_read_line] | lookup_assoc word words does the same as LTerm_read_line.lookup but works
on associative list.
|
lred [LTerm_style] | |
lwhite [LTerm_style] | |
lyellow [LTerm_style] | |
M | |
macro [LTerm_read_line] |
The global macro recorder.
|
macro [LTerm_edit] |
The global macro recorder.
|
magenta [LTerm_style] | |
make_matrix [LTerm_draw] | matrix size creates a matrix of the given size containing only
blank characters.
|
max_entries [LTerm_history] |
Returns the maximum number of entries of the history.
|
max_size [LTerm_history] |
Returns the maximum size of the history.
|
merge [LTerm_resources] | merge res1 res2 merges the two given sets of resources.
|
merge [LTerm_style] | merge s1 s2 is s2 with all undefined fields set to ones of
s1 .
|
meta [LTerm_mouse] | |
meta [LTerm_key] | |
model [LTerm] |
Returns the model of the terminal.
|
move [LTerm] | move term rows columns moves the cursor by the given number of
lines and columns.
|
N | |
name_of_action [LTerm_read_line] | name_of_action act returns the name of the given action.
|
name_of_action [LTerm_edit] | name_of_action act returns the name of the given action.
|
none [LTerm_style] |
Style with all fields set to
None .
|
O | |
of_rope [LTerm_text] |
Creates a styled string from a rope.
|
of_string [LTerm_text] |
Creates a styled string from a string.
|
of_string_maybe_invalid [LTerm_text] |
Creates a styled string from a string.
|
old_count [LTerm_history] |
Returns the number of old entries in the history.
|
outgoing_is_a_tty [LTerm] | incoming_is_a_tty term whether the output of term is a tty
device.
|
P | |
parse [LTerm_resources] | parse str parses a string for a list of properties.
|
parse_event [LTerm_unix] | parse_event encoding stream parses one event from the given
input stream.
|
point [LTerm_draw] | point ctx row column returns the point at given position in
ctx .
|
print [LTerm] | |
print_box [LTerm] | print_box term matrix prints the contents of matrix starting
at current cursor row.
|
print_box_with_newlines [LTerm] | |
printf [LTerm] | |
printl [LTerm] | |
printlf [LTerm] | |
printls [LTerm] | |
prints [LTerm] | |
Q | |
quit [LTerm_ui] | quit () quit the given ui and restore the terminal state.
|
R | |
read_console_input [LTerm_windows] | read_console_input fd reads one input from the given file
descriptor.
|
read_event [LTerm] |
Reads and returns one event.
|
red [LTerm_style] | |
register [LTerm_widget] | |
render [LTerm] |
Render an offscreen array to the given terminal.
|
render_update [LTerm] | render_update displayed to_display does the same as render
to_display but assumes that displayed contains the current
displayed text.
|
reverse [LTerm_style] | |
rgb [LTerm_style] | rgb r g b raises Invalid_argument if one of r , g or b
is not in the range 0..255 .
|
row [LTerm_mouse] | |
row [LTerm_geom] | |
row1 [LTerm_geom] | |
row2 [LTerm_geom] | |
rows [LTerm_geom] | |
run [LTerm_widget] | run term ?save_state widget w runs on the given terminal using
widget as main widget.
|
S | |
save [LTerm_history] | save history ?max_size ?max_entries ?skip_empty ?sjip_dup ?perm
filename saves history to filename .
|
save_state [LTerm] |
Save the current state of the terminal so it can be restored
latter.
|
set_console_cp [LTerm_windows] |
Sets the input codepage used by the console attached to the
current process.
|
set_console_cursor_info [LTerm_windows] | set_console_cursor_info fd size visible sets the size and
visible status of the cursor on the given console.
|
set_console_cursor_position [LTerm_windows] |
Move the cursor to the specified location in the screen
buffer.
|
set_console_mode [LTerm_windows] |
Sets the mode of the given console.
|
set_console_output_cp [LTerm_windows] |
Sets the output codepage used by the console attached to the
current process.
|
set_console_text_attribute [LTerm_windows] | set_console_text_attribute fd attributes
|
set_cursor_position [LTerm_ui] | set_cursor_position ui coord sets the position of the cursor
inside the UI.
|
set_cursor_visible [LTerm_ui] | set_cursor_visible ui visible sets the cursor visible
state.
|
set_escape_time [LTerm] |
Set the time waited before returning the escape key.
|
set_io [LTerm] |
Modifies file descriptors/channels of a terminal.
|
set_max_entries [LTerm_history] |
Sets the maximum number of entries of the history.
|
set_max_size [LTerm_history] |
Sets the maximum size of the history.
|
set_old_count [LTerm_history] | set_old_count history count sets the number of old entries in
the history.
|
set_size_from_fd [LTerm] | set_size_from_fd fd size tries to set the size of the terminal
accessible via the given file descriptor.
|
set_style [LTerm_draw] | set_style point style sets fields of point according to
fields of style .
|
set_style [LTerm] |
Change the style of the termina for subsequent unstyled
output.
|
show_cursor [LTerm] |
Make the cursor visible.
|
sigwinch [LTerm_unix] |
The number of the signal used to indicate that the terminal size
have changed.
|
size [LTerm_history] |
Returns the size (in bytes) of the history.
|
size [LTerm_ui] | size ui returns the current size of the terminal used by the
given user-interface.
|
size [LTerm_draw] | size ctx returns the size of the given context.
|
size [LTerm] |
Returns the curent size of the terminal.
|
size_of_rect [LTerm_geom] |
Returns the size of a rectangle.
|
stderr [LTerm] |
Terminal using
Lwt_unix.stdin as input and Lwt_unix.stderr
as output.
|
stdout [LTerm] |
Terminal using
Lwt_unix.stdin as input and Lwt_unix.stdout
as output.
|
stop [LTerm_widget] | |
string_of_coord [LTerm_geom] |
Returns the string representation of the given coordinates.
|
string_of_rect [LTerm_geom] |
Returns the string representation of the given rectangle.
|
string_of_size [LTerm_geom] |
Returns the string representation of the given size.
|
stylise [LTerm_text] | stylise string style creates a styled string with all styles
set to style .
|
stylise_parenthesis [LTerm_text] | stylise_parenthesis text ?paren pos style searchs for
parenthesis group starting or ending at pos and apply them the
style style .
|
sub [LTerm_draw] | sub ctx rect creates a sub-context from the given context.
|
system_encoding [LTerm_unix] |
The encoding used by the system.
|
T | |
to_rope [LTerm_text] |
Returns the string part of a styled string as a rope.
|
to_string [LTerm_text] |
Returns the string part of a styled string.
|
to_string [LTerm_mouse] |
Returns the string representation of the given mouse event.
|
to_string [LTerm_event] | to_string event returns the string representation of the given
event.
|
to_string [LTerm_key] |
Returns the string representation of the given key.
|
to_string_compact [LTerm_key] |
Returns the string representation of the given key in the form
"C-M-a".
|
U | |
unbind [LTerm_read_line] | unbind seq unbinds seq .
|
unbind [LTerm_edit] | unbind seq unbinds seq .
|
underline [LTerm_style] | |
update_style [LTerm] | update_style ctx style updates the style of the context with
style .
|
W | |
wait [LTerm_ui] | wait ui wait for an event.
|
white [LTerm_style] | |
windows [LTerm] |
Whether the terminal is a windows console or not.
|
with_context [LTerm] | with_context term f creates a new printing context and pass it
to f .
|
write_console_output [LTerm_windows] | write_console_output fd chars size coord rect writes the given
matrix of characters with their attributes on the given console
at given position.
|
Y | |
yellow [LTerm_style] |