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

Public Member Functions

 HidTxtModelCopyCmd (IPMUnknown *boss)
 
virtual ~HidTxtModelCopyCmd ()
 
- 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 bool16 LowMemIsOK () 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

virtual void SetUpTarget ()
 
virtual void Do ()
 
virtual void DoNotify ()
 
virtual PMStringCreateName ()
 
- Protected Member Functions inherited from Command
virtual void SetCommandState (CommandState state)
 
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

Command implementation that copies a kHidTxtModelBoss object to another story.

Note that this command does not copy the range of text in the text model that stores the actual hidden text, it just copies the kHidTxtModelBoss object.

Constructor & Destructor Documentation

HidTxtModelCopyCmd::HidTxtModelCopyCmd (IPMUnknownboss)

Constructor.

Parameters
boss
HidTxtModelCopyCmd::~HidTxtModelCopyCmd ()
virtual

Destructor.

Member Function Documentation

PMString * HidTxtModelCopyCmd::CreateName (void )
protectedvirtual
Returns
the name of the command.

Reimplemented from Command.

void HidTxtModelCopyCmd::Do (void )
protectedvirtual

Copy the object using IScrapUtils::CopyObject.

Implements Command.

void HidTxtModelCopyCmd::DoNotify (void )
protectedvirtual

No notification is currently performed for this operation.

Reimplemented from Command.

void HidTxtModelCopyCmd::SetUpTarget ()
protectedvirtual

This command's item list refers to the object to be copied. The command's IUIDData interface gives the database into which the object is to be copied. So we have to override SetUpTarget to target the database given by the IUIDData data interface.

Reimplemented from Command.