CIP C++ documentation for class "uifcMenuPane"

Class uifcMenuPane

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

Description

Method Summary


`void`	`AddActionListener (uifcMenuPaneListener_ptr listener)`


`xbool`	`CanRedraw ()`


`xbool`	`CanWrap ()`


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


`void`	`DeleteChild (xrstring name)`


`xbool`	`DoesAutoClose ()`


`xbool`	`DoesFocusOnDisplay ()`


`xbool`	`DoesReplayDismissEvent ()`


`uifcKey_ptr`	`GetAcceleratorKey ()`


`xstring`	`GetAcceleratorText ()`


`xint`	`GetContentArrangement ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xint`	`GetHeight ()`


`xstring`	`GetHelpText ()`


`xstring`	`GetOwnerName ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`xint`	`GetRows ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`uifcRichText`	`GetTextFormat ()`


`xstring`	`GetTitleImage ()`


`xstring`	`GetTitleText ()`


`xint`	`GetWidth ()`


`xbool`	`HasBorder ()`


`xbool`	`HasDropShadow ()`


`xbool`	`HasScrollBarsWhenNeeded ()`


`xint`	`InsertChild (uifcComponent_ptr component)`


`xbool`	`IsVisibleInMenuBar ()`


`void`	`OpenPopup ()`


`void`	`PushAction (uifcMenuPaneAction action)`


`void`	`SetAcceleratorKey (uifcKey_ptr key)`


`void`	`SetAutoClose (xbool flag)`


`void`	`SetCanRedraw (xbool flag)`


`void`	`SetCanWrap (xbool flag)`


`void`	`SetContentArrangement (xint value)`


`void`	`SetFocusOnDisplay (xbool flag)`


`void`	`SetFrameOrigin (uifcPoint_ptr value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetFrameSize (uifcDimension_ptr value)`


`void`	`SetHasBorder (xbool flag)`


`void`	`SetHasDropShadow (xbool flag)`


`void`	`SetHasScrollBarsWhenNeeded (xbool flag)`


`void`	`SetHeight (xint value)`


`void`	`SetHelpText (xrstring value)`


`void`	`SetOwnerName (xrstring value)`


`void`	`SetReplayDismissEvent (xbool flag)`


`void`	`SetRows (xint value)`


`void`	`SetTextFormat (uifcRichText value)`


`void`	`SetTitleImage (xrstring value)`


`void`	`SetTitleText (xrstring value)`


`void`	`SetVisibleInMenuBar (xbool flag)`


`void`	`SetWidth (xint 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

Method Detail

void OpenPopup ()

Display the MenuPane as a popup menu.

Returns:

uifcPoint_ptr GetFrameOrigin ()

Determine the position of the component, in pixels, relative to its parent.

Returns:

uifcPoint_ptr GetScreenOrigin ()

Determine the screen position of the component, in pixels.

Returns:

void SetFrameOrigin (uifcPoint_ptr value)

Set the screen position of the MenuPane, in pixels.

Parameters:

value

Returns:

xint InsertChild (uifcComponent_ptr component)

Parameters:

component

Returns:

uifcDimension_ptr GetFrameMinimumSize ()

Determine the minimum size of the component, in pixels.

Returns:

void SetFrameSize (uifcDimension_ptr value)

Set the size of the MenuPane, in pixels.

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:

void SetFrameRectangle (uifcRectangle_ptr rect)

Set the size and screen position of the MenuPane, in pixels.

Parameters:

rect

Returns:

void DeleteChild (xrstring name)

Delete a component from the parent.

Parameters:

name

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:

xbool DoesFocusOnDisplay ()

Returns:: Flag indicating whether the MenuPane should automatically take the focus when it appears on the screen (xtrue), or not (xfalse).

void SetFocusOnDisplay (xbool flag)

Sets flag indicating whether the MenuPane should automatically take the focus when it appears on the screen (xtrue), or not (xfalse).

Parameters:

flag

Returns:

xbool HasDropShadow ()

Returns:: Flag indicating whether the MenuPane displays a drop-shadow around the bottom and right-hand edges of the window, if permitted to do so by the current OS window manager settings.

void SetHasDropShadow (xbool flag)

Sets flag indicating whether the MenuPane displays a drop-shadow around the bottom and right-hand edges of the window, if permitted to do so by the current OS window manager settings.

Parameters:

flag

Returns:

xint GetWidth ()

Returns:: The width in pixels for the menu that the menu should ideally use. This value will be used as long as it is larger than the default menu width.

void SetWidth (xint value)

Sets the width in pixels for the menu that the menu should ideally use. This value will be used as long as it is larger than the default menu width.

Parameters:

value

Returns:

xint GetRows ()

Returns:: The number of visible rows of the MenuPane.

void SetRows (xint value)

Sets the number of visible rows of the MenuPane.

Parameters:

value

Returns:

xbool HasScrollBarsWhenNeeded ()

Returns:: Flag indicating whether scrollbars should only be displayed when they are required (xtrue) or whether they should always be displayed (xfalse).

void SetHasScrollBarsWhenNeeded (xbool flag)

Sets flag indicating whether scrollbars should only be displayed when they are required (xtrue) or whether they should always be displayed (xfalse).

Parameters:

flag

Returns:

uifcKey_ptr GetAcceleratorKey ()

Returns:: The accelerator key which, when pressed, will display the MenuPane when it is used as a popup menu.

void SetAcceleratorKey (uifcKey_ptr key)

Sets the accelerator key which, when pressed, will display the MenuPane when it is used as a popup menu.

Parameters:

key

Returns:

xstring GetTitleImage ()

Returns:: The image of the MenuPane, used only by the MenuBar to generate the necessary display information for the corresponding MenuBar item.
This may be a BIF (the .bif extension is optional) file or a JPG, PNG, PCX, GIF, BMP, ICO or CUR file.

void SetTitleImage (xrstring value)

Sets the image of the MenuPane, used only by the MenuBar to generate the necessary display information for the corresponding MenuBar item.
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:

xbool CanWrap ()

Returns:: Flag indicating whether the MenuPane should attempt to wrap its children into multiple columns (xtrue) when the MenuPane is longer than the height of the screen upon which the MenuPane is to be displayed, or whether the MenuPane should display scroll buttons to allow the contents to be viewed (xfalse).

void SetCanWrap (xbool flag)

Sets flag indicating whether the MenuPane should attempt to wrap its children into multiple columns (xtrue) when the MenuPane is longer than the height of the screen upon which the MenuPane is to be displayed, or whether the MenuPane should display scroll buttons to allow the contents to be viewed (xfalse).

Parameters:

flag

Returns:

xbool DoesReplayDismissEvent ()

Returns:: Flag indicating whether the MenuPane should replay a mouse event which occured outside the component, causing the MenuPane to be dismissed. The mouse event is replayed to the component beneath the cursor, where it would otherwise have been sent, originally.

void SetReplayDismissEvent (xbool flag)

Sets flag indicating whether the MenuPane should replay a mouse event which occured outside the component, causing the MenuPane to be dismissed. The mouse event is replayed to the component beneath the cursor, where it would otherwise have been sent, originally.

Parameters:

flag

Returns:

uifcRichText 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:

Style	Switch on	Switch off
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:

Style	Switch on	Switch off
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:

Style	Switch on	Switch off
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

Style	Switch on	Switch off
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:

xint GetContentArrangement ()

Returns:

The alignment of the image and label of the MenuPane when the MenuPane is a child of a MenuBar.
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 MenuBar button:

1	2	3
4	5	6
7	8	9

The second digit is optional and is the label alignment within the bounds of the MenuBar button, 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 MenuPane when the MenuPane is a child of a MenuBar.
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 MenuBar button:

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:

xbool IsVisibleInMenuBar ()

Returns:: If the MenuPane is parented by a MenuBar then this attribute is a flag indicating whether the MenuPane should be visible in the MenuBar.

void SetVisibleInMenuBar (xbool flag)

Sets if the MenuPane is parented by a MenuBar then this attribute is a flag indicating whether the MenuPane should be visible in the MenuBar.

Parameters:

flag

Returns:

xbool CanRedraw ()

Returns:: Flag indicating whether redraws are permitted in the MenuPane.

void SetCanRedraw (xbool flag)

Sets flag indicating whether redraws are permitted in the MenuPane.

Parameters:

flag

Returns:

xstring 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:

xstring GetTitleText ()

Returns:: The label of the MenuPane, used only by the MenuBar to generate the necessary display information for the corresponding MenuBar item.
The text may be single or multi-line, and may contain a mnemonic by prefixing the mnemonic character with an ampersand.

void SetTitleText (xrstring value)

Sets the label of the MenuPane, used only by the MenuBar to generate the necessary display information for the corresponding MenuBar item.
The text may be single or multi-line, and may contain a mnemonic by prefixing the mnemonic character with an ampersand.

Parameters:

value

Returns:

xint GetHeight ()

Returns:: The height in pixels for the menu that the menu should ideally use. This value will be used as long as it is larger than the default menu height.

void SetHeight (xint value)

Sets the height in pixels for the menu that the menu should ideally use. This value will be used as long as it is larger than the default menu height.

Parameters:

value

Returns:

xstring GetOwnerName ()

Returns:: The name of the component over which the MenuPane was displayed when it is being used as a popup menu.

void SetOwnerName (xrstring value)

Sets the name of the component over which the MenuPane was displayed when it is being used as a popup menu.

Parameters:

value

Returns:

xbool HasBorder ()

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

void SetHasBorder (xbool flag)

Sets flag indicating whether the MenuPane has a decorated shadow border.

Parameters:

flag

Returns:

xbool DoesAutoClose ()

Returns:: Flag indicating whether the MenuPane should close automatically due to the action which has just occured within the current open menu hierarchy. This flag can be used by the application code to prevent the automatic closure of a MenuPane by setting it to xfalse in the OnCloseRequest() callback.

void SetAutoClose (xbool flag)

Sets flag indicating whether the MenuPane should close automatically due to the action which has just occured within the current open menu hierarchy. This flag can be used by the application code to prevent the automatic closure of a MenuPane by setting it to xfalse in the OnCloseRequest() callback.

Parameters:

flag

Returns:

xstring GetAcceleratorText ()

Returns:: The translated text representation of the current value of AcceleratorKey attribute.

void AddActionListener (uifcMenuPaneListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcMenuPaneAction action)

Parameters:

action

Returns:

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