InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPreflightWaxAdornmentInfo Class Referenceabstract

#include <IPreflightWaxAdornmentInfo.h>

Inheritance diagram for IPreflightWaxAdornmentInfo:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IPREFLIGHTWAXADORNMENTINFO }
 

Public Member Functions

virtual ClassID GetAdornmentID () const =0
 
virtual void Initialize ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This interface, in combination with IPreflightTextRangeInfo and IPreflightWaxInfo, provides information about an adornment on a particular wax (run or line) found in the document. This interface is used by preflight rules (IPreflightRuleVisitor) that inspect wax run adornments.

Typical application (in IPreflightRuleVisitor::Visit):

InterfacePtr<IPreflightObject> iObj(iInfo->QueryObject());

InterfacePtr<IPreflightWaxInfo> iWaxInfo(iObj, UseDefaultIID());

InterfacePtr<IPreflightWaxAdornmentInfo> iWaxAdornInfo(iObj, UseDefaultIID());



if (iWaxAdornInfo && iWaxAdornInfo->GetAdornmentID() == kMyAdornmentOfInterest)

{

    ...

Member Function Documentation

virtual ClassID IPreflightWaxAdornmentInfo::GetAdornmentID () const
pure virtual

Get the class ID of the adornment.

Returns
The adornment's class ID.
virtual void IPreflightWaxAdornmentInfo::Initialize ()
pure virtual

Initialize based on preflight object ID. For internal use only.