Sfairadora

  • Reference Guide

Line_editor_def

The definition type of a line editor.
Type
Name
Description
Int|Enki optional
frame_style
The frame style. One of the frame style constants. Only the values FRAME_NONE, FRAME_SIMPLE, and FRAME_DEEP are allowed.
If the value is not specified, an appropriate style is determined automatically based on the editor’s placement.
Int|Enki optional
background
The background color. One of the dispel background constants.
If the value is not specified, an appropriate color is determined automatically based on whether the editor is read-only or not.
Int|Enki optional
alignment
The editor content alignment. One of the alignment constants. Only the values ALIGN_LEFT, ALIGN_CENTER, and ALIGN_RIGHT are allowed.
If the value is not specified, an appropriate alignment is determined automatically. The data type and column settings are then considered.
Bool|Enki
trim_spaces
If set TRUE, spaces at the beginning and end of the string entered are removed before the string is stored to the data item.
The initial value is TRUE.
Bool|Enki
no_close_volatile
If set TRUE, performing editing does not close the volatile window the line editor is possibly contained in.
Int|Enki
write_mode
Determines when the edited data is written to the data item. One of the value write mode constants.
The initial value is WRITE_SPIN.
Bool|Enki
tidy
If set TRUE and a number is edited, the number is displayed with the digits grouped by three and with the decimal separator as set in the document settings, the section Symbols.
The initial value is TRUE.
Bool|Enki optional
raw_text
If set TRUE, the user cannot change the formatting of the edited string.
If the value is not set, it is determined according to the data being edited.
Bool|Enki
spin_buttons
If set TRUE, spin buttons are displayed.
Text|Enki
spin_expr
The expression invoked by the spin buttons. For details, see the description of line editor.
Bool|Enki
noneditable
If set TRUE, the editor can be activated, but not switched to the editing mode (the state with the text cursor).
Bool|Enki
look_for_text
The option “Find text for value”.
Bool|Enki
enable_not_listed
The option “Enable value without text”.
border
The border between the contents of the editor and the frame.
Int|Enki optional
max_string_size
Maximum number of characters that can be entered in the editor.
Int|Enki optional
precision
Decimal number precision.
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.