BPISetDataCmd Class Reference

Inheritance diagram for BPISetDataCmd:

Public Member Functions
	BPISetDataCmd (IPMUnknown *boss)
	~BPISetDataCmd ()
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

Implements a command, ICommand based on Command, that changes the value of IBPIData in the objects given by the command's item list.

The command targets the database and objects passed in the command's item list. Each object referenced should have an IBPIData interface and the value stored there is changed. The new value to be set is passed via the sibling IBPIData interface on kBPISetDataCmdBoss. Note that the implementation used to pass the IBPIData parameter value to the command is not persistent. The implementation used to store the IBPIData value on the targeted objects is persistent.

The command takes care of the need to make the change undoable by saving the current IBPIDtaa value of the objects to be changed so that these values can be resorted if Undo is called.

Constructor & Destructor Documentation

Binds the C implementation class onto its ImplementationID making the C code callable by the application * BPISetDataCmd::BPISetDataCmd

(

IPMUnknown *

boss

)

Constructor.

Parameters

boss	interface ptr from boss object on which this interface is aggregated.

BPISetDataCmd::~BPISetDataCmd

(

)

Destructor.

Member Function Documentation

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

protectedvirtual

The Do method is where all the action happens. In this case we just need to copy the information from this command's IBPIData data interface to the IBPIData interface on the objects targeted by the command's fItemList taking care to first preserve their original value should Undo be required.

Implements Command.

void BPISetDataCmd::DoNotify ( void  )

protectedvirtual

Notify observers about the change made by this command. Notification is done either on the document's subject (changes to page item's IBPIData) or on the workspace's subject (changes to default IBPIData). The first item in the command's fItemList is used to decide the type of notification is needed. See the implementation for the details.

Reimplemented from Command.

bool16 BPISetDataCmd::LowMemIsOK ( void  ) const

inlinevirtual

Returns

kFalse don't use this command if memory is low.

Reimplemented from Command.