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

#include <CWaxRunText.h>

Inheritance diagram for CWaxRunText:
CPMUnknown< IWaxRunText >IWaxRunTextIPMUnknown

Public Member Functions

 CWaxRunText (IPMUnknown *boss)
 
virtual void Draw (GraphicsData *gd, int32 iShapeFlags, Text::DrawPassInfo::Pass pass, const PMRect *areaToDraw) const
 
- Public Member Functions inherited from CPMUnknown< IWaxRunText >
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

virtual void Draw (GraphicsData *gd, int32 iShapeFlags, const PMRect *areaToDraw) const =0
 
virtual bool16 DrawRunForCreateOutlines (IGraphicsPort *gPort, GPortAuxInfoParam &auxInfo) const
 
- Protected Member Functions inherited from CPMUnknown< IWaxRunText >
 CPMUnknown (IPMUnknown *boss)
 

Additional Inherited Members

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

Detailed Description

Base implementation for managing the Draw()ing of the text within this waxRun. Use this implementation if you would like (at least partial) generic waxRun drawing.

Member Function Documentation

virtual void CWaxRunText::Draw (GraphicsDatagd,
int32 iShapeFlags,
Text::DrawPassInfo::Pass pass,
const PMRectareaToDraw 
) const
virtual

Default drawing of the wax run. Draws text and associated objects (i.e. adornments). This method first checks to see if the port is CreateOutlines mode

If so, calls DrawRunForCreateOutlines(). If it returns kFalse, nothing else is done. Otherwise, the auxInfo returned is installed into the graphics port/data for the duration of this method.

It then gathers all adornments that match this pass and calls their draw method. If the pass is kPassText, it calls the other Draw() method on this interface.

See Also
IWaxRunText for details on this method, its parameters and return values..

Implements IWaxRunText.

virtual void CWaxRunText::Draw (GraphicsDatagd,
int32 iShapeFlags,
const PMRectareaToDraw 
) const
protectedpure virtual

Default drawing of the text associated with the waxRun. It is called when the public Draw() method on this interface is called with pass == kPassText. See that method for details on the parameters.

Note
: WaxRuns must define this method themselves. Typically this involves inspecting the IWaxRenderData and processing the IWaxGlyphs associated with this run, taking port modes of PDF and CreateOutlines into consideration.
virtual bool16 CWaxRunText::DrawRunForCreateOutlines (IGraphicsPortgPort,
GPortAuxInfoParamauxInfo 
) const
protectedvirtual

Checks for Create Outlines mode and prepares auxiliary information for the port if appropriate. It also further initializes the port for this particular waxRun. Called by the public Draw() method.

Parameters
gPortIN Where to draw.
auxInfoOUT returned additional information which is needed for create outlines drawing.
Returns
whether this run should be drawn (kTrue) or not.
Note
: This only pertains (and is only called) if the port is designated as Creating Outlines.
: When this method is called, it may divide the waxRun into (potentially many) smaller runs to accomodate the CreateOutlines range and/or parameters.