CIP C++ documentation for class "uifcNakedWindow"

Class uifcNakedWindow

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

Description

Method Summary


`void`	`AddActionListener (uifcNakedWindowListener_ptr listener)`


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


`void`	`DeleteChild (xrstring name)`


`void`	`DeletePopupMenu ()`


`xbool`	`DoesAllowInputWhenBlocked ()`


`xbool`	`DoesAllowKeyboardInput ()`


`xbool`	`DoesAllowWheelInput ()`


`xstring`	`GetDragCursorImage ()`


`xstring`	`GetDragItemName ()`


`xstring`	`GetDragNotValidCursorImage ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xint`	`GetHeight ()`


`xstring`	`GetHelpText ()`


`uifcKey_ptr`	`GetKeyPressed ()`


`xint`	`GetMinimumHeight ()`


`xint`	`GetMinimumWidth ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`xint`	`GetWidth ()`


`xint`	`InsertChild (uifcComponent_ptr component)`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`xbool`	`IsEnabled ()`


`xbool`	`IsValidDragSite ()`


`void`	`PushAction (uifcNakedWindowAction action)`


`void`	`SetAllowInputWhenBlocked (xbool flag)`


`void`	`SetAllowKeyboardInput (xbool flag)`


`void`	`SetAllowWheelInput (xbool flag)`


`void`	`SetDragCursorImage (xrstring value)`


`void`	`SetDragItemName (xrstring value)`


`void`	`SetDragNotValidCursorImage (xrstring value)`


`void`	`SetEnabled (xbool flag)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetHeight (xint value)`


`void`	`SetHelpText (xrstring value)`


`void`	`SetKeyPressed (uifcKey_ptr key)`


`void`	`SetMinimumHeight (xint value)`


`void`	`SetMinimumWidth (xint value)`


`void`	`SetValidDragSite (xbool flag)`


`void`	`SetWidth (xint value)`


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


`void`	`StopTimer (xrstring timerName)`

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:

xint InsertChild (uifcComponent_ptr component)

Parameters:

component

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:

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:

xint GetHeight ()

Returns:: The height in pixels of the NakedWindow.

void SetHeight (xint value)

Sets the height in pixels of the NakedWindow.

Parameters:

value

Returns:

xstring GetDragItemName ()

Returns:: The name of the item being dragged when the user starts a drag & drop operation by dragging within the component.

void SetDragItemName (xrstring value)

Sets the name of the item being dragged when the user starts a drag & drop operation by dragging within the component.

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:

xbool DoesAllowWheelInput ()

Returns:

The response of the component to mouse wheel input.

void SetAllowWheelInput (xbool flag)

Sets the response of the component to mouse wheel input.

Parameters:

flag

Returns:

uifcKey_ptr GetKeyPressed ()

Returns:: The key pressed which generated a OnKeyDown(). To indicate to the NakedWindow that the key should not be passed on to, for example, the mapkey buffer you should modify this attribute to KEY_NONE at the end of your OnKeyDown() callback.

void SetKeyPressed (uifcKey_ptr key)

Sets the key pressed which generated a OnKeyDown(). To indicate to the NakedWindow that the key should not be passed on to, for example, the mapkey buffer you should modify this attribute to KEY_NONE at the end of your OnKeyDown() callback.

Parameters:

key

Returns:

xint GetMinimumHeight ()

Returns:: The minimum height in pixels of the NakedWindow.

void SetMinimumHeight (xint value)

Sets the minimum height in pixels of the NakedWindow.

Parameters:

value

Returns:

xstring GetDragNotValidCursorImage ()

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

void SetDragNotValidCursorImage (xrstring value)

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

Parameters:

value

Returns:

xbool DoesAllowKeyboardInput ()

Returns:: Flag indicating whether the component is capable of receiving keyboard input (xtrue), and hence is capable of receiving the keyboard input focus, or whether it responds only to mouse input (xfalse).

void SetAllowKeyboardInput (xbool flag)

Sets flag indicating whether the component is capable of receiving keyboard input (xtrue), and hence is capable of receiving the keyboard input focus, or whether it responds only to mouse input (xfalse).

Parameters:

flag

Returns:

xbool DoesAllowInputWhenBlocked ()

Returns:: Flag indicating whether user-input events should be processed when the NakedWindow is blocked.

void SetAllowInputWhenBlocked (xbool flag)

Sets flag indicating whether user-input events should be processed when the NakedWindow is blocked.

Parameters:

flag

Returns:

xbool IsValidDragSite ()

Returns:: Flag indicating whether the component can be dragged to start a drag & drop operation.

void SetValidDragSite (xbool flag)

Sets flag indicating whether the component can be dragged to start a drag & drop operation.

Parameters:

flag

Returns:

xint GetWidth ()

Returns:: The width in pixels of the NakedWindow.

void SetWidth (xint value)

Sets the width in pixels of the NakedWindow.

Parameters:

value

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:

xstring GetHelpText ()

Returns:: The popup help-text to be displayed whilst the pointer is over the component.
If the value begins with <HTML> then the help-text is treated as HTML, and rendered accordingly. It is often wise to use HTML help-text in conjunction with HelpTextWidth attribute, to define the maximum width of the popup help-text window.

void SetHelpText (xrstring value)

Sets the popup help-text to be displayed whilst the pointer is over the component.
If the value begins with <HTML> then the help-text is treated as HTML, and rendered accordingly. It is often wise to use HTML help-text in conjunction with HelpTextWidth attribute, to define the maximum width of the popup help-text window.

Parameters:

value

Returns:

xint GetMinimumWidth ()

Returns:: The minimum width in pixels of the NakedWindow.

void SetMinimumWidth (xint value)

Sets the minimum width in pixels of the NakedWindow.

Parameters:

value

Returns:

void AddActionListener (uifcNakedWindowListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcNakedWindowAction action)

Parameters:

action

Returns:

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