InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
ITextAdornmentData Class Referenceabstract
Inheritance diagram for ITextAdornmentData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITEXTADORNMENTDATA }
 

Public Member Functions

virtual bool16 IsActive (const IDrawingStyle *draw) const =0
 
virtual void Attached (const IDrawingStyle *draw, const IWaxRun *run) const =0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual void ITextAdornmentData::Attached (const IDrawingStyledraw,
const IWaxRunrun 
) const
pure virtual

This method is called when an implementation of the the adornment data is attached by reference to a particular WaxRun. Implementations have the opportunity to access private non-const interfaces on this WaxRun boss to store data that might be of interest from the IDrawingStyle.

In general all WaxRuns that share a common set of attributes related to the adornment will share the same adornment data object, each holding an active reference, which is why it is important that an implementation should never change the contents of the adornment data boss outside an IAttrReport::TellComposition() call.

Parameters
drawa pointer to the IDrawingStyle interface on the kComposeStyleBoss for the WaxRun being built.
runa pointer to the IWaxRun interface on the boss being built. Note that at this time the WaxRun has NOT been attached to the WaxLine boss so this information is not available to implementation. Implementations that need this information should simply wait until inkbounds are gather or the adornment is drawn.
virtual bool16 ITextAdornmentData::IsActive (const IDrawingStyledraw) const
pure virtual

This method is called at WaxRun regen time to ask the adornment if it should be attached to WaxRuns. The adornment should use the data privately stored which was gathered from all its attributes that share the adornment and optionally the IDrawingStyle itself to make this decision. The implementation must NOT modify itself at this time.

In general this call is only made once for all WaxRuns that share the common set of attributes that are associated with the adornment data but this is not always true. For example, if another attribute, unrelated to the adornment data becomes active, all present adornments will be asked if they are active again with potentially different IDrawingStyles.

Parameters
drawa pointer to the IDrawingStyle interface on the kComposeStyleBoss for the WaxRun being built.
Returns
kTrue if the adornment should be attached to a WaxRun