Methods Index

CMenuBar

Heritage

Superclass: CNotifier

Description

CMenuBar defines the interface for menubars and submenus. This is the only class that can act on a window menubar directly.

In XVT Portability Toolkit terms, a menubar is a collection of submenus. A submenu is a collection of menu items, separators and/or submenus.

Usage

CMenubar *aMenubar = new CMenuBar(aCWindow,
	MENU_BAR_RID);
 
	CSubmenu aSubmenu("Window, WINDOW_TAG, 'W',
		CMenu::ENABLED);
	aMenubar->AppendSubmenu(aSubmenu);
	aMenuBar->DoUpdate();

-OR-

CMenuItem aMenuItem("~Paste", PASTE_TAG, 'P', 
	CMenu::ENABLED | CMenu::CHECKABLE);
 
aMenuBar->FindSubmenu(MENU_WINDOW)->
	Append(aMenuItem);
 
CMenu *aMenu = aSubmenu.Find(PASTE_TAG);
BOOLEAN isSep = PtrCast(CMenuItem, aMenu)->
	IsSeparator();

-OR-

aMenuBar->SetEnabled(PASTE_TAG);

-OR-

CSubmenu *aSubmenu;
RWOrderedIterator doTo(aMenuBar->GetSubmenus());
 
while (aSubmenu = (CSubmenu *)doTo.Next()) {
	CMenu *aMenu;
	RWOrderedIterator doTo2(aSubmenu->GetMenus());

	while (aMenu = (CMenu *)doTo2.Next()) {
		xvt_debug_printf("Menu: %s",
					aMenu->GetTitle().GetCharPtr());
		if (PtrCast(CSubmenu, aMenu) {
			CSubMenu *aSubmenu = PtrCast(
					CSubmenu, aMenu);
			...
		}
	}
}

Protected Data Members

MENU_TAG itsTag; The menubar tag; a tag is a unique ID associated with a menu
CWindow* itsWindow; The window that owns the menubar
CMenuBarRep* itsMenuBarRep; The menubar implementation
static short itIsReferenceCounted Determines whether to operate under lazy copy on write scheme.


`MENU_TAG`	`itsTag;`	The menubar tag; a tag is a unique ID associated with a menu
`CWindow*`	`itsWindow;`	The window that owns the menubar
`CMenuBarRep*`	`itsMenuBarRep;`	The menubar implementation
`static short`	`itIsReferenceCounted`	Determines whether to operate under lazy copy on write scheme.

Public Methods

Constructor and Destructor Methods

CMenuBar(CWindow *theWindow, MENU_TAG theMenu, 
	BOOLEAN isImport = TRUE);

A constructor. The menubar is attached to the theWindow. If the flag isImport is TRUE, the menubar is loaded from the URL resource file. If isImport is FALSE, this constructor creates an empty menubar that you need to fill. The MENU_TAG cannot be equal to zero.

CMenuBar(const CMenuBar &theMenubar);

A copy constructor.

const CMenuBar &operator= (const CMenuBar &theMenuBar);

An assignment operator.

virtual ~CMenuBar();

The destructor.

Menubar State Methods

MENU_TAG GetTag(void) const;

Returns tag passed in the constructor.

Pop-Up Menu Methods

CWindow* GetWindow(void) const;

Accesses the window that a menubar will use.

void DoPopup(
	const CPoint& theGlobalLoc, 
	MENU_TAG theSubmenuPopup,
	XVT_POPUP_ALIGNMENT theAlign = XVT_POPUP_LEFT_ALIGN);

Pop-up menu using theAlign attribute.

void DoPopup(
	const CPoint& theGlobalLoc,
	MENU_TAG theSubmenuPopup,
	MENU_TAG theOverMenuItem);

Pop-up menu using theOverMenuItem menu element.

Submenu Collection Methods

Submenu collection methods do not perform deep operation. They affect only the top-level submenus of a menubar. To work on a deeper submenu, you need to use the FindSubmenu method .

BOOLEAN AppendSubmenu(const CSubmenu &theSubmenu);

Appends theSubmenu at the end of the list of submenus in the menubar. The physical menubar is not updated until DoUpdate is called.

BOOLEAN InsertSubmenu(MENU_TAG theInFrontOfTag, 
	const CSubmenu &theSubmenu);

Inserts theSubmenu in the list of submenus in front of the submenu tagged theInFrontOfTag. The physical menubar is not updated until DoUpdate is called.

BOOLEAN RemoveSubmenu(MENU_TAG theTag);

Removes the submenu tagged theTag from the menubar. The physical menubar is not updated until DoUpdate is called.

BOOLEAN ReplaceSubmenu(MENU_TAG theTag, const CSubmenu &theSubmenu);

Replaces the submenu tagged theTag with the submenu theSubmenu. The physical menubar is not updated until DoUpdate is called.

CSubmenu* FindSubmenu(MENU_TAG theTag);

Given the submenu tag theTag, returns the existing data structure associated with the

CSubmenu

const RWOrdered* GetSubmenus(void) const;

Returns a list of top-level submenus.

void DoUpdate(void);

Updates the menubar for the window. Goes through the data structures array of submenus and updates the physical menubar. All of the above collection methods update only the internal array of structures. No visual change occurs until DoUpdate is called. Therefore, you can call several collection methods on a menubar, then call DoUpdate once.

"Wide Interface" Methods

The following methods have a unique feature: they can be called on a submenu or menu located at any level in the submenu hierarchy. The burden of locating the submenu object is taken care of by XVT-Power++. In other words, these methods perform deep operations. They let you check, enable, set the title of any menu item or submenu. Similarly they let you query the enable state, the check state and the title directly from the menubar object. You do not have to traverse the hierarchical array of submenus. These "wide interface" methods perform their operation and immediately update the associated data structures (as opposed to the collection methods described above).

void SetTitle(MENU_TAG theTag, 
	const CStringRW &theText);

Sets the title of theTag's submenu to the string theText.

const CStringRW& GetTitle(MENU_TAG theTag) const;

Returns the title of the submenu tagged theTag.

void SetEnabled(MENU_TAG theTag, BOOLEAN isEnabled);

Enables (isEnabled = TRUE) or disables (isEnabled = FALSE) the submenu tagged theTag.

BOOLEAN IsEnabled(MENU_TAG theTag) const;

Returns the enable state of the submenu tagged theTag.

void SetChecked(MENU_TAG theTag, BOOLEAN isChecked);

Checks (isChecked = TRUE) or unchecks (isChecked = FALSE) the submenu tagged theTag.

BOOLEAN IsChecked(MENU_TAG theTag) const;

Returns the check state of the submenu tagged theTag.

BOOLEAN IsCheckable(MENU_TAG theTag) const;

Returns TRUE if theTag both exists in the menubar or submenu and is checkable.

BOOLEAN IsInMenu(MENU_TAG theTag) const;

Returns TRUE if theTag exists in the menubar.

Reference Counting Methods

static BOOLEAN IsReferenceCounted(void);

Indicates whether reference counting is turned on for CMenuBar objects. When reference counting is on, objects are copied using the "copy-on-write" policy.

static void SetReferenceCounting(BOOLEAN isRefCounted);

Sets whether reference counting is turned on for CMenuBar objects. When reference counting is on, objects are copied using the "copy-on-write" policy.

Protected Methods

Utility Methods

CMenuBar(void);

A constructor.

void DestructiveHandle(void);

An implementation method.

CMenu *FindMenu(MENU_TAG theTag);

Given a menu tag theTag, finds the associated CMenu object.

const CMenu* FindMenu(MENU_TAG theTag) const;

A const version of the above FindMenu, so you can call it from a const method.

Menubar Utility Methods

MENU_ITEM* BuildMenuDef(void);

Build a menu item from a submenu.

void InitMenuDefEntry(MENU_ITEM *theXVTMenu, 
	CMenu *theMenu);

An implementation method.

void InitSubmenuDefEntry(MENU_ITEM *theXVTMenu, CSubmenu *theSubmenu);

An implementation method.

void InternalPopup(const CPoint& theGlobalLoc,
	XVT_POPUP_ALIGNMENT theAlign,
	MENU_TAG theSubmenuPopup,
	MENU_TAG theOverMenuItem );

Internal method that provides the implementation for creating popup menus.

[Classes] [Prev] [Next] [Methods]

support@xvt.com