InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
FrmLblData Class Reference
Inheritance diagram for FrmLblData:
CPMUnknown< IFrmLblData >IFrmLblDataIPMUnknown

Public Member Functions

 FrmLblData (IPMUnknown *boss)
 
virtual ~FrmLblData ()
 
virtual void Set (const FrmLblInfo &frmLblInfo)
 
virtual const FrmLblInfoGet () const
 
void ReadWrite (IPMStream *stream, ImplementationID implementation)
 
- Public Member Functions inherited from CPMUnknown< IFrmLblData >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Public Types inherited from IFrmLblData
enum  { kDefaultIID = IID_IFRMLBLDATA }
 
- Protected Member Functions inherited from CPMUnknown< IFrmLblData >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< IFrmLblData >
HelperInterface fHelperInterface
 

Detailed Description

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

Constructor & Destructor Documentation

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

Constructor.

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

Destructor.

Member Function Documentation

virtual const FrmLblInfo& FrmLblData::Get () const
inlinevirtual

Retrieves the current frame label property to be displayed as the adornment.

Returns
The frame label properties.

Implements IFrmLblData.

void FrmLblData::ReadWrite (IPMStreamstream,
ImplementationID implementation 
)

Saves persistently, reads persistent data. Reads if the stream is a 'read-stream' and writes if the stream is a write stream:

void FrmLblData::Set (const FrmLblInfofrmLblInfo)
virtual

Stores new persistent values for the label adornment.

Parameters
thelabel properties to be displayed as the label.

Implements IFrmLblData.