#include <IMenuCustomizationData.h>

Inheritance diagram for IMenuCustomizationData:

Classes
struct	CustomizedSubMenuPath

struct	MenuColorStruct

struct	SubMenuColorStruct

Public Types
enum	{ kDefaultIID = IID_IMENUCUSTOMIZATIONDATA }

enum	tMenuColor { kNoMenuColor = -1, kBlueMenuColor = 0, kGrayMenuColor = 1, kGreenMenuColor = 2, kOrangeMenuColor = 3, kRedMenuColor = 4, kVioletMenuColor = 5, kYellowMenuColor = 6, kNumberOfMenuColors = 7 }

enum	tMenuState { kNormal = 0, kSelected, kDisabled, kNumberOfStates }

enum	MenuSetReadFileError { kMenuReadFileNoError = 0, kMenuFileNotFound, kMenuFileWrongPlatform, kMenuFileFormatWrongOrCorrupt, kMenuFileFormatIncompatible }

Public Member Functions
virtual const PMString &	GetDefaultMenuSetName () const =0

virtual bool16	SetCurrentMenuSetInfo (const PMString &menuSetName, bool16 isModified, bool16 isPreset, bool16 readShortcutSetFromDisk)=0

virtual const PMString &	GetCurrentMenuSetName () const =0

virtual bool16	IsCurrentMenuSetModified () const =0

virtual bool16	IsCurrentMenuSetPreset () const =0

virtual void	HideSubMenu (const PMString &menuPath)=0

virtual void	ShowSubMenu (const PMString &menuPath)=0

virtual bool16	IsSubMenuHidden (const PMString &menuPath) const =0

virtual const K2Vector < CustomizedSubMenuPath > &	GetHiddenSubMenus () const =0

virtual void	SetHiddenSubMenus (const K2Vector< CustomizedSubMenuPath > &hiddenSubMenuList)=0

virtual void	ClearAllHiddenSubMenus ()=0

virtual void	HideMenuAction (const ActionID action)=0

virtual void	ShowMenuAction (const ActionID action)=0

virtual bool16	IsMenuActionHidden (ActionID action) const =0

virtual const K2Vector < ActionID > &	GetHiddenMenuActions () const =0

virtual void	SetHiddenMenuActions (const K2Vector< ActionID > &hiddenActionList)=0

virtual void	ClearAllHiddenActions ()=0

virtual void	SetSubMenuColor (const PMString &menuPath, tMenuColor colorIndex)=0

virtual tMenuColor	GetSubMenuColor (const PMString &menuPath) const =0

virtual const K2Vector < SubMenuColorStruct > &	GetColoredSubMenus () const =0

virtual void	SetColoredSubMenus (const K2Vector< SubMenuColorStruct > &coloredSubMenuList)=0

virtual void	ClearAllColoredSubMenus ()=0

virtual void	SetMenuActionColor (const ActionID action, tMenuColor colorIndex)=0

virtual tMenuColor	GetMenuActionColor (ActionID action) const =0

virtual const K2Vector < MenuColorStruct > &	GetColoredMenuActions () const =0

virtual void	SetColoredMenuActions (const K2Vector< MenuColorStruct > &coloredActionList)=0

virtual void	ClearAllColoredMenuActions ()=0

virtual bool16	GetMenusAreHiddenOrColorized () const =0

virtual void	ClearAllMenusAndColorization ()=0

virtual bool16	WriteXMLMenuFile (IXMLOutStream *s) const =0

virtual bool16	SaveCurrentMenuSetToFile (const PMString &menuSetName) const =0

virtual MenuSetReadFileError	ReadXMLMenuFile (IPMStream *s)=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

This interface is used to get and set menu customization info, on the workspace boss, or on the kSetMenuCustomizationPrefsCmdBoss

Member Enumeration Documentation

enum IMenuCustomizationData::MenuSetReadFileError

Enumerator
kMenuReadFileNoError	kMenuFileNoError success
kMenuFileNotFound	kMenuFileNotFound File was not found
kMenuFileWrongPlatform	kMenuFileWrongPlatform File appears to be from wrong platform(i.e. trying to open windows shortcut set on mac)
kMenuFileFormatWrongOrCorrupt	kMenuFileFormatWrongOrCorrupt File isn't a known type of shortcut set
kMenuFileFormatIncompatible	kMenuFileFormatIncompatible File isn't a version that can be understood

Member Function Documentation

virtual void IMenuCustomizationData::ClearAllColoredMenuActions ( )

pure virtual

Clear the list of the currently colored menu items.

virtual void IMenuCustomizationData::ClearAllColoredSubMenus ( )

pure virtual

Clear the list of the currently colored submenus.

virtual void IMenuCustomizationData::ClearAllHiddenActions ( )

pure virtual

Clear the list of the currently hidden menu items.

virtual void IMenuCustomizationData::ClearAllHiddenSubMenus ( )

pure virtual

Clear the list of the currently hidden submenus.

virtual void IMenuCustomizationData::ClearAllMenusAndColorization ( )

pure virtual

Clear all hidden menus, submenus, and colorization on menus and submenus

virtual const K2Vector<MenuColorStruct>& IMenuCustomizationData::GetColoredMenuActions ( ) const

pure virtual

Get the list of all the currently colored menu items.

virtual const K2Vector<SubMenuColorStruct>& IMenuCustomizationData::GetColoredSubMenus ( ) const

pure virtual

Get the list of all the currently colored submenus.

virtual const PMString& IMenuCustomizationData::GetCurrentMenuSetName ( ) const

pure virtual

Get the name of the current menu customization set

virtual const PMString& IMenuCustomizationData::GetDefaultMenuSetName ( ) const

pure virtual

Get the name of the default menu customization set.

virtual const K2Vector<ActionID>& IMenuCustomizationData::GetHiddenMenuActions ( ) const

pure virtual

Get the list of all the currently hidden menu items.

virtual const K2Vector<CustomizedSubMenuPath>& IMenuCustomizationData::GetHiddenSubMenus ( ) const

pure virtual

Get the list of all the currently hidden submenus.

virtual tMenuColor IMenuCustomizationData::GetMenuActionColor ( ActionID action ) const

pure virtual

Get color of menu item with given ActionID

virtual bool16 IMenuCustomizationData::GetMenusAreHiddenOrColorized ( ) const

pure virtual

Return kTrue if any menus, submenus are hidden or colored, kFalse otherwise.

virtual tMenuColor IMenuCustomizationData::GetSubMenuColor ( const PMString & menuPath ) const

pure virtual

Get color of submenu with given path

virtual void IMenuCustomizationData::HideSubMenu ( const PMString & menuPath )

pure virtual

Hides a submenu with the specified path

virtual bool16 IMenuCustomizationData::IsCurrentMenuSetModified ( ) const

pure virtual

Check if the current menu customization set is modified from the version on disk

virtual bool16 IMenuCustomizationData::IsCurrentMenuSetPreset ( ) const

pure virtual

Check if the current menu customization set is a preset(as opposed to user-created)

virtual bool16 IMenuCustomizationData::IsMenuActionHidden ( ActionID action ) const

pure virtual

Check if menu item with given ActionID is hidden.

virtual bool16 IMenuCustomizationData::IsSubMenuHidden ( const PMString & menuPath ) const

pure virtual

Check if submenu with the given path is hidden.

virtual MenuSetReadFileError IMenuCustomizationData::ReadXMLMenuFile ( IPMStream * s )

pure virtual

Reads menu customization from stream

virtual bool16 IMenuCustomizationData::SaveCurrentMenuSetToFile ( const PMString & menuSetName ) const

pure virtual

Save current customization to a file. Returns kTrue if successful.

virtual void IMenuCustomizationData::SetColoredMenuActions ( const K2Vector< MenuColorStruct > & coloredActionList )

pure virtual

Set the list of the currently colored menu items.

virtual void IMenuCustomizationData::SetColoredSubMenus ( const K2Vector< SubMenuColorStruct > & coloredSubMenuList )

pure virtual

Set the list of the currently colored submenus.

virtual bool16 IMenuCustomizationData::SetCurrentMenuSetInfo	(	const PMString &	menuSetName,
		bool16	isModified,
		bool16	isPreset,
		bool16	readShortcutSetFromDisk
	)

pure virtual

Set the menu set info - name, modified state, whether or not this set is a preset(as opposed to user-created), and indicate if the file should be read from disk

virtual void IMenuCustomizationData::SetHiddenMenuActions ( const K2Vector< ActionID > & hiddenActionList )

pure virtual

Set the list of the currently hidden menu items.

virtual void IMenuCustomizationData::SetHiddenSubMenus ( const K2Vector< CustomizedSubMenuPath > & hiddenSubMenuList )

pure virtual

Set the list of the currently hidden submenus.

virtual void IMenuCustomizationData::SetSubMenuColor	(	const PMString &	menuPath,
		tMenuColor	colorIndex
	)

pure virtual

Set the color for a submenu

virtual void IMenuCustomizationData::ShowMenuAction ( const ActionID action )

pure virtual

Show a menu by action id.

virtual void IMenuCustomizationData::ShowSubMenu ( const PMString & menuPath )

pure virtual

Shows a submenu with the specified path

virtual bool16 IMenuCustomizationData::WriteXMLMenuFile ( IXMLOutStream * s ) const

pure virtual

Write menu customization to XML. Returns kTrue if successful.

Classes

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation