Command.h

//========================================================================================
// 
// $File$
// 
// Owner: EricM
// 
// $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 __COMMAND__
#define __COMMAND__

#include "ICommand.h"
#include "HelperInterface.h"

#include "UIDList.h"
class IResourceAccess;

class Command : public ICommand {
public:
 enum CommandDummyArg { kItemList = 1 };

 Command(IPMUnknown *boss);
 virtual ~Command();
 
 virtual void GetName(PMString *name) const;
 virtual void SetName(const PMString& newName);
 virtual bool16 IsNameRequired() const;
 
 virtual const UIDList* GetItemList() const;
 virtual const UIDList &GetItemListReference() const;
 virtual void SetItemList(const UIDList &newItemList);
 
 virtual void DoImmediate(bool16 isDynamic = kFalse);
 virtual void LWDoImmediate();
 

 virtual void DoDynamic(); 

 virtual CommandState GetCommandState() const;
 virtual bool16 IsDone() const;
 virtual bool16 CanJoin( const ICommand *pNewCmd )const;

 virtual void SetCreatorID(int32 creatorID);
 virtual int32 GetCreatorID() const;
 
 virtual bool16 LowMemIsOK() const;
 
 virtual const Target &GetTarget() const; 
 
 virtual Undoability GetUndoability() const;
 virtual void SetUndoability(Undoability newUndoability);

 virtual void SetActive(bool16 isActive);
 virtual bool16 IsActive() const;
 
 virtual bool8 IsLWProcessed() const;

protected:
 // If you are considering making any of these methods public
 // instead of protected... please let me know. - Zak
 
 virtual void Do() = 0;
 // Executes the command, causing changes to the model.
 //
 // This must be overridden by each command. This method
 // is only called by ExecuteImmediate(), which also sets
 // the command state and calls DoNotify().

 virtual void DoNotify();

 virtual void SetCommandState(CommandState state);

 virtual PMString *CreateName();
 
 virtual void SetUpTarget();

 virtual void PreVerify(CommandState state);

 virtual void PostVerify(CommandState state);

 typedef enum
 {
 kSessionWorkspaceTarget,
 kSessionTarget
 } PredefinedTarget; 

 void SetTarget(const Target &newTarget);

 void SetTarget(PredefinedTarget newTarget);

 void SetTarget(IDataBase *db);

 UIDList fItemList;

#ifdef ID_ENABLE_DEBUGGING
 enum Action { kDoAbsolutelyNothing, kDo} ;
 void LogCommand( Action act ) ;
#endif

private:
 mutable PMString *fName;
 
 CommandState fCommandState;
 int32 fCreatorID;

 Undoability fUndoability;
 bool16 fIsActive;
 UIDRef fTarget;
 // will go away
 bool8 fIsLWProcessed; 

};


#endif // __COMMAND__