Index of class methods


A
add [LTerm_widget.box]
add ?position ?expand widget adds a widget to the box.
allocation [LTerm_widget.t]
The zone occuped by the widget.

C
can_focus [LTerm_widget.t]
Whether the widget can receive the focus or not.
children [LTerm_widget.t]
The children of the widget.
clipboard [LTerm_read_line.abstract]
clipboard [LTerm_read_line.engine]
The clipboard used by the edition engine.
clipboard [LTerm_edit.edit]
The clipboard used by the edition engine.
complete [LTerm_read_line.abstract]
complete [LTerm_read_line.engine]
Complete current input.
completion [LTerm_read_line.abstract]
completion [LTerm_read_line.engine]
Ask for computing completion for current input.
completion_index [LTerm_read_line.abstract]
completion_index [LTerm_read_line.engine]
The position in the completion bar.
completion_start [LTerm_read_line.term]
Index of the first displayed word in the completion bar.
completion_words [LTerm_read_line.abstract]
completion_words [LTerm_read_line.engine]
Current possible completions.
context [LTerm_read_line.abstract]
context [LTerm_read_line.engine]
The context for the edition engine.
context [LTerm_edit.edit]
The context for editing the engine.
cursor [LTerm_edit.edit]
The cursor used by this widget.
cursor_position [LTerm_widget.t]
Method invoked when the widget has the focus, it returns the position of the cursor inside the widget if it should be displayed.

D
draw [LTerm_widget.t]
draw ctx focused draws the widget on the given context.
draw_failure [LTerm_read_line.term]
Draws after an exception has been raised.
draw_success [LTerm_read_line.term]
Draws after accepting current input.
draw_update [LTerm_read_line.term]
Updates current display and put the cursor at current edition position.

E
edit [LTerm_read_line.abstract]
edit [LTerm_read_line.engine]
The edition engine used by this read-line engine.
editable [LTerm_edit.edit]
The editable function of the engine.
empty [LTerm_widget.frame]
Remove the child of the frame.
engine [LTerm_edit.edit]
The edition engine used by this widget.
eval [LTerm_read_line.read_keyword]
If the input correspond to a keyword, returns its associated value.
eval [LTerm_read_line.read_password]
Returns the result as a UTF-8 encoded string.
eval [LTerm_read_line.read_line]
Returns the result as a UTF-8 encoded string.
eval [LTerm_read_line.abstract]
eval [LTerm_read_line.engine]
Evaluates the contents of the engine.
exec [LTerm_read_line.term]
Executes a list of actions.

H
hide [LTerm_read_line.term]
Hide this read-line instance.
history [LTerm_read_line.abstract]
history [LTerm_read_line.engine]
The history zipper.

I
input_next [LTerm_read_line.abstract]
input_next [LTerm_read_line.engine]
The input after the cursor.
input_prev [LTerm_read_line.abstract]
input_prev [LTerm_read_line.engine]
The input before the cursor.
insert [LTerm_read_line.abstract]
insert [LTerm_read_line.engine]
Inserts the given character.

K
key_sequence [LTerm_read_line.term]
The currently typed key sequence.
keywords [LTerm_read_line.read_keyword]
List of keywords with their associated values.

L
label [LTerm_widget.button]
The text displayed on the button.
locale [LTerm_edit.edit]
The locale used by the engine.

M
macro [LTerm_read_line.abstract]
macro [LTerm_read_line.engine]
The macro recorder.
macro [LTerm_edit.edit]
The macro recorder.
match_word [LTerm_edit.edit]
The match word function of the engine.
message [LTerm_read_line.abstract]
message [LTerm_read_line.engine]
A message to display in the completion box.
mode [LTerm_read_line.abstract]
mode [LTerm_read_line.engine]
The current mode.

O
on_click [LTerm_widget.button]
on_click ?switch f calls f when the button is clicked.
on_event [LTerm_widget.t]
on_event ?switch f calls f each time an event is received.

P
parent [LTerm_widget.t]
The parent of the widget, if any.
prompt [LTerm_read_line.term]
The signal holding the prompt.

Q
queue_draw [LTerm_widget.t]
Enqueue a redraw operation.

R
remove [LTerm_widget.box]
remove widget remove a widget from the box.
resource_class [LTerm_widget.t]
The resource class of the widget.
resources [LTerm_widget.t]
The set of resources used by the widget.
run [LTerm_read_line.term]
Run this read-line instance.

S
send_action [LTerm_read_line.abstract]
send_action [LTerm_read_line.engine]
Evolves according to the given action.
send_event [LTerm_widget.t]
Send an event to the widget.
set [LTerm_widget.frame]
Set the widget that is inside the frame.
set_allocation [LTerm_widget.t]
Sets the zone occuped by the widget.
set_completion [LTerm_read_line.abstract]
set_completion [LTerm_read_line.engine]
set_completion index words sets the current completions.
set_label [LTerm_widget.button]
set_locale [LTerm_edit.edit]
set_parent [LTerm_widget.t]
Sets the parent of the widget.
set_prompt [LTerm_read_line.term]
Sets the prompt signal.
set_queue_draw [LTerm_widget.t]
set_queue_draw f sets the function called when the LTerm_widget.t.queue_draw method is invoked, for this widget and all its children.
set_resource_class [LTerm_widget.t]
Sets the resource class of the widget.
set_resources [LTerm_widget.t]
Sets the resources of the widget and of all its children.
set_text [LTerm_widget.label]
show [LTerm_read_line.term]
Show this read-line instance if it has been previously hidden.
show_box [LTerm_read_line.abstract]
show_box [LTerm_read_line.engine]
Whether to show the box or not.
size [LTerm_read_line.term]
The size of the terminal.
size_request [LTerm_widget.t]
The size wanted by the widget.
stylise [LTerm_read_line.abstract]
stylise [LTerm_read_line.engine]
Returns the stylised input and the position of the cursor.

T
text [LTerm_edit.edit]
Shorthand for Zed_rope.to_string (Zed_edit.text edit#engine).
text [LTerm_widget.label]
The text of the label.

U
update_resources [LTerm_widget.t]
Method invoked when the resources or the resource class of the widget change.