InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
HidTxtAnchorTextAdornment Class Reference
Inheritance diagram for HidTxtAnchorTextAdornment:
CPMUnknown< ITextAdornment >ITextAdornmentIPMUnknown

Public Member Functions

 HidTxtAnchorTextAdornment (IPMUnknown *boss)
 
 ~HidTxtAnchorTextAdornment ()
 
virtual void GetInkBounds (PMRect *inkBounds, const PMRect &runInkBounds, IWaxRun *run, IWaxRenderData *renderData, IWaxGlyphs *glyphs, const ITextAdornmentData *data)
 
virtual void Draw (GraphicsData *gd, int32 iShapeFlags, IWaxRun *run, IWaxRenderData *renderData, IWaxGlyphs *glyphs, const ITextAdornmentData *data)
 
virtual Text::DrawPriority GetDrawPriority (void)
 
virtual ITextAdornmentDataSplitAt (int32 offsetInRun, IWaxRun *waxRun, IWaxRun *newWaxRun, ITextAdornmentData *data)
 
- Public Member Functions inherited from CPMUnknown< ITextAdornment >
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 ITextAdornment
enum  { kDefaultIID = IID_ITEXTADORNMENT }
 
- Protected Member Functions inherited from CPMUnknown< ITextAdornment >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< ITextAdornment >
HelperInterface fHelperInterface
 

Detailed Description

Implements a text adornment(ITextAdornment) that indicates the presence of hidden text in the text flow by drawing a pin icon in the shape of a red triangle at the TextIndex on which the hidden text is anchored.

The adornment only draws when an IBoolData interface is added to the adornment boss class under the IID IID_IHIDTXTSHOWADORNMENTBOOLDATA. The interface provides a flag that indicates the HiddenTextEditor is installed. The adornment only draws when the HiddenTextEditor is installed.

See Also
ITextAdornment

Constructor & Destructor Documentation

HidTxtAnchorTextAdornment::HidTxtAnchorTextAdornment (IPMUnknownboss)

Constructor

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

Destructor

Member Function Documentation

void HidTxtAnchorTextAdornment::Draw (GraphicsDatagd,
int32 iShapeFlags,
IWaxRunrun,
IWaxRenderDatarenderData,
IWaxGlyphsglyphs,
const ITextAdornmentDatadata 
)
virtual

Draw a pin like triangle, point down, to indicate the presence of the hidden text anchor.

See Also
ITextAdornment::Draw for a description of the parameters.

Implements ITextAdornment.

Text::DrawPriority HidTxtAnchorTextAdornment::GetDrawPriority (void )
virtual

Return kTAPriMissingGlyphs so the adornment draws behind the text.

Returns
kTAPriMissingGlyphs so the adornment draws behind the text.
See Also
ITextAdornment::GetDrawPriority for a description of the parameters

Implements ITextAdornment.

void HidTxtAnchorTextAdornment::GetInkBounds (PMRectinkBounds,
const PMRectrunInkBounds,
IWaxRunrun,
IWaxRenderDatarenderData,
IWaxGlyphsglyphs,
const ITextAdornmentDatadata 
)
virtual

This adornment draws within the selection bounds of the wax line so it doesn't modify the ink bounds.

See Also
ITextAdornment::GetInkBounds for a description of the parameters.

Implements ITextAdornment.

ITextAdornmentData * HidTxtAnchorTextAdornment::SplitAt (int32 offsetInRun,
IWaxRunwaxRun,
IWaxRunnewWaxRun,
ITextAdornmentDatadata 
)
virtual

Return nil, this adornment does not have any adornment data(ITextAdornmentData), so there's no data to split.

Returns
nil
See Also
ITextAdornment::SplitAt for a description of the parameters

Implements ITextAdornment.