oilmenus.cpp File Reference

(r1785/r1667)

#include "camtypes.h"
#include "oilmenus.h"
#include "menupref.h"
#include "contmenu.h"
#include "menuops.h"
#include "plugmngr.h"
#include "camframe.h"
#include "camelot.h"

Go to the source code of this file.

Defines
#define	new   CAM_DEBUG_NEW
Functions
	DECLARE_SOURCE ("$Revision: 1667 $")
MenuItem *	SetupDefaultMenu ()
	Creates the default mainframe menu for an MDI type interface.
MenuItem *	SetupSharedMenu ()
	Creates a MDI type shared menu.
wxCamMenuBar *	ConvertToWinMenu (MenuItem *GroupSubMenu)
	Converts from a platform-independent menu system into a Windows specific one.
wxMenu *	CreatePopup (MenuItem *pCamSubMenu)
	Converts from a platform-independent menu into a Windows specific one.
BOOL	DestroyCamMenu (MenuItem *CamMenu)
	Destroys all dynamic objects in the menu system, freeing up memory.
BOOL	DestroyWinSubMenu (wxMenu *WinSubMenu)
	Destroys all dynamic objects in the menu system, freeing up memory.
BOOL	DestroyWinMenu (wxMenu *WinMenu)
	Destroys all dynamic objects in the menu system, freeing up memory.
BOOL	DestroyWinSubMenuMFC (wxMenu *pWinSubMenu)
	Destroys all dynamic objects in the menu system, freeing up memory.
BOOL	DestroyWinMenuMFC (wxMenu *pWinMenu)
	Destroys all dynamic objects in the menu system, freeing up memory.
BOOL	InitMenuSystem ()
	Creates both the platform-independent and windows specific menu systems.
void	DeinitMenuSystem ()
	Destroys both the platform-independent and windows specific menu systems.
BOOL	IsMenuCommand (wxCommandEvent &event)
	To identify menu item commands.
MenuItem *	FindMenuItem (UINT32 menuId, MenuItem *GroupSubMenu)
	To find a menu item in the platform independent menu system. Scope: Private To OilMenus.
MenuItem *	GetMenuItem (UINT32 menuId, BOOL *pShowHotKeysFlag)
	To find a menu item in one of the platform independent menu systems.
BOOL	PerformMenuCommand (wxCommandEvent &event)
	To perform menu item command.
BOOL	FindMenu (MenuItem **TargetMenu, wxMenu *pMenu, BOOL *pShowHotKeysFlag)
	To find kernel menu equivalent to Windows menu that is passed in. Scope: Private to be called by UpdateMenu() only!
BOOL	UpdateMenu (wxMenu *pMenu)
	To update menu.
void	UpdateWinMenu (wxMenu *pMenu, MenuItem *kernelMenu)
	To update windows menu system. It is also a Friend of the MenuItem Class.
BOOL	CreateContextMenu (MenuItem *pContextMenu)
	To put a popup menu on screen.
BOOL	DestroyContextMenu ()
	To remove a popup menu from the screen.
MenuItem *	GetCurrentContextMenu ()
	Find out whether the popup menu is open or not and what it is...
MenuItem *	GetMainMDIMenu ()
	To find the menu item associated with the main kernelly MDI menu.
BOOL	UpdatePlugInsWinMenu (MenuItem *pPlugInsMenu)
	This searches for the equivalent Win menu in the main MDI menu structure, destroys anything that is there already and then puts in the new structure.
Variables
MenuItem *	CamelotDefMenu
MenuItem *	CamelotMDIMenu
MenuItem *	CamelotContextMenu
wxCamMenuBar *	WinDefMenu
wxCamMenuBar *	WinMDIMenu
wxMenu *	WinContextMenu

---

Define Documentation

#define new   CAM_DEBUG_NEW

Definition at line 128 of file oilmenus.cpp.

---

Function Documentation

wxCamMenuBar* ConvertToWinMenu (  MenuItem *  GroupSubMenu  )

Converts from a platform-independent menu system into a Windows specific one. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 30/6/93 Parameters: MenuItem  - A platform-independent menu. [INPUTS] None.  [OUTPUTS] Returns: wxMenu - Windows MFC-type menu object. Errors: None See also: OilMenus MenuItem CreatePopup() Definition at line 212 of file oilmenus.cpp. { wxCamMenuBar* WinMenu = new wxCamMenuBar; // Top Level Menu - Menu Bar MenuItem* SubMenu; // Sub Menu Iterator SubMenu = GroupSubMenu->GetFirstMenuItem(); while (SubMenu != NULL) // Assumes that all MenuItems on the { // MenuBar are Group MenuItems wxMenu* pSubMenu = CreatePopup( SubMenu ); if (pSubMenu) { wxString sName((TCHAR*)SubMenu->GetMenuText()); if (!WinMenu->Append( pSubMenu, sName )) { TRACEUSER("luke", _T("Append failed\n")); } } SubMenu = GroupSubMenu->GetNextMenuItem(SubMenu); } return WinMenu; }

BOOL CreateContextMenu (  MenuItem *  pContextMenu  )

To put a popup menu on screen. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 13/03/95 Parameters: pContextMenu  Pointer to a context-sensitive menu [INPUTS] -  [OUTPUTS] Returns: TRUE if menu was created and opened on screen succesfully. FALSE otherwise Errors: None. Definition at line 1181 of file oilmenus.cpp. { BOOL worked = FALSE; // If the previous context menu is hanging around for some reason // get rid of it. DestroyContextMenu(); // Now setup the new context menu CamelotContextMenu = pContextMenu; WinContextMenu = CreatePopup(CamelotContextMenu); if (WinContextMenu==NULL) worked = FALSE; else { // Set the menu states correctly // CamelotContextMenu->UpdateMenuState(FALSE); // UpdateWinMenu(WinContextMenu, CamelotContextMenu); if( CCamFrame::GetMainFrame()->PopupMenu( WinContextMenu ) ) worked = TRUE; else { DestroyCamMenu(CamelotContextMenu); delete CamelotContextMenu; CamelotContextMenu = NULL; } } return worked; }

wxMenu* CreatePopup (  MenuItem *  pCamSubMenu  )

Converts from a platform-independent menu into a Windows specific one. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 30/6/93 Parameters: MenuItem  - A platform-independent menu (popup). [INPUTS] None.  [OUTPUTS] Returns: wxMenu - Windows MFC-type menu object. Errors: None Scope: Private - can only be called from within the OilMenus module See also: OilMenus MenuItem Definition at line 259 of file oilmenus.cpp. { ERROR2IF(pCamSubMenu == 0, 0, "CreatePopup: null pCamSubMenu supplied"); wxMenu* pPopupMenu = new wxMenu( /*wxString( pCamSubMenu->GetMenuText() )*/ ); // Popup Menus in Windows ERROR2IF(pPopupMenu == 0, 0, "CreatePopup failed to allocate new menu"); MenuItem* pSubMenu = pCamSubMenu->GetFirstMenuItem(); // if menu popup hasn't got any sub menu items then setup a dummy menuitem to allow // the OnMenuPopupInit() function to work when menu is selected! if (pSubMenu == 0) { if (!pPopupMenu->Append( pCamSubMenu->GetMenuId(), // Use the Group Menu Id TEXT(""))) // Give it an empty string { TRACEUSER("luke", _T("Append failed\n")); } } while (pSubMenu != 0) { bool fIsUnimpl = *pSubMenu->GetOpToken() == OPTOKEN_DO_NOTHING; bool fNeedSep = pSubMenu->IsFollowedBySeparator() && ( 0 != pCamSubMenu->GetNextMenuItem( pSubMenu ) ); if (pSubMenu->IsMenuItemGroup()) // Distinguish between group & { // single MenuItems wxMenu* pNewMenu = CreatePopup( pSubMenu ); if (pNewMenu) { #if !defined(_DEBUG) if( !fIsUnimpl ) { #endif wxString sName((TCHAR *)pSubMenu->GetMenuText()); if (!pPopupMenu->Append( pSubMenu->GetMenuId(), sName, pNewMenu )) { TRACEUSER("luke", _T("Append failed\n")); } } #if !defined(_DEBUG) } #endif } else { wxItemKind ItemKind = wxITEM_NORMAL; if( pSubMenu->IsCheckable() ) ItemKind = wxITEM_CHECK; #if !defined(_DEBUG) if( !fIsUnimpl ) { #endif // Set the leaf's label ... if (!pPopupMenu->Append( pSubMenu->GetMenuId(), wxString( (TCHAR*)pSubMenu->GetMenuText() ), wxEmptyString, ItemKind )) { TRACEUSER("luke", _T("Append failed\n")); } #if !defined(_DEBUG) } else fNeedSep = false; #else if( fIsUnimpl ) pPopupMenu->Enable( pSubMenu->GetMenuId(), false ); #endif /* // ... and glyph, if any. UINT32 nSelBmpID = pSubMenu->GetMenuSelectedBitmapID(); UINT32 nUnselBmpID = pSubMenu->GetMenuUnselectedBitmapID(); if (nSelBmpID != 0 && nUnselBmpID != 0) pPopupMenu->SetMenuItemBitmaps(pSubMenu->GetMenuId(), 0, &CBitmap(nSelBmpID), &CBitmap(nUnselBmpID)); */ } // Add a separating line if required, BUT... // Don't allow a separator to be added if this is the last item in the menu... if( fNeedSep ) { if (!pPopupMenu->AppendSeparator()) { TRACEUSER("luke", _T("AppendSeparator failed\n")); } } pSubMenu = pCamSubMenu->GetNextMenuItem(pSubMenu); } return pPopupMenu; }

DECLARE_SOURCE (  "$Revision: 1667 $"   )

oilmenus.cpp - Responsibilities include menu initialisation and deinitialisation as well as updating menu states and performing menu commands.

void DeinitMenuSystem (   )

Destroys both the platform-independent and windows specific menu systems. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 30/6/93 Parameters: None.  [INPUTS] None.  [OUTPUTS] Returns: Nothing. Errors: None. See also: OilMenus MenuItem DestroyCamMenu() DestroyWinMenu() InitMenuSystem() Definition at line 687 of file oilmenus.cpp. { if (CamelotDefMenu) { DestroyCamMenu(CamelotDefMenu); //Destroy Platform-Independent delete CamelotDefMenu; CamelotDefMenu = NULL; } if (CamelotMDIMenu) { DestroyCamMenu(CamelotMDIMenu); //Menu System delete CamelotMDIMenu; CamelotMDIMenu = NULL; } PORTNOTE("other","Removed menu destruction - temporary!") #if 0 if (WinMDIMenu) { DestroyWinMenu(WinMDIMenu); //Destroy The MDI Frame Menu WinMDIMenu->Detach(); delete WinMDIMenu; WinMDIMenu = NULL; } #endif //---------------------------------------------------------- // If the context-sensitive menu is left around delete it... /* if (CamelotContextMenu) { DestroyCamMenu(CamelotContextMenu); //Menu System delete CamelotContextMenu; CamelotContextMenu = NULL; } if (WinContextMenu) { DestroyWinMenu(WinContextMenu); //Destroy The MDI Frame Menu // WinContextMenu->Detach(); WinContextMenu->DestroyMenu(); // DestroyMenu releases Windows resources and calls Detach delete WinContextMenu; WinContextMenu = NULL; } */ ContextMenu::HideCurrent(); }

BOOL DestroyCamMenu (  MenuItem *  CamMenu  )

Destroys all dynamic objects in the menu system, freeing up memory. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 30/6/93 Parameters: MenuItem  - A platform-independent menu. [INPUTS] None.  [OUTPUTS] Returns: True - If all objects in menu system were destroyed successfully Errors: None Scope: Private - can only be called from within the OilMenus module See also: OilMenus MenuItem DestroyWinMenu() DeInitMenuSystem() Definition at line 382 of file oilmenus.cpp. { MenuItem *subMenu; MenuItem *tempMenu; subMenu = CamMenu->GetFirstMenuItem(); while (subMenu != NULL) { // if MenuItem is a group then delete all MenuItems within it if (subMenu->IsMenuItemGroup()) DestroyCamMenu(subMenu); // Get Next MenuItem before the current is deleted tempMenu = CamMenu->GetNextMenuItem(subMenu); // Object pointed to by subMenu is deleted and memory is freed. delete CamMenu->RemoveMenuItem(subMenu); // Submenu now points to next item subMenu = tempMenu; } return TRUE; }

BOOL DestroyContextMenu (   )

To remove a popup menu from the screen. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 14/03/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: TRUE if menu was destroyed succesfully. FALSE otherwise Errors: None. Definition at line 1232 of file oilmenus.cpp. { // If the previous context menu is hanging around for some reason // get rid of it. if (WinContextMenu) { DestroyWinMenu(WinContextMenu); // WinContextMenu->Detach(); // WinContextMenu->Destroy(); // DestroyMenu releases Windows resources and calls Detach delete WinContextMenu; WinContextMenu = NULL; } if (CamelotContextMenu) { DestroyCamMenu(CamelotContextMenu); delete CamelotContextMenu; CamelotContextMenu = NULL; } return TRUE; }

BOOL DestroyWinMenu (  wxMenu *  WinMenu  )

Destroys all dynamic objects in the menu system, freeing up memory. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 30/6/93 Parameters: wxMenu  - Windows menu object. [INPUTS] None.  [OUTPUTS] Returns: True - If all objects in menu system were destroyed successfully Errors: Does not work with nested, hierarchical menus yet! Scope: Private - can only be called from within the OilMenus module See also: OilMenus MenuItem DestroyCamMenu() DeInitMenuSystem() Definition at line 436 of file oilmenus.cpp. { PORTNOTE("other","Removed menu destruction - temporary!") #if 0 wxMenu *subMenu; INT32 position = 0; INT32 noItems = WinMenu->GetMenuItemCount(); while ((noItems > 0) && (position < noItems)) { subMenu = WinMenu->GetSubMenu(position); if (subMenu != NULL) { DestroyWinSubMenu(subMenu); subMenu->Detach(); delete subMenu; } position++; } #endif return TRUE; }

BOOL DestroyWinMenuMFC (  wxMenu *  pWinMenu  )

Destroys all dynamic objects in the menu system, freeing up memory. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 7/3/97 Parameters: wxMenu  - Windows menu object. [INPUTS] None.  [OUTPUTS] Returns: True - If all objects in menu system were destroyed successfully Errors: Does not work with nested, hierarchical menus yet! Scope: Private - can only be called from within the OilMenus module See also: OilMenus MenuItem DestroyCamMenu() DeInitMenuSystem() Definition at line 540 of file oilmenus.cpp. { PORTNOTE("other","Removed menu destruction - temporary!") #if 0 ERROR2IF(pWinMenu == NULL, FALSE,"DestroyWinMenuMFC bad pWinMenu supplied"); wxMenu *pSubMenu = NULL; INT32 noItems = pWinMenu->GetMenuItemCount(); // Walk backwards through the list removing items from the end, otherwise // we would need to recalculate the position after each menu deletion as the // position will have changed. BOOL ok = TRUE; INT32 position = noItems - 1; while (position >= 0) { pSubMenu = pWinMenu->GetSubMenu(position); if (pSubMenu != NULL) ok = DestroyWinSubMenuMFC(pSubMenu); // now delete the menu item ok = pWinMenu->DeleteMenu( position, MF_BYPOSITION ); if (pSubMenu != NULL) { pSubMenu->Detach(); delete pSubMenu; } position--; } #endif return TRUE; }

BOOL DestroyWinSubMenu (  wxMenu *  WinSubMenu  )

Destroys all dynamic objects in the menu system, freeing up memory. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 30/6/93 Parameters: wxMenu  - Windows menu object. [INPUTS] None.  [OUTPUTS] Returns: True - If all objects in menu system were destroyed successfully Errors: None! Scope: Private - can only be called from within the OilMenus module See also: OilMenus MenuItem DestroyWinMenu() DeInitMenuSystem() Definition at line 483 of file oilmenus.cpp. { PORTNOTE("other","Removed menu destruction - temporary!") #if 0 wxMenu *subMenu; UINT32 subMenuId; INT32 position = 0; INT32 noItems = WinSubMenu->GetMenuItemCount(); while ((noItems > 0) && (position < noItems)) { subMenuId = WinSubMenu->GetMenuItemID(position); if (subMenuId == (UINT32)-1) { subMenu = WinSubMenu->GetSubMenu(position); if (subMenu != NULL) { DestroyWinSubMenu(subMenu); subMenu->Detach(); delete subMenu; } } position++; } #endif return TRUE; }

BOOL DestroyWinSubMenuMFC (  wxMenu *  pWinSubMenu  )

Destroys all dynamic objects in the menu system, freeing up memory. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 7/3/97 Parameters: wxMenu  - Windows menu object. [INPUTS] None.  [OUTPUTS] Returns: True - If all objects in menu system were destroyed successfully Errors: None! Scope: Private - can only be called from within the OilMenus module See also: OilMenus MenuItem DestroyWinMenu() DeInitMenuSystem() Definition at line 596 of file oilmenus.cpp. { PORTNOTE("other","Removed menu destruction - temporary!") #if 0 ERROR2IF(pWinSubMenu == NULL, FALSE,"DestroyWinMenuMFC bad pWinSubMenu supplied"); wxMenu *pSubMenu = NULL; INT32 noItems = pWinSubMenu->GetMenuItemCount(); // Walk backwards through the list removing items from the end, otherwise // we would need to recalculate the position after each menu deletion as the // position will have changed. BOOL ok = TRUE; INT32 position = noItems - 1; while (position >= 0) { pSubMenu = pWinSubMenu->GetSubMenu(position); if (pSubMenu != NULL) ok = DestroyWinSubMenuMFC(pSubMenu); // now delete the menu item ok = pWinSubMenu->DeleteMenu( position, MF_BYPOSITION ); if (pSubMenu != NULL) { pSubMenu->Detach(); delete pSubMenu; } position--; } #endif return TRUE; }

BOOL FindMenu (  MenuItem **  TargetMenu, wxMenu *  pMenu, BOOL *  pShowHotKeysFlag )

To find kernel menu equivalent to Windows menu that is passed in. Scope: Private to be called by UpdateMenu() only! Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 29/9/93 Parameters: A  pointer to a Windows wxMenu [INPUTS] A  pointer to a Camelot MenuItem. [OUTPUTS] Returns: TRUE if found successfully FALSE otherwise Errors: None. See also: CMainFrame wxMenu MenuItem Definition at line 916 of file oilmenus.cpp. { UINT32 TargetMenuId = (UINT32)-1; size_t position = 0; size_t noItems = pMenu->GetMenuItemCount(); // Get id of first non sub-menu item in Windows wxMenu // TargetMenuID is -1 if its a sub-menu item and 0 if its a separator // No separator check present, added by Neville 31/10/97 TargetMenuId = pMenu->FindItemByPosition( position )->GetId(); while ( (noItems > 0) && (position < noItems) && ((TargetMenuId == (UINT32)-1) || (TargetMenuId == 0)) ) { TargetMenuId = pMenu->FindItemByPosition( position )->GetId(); position++; } if (TargetMenuId != (UINT32)-1) { //Use ID to get MenuItem object *TargetMenu = GetMenuItem(TargetMenuId, pShowHotKeysFlag); if (*TargetMenu != NULL) // couldn't find it, probably { // the system menu on the close box //Get Parent Id of MenuItem TargetMenuId = (*TargetMenu)->GetMenuItemParentId(); //Use Parent Id to get menu we want! *TargetMenu = GetMenuItem(TargetMenuId, pShowHotKeysFlag); if (*TargetMenu) return TRUE; else return FALSE; } } return FALSE; }

MenuItem* FindMenuItem (  UINT32  menuId, MenuItem *  GroupSubMenu )

To find a menu item in the platform independent menu system. Scope: Private To OilMenus. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 2/7/93 Parameters: Menu  ID & Group Sub Menu [INPUTS] None.  [OUTPUTS] Returns: MenuItem if found NULL if menu item is not found Errors: None. See also: MenuItem Definition at line 785 of file oilmenus.cpp. { if (GroupSubMenu==NULL) return NULL; if (GroupSubMenu->GetMenuId() == menuId) return GroupSubMenu; MenuItem* subsubMenu; MenuItem* subMenu = GroupSubMenu->GetFirstMenuItem(); while (subMenu != NULL) { if (subMenu->GetMenuId() == menuId) return subMenu; if (subMenu->IsMenuItemGroup()) { subsubMenu = FindMenuItem(menuId, subMenu); if (subsubMenu != NULL) return subsubMenu; } subMenu = GroupSubMenu->GetNextMenuItem(subMenu); } return NULL; }

MenuItem* GetCurrentContextMenu (   )

Find out whether the popup menu is open or not and what it is... Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 14/03/95 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A pointer to the current context menu (kernel form) if it exists AND the Windows equivalent exists AND it's currently on screen. Errors: None. Definition at line 1273 of file oilmenus.cpp. { if (WinContextMenu!=NULL && CamelotContextMenu!=NULL) return CamelotContextMenu; else return NULL; }

MenuItem* GetMainMDIMenu (   )

To find the menu item associated with the main kernelly MDI menu. Author: Phil_Martin (Xara Group Ltd) <camelotdev@xara.com> Date: 17/1/97 Parameters: -  [INPUTS] -  [OUTPUTS] Returns: A pointer to the main MDI menu. Errors: None. Definition at line 1295 of file oilmenus.cpp. { return CamelotMDIMenu; }

MenuItem* GetMenuItem (  UINT32  menuId, BOOL *  pShowHotKeysFlag )

To find a menu item in one of the platform independent menu systems. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 28/9/93 Parameters: Menu  ID [INPUTS] None.  [OUTPUTS] Returns: MenuItem if found NULL if menu item is not found Errors: None. See also: MenuItem FindMenuItem Definition at line 831 of file oilmenus.cpp. { // If There are no active child windows Then search for menu option in default menu // Else search for menu option in MDI shared menu. MenuItem* pItem = NULL; if (pShowHotKeysFlag) *pShowHotKeysFlag = TRUE; PORTNOTE( "other", "We always use MDIMenu" ) /* if( NULL == ( (wxDocMDIParentFrame *)CCamFrame::GetMainFrame() )->GetActiveChild() ) { // There is no document (MDI child) window, so we want to look only in the // current context-sensitive menu (if any), and then (if that fails), in the // default camelot menu. pItem = FindMenuItem(menuId, CamelotContextMenu); // Look in Context sensitive menu first if (pItem == NULL) pItem = FindMenuItem(menuId, CamelotDefMenu); // Look in default menu } else */ { pItem = FindMenuItem(menuId, CamelotContextMenu); // Look in Context sensitive menu first if (pItem == NULL) pItem = FindMenuItem(menuId, CamelotMDIMenu); else if (pShowHotKeysFlag) *pShowHotKeysFlag = FALSE; // ContextMenu shouldn't show hot keys } return pItem; }

BOOL InitMenuSystem (   )

Creates both the platform-independent and windows specific menu systems. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 30/6/93 Parameters: None.  [INPUTS] None.  [OUTPUTS] Returns: TRUE if initialisation was successful Errors: None. See also: OilMenus MenuItem SetupDefaultMenu() SetupSharedMenu() ConvertToWinMenu() DeInitMenuSystem() Definition at line 649 of file oilmenus.cpp. { CamelotDefMenu = SetupDefaultMenu(); //MainFrame Menu CamelotMDIMenu = SetupSharedMenu(); //MDI Menu CamelotContextMenu = NULL; if (CamelotDefMenu) WinDefMenu = ConvertToWinMenu(CamelotDefMenu); //Windows MainFrame Menu else return FALSE; if (CamelotMDIMenu) WinMDIMenu = ConvertToWinMenu(CamelotMDIMenu); //Windows MDI Menu else return FALSE; return TRUE; }

BOOL IsMenuCommand (  wxCommandEvent &  event  )

To identify menu item commands. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 2/7/93 Parameters: wParam  & lParam - Windows API command parameters. [INPUTS] None.  [OUTPUTS] Returns: TRUE if command is a menu command FALSE otherwise Errors: None. See also: CMainFrame Definition at line 756 of file oilmenus.cpp. { return event.GetEventType() == wxEVT_COMMAND_MENU_SELECTED; }

BOOL PerformMenuCommand (  wxCommandEvent &  event  )

To perform menu item command. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 2/7/93 Parameters: wParam  & lParam - Windows API command parameters. [INPUTS] None.  [OUTPUTS] Returns: TRUE if MenuItem found and command is performed FALSE otherwise Errors: None. See also: CMainFrame MenuItem FindMenuItem() MenuItem::PerformAction() Definition at line 881 of file oilmenus.cpp. { MenuItem* TargetItem; // Get appropriate menu item given the menu id TargetItem = GetMenuItem( event.GetId() ); if (TargetItem) { TargetItem->PerformAction(); return TRUE; } return FALSE; }

MenuItem* SetupDefaultMenu (   )

Creates the default mainframe menu for an MDI type interface. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 30/6/93 Parameters: None.  [INPUTS] None.  [OUTPUTS] Returns: MenuItem - A platform independent mainframe menu. Errors: None See also: OilMenus MenuItem SetupSharedMenu() GetMenuPreferences() Definition at line 156 of file oilmenus.cpp. { MenuItem* pMenu = GetMenuPreferences(_R(IDM_DEFAULT_MENU)); return pMenu; }

MenuItem* SetupSharedMenu (   )

Creates a MDI type shared menu. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 30/6/93 Parameters: None.  [INPUTS] None.  [OUTPUTS] Returns: MenuItem - A platform independent MDI menu. Errors: None See also: OilMenus MenuItem SetupDefaultMenu() GetMenuPreferences() Definition at line 180 of file oilmenus.cpp. { MenuItem* pMenu = GetMenuPreferences(_R(IDM_SHARED_MENU)); return pMenu; }

BOOL UpdateMenu (  wxMenu *  pMenu  )

To update menu. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 8/7/93 Parameters: A  pointer to a wxMenu [INPUTS] None.  [OUTPUTS] Returns: FALSE if Menu is not found in the Kernel TRUE otherwize. Errors: None. See also: CMainFrame wxMenu MenuItem Definition at line 974 of file oilmenus.cpp. { MenuItem* TargetMenu = NULL; BOOL ShowHotKeys = TRUE; if (FindMenu(&TargetMenu, pMenu, &ShowHotKeys)) { ERROR3IF(TargetMenu==NULL,"FindMenu returned TRUE but didn't fill in menu pointer"); #ifdef PHOTOSHOPPLUGINS // Only add in if required - general plug-in removal at present //#ifdef NEW_NATIVE_FILTER // Must check if we are going to drop down the Plug-Ins menu item // If so then check that we have parsed the plug-ins. PlugInManager* pManager = GetApplication()->GetPlugInManager(); if (pManager != NULL && !pManager->SearchedPathsYet()) { MenuItem * pPlugInsMenu = pManager->FindPlugInMainMenuItem(); // a pointer compare should be an adequote test if (pPlugInsMenu != NULL && TargetMenu != NULL && pPlugInsMenu == TargetMenu) { pManager->CheckHaveDetailsOnPlugIns(); // Now done in UpdatePlugInsWinMenu // Force the menu bar to be redrawn as we are in the middle of pulling the // menu down and we have changed it. //HWND hwnd = GetMainFrame()->GetSafeHwnd(); //DrawMenuBar(hwnd); // Cannot fall through to the code below as the pMenu we have had passed in // may now be completely false. This will cause problems in the UpdateWinMenu call. // So return now. return TRUE; } } //#endif #endif // Update Kernel Menu TargetMenu->UpdateMenuState(ShowHotKeys); // Update OIL Menu UpdateWinMenu(pMenu, TargetMenu); return TRUE; } else return FALSE; }

BOOL UpdatePlugInsWinMenu (  MenuItem *  pPlugInsMenu  )

This searches for the equivalent Win menu in the main MDI menu structure, destroys anything that is there already and then puts in the new structure. Author: Neville_Humphrys (Xara Group Ltd) <camelotdev@xara.com> Date: 20/1/97 Parameters: pPlugInsMenu  Pointer to the plug-ins kernel menu structure [INPUTS] -  [OUTPUTS] Returns: TRUE if win menu was updated succesfully. FALSE otherwise Errors: None. Definition at line 1315 of file oilmenus.cpp. { #ifdef PHOTOSHOPPLUGINS // Only add in if required - general plug-in removal at present ERROR2IF(pPlugInsMenu == NULL,FALSE,"UpdatePlugInsWinMenu null plug-ins menu supplied"); BOOL worked = FALSE; // Find the section in the current MDI main win menu INT32 PlugInMenuPos = -1; wxMenu * pWinMainMenu = FindSubMenu(WinMDIMenu, PlugInMenuPos, (TCHAR *) pPlugInsMenu->GetMenuText()); if (pWinMainMenu == NULL) return FALSE; wxMenu * pPlugInsWinMenu = pWinMainMenu->GetSubMenu(PlugInMenuPos); if (pPlugInsWinMenu == NULL) return FALSE; // If the previous plug-ins menu is hanging around for some reason // get rid of it. // Try and destroy all the sub-menu items first BOOL ok = DestroyWinMenuMFC(pPlugInsWinMenu); ok = ok && pWinMainMenu->DeleteMenu( PlugInMenuPos, MF_BYPOSITION ); pPlugInsWinMenu->Detach(); delete pPlugInsWinMenu; // Now setup the new plug-ins menu inserting it at the old position // First create the new windows menu from the kernel version wxMenu * pNewWinMenu = CreatePopup(pPlugInsMenu); ERROR3IF(pNewWinMenu == NULL,"Failed to create new plug-ins main menu item"); if (pNewWinMenu) { // That went ok so now add it in at the old position in the main menu pWinMainMenu->InsertMenu(PlugInMenuPos, MF_POPUP | MF_BYPOSITION, (UINT32)(pNewWinMenu->GetSafeHmenu()), pPlugInsMenu->GetMenuText() ); } // Force the menu bar to be redrawn as we are in the middle of pulling the // menu down and we have changed it. HWND hwnd = GetMainFrame()->GetSafeHwnd(); DrawMenuBar(hwnd); // This code should happen in the UpdateMenu after our issuing of the DrawMenuBar command // Update Kernel Menu pPlugInsMenu->UpdateMenuState(FALSE); // Update OIL Menu UpdateWinMenu(pNewWinMenu, pPlugInsMenu); return worked; #else return TRUE; #endif // PHOTOSHOPPLUGINS }

void UpdateWinMenu (  wxMenu *  pMenu, MenuItem *  kernelMenu )

To update windows menu system. It is also a Friend of the MenuItem Class. Author: Mario_Shamtani (Xara Group Ltd) <camelotdev@xara.com> Date: 8/7/93 Parameters: A  pointer to a wxMenu and a kernel menu object [INPUTS] None.  [OUTPUTS] Returns: None. Errors: None. See also: CMainFrame wxMenu MenuItem Definition at line 1038 of file oilmenus.cpp. { if (kernelMenu == NULL) return; MenuItem* subMenu = (kernelMenu->GetFirstMenuItem()); //Read through list of Kernel MenuItems updating their state while (subMenu != NULL) { if (!subMenu->IsMenuItemGroup()) { wxItemKind ItemKind = wxITEM_NORMAL; if( subMenu->IsCheckable() ) ItemKind = wxITEM_CHECK; // Make sure the wxMenu has this menu item in it... wxMenuItem *pItem = pMenu->FindItem( subMenu->GetMenuId() ); if( NULL == pItem ) { // This menu item is missing, probably deleted by the bit of code below // We have to put it back in again to be on the safe side // Find out the position of the next visible menu item, so we can insert just before it MenuItem* NextMenu = subMenu; while( NULL != NextMenu && NULL == pMenu->FindItem( NextMenu->GetMenuId() ) ) { NextMenu = (kernelMenu->GetNextMenuItem(NextMenu)); } // If there was a next item, insert before it, else append to the end of the menu if (NextMenu!=NULL) { BOOL MenuAdded = FALSE; BOOL PrevWasSeparator = FALSE; size_t NumMenuItems = pMenu->GetMenuItemCount(); for( size_t i=0; (!MenuAdded) && (i<NumMenuItems); i++ ) { // loop through all the menu items to try and find our ID wxMenuItem* pMenuItem = pMenu->FindItemByPosition( i ); UINT32 MenuID = pMenuItem->GetId(); if (MenuID == NextMenu->GetMenuId()) { // We will be wanting to insert just before this one size_t InsertPos = i; // but was the previous item was a separator if (PrevWasSeparator) InsertPos--; // Insert the menu and set the flag to say it was inserted pMenu->Insert( InsertPos, subMenu->GetMenuId(), subMenu->GetMenuText(), _T(""), ItemKind ); MenuAdded = TRUE; } // Unset the Prev Separator flag PrevWasSeparator = FALSE; // if this was a separator, then remember for the next loop if( pMenuItem->IsSeparator() ) PrevWasSeparator = TRUE; } } else pMenu->Append( subMenu->GetMenuId(), subMenu->GetMenuText(), _T(""), ItemKind ); } PORTNOTE( "menu", "Remove Unimplemented menuitems from menu, under Release" ) #if !defined(_DEBUG) if( subMenu->Description == _T("Unimplemented") ) subMenu->ControlState.RemoveFromMenu = true; #endif if( !subMenu->ControlState.RemoveFromMenu ) { //Update the Menu Text pMenu->FindItem( subMenu->GetMenuId() )->SetText( wxString( (TCHAR *)subMenu->GetMenuText() ) ); if (subMenu->ControlState.Greyed) //Disable and Grey Menu Item pMenu->Enable( subMenu->GetMenuId(), false ); else { //Enable Menu Item and UnGrey pMenu->Enable( subMenu->GetMenuId(), true ); if (subMenu->ControlState.Ticked) { TRACE( _T("Check %s\n"), (PCTSTR)subMenu->GetMenuText() ); //Tick Menu Item if (pMenu->FindItem(subMenu->GetMenuId())->IsCheckable()) pMenu->Check( subMenu->GetMenuId(), true ); } else //UnTick Menu Item if (pMenu->FindItem(subMenu->GetMenuId())->IsCheckable()) pMenu->Check( subMenu->GetMenuId(), false ); } } else // See if this menu item want itself removed from the menu { // take it out of the menu pMenu->Delete( subMenu->GetMenuId() ); } } else { // It's a menu item group, so we need to recurse down wxMenuItem *pItem = pMenu->FindItem( subMenu->GetMenuId() ); if (pItem) { wxMenu * pwxSubMenu = pItem->GetSubMenu(); if (pwxSubMenu) { UpdateWinMenu(pwxSubMenu,subMenu); } } } subMenu = (kernelMenu->GetNextMenuItem(subMenu)); } }

---

Variable Documentation

MenuItem* CamelotContextMenu

Definition at line 132 of file oilmenus.cpp.

MenuItem* CamelotDefMenu

Definition at line 130 of file oilmenus.cpp.

MenuItem* CamelotMDIMenu

Definition at line 131 of file oilmenus.cpp.

wxMenu* WinContextMenu

Definition at line 136 of file oilmenus.cpp.

wxCamMenuBar* WinDefMenu

Definition at line 134 of file oilmenus.cpp.

wxCamMenuBar* WinMDIMenu

Definition at line 135 of file oilmenus.cpp.

---