InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
PstLstModifyDataCmd Class Reference
Inheritance diagram for PstLstModifyDataCmd:
CommandICommandIPMUnknown

Public Member Functions

 PstLstModifyDataCmd (IPMUnknown *boss)
 
virtual ~PstLstModifyDataCmd ()
 
bool16 LowMemIsOK () const
 
- Public Member Functions inherited from Command
 Command (IPMUnknown *boss)
 
virtual void GetName (PMString *name) const
 
virtual void SetName (const PMString &newName)
 
virtual bool16 IsNameRequired () const
 
virtual const UIDListGetItemList () const
 
virtual const UIDListGetItemListReference () 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 const TargetGetTarget () const
 
virtual Undoability GetUndoability () const
 
virtual void SetUndoability (Undoability newUndoability)
 
virtual void SetActive (bool16 isActive)
 
virtual bool16 IsActive () const
 
virtual bool8 IsLWProcessed () const
 

Protected Member Functions

void Do ()
 
void DoNotify ()
 
PMStringCreateName ()
 
- Protected Member Functions inherited from Command
virtual void SetCommandState (CommandState state)
 
virtual void SetUpTarget ()
 
virtual void PreVerify (CommandState state)
 
virtual void PostVerify (CommandState state)
 
void SetTarget (const Target &newTarget)
 
void SetTarget (PredefinedTarget newTarget)
 
void SetTarget (IDataBase *db)
 

Additional Inherited Members

- Public Types inherited from Command
enum  CommandDummyArg { kItemList = 1 }
 
- Protected Types inherited from Command
enum  PredefinedTarget { kSessionWorkspaceTarget, kSessionTarget }
 
- Protected Attributes inherited from Command
UIDList fItemList
 

Detailed Description

PstLstModifyDataCmd will modify the string data of the current selected IPstLstData in the IPstLstUIDList of the page item that is of interest to the user. Note this implementation actually handles more than just one page item.

PstLstModifyDataCmd implements ICommand based on the partial implementation Command.

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * PstLstModifyDataCmd::PstLstModifyDataCmd (IPMUnknownboss)

Constructor, we initialize all the private members and pass the boss pointer to the parent class (Command).

PstLstModifyDataCmd::~PstLstModifyDataCmd ()
virtual

Destructor

Member Function Documentation

PMString * PstLstModifyDataCmd::CreateName (void )
protectedvirtual

Gives the name that shows up under the Edit menu and allows the user to undo or redo the command.

Returns
pointer to a PMString allocated using the new operator. Deleted by caller.

Reimplemented from Command.

void PstLstModifyDataCmd::Do (void )
protectedvirtual

The Do method is where we access the IPstLstData data objects, and modify them with the string specified in the IPstLstData interface aggregated by the command boss. Since there may be multiple items selected, we have to repeat this process thru all the passed in ItemList.

Implements Command.

void PstLstModifyDataCmd::DoNotify (void )
protectedvirtual

Notify all the document observers that a change to the page item's IPstLstData has happened.

Reimplemented from Command.

bool16 PstLstModifyDataCmd::LowMemIsOK (void ) const
inlinevirtual

Don't execute this command if the memory is low.

Reimplemented from Command.