Sfairadora

  • Reference Guide

Column Properties

Information about marked columns and their properties.
Type
Name
Description
Dword
enable_changes
The level of changes enabled:
0
changes in data are enabled.
1 changes in view are enabled.
2 changes in presentation are enabled.
The attribute should not be altered.
Bool
simple_editor
If set TRUE, a simplified editor of column properties should be used. (That is, an editor without the view properties).
The attribute should not be altered.
Column definition optional
(see below)
def
The definition of the column.
Bool
width_value_set
If set TRUE, the attribute _width contains a valid value. (See the comment below in front of the section Column Definition).
Dword optional
_width
The fixed width of the column (in pixels). If the value is not specified, the widths is determined automatically according to the width of the column contents.
String optional
data_name
The name of the item corresponding to the column at the data level.
Bool optional
data_optional
If set TRUE, the item at the data level is optional.
Data_type_def optional
data_type
The type of the item at the data level.
Data_type optional
struct_data_type
The type of the structure at the data level of which the above specified item is a member. This information is used to prevent duplicity in the item names.
The attribute should not be altered.
String optional
view_name
The name of the item corresponding to the column at the view level.
Bool optional
view_optional
If set TRUE, the item at the view level is optional.
Data_type_def optional
view_type
The type of the item at the view level.
Data_type optional
struct_view_type
The type of the structure at the view level of which the above specified item is a member. This information is used to prevent duplicity in the item names.
The attribute should not be altered.
Data_type optional
summary_type
The data type of the column summary.
The attribute should not be altered.
Seq(marked column)
(see below)
list
The list of marked columns or information about the active column.
The attribute should not be altered.
Bool
multicolumn_selection
If set TRUE, the information contained in this structure pertain to more than one column (i.e. more than one column is marked.)
The attribute should not be altered.

Column Definition

The structure corresponds to the Column Properties window.
The attributes X_value_set determine whether the attribute X contains a valid value. That means, that if the attribute X does not contain a value and the attribute X_value_set is set to TRUE, the value will be subsequently removed from the table definition, too. In the other case, when the attribute X_value_set is set to FALSE, the value of the attribute X is not written to the table definition. If there is no attribute X_value_set and the attribute X does not have a value set, the value in the table definition is left unchanged. Thus, an attribute X_value_set is used with those attributes that are themselves optional.
Type
Name
Description
Atom|Enki optional
id
The column identifier.
Int|Enki optional
family
The column family. One of the column family constants.
Int|Enki optional
title_alignment
The alignment of the column title. One of the alignment constants. Only the values ALIGN_LEFT, ALIGN_CENTER, are ALIGN_RIGHT allowed.
Bool|Enki optional
full_title
If set TRUE, the full title is to be displayed.
Bool
icon_value_set
If set TRUE, the attribute icon contains a valid value.
Icon|Enki optional
icon
The icon displayed in the column header.
Rich_string|
Enki optional
title
The title displayed in the column header.
Dref|Enki optional
data_ref
The reference of the column data relative to the table row.
Bool|Enki optional
init_hidden
If set TRUE, the column is initially hidden.
Bool
size_min_value_set
If set TRUE, the attribute size_min contains a valid value.
Int|Enki optional
size_min
The minimum column width.
Bool
size_max_value_set
If set TRUE, the attribute size_max contains a valid value.
Int|Enki optional
size_max
The maximum column width.
Bool
background_value_set
If set TRUE, the attribute background contains a valid value.
Int|Enki optional
background
The column background. One of the dispel background constants.
Bool
child_value_set
If set TRUE, the attribute child contains a valid value.
child
The pattern of the dispel that presents the content of the cells.
Bool
horizontal_alignment_value_set
If set TRUE, the attribute horizontal_alignment contains a valid value.
Int|Enki optional
horizontal_alignment
The horizontal cell alignment. One of the alignment constants. Only the values ALIGN_LEFT, ALIGN_CENTER, and ALIGN_RIGHT are allowed.
Bool
vertical_alignment_value_set
If set TRUE, the attribute vertical_alignment contains a valid value.
Int|Enki optional
vertical_alignmen
The vertical cell alignment. One of the alignment constants. Only the values ALIGN_LEFT, ALIGN_CENTER, ALIGN_RIGHT, and ALIGN_BLOCK are allowed.
Bool|Enki optional
separator
If set TRUE, the column is separated from the previous.
Int|Enki optional
space_before
The space before the column.
Int|Enki optional
space_after
The space after the column.
Int|Enki optional
delta
Vertical shift of the dispel in the cell.
seq_ed
Information about the subordinate sequence editor contained within the cell, if the column type is DATA_FAMILY_SEQ.
Column_list_info optional
columns
The list of sub-columns, if the column family is DATA_FAMILY_SEQ or DATA_FAMILY_COLUMN_GROUP.
Bool
summary_exc _value_set
If set TRUE, the attribute summary_exc contains a valid value.
Summary_exception_info optional
(see the description at Column_list_info)
summary_exc
The summary exceptions for the column.

Marked Column

The structure is used to identify a column within a table.
Type
Name
Description
Atom
id
The column identifier.
Dref
ref
The reference to the data item pertaining to the column relative to the row.
Dref
resolved_data_ref
The full reference to the data item of the cell currently being edited. The reference is relative to the root object in which the edited sequence is contained. The indexes to the intermediate sequences are replaced with asterisks.