IMenuManager.h

//========================================================================================
// 
// $File$
// 
// Owner: lance bushore
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __IMenuManager__
#define __IMenuManager__

#include "IPMUnknown.h"

#include "ActionID.h"
#include "OMTypes.h"
#include "TextChar.h"

class PMReal;
class PMString;

 const textchar kMenuPathSeparator = kTextChar_Colon ;
 const textchar kMenuSeparatorChar = kTextChar_HyphenMinus ;

class IMenuManager : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IMENUMANAGER };
 
 virtual void AddMenuItem(ActionID actionID, PMString menuPath, PMReal menuPos, bool16 isDynamic, bool16 isOwnerDraw = kFalse, uint32 iconPluginID = 0, uint32 iconRsrcID = 0) = 0;
 
 virtual void RemoveAllMenusForAction(ActionID actionID) = 0;
 
 virtual void RemoveMenuItem(PMString menuPath, ActionID actionID) = 0;

 virtual void RemoveSubmenuAndChildren(PMString menuPath) = 0;

 virtual void HandlePopupMenu(PMString popupLabel, GSysPoint whereToPop, GSysPoint mousePoint, bool16 removeDisabledItems = kTrue, IPMUnknown* widget = nil, GSysRect* excludeRect = nil) = 0;

 virtual bool16 IsMenuUp() const = 0;

 virtual void RemoveIconOfActionID(ActionID actionID, PMString menuPath) = 0;

 virtual void SetIconForMenuPath(const ActionID actionID, const PMString menuPath, uint32 iconPluginID = 0, uint32 iconRsrcID = 0) = 0;

#ifdef DEBUG
 typedef enum { positionInfo, rootMenuNames, allMenuNames, allMenuInfo, macMenuIDs} MenuInfoType;
 virtual void DumpMenuInfo(MenuInfoType infoType) const = 0;
#endif

 virtual PMRect GetMenuBounds(PMString inMenuName) = 0;

 virtual void ShowMenuItem(PMString menuPath, PMRect & position) = 0;
};

#endif // __IMenuManager__