ICommand.h

//========================================================================================
// 
// $File$
// 
// Owner: Roey Horns
// 
// $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.
// 
// 
// Reviewed: 10/06/98
// 
//========================================================================================

#ifndef __ICOMMAND__
#define __ICOMMAND__

#include "IPMUnknown.h"
#include "CommandID.h"

class PMString;
class UIDList;

class ICommand : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICOMMAND };

 //====================================================================================
 // methods and typedefs for clients and implementors of commands
 //====================================================================================

 virtual void GetName(PMString *name) const = 0;

 virtual void SetName(const PMString& newName) = 0;
 
 virtual bool16 IsNameRequired() const = 0;

 virtual const UIDList* GetItemList() const = 0;

 virtual const UIDList& GetItemListReference() const = 0;

 virtual void SetItemList(const UIDList &newItemList) = 0;
 
 typedef enum
 {
 kNotDone,
 kDoneDynamic, 
 kDone
 } CommandState;
 

 virtual CommandState GetCommandState() const = 0;

 virtual bool16 IsDone() const = 0;
 
 typedef enum
 {
 kAutoUndo = 0,

 kRegularUndo, 

 } Undoability;
 
 virtual Undoability GetUndoability() const = 0;
 
 virtual void SetUndoability(Undoability newUndoability) = 0;
 
 enum {
 kUniqueCreatorID = ~(int32)0,
 kPassthroughCreatorID = ~(int32)1 
 }; 
 virtual void SetCreatorID(int32 creatorID) = 0;

 virtual int32 GetCreatorID() const = 0;
 
 enum Priority { kLowestPriority, kLowPriority, kMediumPriority, kHighPriority, kHighestPriority };
 
 //====================================================================================
 // methods and typedefs for implementors of commands only
 // (see also the base class Command.h)
 //====================================================================================

 virtual bool16 CanJoin( const ICommand *pNewCmd ) const= 0;
 
 virtual bool16 LowMemIsOK() const = 0;
 
 //====================================================================================
 // for internal use only
 //======================================n=============================================
 // Not exposing these to Doc++ since they're for internal use only 
 //====================================================================================
 typedef UIDRef Target;
 
 virtual const Target &GetTarget() const = 0;
 virtual void DoImmediate(bool16 isDynamic = kFalse) = 0;
 virtual void LWDoImmediate() = 0;
 virtual void SetActive(bool16 isActive) = 0;
 virtual bool16 IsActive() const = 0;
 virtual bool8 IsLWProcessed() const = 0;
};

#endif // __ICOMMAND__