IActionMenuManager.h

//========================================================================================
// 
// $File$
// 
// Owner: Tim Wright
// 
// $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.
// 
// 
// Comments: Gathers menu items and order for events...
// 
//========================================================================================

#ifndef __IActionMenuManager_h__
#define __IActionMenuManager_h__

#include "IPMUnknown.h"
#include "BehaviorUIID.h"
#include "BehaviorID.h"
#include "BehaviorTypes.h"


class IDropDownListController;

//========================================================================================
// CLASS IActionMenuManager
//========================================================================================

class IActionMenuManager : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IACTIONMENUMANAGER };
 
 virtual void AddEventMenuItem(ActionEvent inEvent, const PMString& inName, double inOrder) = 0;
 
 virtual void AddEventSeparatorItem(ActionEvent inBeforeEvent, double inOrder) = 0;

 /* TODO: add methods to allow specifing the ordering of the behaviors, as well as the events... */

 virtual void BuildEventMenuSupportingSelection(IDropDownListController* inDropDownList, const ActionEvent& inSelectEvent) = 0;
};

//========================================================================================

struct EventMenuInfo
{
 typedef object_type data_type;

 EventMenuInfo()
 : fName(),
 fOrder(0.0),
 fServiceIndex(0),
 fSeparator(false),
 fEvent(kNoEvt)
 {}
 
 EventMenuInfo(ActionEvent inEvent, const PMString& inName, double inOrder, int32 inServiceIndex, bool inSep)
 : fEvent(inEvent),
 fName(inName),
 fOrder(inOrder),
 fServiceIndex(inServiceIndex),
 fSeparator(inSep)
 {}

 ActionEvent fEvent;
 PMString fName;
 double fOrder;
 bool fSeparator;
 int32 fServiceIndex;
};

#endif // __IActionMenuManager_h__