Functions

of_checksizetype

Description

Determines whether the specified object is resizable in the current UI layout.

Note: this is not a public function and the internal algorithm may be modified in future by Appeon, therefore please do not use this function directly.

Syntax

of_checksizetype ( eon_cst_resizeattrib a_attr, string as_filterstart, string as_origstart, string as_origlength )

of_getcomponentname

Description

Returns the name of the container that contains the current object (usually the container is a window, user object, or tab control).

Syntax

of_getcomponentname ( )

of_getminmaxpoints

Description

Determines the four extreme points of the controls within a control array by looking at the X, Y, Width, Height, BeginX, BeginY, EndX, EndY attributes.

Syntax

of_getminmaxpoints ( windowobject awo_control[], ref integer ai_min_x, ref integer ai_min_y, ref integer ai_max_x, ref integer ai_max_y )

Parameter

awo_control[] - The control array for whom the Min and Max attributes are needed.

ai_min_x - The minimum X point found by looking at the X attributes of all the controls on the control array (by reference).

ai_min_y - The minimum Y point found by looking at the X attributes of all the controls on the control array (by reference).

ai_max_x - The maximum X point found by adding the X and Width attributes of all the controls on the control array (by reference).

ai_max_y - The maximum Y point found by adding the Y and Height attributes of all the controls on the control array (by reference).

Return value

1 - success.

-1 - an error occurs.

of_init

Description

Initializes all the registered objects, calculates their sizes and locations, and completes the registration.

Note: this function is called in of_init ( userobject ) and of_init ( window ), so please do not directly call this function.

Syntax

of_init ( )

Return value

1 - success.

of_init (userobject)

Description

Analyzes and registers the internal object of the user object.

Syntax

of_init ( userobject a_obj )

Parameter

a_obj - the user object to be analyzed.

Return value

1 - success.

of_init (window)

Description

Analyzes and registers the internal object of the window.

Syntax

of_init ( window a_obj )

Parameter

a_obj - the window to be analyzed.

Return value

1 - success.

of_register

Syntax 1: of_register ( windowobject awo_control, boolean ab_scale, integer ai_movex, integer ai_movey, integer ai_scalewidth, integer ai_scaleheight ) returns integer

Syntax 2: of_register ( windowobject awo_control, integer ai_movex, integer ai_movey, integer ai_scalewidth, integer ai_scaleheight ) returns integer

Syntax 3: of_register ( windowobject awo_control, string as_method ) returns integer

Syntax 4: of_register ( windowobject awo_obj ) returns integer

syntax 1

Description

Register a control which needs to either be moved or resized when the parent object is resized. The action taken on this control depends on the four attributes: ai_movex, ai_movey, ai_scalewidth, ai_scaleheight.

Note: the service object needs to be initialized (of_setorigsize) prior to any registering (this function) of objects.

Syntax

of_register ( windowobject awo_control, boolean ab_scale, integer ai_movex, integer ai_movey, integer ai_scalewidth, integer ai_scaleheight )

Parameter

awo_control - The window object being registered.

ab_scale - If the object should be registered as a Scale type.

ai_movex - The percentage to move the object along the x axis.

ai_movey - The percentage to move the object along the y axis.

ai_scalewidth - The percentage to scale the object along the x axis.

ai_scaleheight - The percentage to scale the object along the y axis.

Return value

1 if it succeeds and -1 if an error occurs.

syntax 2

Description

Register a control which needs to either be moved or resized when the parent object is resized.

Syntax

of_register ( windowobject awo_control, integer ai_movex, integer ai_movey, integer ai_scalewidth, integer ai_scaleheight )

Parameter

awo_control - The window object being registered.

ai_movex - The percentage to move the object along the x axis.

ai_movey - The percentage to move the object along the y axis.

ai_scalewidth - The percentage to scale the object along the x axis.

ai_scaleheight - The percentage to scale the object along the y axis.

Return value

1 if it succeeds and -1 if an error occurs.

syntax 3

Description

Register a control which needs to either be moved or resized when the parent object is resized.

Syntax

of_register ( windowobject awo_control, string as_method )

Parameter

awo_control - The window object being registered.

as_method - The desired resize/move method. Valid values are:

  • 'FixedToRight'

  • 'FixedToBottom'

  • 'FixedToRight&Bottom'

  • 'Scale'

  • 'ScaleToRight'

  • 'ScaleToBottom'

  • 'ScaleToRight&Bottom'

  • 'FixedToRight&ScaleToBottom'

  • 'FixedToBottom&ScaleToRight'

Return value

1 if it succeeds and -1 if an error occurs.

syntax 4

Description

Register a control which needs to either be moved or resized when the parent object is resized.

Syntax

of_register ( windowobject awo_obj )

Parameter

awo_obj - The window object being registered.

Return value

1 if it succeeds and -1 if an error occurs.

of_resize

Description

Moves or resizes objects that were registered with the service. Performs the actions that were requested via the of_setorigsize and of_register functions.

Syntax

of_resize ( integer ai_newwidth, integer ai_newheight )

Parameter

ai_newwidth - The new width of the parent object.

ai_newheight - The new height of the parent object.

Return value

1 - success.

-1 - an error occurs.

of_setminsize

Description

Sets the current object minimum size attributes.

Note: the service object needs to be initialized (of_setorigsize) prior to setting the Minimum size of the object.

Syntax

of_setminsize ( integer ai_minwidth, integer ai_minheight )

Parameter

ai_minwidth - The minimum width for the parent object.

ai_minheight - The minimum height for the parent object.

Return value

1 - success.

-1 - an error occurs.

of_setorigsize

Description

Initializes the Resize object by setting the current object size.

Note: the service object needs to be initialized (this function) prior to the registering (of_register) of objects.

Syntax

of_setorigsize ( integer ai_width, integer ai_height )

Parameter

ai_width - The current width of the parent object.

ai_height - The current height of the parent object.

Return value

1 - success.

-1 - an error occurs.

of_setresizetype

Description

Determines the resizing behavior of the object according to the resize type (resizable or unresizable) of surrounding controls.

Note: this is not a public function, and the internal algorithm may be modified in future by Appeon, therefore, please do not use this function directly.

Syntax

of_setresizetype ( powerobject awo_control, boolean ab_leftsizetype, boolean ab_upsizetype, boolean ab_selfsizable )

of_typeof

Description

Determines on the type of an object for the purposes of getting to its attributes. Same as of_typeOf in the PFC n_cst_resize object but with additional evaluation to the MonthCalender and the DatePicker objects in PowerBuilder 12.5 or later versions.

Syntax

of_typeOf ( powerobject awo_control )

Parameter

awo_control - The window object for which a type is needed.

Return value

string - Describes the type of the object.

'!' - an error occurs.

of_unregister

Description

Unregister a control that was previously registered.

Syntax

of_unregister ( windowobject awo_control )

Parameter

awo_control - The control to unregister.

Return value

1 if it succeeds and -1 if an error occurs.