Sfairadora

  • Reference Guide

State Object of Universal Dispel

Universal dispels publish the definition object of its presentation, so that it can be, for instance, created a tool to modify the generated presentation in a similar manner, as it can be modified with standard dispel definition editor. The state object is published under the identifier universal_dispel_child_def.
Type
Name
Description
Atom|Enki
class
Dispel class identifier. See Dispel_def.
Union
def
The definition of the presentation. See Dispel_def.
Dref
src_ref
Internal data used by universal dispel.
Byte
unidisp_change_info
If the presentation definition is to be modified externally, this item can be used to control the manner the universal dispel reacts to these modifications.
It can be one of the following values:
UNIDISP_CI_NORMAL (0)
no change (normal state)
UNIDISP_CI_LOCK (1)
if set, the changes in the presentation definition are not reflected in the presentation.
UNIDISP_CI_SYNC (2)
should be set when some modifications were made both in the data type of the edited data and the presentation definition. When this value is set, the universal dispel assumes, that these changes correspond to each other.
Normally, when modifying the presentation definition, it is not necessary to set this item. Nonetheless, when both the data type of edited data and the definition of the presentation are changed simultaneously, it is necessary first to set this item to UNIDISP_CI_LOCK, then perform the modifications as desired and finally to set UNIDISP_CI_SYNC. At next synchronization of the presentation with its definition, the universal dispel reverts this value back to UNIDISP_CI_NORMAL.
Atom const
unidisp_data_id
The identifier of the object where the data being edited by the universal dispel is located. The value is identical to the data_id item of the universal dispel definition object.
Dref const
unidisp_data_ref
The reference to the data item edited by the universal dispel. The value is identical to the data_ref item of the universal dispel definition object.
Bool const
unidisp_enable_change
Set TRUE when the universal dispel enables the user to edit the generated presentation definition.
The value is identical to the enable_change item of the universal dispel definition object.