Sfairadora

  • Reference Guide

Header_provider_def

The definition object of a header provider.
Type
Name
Description
Bool|Enki
horizontal
If set TRUE, the header and footer are displayed to the left and right rather than to top and bottom.
Header_info
(see below)
header
The definition of the header.
child
The definition of the dispel (a child), to which the header and footer are attached.
Int|Enki
alignment
The child’s alignment. One of the alignment constants. Only the values ALIGN_LEFT, ALIGN_CENTER, ALIGN_RIGHT, and ALIGN_BLOCK are allowed.
Bool|Enki
stretch_along
If set TRUE, the child is stretched to the maximum height in the vertical arrangement (or to the maximum width in the horizontal arrangement).
Header_info
(see below)
footer
The definition of the footer.

Header_info

Type
Name
Description
Int|Enki
place
The placement of the header/footer. One of the header placement constants.
The initial value is HP_ALWAYS_VISIBLE.
Bool|Enki
view_active
If set TRUE, the header/footer is displayed only when the child is active.
Int|Enki
alignment
The alignment of the header/footer. One of the alignment constants. Only the values ALIGN_LEFT, ALIGN_CENTER, ALIGN_RIGHT, and ALIGN_BLOCK are allowed.
Bool|Enki
child_relative_pos
If set TRUE, the header/footer’s position is aligned with the child’s position.
The initial value is TRUE.
Bool|Enki
h_scroll_bar
If set TRUE and the width if the header/footer exceeds the size of the window, a scroll bar is displayed.
Bool|Enki
v_scroll_bar
Analogical to h_scroll_bar, but for the vertical scroll bar.
Int|Enki
divider_style
The style of the line drawn between the header/footer pane and the child pane. One of the pane divider line style constants.
The divider line is displayed only when the child is displayed in a separate pane (i.e. it is not displayed by the child).
Int|Enki optional
divider_width
The width of the space to which the divider line is drawn.
Bool|Enki
divider_movable
If set TRUE, the user can move the divider line position using mouse.
child
Definition of the dispel contained in the header/footer.