PstLstDeletePageItemCmd Class Reference

Inheritance diagram for PstLstDeletePageItemCmd:

Public Member Functions
	PstLstDeletePageItemCmd (IPMUnknown *boss)
	~PstLstDeletePageItemCmd ()
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 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 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 Member Functions
void	Do ()
void	DoNotify ()
PMString *	CreateName ()
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

This command is similar to PstLstDeleteDataCmd, but it is used when a page item is deleted, we need to delete ALL the data boss we added to the item, also we need to restore them in the event of undo deleting page item. So unlike PstLstDeleteDataCmd, which only deletes the current selected UID and its associated data boss for each selected page item, this command delete EVERY one that's carried by a page item.

PstLstDeletePageItemCmd 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 * PstLstDeletePageItemCmd::PstLstDeletePageItemCmd

(

IPMUnknown *

boss

)

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

PstLstDeletePageItemCmd::~PstLstDeletePageItemCmd

(

)

Destructor

Member Function Documentation

PMString * PstLstDeletePageItemCmd::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 PstLstDeletePageItemCmd::Do ( void  )

protectedvirtual

Loop thru all the selected page items, delete all items' kPstLstDataBoss UID from the database, also remove all corresponding entries in the IPstLstUIDList of the item.

Implements Command.

void PstLstDeletePageItemCmd::DoNotify ( void  )

protectedvirtual

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

Reimplemented from Command.

bool16 PstLstDeletePageItemCmd::LowMemIsOK ( void  ) const

inlinevirtual

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

Reimplemented from Command.