CIP C++ documentation for class "uifcSash"

Class uifcSash

# include <uifcSash.h> class uifcSash : public virtual uifcComponent { xaideclare(uifcSash) ... };

Description

Method Summary


`void`	`AddActionListener (uifcSashListener_ptr listener)`


`void`	`CreateTimer (uifcSashTimer_ptr timer, xrstring timerName, xbool writeInTrail)`


`void`	`DeletePopupMenu ()`


`xbool`	`DoesDynamicUpdate ()`


`xbool`	`DoesRememberSize ()`


`xstring`	`GetDragCursorImage ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`uifcOrientation`	`GetOrientation ()`


`xint`	`GetPosition ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcSashGravity`	`GetSashGravity ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`xbool`	`IsEnabled ()`


`void`	`PushAction (uifcSashAction action)`


`void`	`SetDragCursorImage (xrstring value)`


`void`	`SetDynamicUpdate (xbool flag)`


`void`	`SetEnabled (xbool flag)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetOrientation (uifcOrientation value)`


`void`	`SetPosition (xint value)`


`void`	`SetRememberSize (xbool flag)`


`void`	`SetSashGravity (uifcSashGravity value)`


`void`	`StartTimer (xrstring timerName, xint duration)`


`void`	`StopTimer (xrstring timerName)`


`void`	`SwapChildren ()`

Methods Inherited from Class uifcComponent:: GetDialog, GetComponent, CreateInParent, AddPopupMenu, IsVisible, SetVisible, GetComponentClass, GetComponentClassName, IsAlwaysAtFront, SetAlwaysAtFront, GetBackgroundColor, SetBackgroundColor, IsAttachedAtBottom, SetAttachedAtBottom, GetBottomOffset, SetBottomOffset, GetCursorImage, SetCursorImage, GetTextColor, SetTextColor, GetHelpTextAlignment, SetHelpTextAlignment, GetHelpTextWidth, SetHelpTextWidth, GetHelpTextOriginX, SetHelpTextOriginX, GetHelpTextOriginY, SetHelpTextOriginY, CanInheritPopupMenu, SetCanInheritPopupMenu, IsAttachedAtLeft, SetAttachedAtLeft, GetLeftOffset, SetLeftOffset, DoesReserveSpace, SetReserveSpace, GetParentName, GetPopupMenuName, SetPopupMenuName, CanPopupMenuWhenDisabled, SetCanPopupMenuWhenDisabled, IsAttachedAtRight, SetAttachedAtRight, GetRightOffset, SetRightOffset, IsAttachedAtTop, SetAttachedAtTop, GetTopOffset, SetTopOffset, IsValidDropSite, SetValidDropSite, GetValidDropTypeFlags, SetValidDropTypeFlags, GetChildNameArray, DoesAllowTrailRecording, SetAllowTrailRecording, CanReduceHeight, SetCanReduceHeight, CanReduceWidth, SetCanReduceWidth

Method Detail

void SetFrameRectangle (uifcRectangle_ptr rect)

Set the size and screen position of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

rect

Returns:

void DeletePopupMenu ()

Delete a MenuPane from the component.

Returns:

uifcPoint_ptr GetFrameOrigin ()

Determine the position of the component, in pixels, relative to its parent.

Returns:

xint InsertPopupMenu (uifcComponent_ptr component)

Add a MenuPane to be displayed when the user presses the right mouse button over the component.

Parameters:

component

Returns:

void SetFrameOrigin (uifcPoint_ptr value)

Set the screen position of the component, in pixels, relative to its parent. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

value

Returns:

uifcDimension_ptr GetFrameMinimumSize ()

Determine the minimum size of the component, in pixels.

Returns:

uifcPoint_ptr GetScreenOrigin ()

Determine the screen position of the component, in pixels.

Returns:

void SetFrameSize (uifcDimension_ptr value)

Set the size of the component, in pixels. This operation is only supported when the component's parent is one of the following classes : DrawingArea NakedWindow PGLWindow

Parameters:

value

Returns:

uifcRectangle_ptr GetScreenRectangle ()

Determine the size and screen position of the component, in pixels.

Returns:

void SwapChildren ()

Swap the positions of the two children of the Sash, modifying the Position attribute and inverting the SashGravity attribute as necessary.

Returns:

uifcRectangle_ptr GetRectangleOfMonitor ()

Determine the rectangle of the screen upon which the majority of the given component is displayed.

Returns:

uifcDimension_ptr GetFrameSize ()

Determine the size of the component, in pixels.

Returns:

uifcRectangle_ptr GetFrameRectangle ()

Determine the size and position of the component, in pixels.

Returns:

xbool DoesDynamicUpdate ()

Returns:: Flag indicating whether the Sash takes advantage of the "Show window contents when dragging" setting of the desktop (xtrue), or whether the dragging of the Sash uses rubber-banding (xfalse).

void SetDynamicUpdate (xbool flag)

Sets flag indicating whether the Sash takes advantage of the "Show window contents when dragging" setting of the desktop (xtrue), or whether the dragging of the Sash uses rubber-banding (xfalse).

Parameters:

flag

Returns:

uifcOrientation GetOrientation ()

Returns:

The orientation of the Sash.

ORIENTATION_HORIZONTAL	Horizontal, with the first child being positioned to the left of the second child
ORIENTATION_VERTICAL	Vertical, with the first child being positioned above the second child

void SetOrientation (uifcOrientation value)

Sets the orientation of the Sash.

ORIENTATION_HORIZONTAL	Horizontal, with the first child being positioned to the left of the second child
ORIENTATION_VERTICAL	Vertical, with the first child being positioned above the second child

Parameters:

value

Returns:

xstring GetDragCursorImage ()

Returns:: The cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over a valid drop-site.

void SetDragCursorImage (xrstring value)

Sets the cursor to use when the user starts a drag & drop operation by dragging the component and the pointer is over a valid drop-site.

Parameters:

value

Returns:

xint GetPosition ()

Returns:: The percentage position of the sash divider of the Sash between the minimum sizes of the two children.

void SetPosition (xint value)

Sets the percentage position of the sash divider of the Sash between the minimum sizes of the two children.

Parameters:

value

Returns:

xbool DoesRememberSize ()

Returns:: Flag indicating whether the Sash should remember its size when the Dialog in which it is contained is destroyed so that when the Dialog is recreated the Sash will initially be created with the same size.

void SetRememberSize (xbool flag)

Sets flag indicating whether the Sash should remember its size when the Dialog in which it is contained is destroyed so that when the Dialog is recreated the Sash will initially be created with the same size.

Parameters:

flag

Returns:

xbool IsEnabled ()

Returns:: Flag indicating whether the component is disabled (xfalse) or sensitive to user input (xtrue).

void SetEnabled (xbool flag)

Sets flag indicating whether the component is disabled (xfalse) or sensitive to user input (xtrue).

Parameters:

flag

Returns:

uifcSashGravity GetSashGravity ()

Returns:

The gravity of the Sash, which is used to determine where the sash divider should be placed after the Sash is resized.

SASH_GRAVITY_FIRST	The Sash maintains its position relative to the first child
NO_SASH_GRAVITY	The Sash maintains its percentage position between both children
SASH_GRAVITY_SECOND	The Sash maintains its position relative to the second child

void SetSashGravity (uifcSashGravity value)

Sets the gravity of the Sash, which is used to determine where the sash divider should be placed after the Sash is resized.

SASH_GRAVITY_FIRST	The Sash maintains its position relative to the first child
NO_SASH_GRAVITY	The Sash maintains its percentage position between both children
SASH_GRAVITY_SECOND	The Sash maintains its position relative to the second child

Parameters:

value

Returns:

void AddActionListener (uifcSashListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcSashAction action)

Parameters:

action

Returns:

void CreateTimer (uifcSashTimer_ptr timer, xrstring timerName, xbool writeInTrail)

Parameters:

timer
timerName
writeInTrail

Returns:

void StartTimer (xrstring timerName, xint duration)

Parameters:

timerName
duration

Returns:

void StopTimer (xrstring timerName)

Parameters:

timerName

Returns: