Sfairadora

  • Reference Guide

Disp_folder_def

The definition type of a disp-folder.
Type
Name
Description
Folded_view_info
(see below)
folded_view
Definition of the folded state.
Unfolded_view_info
(see below)
unfolded_view
Definition of the unfolded state.
External_view_info
external_view
Definition of the external display (i.e. presentation displayed in a separate window).
Bool|Enki
init_unfolded
If set TRUE, the disp-folder is initially unfolded.
Int|Enki optional
background
The background color. One of the dispel background constants.
If the value is not specified, a suitable one is determined automatically.
Bool|Enki optional
expander
If set TRUE, the expander button is displayed..
Bool|Enki
permanent_expander_space
If set TRUE, an empty space in place of the expander button is displayed.
Bool|Enki optional
tree_lines
If set TRUE, thin lines forming a tree-structure in a group of disp-folders are displayed (similar those in the left pane of the help window).
Int|Enki
drag_hover
Defines the action performed when the mouse hovers on the disp-folder during drag-and-drop. One of the following values:
0
no action.
1
pressing the button.
2
set value (see the attribute rb_set_value)
The initial value is 1.
Bool|Enki
no_close_volatile
If set TRUE, pressing the button does not close the volatile window the disp-folder is possibly contained in.
Bool|Enki
no_user_data_transfer
If set TRUE, and a data item is associated (via the attributes data_id and data_ref) with the disp folder, the user is not allowed to copy the data item by dragging them with the mouse.
Bool|Enki
query_remove
If set TRUE and a data item is associated (via the attributes data_id and data_ref) with the disp-folder and the data item is optional, the user will be asked for confirmation before data is deleted by pressing the Delete key.
The initial value is TRUE.
Int|Enki optional
hit_action
Selects the action switching between the folded and unfolded display. One of the unfolding action constants.
Int|Enki
rb_set_value
Selects the action to set value (the value rb_value to the data item rb_data_id:rb_data_ref). One of the radio-button functionality action constants.
Atom|Enki optional
rb_data_id
The name of the object containing the target data item that receives the rb_value (the radio-button functionality).
Dref|Enki optional
rb_data_ref
The reference of the data item within the object identified by rb_data_id.
rb_value
The value to be set to rb_data_id:rb_data_ref by the radio-button functionality.
Bool|Enki
direct_edit
If set TRUE and a data item is associated with the disp-folder via the attributes data_id:data_ref, the data item is edited directly instead of editing its copy.
Atom|Enki optional
data_id
The name of the object containing the data item associated with the disp-folder.
Dref|Enki optional
data_ref
A reference to the associated data item within the object specified by data_id.
Atom|Enki optional
data_sub_id
The name under which the associated data (determined by the attributes data_id:data_ref) is published to the disp-folder’s content.
Text|Enki optional
validator
The function verifying data validity. If the type Text is specified, it is an Enki function. If the type Enki is specified, it is a function returning the validator’s source text (i.e. an indirect function).
Bool|Enki optional
bind_undisplayed
If set TRUE, all the subordinate dispels are always created.
Bool|Enki
autodisable
If set TRUE and all the dispels in the external display are disabled, the entire disp-folder is disabled.
This operation requires the attribute bind_undisplayed to be set TRUE and the unfolded display not to be defined or to be set the same as the external display.
This is used, for instance, to disable a menu item when all its entries are disables.
Int
editor_case
This attribute is used by the editor of the disp-folder definition object to store information on which variant of the editor was used.

Folded_view_info

The definition of the display in the folded state.
Type
Name
Description
Int|Enki optional
exteranlizer
The appearance of the externalizer sign. One of the externalizer form constants.
Int|Enki optional
title_style
The style of the frame around the title. One of the button style constants.
Bool|Enki
title_nonactivable
If set TRUE, the title cannot be activated.
Int|Enki
text_style
The text style of the title. One of the label text style constants.
Int|Enki optional
alignment
The title alignment. One of the alignment constants. Only the values ALIGN_LEFT, ALIGN_CENTER, and ALIGN_RIGHT are allowed.
Bool|Enki optional
button_stretch_x
If set TRUE, the button containing the title is stretch to the maximum width possible.
Bool|Enki
button_stretch_y
If set TRUE, the button containing the title is stretch to the maximum height possible.
Int|Enki optional
child_pos
The child’s position relative to the title. One of the child position constants.
Icon|Enki optional
icon
The icon displayed by the title.
Rich_string|
Enki
title
The text of the title.
border
The border around the title.
child
The definition of the dispel displayed when the disp-folder is folded.

Unfolded_view_info

The definition of the display in the folded state.
Type
Name
Description
All the attributes are the same as in Folded_view_info, only the attribute same_as_external is added. If the value the attributes icon or title is not set, the values from folded_view are used.
Bool
same_as_external
If set TRUE, the definition of the child of the external display is used for unfolded display, too.

External_view_info

The definition of the external display (i.e. presentation displayed in a separate window).
Type
Name
Description
child
The definition of the dispel displayed in the window.
String|Enki optional
wnd_title
The window title.
Int|Enki
wnd_style
The window style. One of the window style constants.