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

Public Member Functions

 BscTAAdornment (IPMUnknown *boss)
 
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
 

Protected Member Functions

bool16 WaxIsPathType (const IWaxRun *waxRun)
 
void TOPGlyphSelectionPath (GraphicsData *gd, IWaxRun *run, IWaxGlyphs *waxGlyphs, const PMLineSeg &selection, int32 index)
 
void DrawBoundsForOneGlyph (IGraphicsPort *gPort, const PMReal &runPosition, PMMatrix &position, const PMLineSeg &selection, Fixed width)
 
- Protected Member Functions inherited from CPMUnknown< ITextAdornment >
 CPMUnknown (IPMUnknown *boss)
 

Static Protected Member Functions

static PMReal GetRunWidth (IWaxGlyphs *runGlyphs)
 

Additional Inherited Members

- Public Types inherited from ITextAdornment
enum  { kDefaultIID = IID_ITEXTADORNMENT }
 
- Protected Attributes inherited from CPMUnknown< ITextAdornment >
HelperInterface fHelperInterface
 

Detailed Description

Provides a custom character adornment, a shade behind the text to which the corresponding custom attribute, introduced by the kBscTAAttrBoss, applies. See kBscTAAttrBoss and kBscTAAdornmentBoss.

Constructor & Destructor Documentation

BscTAAdornment::BscTAAdornment (IPMUnknownboss)
inline

Constructor

Parameters
bossinterface ptr from boss object on which this interface is aggregated.

Member Function Documentation

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

Shade the text to which our character attribute applies, see ITextAdornment::GetInkBounds.

Implements ITextAdornment.

void BscTAAdornment::DrawBoundsForOneGlyph (IGraphicsPortgPort,
const PMRealrunPosition,
PMMatrixposition,
const PMLineSegselection,
Fixed width 
)
protected

Draw bounds for one glyph.

Parameters
gPort
runPosition
position
selection
width
Text::DrawPriority BscTAAdornment::GetDrawPriority (void )
virtual

Gets the drawing priority.

Returns
the Draw priority of the adornment.

Implements ITextAdornment.

Binds the C implementation class onto its ImplementationID making the C code callable by the application *void BscTAAdornment::GetInkBounds (PMRectinkBounds,
const PMRectrunInkBounds,
IWaxRunrun,
IWaxRenderDatarenderData,
IWaxGlyphsglyphs,
const ITextAdornmentDatadata 
)
virtual

Returns the inkBounds and a flag indicating whether the adornment would draw on this run, see ITextAdornment::GetInkBounds.

Implements ITextAdornment.

PMReal BscTAAdornment::GetRunWidth (IWaxGlyphsrunGlyphs)
staticprotected

Gets the run width (helper method).

Parameters
runGlyphsis the glyph of the wax run.
Returns
the width of the run to be shade, adjusted for carriage return
ITextAdornmentData * BscTAAdornment::SplitAt (int32 offsetInRun,
IWaxRunwaxRun,
IWaxRunnewWaxRun,
ITextAdornmentDatadata 
)
virtual

The adorned run is splitting: split the given data at the given offset. We are not really splitting the adornment, so we simply return nil.

See ITextAdornment::SplitAt

Implements ITextAdornment.

void BscTAAdornment::TOPGlyphSelectionPath (GraphicsDatagd,
IWaxRunrun,
IWaxGlyphswaxGlyphs,
const PMLineSegselection,
int32 index 
)
protected

Figure out the selection path for the TOP, just in case the tags are inserted there

Parameters
gdis the graphic data that contains the graphic port where all the drawing will occur.
runis the wax line that owns the run.
waxGlyphsstores the identifier and width of each glyph in the run.
selection
indexis the index of glyph run.
bool16 BscTAAdornment::WaxIsPathType (const IWaxRunwaxRun)
protected

Check if it is text on path or not

Parameters
waxRunis the wax line that owns the run.
Returns
kTrue if the run is text on path (TOP)