Sfairadora

  • Reference Guide

Rich_text_editor_def

The definition type of a rich text editor.
Type
Name
Description
Int|Enki optional
frame_style
The button style. One of the frame style constants. Only the values FRAME_NONE, FRAME_SIMPLE, and FRAME_DEEP are allowed.
Bool|Enki
immedate_edit
If set TRUE, the editor is immediately switched to the editing mode (i.e. the text cursor is displayed) when activated.
Bool|Enki
write_immediate
If set TRUE, the edited text is stored to the data item whenever a change is made. If set FALSE, the text is stored only at the end of editing.
border
The border between the editor’s contents and the frame.
Int|Enki
ruler_place
The ruler placement. One of the header placement constants.
The initial value is HP_ALWAYS_VISIBLE.
Bool|Enki
ruler_on_edit
If set TRUE, the ruler is displayed only when the editor is in the editing state (i.e. the text cursor is displayed).
Bool|Enki
dynamic_width
If set TRUE, the editor is enabled to change its width when the window is resized.
Bool|Enki
show_page_breaks
If set TRUE, the editor displays page breaks.
The initial value is TRUE.
Text|Enki optional
data_getter
The getter functions. If the type Text is specified, it is an Enki function. If the type Enki is specified, it is a function returning the getter function’s source text (i.e. an indirect function).
Text|Enki optional
data_setter
The setter functions. If the type Text is specified, it is an Enki function. If the type Enki is specified, it is a function returning the setter function’s source text (i.e. an indirect function).
Data_type_def|Enki optional
data_type
The type to be stored to the data item. If not set, the type is inferred from the data item’s type.
Atom|Enki
data_id
The name of the object where the edited data item is located.
Dref|Enki
data_ref
The reference of the edited data item within the object specified above.
Atom|Enki optional
language
The name of the programming language can be specified here if the editor is intended to edit a function. In the present version, only the value "Enkidu" makes sense. The context help and contents of the menu Insert are determined according to the value of this attribute.