ContextMenu Class Reference

Encapsulate the concept of pop-up, context-sensitive menus at the kernel level. More...

#include <contmenu.h>

Inheritance diagram for ContextMenu:

List of all members.

Public Member Functions
	ContextMenu ()
virtual	~ContextMenu ()
BOOL	Show ()
BOOL	ShowOverView (Spread *pSpread, DocCoord ClickPos, ClickModifiers ClickMods)
	This function does the same job as ShowMenu but unfortunately needs some parameters to pass on to the menu builders. Not very neat, I know...
BOOL	Hide ()
	Close and delete any context menu that may be open.
virtual BOOL	Build ()
	Base class implementation of menu builder. This function builds a menu statically by creating the appropriate objects. It does NOT call teh menu script interpreter because I am unhappy about the reliability of repeatedly calling that code.
virtual BOOL	BuildOverView (Spread *pSpread, DocCoord ClickPos, ClickModifiers ClickMods)
	Base class function which, when overridden in derived classes, will build a pop-up menu according to a given position in a view.
BOOL	BuildTransferCommands (BOOL NodeCommands)
	Append the standard "transfer command" menu items to the input root menu This function adds: Cut Copy Paste (Paste link When we implement OLE...) And if NodeCommands is TRUE: ----- Delete Duplicate Clone -----.
BOOL	BuildEffectCommands ()
	Append the "effect" menu items to the input root menu.
BOOL	BuildCommand (TCHAR *pOpToken, BOOL Separator=FALSE, MenuItem *pRootMenu=NULL, const String &strNewText=String(_T("")), OpMenuParam *pParam=NULL)
	Append a new menu item to this menu. Passing pRootMenu as NULL (leaving it defaulted) causes the new item to be added to the first level of the pop-up menu. Passing pRootMenu non-NULL allows you to build a submenu.
MenuItem *	GetLastItem ()
	Get pointer to item last previously created.
Static Public Member Functions
static BOOL	HideCurrent ()
	Close and delete the current context menu if it's open.
Protected Attributes
MenuItem *	pRootItem
MenuItem *	pLastItem
UINT32	AutoIDStash
Static Protected Attributes
static ContextMenu *	pCurrentMenu = NULL
Private Member Functions
	CC_DECLARE_MEMDUMP (ContextMenu)

---

Detailed Description

Encapsulate the concept of pop-up, context-sensitive menus at the kernel level.

Author:

Phil_Martin (Xara Group Ltd) <camelotdev@xara.com>

Date:

13/03/95

To create and use a new context-sensitive menu: Derive a new subclass from ContextMenu, e.g. ViewContextMenu. Create the operations that you want to use from the menu or use existing operations. Implement a new Build function in your subclass to build your menu using the helper functions provided (see func headers for more details). That's all there is to it - the menu system handles everything else!

Note: There are guidelines about how to construct a pop-up menu and when to open it. The menu should be formed something like this: Clicked object's primary commands Clicked object's transfer commands (e.g. cut, copy, etc...) "Properties..." command The menu should be opened in response to a BUTTON UP event!!!

Definition at line 139 of file contmenu.h.

---

Constructor & Destructor Documentation

ContextMenu::ContextMenu (   )

Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 13/03/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE FALSE Errors: - Definition at line 145 of file contmenu.cpp. { pRootItem = NULL; pLastItem = NULL; AutoIDStash = 0; }

ContextMenu::~ContextMenu (   )  [virtual]

Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 13/03/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE FALSE Errors: - Definition at line 170 of file contmenu.cpp. { }

---

Member Function Documentation

BOOL ContextMenu::Build (  void   )  [virtual]

Base class implementation of menu builder. This function builds a menu statically by creating the appropriate objects. It does NOT call teh menu script interpreter because I am unhappy about the reliability of repeatedly calling that code. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 13/03/95 Parameters: pRootMenu  Pointer to root menu item to add new items to. [INPUTS] -  [OUTPUTS] Returns: TRUE if menu built OK FALSE (and sets error) otherwise An overloaded version of this function could be written which takes in a reference to a "file" to be opened and interpreted. Note also that by building the menu programmatically it can change depending on the context within which it is opened... The standard layout for pop-up menus is: Clicked object's primary commands Transfer commands Other commands supported by the clicked object The "What's this?" command The Properties... command These are only guidelines and you can omit any sections you don't need. To implement an overriden version of this function you simply need to make it add new menu items to the root menu. There are helper functions to make this easier: BuildTransferCommands will add Cut,Copy,Paste,etc. BuildCommand will take any OPTOKEN you give it and build an item linked to that OPTOKEN. Returns: Errors: - Reimplemented in BfxPlugInContextMenu, ColEditContextMenu, PaletteContextMenu, PlugInsContextMenu, PreviewContextMenu, RulerContextMenu, OriginContextMenu, and GalleryContextMenu. Definition at line 373 of file contmenu.cpp. { ERROR2(FALSE,"ContextMenu::Build called in base class - should be overridden!"); }

BOOL ContextMenu::BuildCommand (  TCHAR *  pOpToken, BOOL  Separator = FALSE, MenuItem *  pRootMenu = NULL, const String &  strNewText = String( _T("") ), OpMenuParam *  pParam = NULL )

Append a new menu item to this menu. Passing pRootMenu as NULL (leaving it defaulted) causes the new item to be added to the first level of the pop-up menu. Passing pRootMenu non-NULL allows you to build a submenu. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 17/03/95 Parameters: pOpToken  Pointer to optoken for this item [INPUTS] Separator Flag that separator is required after this item pRootMenu Pointer to root menu to add this to or NULL for main root -  [OUTPUTS] Returns: Pointer to first MenuItem in the kernel menu definition Errors: - Definition at line 504 of file contmenu.cpp. { MenuItem* pNewItem; // If caller hasn't specified a root menu use the root of the whole thing... if (pRootMenu == NULL) pRootMenu = pRootItem; // Create a new kernel menu item... pNewItem = CreateMenuItem(pOpToken, pRootMenu->GetMenuId(), Separator); // If that worked, add it to the root menu. Else flag failure. if (pNewItem) { pLastItem = pNewItem; if (!strNewText.IsEmpty()) pNewItem->SetMenuText(strNewText); if (pParam) pNewItem->SetMenuParam(pParam); pRootMenu->AddMenuItem(pNewItem); return TRUE; } else return FALSE; }

BOOL ContextMenu::BuildEffectCommands (   )

Append the "effect" menu items to the input root menu. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 13/03/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: Pointer to first MenuItem in the kernel menu definition Errors: - Definition at line 467 of file contmenu.cpp. { EffectsStack* pStack = GetApplication()->FindSelection()->GetEffectsStack(); // Cached copy if (pStack->IsEmpty() || !pStack->bConsistent) return TRUE; BuildCommand( TOOL_OPTOKEN_LIVEEFFECT ); // Go to Effects tool pStack->BuildEffectMenu(this); // <List of effects> BuildCommand(OPTOKEN_DELETEALL_LIVEEFFECT, TRUE); // Remove all Effects return TRUE; }

BOOL ContextMenu::BuildOverView (  Spread *  pSpread, DocCoord  ClickPos, ClickModifiers  ClickMods )  [virtual]

Base class function which, when overridden in derived classes, will build a pop-up menu according to a given position in a view. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 13/03/95 Parameters: pRootMenu  Pointer to root menu item to add new items to. [INPUTS] -  [OUTPUTS] Returns: TRUE if menu built OK FALSE (and sets error) otherwise Errors: - Reimplemented in ViewContextMenu. Definition at line 397 of file contmenu.cpp. { ERROR2(FALSE,"ContextMenu::BuildOverView called in base class - should be overridden!"); }

BOOL ContextMenu::BuildTransferCommands (  BOOL  NodeCommands  )

Append the standard "transfer command" menu items to the input root menu This function adds: Cut Copy Paste (Paste link When we implement OLE...) And if NodeCommands is TRUE: ----- Delete Duplicate Clone -----. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 13/03/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: Pointer to first MenuItem in the kernel menu definition Errors: - Definition at line 431 of file contmenu.cpp. { // Build the standard transfer command menu items... BuildCommand(OPTOKEN_CUT); BuildCommand(OPTOKEN_COPY); BuildCommand(OPTOKEN_PASTE, TRUE); // BuildCommand(OPTOKEN_PASTELINK); // If caller wants transfer commands for Nodes in the document build them... if (NodeCommands) { BuildCommand(OPTOKEN_DELETE); BuildCommand(OPTOKEN_DUPLICATE); BuildCommand(OPTOKEN_CLONE, TRUE); } return TRUE; }

ContextMenu::CC_DECLARE_MEMDUMP (  ContextMenu   )  [private]

MenuItem * ContextMenu::GetLastItem (   )

Get pointer to item last previously created. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 17/03/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: Pointer to last MenuItem defined Errors: - Definition at line 551 of file contmenu.cpp. { return pLastItem; }

BOOL ContextMenu::Hide (   )

Close and delete any context menu that may be open. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 13/03/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE FALSE Errors: - Definition at line 291 of file contmenu.cpp. { DestroyContextMenu(); // Restore ID generator state MenuItem::SetAutomaticIDState(AutoIDStash); AutoIDStash = 0; if (pCurrentMenu==this) pCurrentMenu = NULL; delete this; return TRUE; }

BOOL ContextMenu::HideCurrent (   )  [static]

Close and delete the current context menu if it's open. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 28/10/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE FALSE Errors: - Definition at line 324 of file contmenu.cpp. { if (pCurrentMenu) pCurrentMenu->Hide(); return TRUE; }

BOOL ContextMenu::Show (   )

Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 13/03/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE FALSE Errors: - Definition at line 192 of file contmenu.cpp. { // If there's a menu still around for some reason, get rid of it. if (pCurrentMenu) { pCurrentMenu->Hide(); } // Preserve current ID generator state AutoIDStash = MenuItem::GetAutomaticIDState(); // Make a new root item pRootItem = new MenuItem("CONTEXT"); if (pRootItem) { // OK, make this menu current and try to build it's contents pCurrentMenu=this; if (Build()) { // Kernel menu built OK so create the OILy part of it... CreateContextMenu(pRootItem); return TRUE; } } // Failed to completely build Kernel menu structure so delete anything // that might have been built... Hide(); return FALSE; }

BOOL ContextMenu::ShowOverView (  Spread *  pSpread, DocCoord  ClickPos, ClickModifiers  ClickMods )

This function does the same job as ShowMenu but unfortunately needs some parameters to pass on to the menu builders. Not very neat, I know... Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 13/03/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE FALSE Errors: - Definition at line 242 of file contmenu.cpp. { // If there's a menu still around for some reason, get rid of it. if (pCurrentMenu) { pCurrentMenu->Hide(); } // Preserve current ID generator state AutoIDStash = MenuItem::GetAutomaticIDState(); // Make a new root item pRootItem = new MenuItem("CONTEXT"); if (pRootItem) { // OK, make this menu current and try to build it's contents pCurrentMenu=this; if (BuildOverView(pSpread, ClickPos, ClickMods)) { // Kernel menu built OK so create the OILy part of it... CreateContextMenu(pRootItem); return TRUE; } } // Failed to completely build Kernel menu structure so delete anything // that might have been built... Hide(); return FALSE; }

---

Member Data Documentation

UINT32 ContextMenu::AutoIDStash [protected]

Definition at line 175 of file contmenu.h.

ContextMenu * ContextMenu::pCurrentMenu = NULL [static, protected]

Definition at line 177 of file contmenu.h.

MenuItem* ContextMenu::pLastItem [protected]

Definition at line 174 of file contmenu.h.

MenuItem* ContextMenu::pRootItem [protected]

Definition at line 173 of file contmenu.h.

---

The documentation for this class was generated from the following files:

• Kernel/contmenu.h (r1785/r1282)
• Kernel/contmenu.cpp (r1785/r1282)

---