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

Public Member Functions

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

virtual void Do (void)
 
virtual void DoNotify (void)
 
virtual PMStringCreateName (void)
 
- 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

Stores persistent data to control the display of the frame label adornment; implements ICommand.

Constructor & Destructor Documentation

FrmLblCmd::FrmLblCmd (IPMUnknownboss)

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

Parameters
bossinterface ptr from boss object on which this interface is aggregated.
FrmLblCmd::~FrmLblCmd (void )
virtual

Destructor

Member Function Documentation

PMString * FrmLblCmd::CreateName (void )
protectedvirtual

Report the name of the command

See Also
Command::CreateName

Reimplemented from Command.

void FrmLblCmd::Do (void )
protectedvirtual

Execute the main behaviour of the command. The Do method is where all the action happens. In this case we just need to copy the information from the commands data interface to the frames data interface.

See Also
Command::Do

Implements Command.

void FrmLblCmd::DoNotify (void )
protectedvirtual

Notify interested observers. In our case, we broadcast a change at the document level.

See Also
Command::DoNotify

Reimplemented from Command.

bool16 FrmLblCmd::LowMemIsOK (void ) const
inlinevirtual

See Command::LowMemIsOk

Returns
bool16

Reimplemented from Command.