CIP C++ documentation for class "uifcComponent"

Class uifcComponent

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

Description

Direct Known Subclasses:: uifcExternal_Containers, uifcButtonBase, uifcGridContainer, uifcDrawingArea, uifcHTMLWindow, uifcText, uifcSelection, uifcMenuBar, uifcMenuPane, uifcPHolder, uifcRange_Controls, uifcSash, uifcScrolledLayout, uifcSeparator, uifcTab, uifcThumbWheel, uifcToolBar

Method Summary


`xint`	`AddPopupMenu (uifcComponent_ptr parentComponent)`


`xbool`	`CanInheritPopupMenu ()`


`xbool`	`CanPopupMenuWhenDisabled ()`


`xbool`	`CanReduceHeight ()`


`xbool`	`CanReduceWidth ()`


`xint`	`CreateInParent (uifcComponent_ptr parentComponent, uifcGridData_ptr gridData)`


`xbool`	`DoesAllowTrailRecording ()`


`xbool`	`DoesReserveSpace ()`


`uifcColor_ptr`	`GetBackgroundColor ()`


`xint`	`GetBottomOffset ()`


`xstringsequence_ptr`	`GetChildNameArray ()`


`xstring`	`GetComponent ()`


`xint`	`GetComponentClass ()`


`xstring`	`GetComponentClassName ()`


`xstring`	`GetCursorImage ()`


`xstring`	`GetDialog ()`


`uifcAlignment`	`GetHelpTextAlignment ()`


`xint`	`GetHelpTextOriginX ()`


`xint`	`GetHelpTextOriginY ()`


`xint`	`GetHelpTextWidth ()`


`xint`	`GetLeftOffset ()`


`xstring`	`GetParentName ()`


`xstring`	`GetPopupMenuName ()`


`xint`	`GetRightOffset ()`


`uifcColor_ptr`	`GetTextColor ()`


`xint`	`GetTopOffset ()`


`uifcDragDropFlags`	`GetValidDropTypeFlags ()`


`xbool`	`IsAlwaysAtFront ()`


`xbool`	`IsAttachedAtBottom ()`


`xbool`	`IsAttachedAtLeft ()`


`xbool`	`IsAttachedAtRight ()`


`xbool`	`IsAttachedAtTop ()`


`xbool`	`IsValidDropSite ()`


`xbool`	`IsVisible ()`


`void`	`SetAllowTrailRecording (xbool flag)`


`void`	`SetAlwaysAtFront (xbool flag)`


`void`	`SetAttachedAtBottom (xbool flag)`


`void`	`SetAttachedAtLeft (xbool flag)`


`void`	`SetAttachedAtRight (xbool flag)`


`void`	`SetAttachedAtTop (xbool flag)`


`void`	`SetBackgroundColor (uifcColor_ptr color)`


`void`	`SetBottomOffset (xint value)`


`void`	`SetCanInheritPopupMenu (xbool flag)`


`void`	`SetCanPopupMenuWhenDisabled (xbool flag)`


`void`	`SetCanReduceHeight (xbool flag)`


`void`	`SetCanReduceWidth (xbool flag)`


`void`	`SetCursorImage (xrstring value)`


`void`	`SetHelpTextAlignment (uifcAlignment value)`


`void`	`SetHelpTextOriginX (xint value)`


`void`	`SetHelpTextOriginY (xint value)`


`void`	`SetHelpTextWidth (xint value)`


`void`	`SetLeftOffset (xint value)`


`void`	`SetPopupMenuName (xrstring value)`


`void`	`SetReserveSpace (xbool flag)`


`void`	`SetRightOffset (xint value)`


`void`	`SetTextColor (uifcColor_ptr color)`


`void`	`SetTopOffset (xint value)`


`void`	`SetValidDropSite (xbool flag)`


`void`	`SetValidDropTypeFlags (uifcDragDropFlags value)`


`void`	`SetVisible (xbool flag)`

Method Detail

xstring GetDialog ()

Returns:

xstring GetComponent ()

Returns:

xint CreateInParent (uifcComponent_ptr parentComponent, uifcGridData_ptr gridData)

Parameters:

parentComponent
gridData

Returns:

xint AddPopupMenu (uifcComponent_ptr parentComponent)

Parameters:

parentComponent

Returns:

xbool IsVisible ()

Returns:: Flag indicating whether the component is shown (xtrue) or hidden (xfalse).

void SetVisible (xbool flag)

Sets flag indicating whether the component is shown (xtrue) or hidden (xfalse).

Parameters:

flag

Returns:

xint GetComponentClass ()

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

xstring GetComponentClassName ()

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

xbool IsAlwaysAtFront ()

Returns:: If component is a child of a DrawingArea, NakedWindow or a PGLWindow class, this flag designates whether the component will be above its siblings in the Z-order. There is no precedence in the Z-order between sibling components that have this flag set. i.e. Always on top behaviour will only be seen if one component amongst others has this Attribute set.

void SetAlwaysAtFront (xbool flag)

Sets if component is a child of a DrawingArea, NakedWindow or a PGLWindow class, this flag designates whether the component will be above its siblings in the Z-order. There is no precedence in the Z-order between sibling components that have this flag set. i.e. Always on top behaviour will only be seen if one component amongst others has this Attribute set.

Parameters:

flag

Returns:

uifcColor_ptr GetBackgroundColor ()

Returns:: The background color of the component as a uifcColor.

void SetBackgroundColor (uifcColor_ptr color)

Sets the background color of the component as a uifcColor.

Parameters:

color

Returns:

xbool IsAttachedAtBottom ()

Returns:: Flag indicating whether the bottom of the component is attached to its parent.

void SetAttachedAtBottom (xbool flag)

Sets flag indicating whether the bottom of the component is attached to its parent.

Parameters:

flag

Returns:

xint GetBottomOffset ()

Returns:: The size of the offset between the bottom of the component and its parent. A value of -1 indicates that the parent's own offset should be used.

void SetBottomOffset (xint value)

Sets the size of the offset between the bottom of the component and its parent. A value of -1 indicates that the parent's own offset should be used.

Parameters:

value

Returns:

xstring GetCursorImage ()

Returns:: The cursor to use whilst the pointer is over the component. A value of "" indicates that the parent's own cursor should be used.

void SetCursorImage (xrstring value)

Sets the cursor to use whilst the pointer is over the component. A value of "" indicates that the parent's own cursor should be used.

Parameters:

value

Returns:

uifcColor_ptr GetTextColor ()

Returns:: The foreground color of the component as a uifcColor.

void SetTextColor (uifcColor_ptr color)

Sets the foreground color of the component as a uifcColor.

Parameters:

color

Returns:

uifcAlignment GetHelpTextAlignment ()

Returns:

The justification of the content of the popup help-text window which is displayed whilst the pointer is over the component.

ALIGNMENT_LEFT	Left justified
ALIGNMENT_CENTER	Center justified
ALIGNMENT_RIGHT	Right justified

void SetHelpTextAlignment (uifcAlignment value)

Sets the justification of the content of the popup help-text window which is displayed whilst the pointer is over the component.

ALIGNMENT_LEFT	Left justified
ALIGNMENT_CENTER	Center justified
ALIGNMENT_RIGHT	Right justified

Parameters:

value

Returns:

xint GetHelpTextWidth ()

Returns:: The width of the popup help-text window, in character widths.
A value of 0 indicates that the window should size itself based upon its contents.

void SetHelpTextWidth (xint value)

Sets the width of the popup help-text window, in character widths.
A value of 0 indicates that the window should size itself based upon its contents.

Parameters:

value

Returns:

xint GetHelpTextOriginX ()

Returns:: The X co-ordinate of the position of the popup help-text to be displayed whilst the pointer is over the component.

void SetHelpTextOriginX (xint value)

Sets the X co-ordinate of the position of the popup help-text to be displayed whilst the pointer is over the component.

Parameters:

value

Returns:

xint GetHelpTextOriginY ()

Returns:: The Y co-ordinate of the position of the popup help-text to be displayed whilst the pointer is over the component.

void SetHelpTextOriginY (xint value)

Sets the Y co-ordinate of the position of the popup help-text to be displayed whilst the pointer is over the component.

Parameters:

value

Returns:

xbool CanInheritPopupMenu ()

Returns:: Flag indicating whether the component should inherit the PopupMenuName attribute of its parent.

void SetCanInheritPopupMenu (xbool flag)

Sets flag indicating whether the component should inherit the PopupMenuName attribute of its parent.

Parameters:

flag

Returns:

xbool IsAttachedAtLeft ()

Returns:: Flag indicating whether the left-hand side of the component is attached to its parent.

void SetAttachedAtLeft (xbool flag)

Sets flag indicating whether the left-hand side of the component is attached to its parent.

Parameters:

flag

Returns:

xint GetLeftOffset ()

Returns:: The size of the offset between the left-hand side of the component and its parent. A value of -1 indicates that the parent's own offset should be used.

void SetLeftOffset (xint value)

Sets the size of the offset between the left-hand side of the component and its parent. A value of -1 indicates that the parent's own offset should be used.

Parameters:

value

Returns:

xbool DoesReserveSpace ()

Returns:: Flag indicating whether the component should occupy any space whilst it is invisible.

void SetReserveSpace (xbool flag)

Sets flag indicating whether the component should occupy any space whilst it is invisible.

Parameters:

flag

Returns:

xstring GetParentName ()

Returns:: The name of the parent component of the component.

xstring GetPopupMenuName ()

Returns:: The name of the MenuPane to be displayed when the user presses the right mouse button over the component. A value of "" indicates that the parent's own popup menu should be displayed.

void SetPopupMenuName (xrstring value)

Sets the name of the MenuPane to be displayed when the user presses the right mouse button over the component. A value of "" indicates that the parent's own popup menu should be displayed.

Parameters:

value

Returns:

xbool CanPopupMenuWhenDisabled ()

Returns:: Flag indicating whether the component should display its popup menu when it is insensitive (xtrue) or whether no popup menu should be displayed at such times (xfalse).

void SetCanPopupMenuWhenDisabled (xbool flag)

Sets flag indicating whether the component should display its popup menu when it is insensitive (xtrue) or whether no popup menu should be displayed at such times (xfalse).

Parameters:

flag

Returns:

xbool IsAttachedAtRight ()

Returns:: Flag indicating whether the right-hand side of the component is attached to its parent.

void SetAttachedAtRight (xbool flag)

Sets flag indicating whether the right-hand side of the component is attached to its parent.

Parameters:

flag

Returns:

xint GetRightOffset ()

Returns:: The size of the offset between the right-hand side of the component and its parent. A value of -1 indicates that the parent's own offset should be used.

void SetRightOffset (xint value)

Sets the size of the offset between the right-hand side of the component and its parent. A value of -1 indicates that the parent's own offset should be used.

Parameters:

value

Returns:

xbool IsAttachedAtTop ()

Returns:: Flag indicating whether the top of the component is attached to its parent.

void SetAttachedAtTop (xbool flag)

Sets flag indicating whether the top of the component is attached to its parent.

Parameters:

flag

Returns:

xint GetTopOffset ()

Returns:: The size of the offset between the top of the component and its parent. A value of -1 indicates that the parent's own offset should be used.

void SetTopOffset (xint value)

Sets the size of the offset between the top of the component and its parent. A value of -1 indicates that the parent's own offset should be used.

Parameters:

value

Returns:

xbool IsValidDropSite ()

Returns:: Flag indicating whether the component acts as a drop-site during drag & drop.

void SetValidDropSite (xbool flag)

Sets flag indicating whether the component acts as a drop-site during drag & drop.

Parameters:

flag

Returns:

uifcDragDropFlags GetValidDropTypeFlags ()

Returns:

A bitwise OR of the drag & drop data types which may be dragged and dropped over the component.

DRAG_DROP_NOTHING	Nothing
DRAG_DROP_FILES	An array of filenames
DRAG_DROP_COMPONENT	A component

void SetValidDropTypeFlags (uifcDragDropFlags value)

Sets a bitwise OR of the drag & drop data types which may be dragged and dropped over the component.

DRAG_DROP_NOTHING	Nothing
DRAG_DROP_FILES	An array of filenames
DRAG_DROP_COMPONENT	A component

Parameters:

value

Returns:

xstringsequence_ptr GetChildNameArray ()

Returns:: The names of the children of the component.

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:

xbool CanReduceHeight ()

Returns:: Flag indicating whether the component will allow the height of the grid cell containing it to be reduced.
This attribute is only supported when the component's parent is a Dialog or a Layout.

void SetCanReduceHeight (xbool flag)

Sets flag indicating whether the component will allow the height of the grid cell containing it to be reduced.
This attribute is only supported when the component's parent is a Dialog or a Layout.

Parameters:

flag

Returns:

xbool CanReduceWidth ()

Returns:: Flag indicating whether the component will allow the width of the grid cell containing it to be reduced.
This attribute is only supported when the component's parent is a Dialog or a Layout.

void SetCanReduceWidth (xbool flag)

Sets flag indicating whether the component will allow the width of the grid cell containing it to be reduced.
This attribute is only supported when the component's parent is a Dialog or a Layout.

Parameters:

flag

Returns: