CIP C++ documentation for class "uifcLabel"

Class uifcLabel

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

Description

Method Summary


`void`	`AddActionListener (uifcLabelListener_ptr listener)`


`xbool`	`CanResizeWhenNeeded ()`


`xbool`	`CanTruncateText ()`


`xbool`	`CanWrap ()`


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


`void`	`DeletePopupMenu ()`


`xint`	`GetContentArrangement ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xstring`	`GetImage ()`


`xint`	`GetImageBackgroundColor ()`


`xint`	`GetImageColor ()`


`xstringsequence_ptr`	`GetItemImageArray ()`


`xintsequence_ptr`	`GetItemImageBackgroundColorArray ()`


`xintsequence_ptr`	`GetItemImageColorArray ()`


`xstringsequence_ptr`	`GetItemNameArray ()`


`xstringsequence_ptr`	`GetItemTextArray ()`


`xstring`	`GetMnemonicFocusName ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`xstringsequence_ptr`	`GetSelectedItemNameArray ()`


`xstring`	`GetText ()`


`uifcAlignment`	`GetTextAlignment ()`


`uifcDimension_ptr`	`GetTextSize (xrstring str)`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`xbool`	`IsStatusBar ()`


`void`	`PushAction (uifcLabelAction action)`


`void`	`SetCanResizeWhenNeeded (xbool flag)`


`void`	`SetCanTruncateText (xbool flag)`


`void`	`SetCanWrap (xbool flag)`


`void`	`SetContentArrangement (xint value)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetImage (xrstring value)`


`void`	`SetImageBackgroundColor (xint value)`


`void`	`SetImageColor (xint value)`


`void`	`SetItemImageArray (xstringsequence_ptr values)`


`void`	`SetItemImageBackgroundColorArray (xintsequence_ptr values)`


`void`	`SetItemImageColorArray (xintsequence_ptr values)`


`void`	`SetItemNameArray (xstringsequence_ptr values)`


`void`	`SetItemTextArray (xstringsequence_ptr values)`


`void`	`SetMnemonicFocusName (xrstring value)`


`void`	`SetSelectedItemNameArray (xstringsequence_ptr values)`


`void`	`SetStatusBar (xbool flag)`


`void`	`SetText (xrstring value)`


`void`	`SetTextAlignment (uifcAlignment 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

Methods Inherited from Class uifcText:: GetFontName, SetFontName, GetFontClass, SetFontClass, GetFontSize, SetFontSize, IsEnabled, SetEnabled, GetHelpText, SetHelpText, GetWidth, SetWidth, GetFontStyle, SetFontStyle

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:

uifcDimension_ptr GetTextSize (xrstring str)

Get the size in pixels of the given text string.

Parameters:

str

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:

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 GetImageColor ()

Returns:: The foreground color of the image of the Label, if the image has a depth of 1, as a uifcColor.

void SetImageColor (xint value)

Sets the foreground color of the image of the Label, if the image has a depth of 1, as a uifcColor.

Parameters:

value

Returns:

xstring GetImage ()

Returns:: The image of the Label.
This may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

void SetImage (xrstring value)

Sets the image of the Label.
This may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

Parameters:

value

Returns:

xintsequence_ptr GetItemImageBackgroundColorArray ()

Returns:: The background colors of the images of the items of the component, as either a uifcColor or a uifcColor.

void SetItemImageBackgroundColorArray (xintsequence_ptr values)

Sets the background colors of the images of the items of the component, as either a uifcColor or a uifcColor.

Parameters:

values

Returns:

xstring GetText ()

Returns:: The label of the Label.
The text may be single or multi-line, and may contain a mnemonic by prefixing the mnemonic character with an ampersand.

void SetText (xrstring value)

Sets the label of the Label.
The text may be single or multi-line, and may contain a mnemonic by prefixing the mnemonic character with an ampersand.

Parameters:

value

Returns:

xbool IsStatusBar ()

Returns:: Flag indicating whether the Label has a decorated sunken shadow border.

void SetStatusBar (xbool flag)

Sets flag indicating whether the Label has a decorated sunken shadow border.

Parameters:

flag

Returns:

uifcAlignment GetTextAlignment ()

Returns:

The justification of the label of the Label if 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 label of the Label if the label is multi-line.

ALIGNMENT_LEFT	Left justified
ALIGNMENT_CENTER	Center justified
ALIGNMENT_RIGHT	Right justified

Parameters:

value

Returns:

xbool CanWrap ()

Returns:: Flag indicating whether the label of the component should wrap within the available space granted to the component by its parent. Currently this flag is only supported for components which are the children of a MenuPane, where the MenuPane has been assigned a given size by the application code.

void SetCanWrap (xbool flag)

Sets flag indicating whether the label of the component should wrap within the available space granted to the component by its parent. Currently this flag is only supported for components which are the children of a MenuPane, where the MenuPane has been assigned a given size by the application code.

Parameters:

flag

Returns:

xstringsequence_ptr GetSelectedItemNameArray ()

Returns:: The names of the selected items of the component.

void SetSelectedItemNameArray (xstringsequence_ptr values)

Sets the names of the selected items of the component.

Parameters:

values

Returns:

xint GetContentArrangement ()

Returns:

The alignment of the image and label of the Label.
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 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 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 Label.
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 Label:

1	2	3
4	5	6
7	8	9

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:

xstringsequence_ptr 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 (xstringsequence_ptr values)

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:

xbool CanTruncateText ()

Returns:: Flag indicating whether to truncate the label of the Label with ellipsis if there is insufficient space to display the entire text string.

void SetCanTruncateText (xbool flag)

Sets flag indicating whether to truncate the label of the Label with ellipsis if there is insufficient space to display the entire text string.

Parameters:

flag

Returns:

xintsequence_ptr GetItemImageColorArray ()

Returns:: The foreground colors of the images of the items of the component, as either a uifcColor or a uifcColor.

void SetItemImageColorArray (xintsequence_ptr values)

Sets the foreground colors of the images of the items of the component, as either a uifcColor or a uifcColor.

Parameters:

values

Returns:

xstringsequence_ptr GetItemNameArray ()

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

void SetItemNameArray (xstringsequence_ptr values)

Sets the names of the items of the component.

Parameters:

values

Returns:

xbool CanResizeWhenNeeded ()

Returns:: Flag indicating whether the Label should attempt to resize when its contents are changed.

void SetCanResizeWhenNeeded (xbool flag)

Sets flag indicating whether the Label should attempt to resize when its contents are changed.

Parameters:

flag

Returns:

xstring GetMnemonicFocusName ()

Returns:: The name of the component which should receive the keyboard input focus when the user presses the mnemonic key combination of the Label.

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 Label.

Parameters:

value

Returns:

xstringsequence_ptr GetItemTextArray ()

Returns:: The labels of the items of the component.

void SetItemTextArray (xstringsequence_ptr values)

Sets the labels of the items of the component.

Parameters:

values

Returns:

xint GetImageBackgroundColor ()

Returns:: The background color of the image of the Label, if the image has a depth of 1, as a uifcColor.

void SetImageBackgroundColor (xint value)

Sets the background color of the image of the Label, if the image has a depth of 1, as a uifcColor.

Parameters:

value

Returns:

void AddActionListener (uifcLabelListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcLabelAction action)

Parameters:

action

Returns:

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