API Documentation > Interface Classes > Class uifcLayout
Class uifcLayout

# include <uifcLayout.h>

class uifcLayout
: public virtual uifcGridContainer
{
xaideclare(uifcLayout)
...
};


Description
Methods Inherited from Class uifcComponent::
Methods Inherited from Class uifcGridContainer::
Method Summary
void
void
CreateTimer (uifcLayoutTimer_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
StartTimer (xrstring timerName, xint duration)
void
StopTimer (xrstring timerName)
Method Detail
void
DeletePopupMenu
()
Delete a MenuPane from the component.
Returns:
GetScreenOrigin
()
Determine the screen position of the component, in pixels.
Returns:
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:
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:
InsertChild
(uifcComponent_ptr component, uifcGridData_ptr gridData)
Parameters:
component
gridData
Returns:
GetFrameMinimumSize
()
Determine the minimum size of the component, in pixels.
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:
GetScreenRectangle
()
Determine the size and screen position of the component, in pixels.
Returns:
GetRectangleOfMonitor
()
Determine the rectangle of the screen upon which the majority of the given component is displayed.
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:
void
DeleteChild
(xrstring name)
Delete a component from the parent.
Parameters:
name
Returns:
GetFrameSize
()
Determine the size of the component, in pixels.
Returns:
GetFrameRectangle
()
Determine the size and position of the component, in pixels.
Returns:
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:
DoesFocusOnDisplay
()
Returns:
If the focus is on a child component of a Layout, which itself is a child of a Tab, this flag indicates where the focus will go when the Tab page is changed (making the component with the focus invisible). If xtrue, the focus will fall on the appropriate child component of the Layout in the new Tab page. If xfalse, the focus will revert to the title of the new Tab page (if the Tab is decorated).
void
SetFocusOnDisplay
(xbool flag)
Sets if the focus is on a child component of a Layout, which itself is a child of a Tab, this flag indicates where the focus will go when the Tab page is changed (making the component with the focus invisible). If xtrue, the focus will fall on the appropriate child component of the Layout in the new Tab page. If xfalse, the focus will revert to the title of the new Tab page (if the Tab is decorated).
Parameters:
flag
Returns:
GetKeyPressed
()
Returns:
The key pressed which generated a OnKeyDown(). To indicate to the component 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 component 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:
GetTextAlignment
()
Returns:
The justification of the label of the Layout if the Layout is decorated.
ALIGNMENT_LEFT
Left justified
ALIGNMENT_CENTER
Center justified
ALIGNMENT_RIGHT
Right justified
void
SetTextAlignment
(uifcAlignment value)
Sets the justification of the label of the Layout if the Layout is decorated.
ALIGNMENT_LEFT
Left justified
ALIGNMENT_CENTER
Center justified
ALIGNMENT_RIGHT
Right justified
Parameters:
value
Returns:
GetMnemonicFocusName
()
Returns:
The name of the component which should receive the keyboard input focus when the user presses the mnemonic key combination of the Layout.
void
SetMnemonicFocusName
(xrstring value)
Sets the name of the component which should receive the keyboard input focus when the user presses the mnemonic key combination of the Layout.
Parameters:
value
Returns:
GetTextFormat
()
Returns:
The format of the display text of the component.
RICHTEXT_OFF
Plain text
RICHTEXT_ON
A very restricted subset of HTML
RICHTEXT_ON + <HTML>
HTML as supported by the HTMLWindow
The UI RichText format supports the following styles, controlled by their corresponding tokens:
Bold
\b
\b0
Italic
\i
\i0
Underlined
\ul
\ulnone
Strike-through
\strike
\strike0
Superscript
\super
\nosupersub
Subscript
\sub
\nosupersub
Foreground Color
\cfRRGGBB
\cf0
Background Color
\cbRRGGBB
\cb0
Picture
\pictNAME
n/a
N.B. Each token must be followed immediately by another token or a whitespace character (e.g. space, newline).
The very restricted subset of HTML supports the following styles, controlled by their corresponding tokens:
Bold
<b>
</b>
Italic
<i>
</i>
Underlined
<u>
</u>
Strike-through
<strike>
</strike>
Superscript
<sup>
</sup>
Subscript
<sub>
</sub>
Foreground Color
<font color=#RRGGBB>
</font>
Background Color
<span style="background:#RRGGBB">
</span>
Picture
<img src="NAME">
n/a
void
SetTextFormat
(uifcRichText value)
Sets the format of the display text of the component.
RICHTEXT_OFF
Plain text
RICHTEXT_ON
A very restricted subset of HTML
RICHTEXT_ON + <HTML>
HTML as supported by the HTMLWindow
The UI RichText format supports the following styles, controlled by their corresponding tokens:
Bold
\b
\b0
Italic
\i
\i0
Underlined
\ul
\ulnone
Strike-through
\strike
\strike0
Superscript
\super
\nosupersub
Subscript
\sub
\nosupersub
Foreground Color
\cfRRGGBB
\cf0
Background Color
\cbRRGGBB
\cb0
Picture
\pictNAME
n/a
N.B. Each token must be followed immediately by another token or a whitespace character (e.g. space, newline).
The very restricted subset of HTML supports the following styles, controlled by their corresponding tokens:
Bold
<b>
</b>
Italic
<i>
</i>
Underlined
<u>
</u>
Strike-through
<strike>
</strike>
Superscript
<sup>
</sup>
Subscript
<sub>
</sub>
Foreground Color
<font color=#RRGGBB>
</font>
Background Color
<span style="background:#RRGGBB">
</span>
Picture
<img src="NAME">
n/a
Parameters:
value
Returns:
GetContentArrangement
()
Returns:
The alignment of the image and label of the Layout when the Layout is decorated.
This is made up of between 1 and 4 digits which represent the relative locations of the image and label.
The first digit is the image alignment within the bounds of the Layout label:
1
2
3
4
5
6
7
8
9
The second digit is optional and is the label alignment within the bounds of the Layout label, using the same scheme as above. If no digit is specified then the label alignment is assumed to be the same as the image alignment.
The third digit is also optional and is the relative position of the image and the label if the first 2 digits are equal. If no digit is specified then the relative position is assumed to be 1.
1
The image to the left of the label
2
The image to the right of the label
3
The image above the label
4
The image below the label
The fourth digit is also optional and is a flag representing whether how the image and label should be displayed. If no digit is specified then then fourth digit is assumed to be 1.
1
Display both the image and label
2
Display only the image
3
Display only the label
void
SetContentArrangement
(xint value)
Sets the alignment of the image and label of the Layout when the Layout is decorated.
This is made up of between 1 and 4 digits which represent the relative locations of the image and label.
The first digit is the image alignment within the bounds of the Layout label:
1
2
3
4
5
6
7
8
9
The second digit is optional and is the label alignment within the bounds of the Layout label, using the same scheme as above. If no digit is specified then the label alignment is assumed to be the same as the image alignment.
The third digit is also optional and is the relative position of the image and the label if the first 2 digits are equal. If no digit is specified then the relative position is assumed to be 1.
1
The image to the left of the label
2
The image to the right of the label
3
The image above the label
4
The image below the label
The fourth digit is also optional and is a flag representing whether how the image and label should be displayed. If no digit is specified then then fourth digit is assumed to be 1.
1
Display both the image and label
2
Display only the image
3
Display only the label
Parameters:
value
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:
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:
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:
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:
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:
void
AddActionListener
Parameters:
listener
Returns:
void
PushAction
(uifcLayoutAction action)
Parameters:
action
Returns:
void
CreateTimer
(uifcLayoutTimer_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?