CIP C++ documentation for class "uifcDesktop"

Class uifcDesktop

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

Description

Method Summary


`void`	`AddActionListener (uifcDesktopListener_ptr listener)`


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


`void`	`DeleteChild (xrstring name)`


`xbool`	`DoesAllowTrailRecording ()`


`void`	`DrawDropIndicator (uifcRectangle_ptr rect, uifcOrientation orientation)`


`xstring`	`GetActiveDialogName ()`


`xstringsequence_ptr`	`GetChildNameArray ()`


`xstring`	`GetComponent ()`


`xint`	`GetComponentClass ()`


`uifcPoint_ptr`	`GetCursorPosition ()`


`xstring`	`GetDialog ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`void`	`PushAction (uifcDesktopAction action)`


`xstring`	`ReadTextFromTrail (xrstring name)`


`void`	`SetActiveDialogName (xrstring value)`


`void`	`SetAllowTrailRecording (xbool flag)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


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


`void`	`StopTimer (xrstring timerName)`


`void`	`WriteTextToTrail (xrstring name, xrstring trail_data)`

Method Detail

xstring GetDialog ()

Returns:

xstring GetComponent ()

Returns:

uifcPoint_ptr GetCursorPosition ()

Get the cursor pointer position relative to the component.

Returns:

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 WriteTextToTrail (xrstring name, xrstring trail_data)

Write the data given by trail_data to the trail file so that when read during playback, a trail file callback for name is generated, which the application can then act on. 'name' is an identifier to distinguish this from trail output from other sources such as Creo UI.

Parameters:

name
trail_data

Returns:

uifcPoint_ptr GetFrameOrigin ()

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

Returns:

uifcPoint_ptr GetScreenOrigin ()

Determine the screen position of the component, in pixels.

Returns:

void DrawDropIndicator (uifcRectangle_ptr rect, uifcOrientation orientation)

Draw a drag & drop indicator of given size and orientation. rect - size of the indicator orientation - orientation of the indicator (See purpose) ORIENTATION_HORIZONTAL - Horizontal ORIENTATION_VERTICAL - Vertical The coordinates of this rectangle will be stored by the Desktop so that it can automatically be removed upon the next call to DrawDropIndicator operation if the rectangles differ. In addition the drag & drop indicator will automatically be removed upon the next call to DrawRubberBand operation as these two operations are mutually exclusive. This operation provides a simple way to achieve smooth drag & drop indication over the Desktop. ORIENTATION_HORIZONTAL - Horizontal ORIENTATION_VERTICAL - Vertical The coordinates of this rectangle will be stored by the Desktop so that it can automatically be removed upon the next call to DrawDropIndicator operation if the rectangles differ. In addition the drag & drop indicator will automatically be removed upon the next call to DrawRubberBand operation as these two operations are mutually exclusive. This operation provides a simple way to achieve smooth drag & drop indication over the Desktop.

Parameters:

rect
orientation

Returns:

uifcDimension_ptr GetFrameMinimumSize ()

Determine the minimum size of the component, in pixels.

Returns:

xstring ReadTextFromTrail (xrstring name)

Read the data for the trail file callback for name, from the trail file into trail_data.

Parameters:

name

Returns:

uifcRectangle_ptr GetScreenRectangle ()

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

Returns:

uifcRectangle_ptr GetRectangleOfMonitor ()

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

Returns:

void DeleteChild (xrstring name)

Delete a component from the parent.

Parameters:

name

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:

xstringsequence_ptr GetChildNameArray ()

Returns:: The names of all of the active Dialogs of the application.

xint GetComponentClass ()

Returns:: The ID of the component's class.

xstring GetActiveDialogName ()

Returns:: The name of the Dialog which has the keyboard input focus - viz. the current active Dialog.

void SetActiveDialogName (xrstring value)

Sets the name of the Dialog which has the keyboard input focus - viz. the current active Dialog.

Parameters:

value

Returns:

xbool DoesAllowTrailRecording ()

Returns:: Flag indicating whether the component and any of its children should output their actions to trail file.

void SetAllowTrailRecording (xbool flag)

Sets flag indicating whether the component and any of its children should output their actions to trail file.

Parameters:

flag

Returns:

void AddActionListener (uifcDesktopListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcDesktopAction action)

Parameters:

action

Returns:

void CreateTimer (uifcDesktopTimer_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: