API Documentation > Interface Classes > Class uifcComponent
Class uifcComponent

# include <uifcComponent.h>

class uifcComponent
: public virtual uifcBaseUIObject
{
xaideclare(uifcComponent)
...
};


Description
Direct Known Subclasses:
Method Summary
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
void
Method Detail
GetDialog
()
Returns:
GetComponent
()
Returns:
CreateInParent
(uifcComponent_ptr parentComponent, uifcGridData_ptr gridData)
Parameters:
parentComponent
gridData
Returns:
AddPopupMenu
(uifcComponent_ptr parentComponent)
Parameters:
parentComponent
Returns:
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:
GetComponentClass
()
Returns:
The ID of the component's class.
GetComponentClassName
()
Returns:
The name of the component's class.
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
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:
GetParentName
()
Returns:
The name of the parent component of the component.
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:
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:
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:
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:
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:
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:
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:
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
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:
GetChildNameArray
()
Returns:
The names of the children of the component.
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:
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:
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:
Was this helpful?