CIP C++ documentation for class "uifcMenuBar"

Class uifcMenuBar

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

Description

Method Summary


`void`	`AddActionListener (uifcMenuBarListener_ptr listener)`


`xbool`	`CanRedraw ()`


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


`void`	`DeletePopupMenu ()`


`xbool`	`DoesReplayDismissEvent ()`


`xstring`	`GetDragCursorImage ()`


`xstring`	`GetDragItemName ()`


`xstring`	`GetDragNotValidCursorImage ()`


`xstring`	`GetDropItemName ()`


`xstringsequence_ptr`	`GetEnabledItemNameArray ()`


`uifcFontClass`	`GetFontClass ()`


`uifcDimension_ptr`	`GetFrameMinimumSize ()`


`uifcPoint_ptr`	`GetFrameOrigin ()`


`uifcRectangle_ptr`	`GetFrameRectangle ()`


`uifcDimension_ptr`	`GetFrameSize ()`


`xstring`	`GetHelpText ()`


`xstringsequence_ptr`	`GetItemHelpTextArray ()`


`xstringsequence_ptr`	`GetItemImageArray ()`


`xstringsequence_ptr`	`GetItemNameArray ()`


`uifcColors_ptr`	`GetItemTextColorArray ()`


`xstring`	`GetMostRecentItemName ()`


`uifcRectangle_ptr`	`GetRectangleOfMonitor ()`


`uifcPoint_ptr`	`GetScreenOrigin ()`


`uifcRectangle_ptr`	`GetScreenRectangle ()`


`xstringsequence_ptr`	`GetSelectedItemNameArray ()`


`xstringsequence_ptr`	`GetVisibleItemNameArray ()`


`void`	`InsertItem (uifcMenuBarItem_ptr menubaritem, uifcComponentPositionData_ptr comp_pos_data)`


`xint`	`InsertPopupMenu (uifcComponent_ptr component)`


`xbool`	`IsEnabled ()`


`xbool`	`IsValidDragSite ()`


`void`	`PushAction (uifcMenuBarAction action)`


`void`	`SetCanRedraw (xbool flag)`


`void`	`SetDragCursorImage (xrstring value)`


`void`	`SetDragNotValidCursorImage (xrstring value)`


`void`	`SetEnabled (xbool flag)`


`void`	`SetEnabledItemNameArray (xstringsequence_ptr values)`


`void`	`SetFontClass (uifcFontClass value)`


`void`	`SetFrameRectangle (uifcRectangle_ptr rect)`


`void`	`SetHelpText (xrstring value)`


`void`	`SetItemHelpTextArray (xstringsequence_ptr values)`


`void`	`SetItemImageArray (xstringsequence_ptr values)`


`void`	`SetItemNameArray (xstringsequence_ptr values)`


`void`	`SetItemTextColorArray (uifcColors_ptr colors)`


`void`	`SetReplayDismissEvent (xbool flag)`


`void`	`SetSelectedItemNameArray (xstringsequence_ptr values)`


`void`	`SetValidDragSite (xbool flag)`


`void`	`SetVisibleItemNameArray (xstringsequence_ptr values)`


`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 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 InsertItem (uifcMenuBarItem_ptr menubaritem, uifcComponentPositionData_ptr comp_pos_data)

Parameters:

menubaritem
comp_pos_data

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:

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:

xstring GetDragItemName ()

Returns:: The name of the item being dragged when the user starts a drag & drop operation by dragging within the component.

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

xbool DoesReplayDismissEvent ()

Returns:: Flag indicating whether the MenuBar should replay a mouse event which occured outside the open MenuPane hierarchy of the MenuBar, causing the MenuPane to be dismissed and the MenuBar to close. 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 MenuBar should replay a mouse event which occured outside the open MenuPane hierarchy of the MenuBar, causing the MenuPane to be dismissed and the MenuBar to close. The mouse event is replayed to the component beneath the cursor, where it would otherwise have been sent, originally.

Parameters:

flag

Returns:

xstringsequence_ptr GetVisibleItemNameArray ()

Returns:: The names of the visible items of the component. An empty array indicates that every item of the component is visible.

void SetVisibleItemNameArray (xstringsequence_ptr values)

Sets the names of the visible items of the component. An empty array indicates that every item of the component is visible.

Parameters:

values

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:

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

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

xstring GetDropItemName ()

Returns:: The name of the item beneath the pointer whilst the pointer is over the component during a drag & drop operation.

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:

xstringsequence_ptr GetItemHelpTextArray ()

Returns:: The popup help-text to be displayed for the items of the component whilst the pointer is over the component.

void SetItemHelpTextArray (xstringsequence_ptr values)

Sets the popup help-text to be displayed for the items of the component whilst the pointer is over the component.

Parameters:

values

Returns:

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

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

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:

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

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:

xbool CanRedraw ()

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

void SetCanRedraw (xbool flag)

Sets flag indicating whether redraws are permitted in the MenuBar.

Parameters:

flag

Returns:

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

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

Returns:: The item which was beneath the pointer the last time the pointer was over the component.

void AddActionListener (uifcMenuBarListener_ptr listener)

Parameters:

listener

Returns:

void PushAction (uifcMenuBarAction action)

Parameters:

action

Returns:

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