API Documentation > Interface Classes > Class uifcTab
Class uifcTab

# include <uifcTab.h>

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


Description
User Guide References:
Methods Inherited from Class uifcComponent::
Method Summary
void
void
CreateTimer (uifcTabTimer_ptr timer, xrstring timerName, xbool writeInTrail)
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
void
void
void
void
void
void
void
void
void
void
void
void
StartTimer (xrstring timerName, xint duration)
void
StopTimer (xrstring timerName)
Method Detail
GetFrameOrigin
()
Determine the position of the component, in pixels, relative to its parent.
Returns:
InsertPopupMenu
(uifcComponent_ptr component)
Add a MenuPane to be displayed when the user presses the right mouse button over the component.
Parameters:
component
Returns:
InsertChild
(uifcComponent_ptr component)
Parameters:
component
Returns:
void
DeleteChild
(xrstring name)
Delete a component from the parent.
Parameters:
name
Returns:
GetFrameSize
()
Determine the size of the component, in pixels.
Returns:
void
DeletePopupMenu
()
Delete a MenuPane from the component.
Returns:
GetScreenOrigin
()
Determine the screen position of the component, in pixels.
Returns:
void
InsertItem
(uifcTabItem_ptr tabitem, uifcItemPositionData_ptr item_pos_data)
Parameters:
tabitem
item_pos_data
Returns:
void
SetFrameSize
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:
void
InsertItems
Parameters:
tabitems
posData
Returns:
GetFrameRectangle
()
Determine the size and position of the component, in pixels.
Returns:
void
DeleteItemsByName
Delete items from the component.
Parameters:
names
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:
GetFrameMinimumSize
()
Determine the minimum size of the component, in pixels.
Returns:
GetScreenRectangle
()
Determine the size and screen position of the component, in pixels.
Returns:
void
SetFrameRectangle
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:
GetRectangleOfMonitor
()
Determine the rectangle of the screen upon which the majority of the given component is displayed.
Returns:
DoesFocusOnSelection
()
Returns:
Flag to indicate where the focus should go if a child component of a Tab that has the focus, is made invisible when the Tab page is changed. If xtrue, the focus will go to the appropriate child in the newly visible Tab page. If xfalse, the focus will fall on the label of the new Tab page (if the Tab is decorated).
void
SetFocusOnSelection
(xbool flag)
Sets flag to indicate where the focus should go if a child component of a Tab that has the focus, is made invisible when the Tab page is changed. If xtrue, the focus will go to the appropriate child in the newly visible Tab page. If xfalse, the focus will fall on the label of the new Tab page (if the Tab is decorated).
Parameters:
flag
Returns:
IsHeightFixed
()
Returns:
Flag indicating whether the Tab should resize vertically when the Tab is collapsible (xfalse) or whether the Tab should always be tall enough to contain all of its children (xtrue).
void
SetHeightFixed
(xbool flag)
Sets flag indicating whether the Tab should resize vertically when the Tab is collapsible (xfalse) or whether the Tab should always be tall enough to contain all of its children (xtrue).
Parameters:
flag
Returns:
GetDragItemName
()
Returns:
The name of the item being dragged when the user starts a drag & drop operation by dragging within the component.
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:
DoesSizeByContents
()
Returns:
Flag indicating whether the Tab should take into account the size of its tab buttons when calculating its initial size.
void
SetSizeByContents
(xbool flag)
Sets flag indicating whether the Tab should take into account the size of its tab buttons when calculating its initial size.
Parameters:
flag
Returns:
IsWidthFixed
()
Returns:
Flag indicating whether the Tab should resize horizontally when the Tab is collapsible (xfalse) or whether the Tab should always be wide enough to contain all of its children (xtrue).
void
SetWidthFixed
(xbool flag)
Sets flag indicating whether the Tab should resize horizontally when the Tab is collapsible (xfalse) or whether the Tab should always be wide enough to contain all of its children (xtrue).
Parameters:
flag
Returns:
GetTextAlignment
()
Returns:
The justification of the each of the labels of the Tab buttons if the Tab is decorated and the label is multi-line.
ALIGNMENT_LEFT
Left justified
ALIGNMENT_CENTER
Center justified
ALIGNMENT_RIGHT
Right justified
void
SetTextAlignment
(uifcAlignment value)
Sets the justification of the each of the labels of the Tab buttons if the Tab is decorated and the label is multi-line.
ALIGNMENT_LEFT
Left justified
ALIGNMENT_CENTER
Center justified
ALIGNMENT_RIGHT
Right justified
Parameters:
value
Returns:
CanWrap
()
Returns:
Flag indicating whether the page buttons of a decorated Tab should wrap onto multiple lines when there is insufficient space to display them all on a single line.
void
SetCanWrap
(xbool flag)
Sets flag indicating whether the page buttons of a decorated Tab should wrap onto multiple lines when there is insufficient space to display them all on a single line.
Parameters:
flag
Returns:
GetVisibleItemNameArray
()
Returns:
The names of the children of the component to be used for each of the items of the component.
This allows the same child to be used for more than one tab-page.
void
SetVisibleItemNameArray
Sets the names of the children of the component to be used for each of the items of the component.
This allows the same child to be used for more than one tab-page.
Parameters:
values
Returns:
GetSelectedItemNameArray
()
Returns:
The names of the selected items of the component.
void
SetSelectedItemNameArray
Sets the names of the selected items of the component.
Parameters:
values
Returns:
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:
GetItemTextColorArray
()
Returns:
The foreground colors of the items of the component, as a uifcColor.
void
SetItemTextColorArray
(uifcColors_ptr colors)
Sets the foreground colors of the items of the component, as a uifcColor.
Parameters:
colors
Returns:
GetButtonPlacement
()
Returns:
The justification of the labels of the Tab if the Tab is decorated.
LABEL_ALIGNMENT_TOP
Above the children
LABEL_ALIGNMENT_BOTTOM
Below the children
LABEL_ALIGNMENT_LEFT
To the left of the children
LABEL_ALIGNMENT_RIGHT
To the right of the children
void
SetButtonPlacement
Sets the justification of the labels of the Tab if the Tab is decorated.
LABEL_ALIGNMENT_TOP
Above the children
LABEL_ALIGNMENT_BOTTOM
Below the children
LABEL_ALIGNMENT_LEFT
To the left of the children
LABEL_ALIGNMENT_RIGHT
To the right of the children
Parameters:
value
Returns:
GetDropItemName
()
Returns:
The name of the item beneath the pointer whilst the pointer is over the component during a drag & drop operation.
GetItemImageArray
()
Returns:
The images of the items of the component.
Each image may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.
void
SetItemImageArray
Sets the images of the items of the component.
Each image may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.
Parameters:
values
Returns:
GetFontName
()
Returns:
The name of the font used to draw text in the component. This may also contain a comma-separated list of font names, in which case the closest match (or the first exact match, if available) will be used.
void
SetFontName
(xrstring value)
Sets the name of the font used to draw text in the component. This may also contain a comma-separated list of font names, in which case the closest match (or the first exact match, if available) will be used.
Parameters:
value
Returns:
GetItemHelpTextArray
()
Returns:
The popup help-text to be displayed for the items of the component whilst the pointer is over the component.
void
SetItemHelpTextArray
Sets the popup help-text to be displayed for the items of the component whilst the pointer is over the component.
Parameters:
values
Returns:
GetFontClass
()
Returns:
The base font class to be used to draw text in the component.
FONT_CLASS_DEFAULT
The default font
FONT_CLASS_DESKTOP
The font used by the Window Manager for the text of desktop icons
FONT_CLASS_MENU
The font used by MenuBars and components within MenuPanes
FONT_CLASS_POPUPHELP
The font used by the popup helptext
FONT_CLASS_MESSAGE
The font used for messages in the UI Message Dialog
FONT_CLASS_TITLEBAR
The font used to draw the titlebar text of a Dialog
FONT_CLASS_FIXED
A system-specific fixed width font for the locale
void
SetFontClass
(uifcFontClass value)
Sets the base font class to be used to draw text in the component.
FONT_CLASS_DEFAULT
The default font
FONT_CLASS_DESKTOP
The font used by the Window Manager for the text of desktop icons
FONT_CLASS_MENU
The font used by MenuBars and components within MenuPanes
FONT_CLASS_POPUPHELP
The font used by the popup helptext
FONT_CLASS_MESSAGE
The font used for messages in the UI Message Dialog
FONT_CLASS_TITLEBAR
The font used to draw the titlebar text of a Dialog
FONT_CLASS_FIXED
A system-specific fixed width font for the locale
Parameters:
value
Returns:
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:
GetItemNameArray
()
Returns:
The names of the items of the component.
void
SetItemNameArray
Sets the names of the items of the component.
Parameters:
values
Returns:
CanResizeWhenNeeded
()
Returns:
Flag indicating whether the Tab should attempt to resize when its contents are changed.
void
SetCanResizeWhenNeeded
(xbool flag)
Sets flag indicating whether the Tab should attempt to resize when its contents are changed.
Parameters:
flag
Returns:
GetFontSize
()
Returns:
The point-size of the font used to draw text in the component.
void
SetFontSize
(xreal value)
Sets the point-size of the font used to draw text in the component.
Parameters:
value
Returns:
GetEnabledItemNameArray
()
Returns:
The names of the selectable items of the component. An empty array indicates that every item of the component may be selected.
void
SetEnabledItemNameArray
Sets the names of the selectable items of the component. An empty array indicates that every item of the component may be selected.
Parameters:
values
Returns:
CanRedraw
()
Returns:
Flag indicating whether redraws are permitted in the Tab.
void
SetCanRedraw
(xbool flag)
Sets flag indicating whether redraws are permitted in the Tab.
Parameters:
flag
Returns:
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:
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:
GetMostRecentItemName
()
Returns:
The item which was beneath the pointer the last time the pointer was over the component.
GetItemTextArray
()
Returns:
The labels of the items of the component.
void
SetItemTextArray
Sets the labels of the items of the component.
Parameters:
values
Returns:
GetFontStyle
()
Returns:
A bitwise OR of the styles of the font used to draw text in the component.
FONT_STYLE_REGULAR
The font is regularly spaced, slanted and weighted
FONT_STYLE_CONDENSED
The font is condensed
FONT_STYLE_ITALIC
The font is italicised
FONT_STYLE_BOLD
The font is emboldened
void
SetFontStyle
(uifcFontStyle value)
Sets a bitwise OR of the styles of the font used to draw text in the component.
FONT_STYLE_REGULAR
The font is regularly spaced, slanted and weighted
FONT_STYLE_CONDENSED
The font is condensed
FONT_STYLE_ITALIC
The font is italicised
FONT_STYLE_BOLD
The font is emboldened
Parameters:
value
Returns:
HasVariableSize
()
Returns:
Flag indicating whether the Tab should be sized according to the size of the visible child (xtrue) or whether the Tab should be large enough to contain all of the children (xfalse).
If this attribute is set to xtrue then the WidthFixed attribute and HeightFixed attribute control whether the Tab should resize horizontally or vertically or in both directions when the selection of the Tab is changed.
void
SetHasVariableSize
(xbool flag)
Sets flag indicating whether the Tab should be sized according to the size of the visible child (xtrue) or whether the Tab should be large enough to contain all of the children (xfalse).
If this attribute is set to xtrue then the WidthFixed attribute and HeightFixed attribute control whether the Tab should resize horizontally or vertically or in both directions when the selection of the Tab is changed.
Parameters:
flag
Returns:
HasBorder
()
Returns:
Flag indicating whether the Tab has a decorated shadow border.
void
SetHasBorder
(xbool flag)
Sets flag indicating whether the Tab has a decorated shadow border.
Parameters:
flag
Returns:
void
AddActionListener
(uifcTabListener_ptr listener)
Parameters:
listener
Returns:
void
PushAction
(uifcTabAction action)
Parameters:
action
Returns:
void
CreateTimer
(uifcTabTimer_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:
Was this helpful?