IActionManager.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 __IActionManager__
#define __IActionManager__


#include "IPMUnknown.h"

#include "ActionID.h"
#include "PMPoint.h"
#include "PMTypes.h"
#include "ActionDefs.h"
#include "TextChar.h"

class IActionComponent;
class IActionStateList;
class PMString;

 const textchar kActionAreaSeparator = kTextChar_Colon ;

class IActionManager : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IACTIONMANAGER };
 
 virtual void AddAction( const IActionComponent* actionComponent, const ActionID& actionID, const PMString& actionName, const PMString& actionArea,
 int16 actionType, uint32 enablingType, PMIID selectionIID, bool16 userEditable) = 0;

 virtual void AddAction( ClassID componentID, ActionID actionID, PMString actionName, PMString actionArea, 
 int16 actionType, uint32 enablingType, PMIID selectionIID, bool16 userEditable) = 0;
 
 virtual void RemoveAction( const ActionID& actionID, int16 actionType = kNormalAction, const ClassID& componentID = kInvalidClass ) = 0;
 
 virtual int32 GetNumActions() const = 0;
 
 virtual ActionID GetNthAction(int32 index) const = 0;
 
 virtual bool16 IsValidAction(const ActionID& actionID) const = 0;
 
 virtual PMString GetActionArea(const ActionID& actionID) const= 0;

 virtual PMString GetActionName(const ActionID& actionID) const= 0;
 
 virtual bool16 IsActionUserEditable(const ActionID& actionID) const= 0;

 virtual void UpdateActionArea( const ActionID& actionID, const PMString& actionArea ) = 0 ;

 virtual void UpdateActionName( const ActionID& actionID, const PMString& actionName ) = 0 ;

 virtual void UpdateActionStates(IActiveContext* ac, IActionStateList *listToUpdate, GSysPoint mousePoint = kInvalidMousePoint, IPMUnknown* widget = nil) = 0;

 virtual void PerformAction(IActiveContext* ac, const ActionID& actionID, GSysPoint mousePoint = kInvalidMousePoint, IPMUnknown* widget = nil) const = 0;
 
 virtual IActionComponent* QueryActionComponent( const ActionID& actionID ) const= 0;

 virtual bool16 PreStartup(const PMLocaleId& locale) = 0;

 virtual bool16 PostStartup(const PMLocaleId& locale) = 0;

 virtual void Shutdown(const PMLocaleId& locale) = 0;
 
#ifdef DEBUG
 typedef enum { enablingInfo, customEnableInfo, nonEditableInfo, allActionInfo, prePostNotifyInfo, actionNameInfo, actionMenuStringInfo } ActionInfoType;
 virtual void DumpActionInfo(ActionInfoType infoType) = 0;
#endif 
};

#endif // __IActionManager__