Sfairadora

  • Reference Guide

Sequence Editor

The sequence editor is used to display and edit the sequence data type category – that is, series of elements of the same type and variable length (i.e. lists). The sequence editor can also display and edit arrays. The table dispel has a function similar to that of the sequence editor: it is used to edit sequences whose elements are structures. These sequences should be managed by the table dispel because it can display structure items in aligned columns with headers. In contrast, the sequence editor should be used in simpler circumstances such as sequences of numbers or situations where the sequence is not a table.
In principle, an element template – a dispel definition object is defined for the sequence editor. Dispels are then replicated according to this template, and their number is equal to the current number of the edited sequence elements. Every instance of the element dispel is provided with a data object, representing the sequence element, by the sequence editor.
The use of the sequence editor is mostly analogical to the use of a table.

Display

Item
Description
Alignment
If the sequence editor elements have different widths, this setting determines their alignment. The options are: left, center, right, and in block. In block alignment expands all elements so that their width is equal to the width of the widest element (if permitted by the element dispel).
Horizontal
If checked, the editor elements are placed side by side instead of under each other.
Multicolumn
If checked, and the number of elements is greater than can fit within the window, they will be broken into several columns. (Or into several rows if horizontal arrangement is selected.)
Space before element
The size (in pixels) of the space before every element – i.e. the space above the element in case of vertical arrangement, and the space to the left of the element in case of horizontal arrangement.
Space after element
The size (in pixels) of the space after every element.
Space between elements
The space (in pixels) between elements. In contrast to the space before and after element, it is not displayed before the first and after the last element. The space between inner elements is therefore equal to the sum of the spaces before, between, and after the elements.
Element indent
Space on the left in case of left alignment, or on the right in case of right alignment. If centered alignment is in place, the number represents the shift relative to the center – positive values cause a shift to the right and vice versa. Only positive values are valid for other than centered alignment; negative values are interpreted as zero.
Line between elements
This option allows you to draw a line between elements. The line is drawn in the space between elements. If the space is not wide enough, the line is not displayed.
none
no line (default setting)
simple
a simple black line one pixel wide (the actual color may differ depending on Windows settings). The space between elements must be at least 1.
groove
three-dimensional line resembling a groove. The space between elements must be at least 2.
Borders
Border around the editor.
Background
Background color displayed in the area without element dispels. The options are gray, white, or auto. Actual colors depend on Windows color setting. Gray is the color of window background whereas white is used in the background of fields (such as table cells etc.). If the auto option is in place, the background will be white if the sequence editor is located in a dispel with white background.

Element Template

The dispel defined in this section is replicated in the editor once for every element of the edited sequence. The Object name of this dispel should be set to item_data to make sure that the dispel edits the right data. This object is provided individually to every element editor by the sequence editor. This object can be renamed by means of the Object name of data for elements field described below.
Example: suppose you have a sequence of integer numbers. Select line editor for element template. Set Object name to item_data and Data reference to . (empty reference).

Functionality

Item
Description
Object name
Name of the object where the edited sequence (or array) is located. You can select one of the objects provided by parent dispels.
Data reference
Reference to a sequence (or array) within the above identified object.
Object name of data for elements
Name of the data object that will be used to provide sequence elements data to the dispels editing the respective elements. The default name is item_data.
Other
Data type of inserted element
The data type of the newly inserted sequence element. Usually it need not be specified – it is determined automatically from the sequence elements type. However, if the type of the sequence element is Union, it may be necessary to specify the actual type to be inserted by the editor.
Disable deleting elements
If checked, sequence elements cannot be deleted by the sequence editor.
Confirm deleting elements
If checked, a warning dialog requesting confirmation is displayed by the sequence editor before elements are deleted from the sequence.
Inserting
This option determines the method used in the sequence editor to insert new elements:
disabled
new elements cannot be inserted by the sequence editor.
no empty element
the sequence editor will not have an empty element for insertion at its end. New elements can be inserted only by the Ins key, or another dispel outside the sequence editor inserting new elements can be added (button etc.). Elements are thus inserted directly ­without a candidate item.
immediate
when the user inserts an element into the editor, the element is immediately inserted into the edited sequence, too. Values are entered directly into elements that have been thus inserted into the sequence.
using candidate
if a new element is to be inserted, a candidate item is created first. It looks like other items, but there are buttons on its right hand side used to insert the new item or to cancel it without inserting. The candidate can be used to enter data for insertion, but it is not really inserted until the user clicks the insertion button.
auto
automatically selects between candidate and immediate inserting. Immediate inserting is used if the sequence editor is subordinated to another sequence editor or to another table and is already located in another parent candidate. (That is, nested sequences in a candidate do not create further candidates).
Marking
Element marking mode:
disabled
elements cannot be marked.
enabled
elements can be marked; the selection is canceled when the editor is deactivated.
persistent
elements can be marked; the selection persists even if the editor is deactivated.
Disable dragging elements by mouse
If checked, an unmarked element cannot be dragged by the mouse nor copied via clipboard. To perform a copy/move operation, the user has to mark the element first. This may be useful if element dispels are more complex and their dragging would appear confusing.

Alignment

This section is used to define simultaneously aligned subordinate dispels. Alignment is explained in a separate chapter.
Definition type: Seq_editor_def