SetupSheet

From STX Wiki
Jump to navigation Jump to search

SetupSheet : ModalDialog

SetupSheet Members Functions

The SetupSheet class has the following member functions. See ModalDialog Class Members for a list of functions implemented in the parent class.

Data

Performs data exchange between the controls of the active page and the variables and shell items bound to the controls.

Usage:

inst DATA direction

Parameters:
direction
The data exchange direction. The following values are supported:
READ
WRITE
Result:

none, sideeffect: variable <-> control data exchange

DEFINEPAGES first ; count ; page0 ; page1 ; ...

usage:
first index of first control to be used for property pages
count maximum number of controls per page
pageX caption of page select button X
result:

none

description:

Initialize the page button controls and pages. This function must be called before the page controls are created.

GETPAGE

result:

index of active page

GETPAGECONTROL

result:

index of first control on the active page

GETPAGEWINDOW

result:

position and size of property page ('x y w h')

description:

Computes and returns the position (x,y = upper left corner) and size (w,h = width and height) of the property page.

LOOP [okay cancel page]

usage:
okay, cancel index of okay- and cancel-control
page index of page to be activated
result:

message id

description:

Calls first the function SHOW to make sure the dialog is displayed and than enters the message loop. The page select buttons are handled by this function. If a new page was selected, the message id NEWPAGE is returned, otherwise the result of the parent class member is returned.

SETPAGE page

usage:
page index of page to be selected (0 .. number of pages – 1)
result:

none

description:

Activates the specified page.

SETPAGEWINDOW x y w h

usage:
x, y position of first page button
w,h width and height of property page
result:

none

description:

Define the position of the first page button (x y) and the size of the property page (w h). This function must be called before page headers are defined (by calling DEFINEPAGES).

SHOW okay cancel page

usage:
okay, cancel index of okay- and cancel-control
page index of page to be activated
result:

none

description:

Shows the property page dialog and activates the specified page. Calls the parent class member function.