InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ICmdHistory Class Referenceabstract

#include <ICmdHistory.h>

Inheritance diagram for ICmdHistory:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ICMDHISTORY }
 

Public Member Functions

virtual bool16 CanUndo (const UIDRef &target)=0
 
virtual int32 GetUndoStepCount (const UIDRef &target)=0
 
virtual void GetNthUndoStepName (PMString *text, int32 n, const UIDRef &target)=0
 
virtual ErrorCode Undo (int32 steps, const UIDRef &target)=0
 
virtual bool16 CanRedo (const UIDRef &target)=0
 
virtual int32 GetRedoStepCount (const UIDRef &target)=0
 
virtual void GetNthRedoStepName (PMString *text, int32 n, const UIDRef &target)=0
 
virtual ErrorCode Redo (int32 steps, const UIDRef &target)=0
 
virtual void Discard (const UIDRef &target)=0
 
virtual void Disable (const UIDRef &target)=0
 
virtual void Enable (const UIDRef &target)=0
 
virtual bool16 BeginPush (int32 numItems)=0
 
virtual void Push (const CmdStackItem &item)=0
 
virtual void EndPush ()=0
 
virtual bool16 Enabled (const UIDRef &target) const =0
 
virtual bool16 DiscardRedo (const UIDRef &target)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

The CmdHistory of a given target is the collection of all undoable and redoable steps that are currently available for this target. It hides single commands (ICommand) and command sequences (ICommandSequence). You can only access history steps, which are the undo/redo steps available via the undo/redo menu items. There is only one global CmdHistory. In order to use it you have to specify the target (ICommandMgr) you are interested in.

See Also
ICommand
ICommandMgr