Sfairadora

  • Reference Guide

Attributes Common to All Dispels

Here, the attributes common to all dispels are described. A detailed description of them can be found in the chapter Properties Common to All Dispels.
Type
Name
Description
Atom|Enki optional
tag
The tag of the dispel. Is should be an identifier. It is used when aligning the dispels
Context_help_def|Dword
(see below)
help
The text of the context help for the dispel.
Rich_string|
Rich_text|
Enki|
Enkidu optional
tool_tip
The text of the tool tip.
Bool|Enki
data_deficit_gray
The manner the dispel is displayed when it lacks data. If set TRUE, it is displayed gray; if set FALSE, it is not displayed at all.
Int|Enki
forced_display
Forced manner of displaying. It is useful especially when specified dynamically using an expression.
One of the following values:
FORCED_DISPLAY_DEFAULT
normal
FORCED_DISPLAY_GRAY
gray
FORCED_DISPLAY_HIDDEN
hidden
Bool|Enki optional
write_permission
Enabling writing (for editors):
TRUE
enable writing
FALSE
read-only
NOT_PRESENT
writing is determined by the superordinate dispel
Bool|Enki
nonactivable
If set TRUE, activation of the dispel is disabled.
Dispel_events_def optional
(see below)
events
Event handling functions.

Context_help_def

Type
Name
Description
Rich_string|
Enki
title
Help entry title.
Rich_text|
Enkidu|
Enki
body
The text of the context help.
Bool
unfolded
This item is not strictly speaking a part of the dispel definition. The context help window stores here information on the help item being folded or unfolded by the user. Thus, it is rather a state item. The instant state of the help folding/unfolding can be affected by setting this item.

Dispel_events_def

Type
Name
Description
Enki
displayed
The function called when the dispel has been displayed.
Enki
undisplayed
The function called when the dispel has been undisplayed.