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

#include <IDrawTag.h>

Inheritance diagram for IDrawTag:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDRAWTAG }
 

Public Member Functions

virtual void Draw (const RunDescription &description, int32 lineIndex, IGraphicsPort *gPort, PMReal *runWidth, int32 flags, UID textThreadUID=kInvalidUID)=0
 
virtual void ComputeTagWidth (const RunDescription &description, PMReal *runWidth, UID textThreadUID=kInvalidUID)=0
 
virtual void DrawPngIcon (const PMPoint &topLeft, const PluginID &pid, const RsrcID &rid, IGraphicsPort *gPort)=0
 
virtual PMReal GetPngIconWidth (const PluginID &pid, const RsrcID &rid)=0
 
virtual PMReal GetPngIconHeight (const PluginID &pid, const RsrcID &rid)=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

IDrawTag an interface to draw tags such as inline notes, xml, and inline footnotes in galley and story view.

Member Function Documentation

virtual void IDrawTag::ComputeTagWidth (const RunDescriptiondescription,
PMRealrunWidth,
UID textThreadUID = kInvalidUID 
)
pure virtual

Compute tag width of the specified run

Parameters
INdescription a run description to get a cooresponding ITextRun for
OUTrunWidth the width of the tag that is drawn
INtextThreadUID UID of the thread or kInvalidUID if primary story thread
Returns
void
virtual void IDrawTag::Draw (const RunDescriptiondescription,
int32 lineIndex,
IGraphicsPortgPort,
PMRealrunWidth,
int32 flags,
UID textThreadUID = kInvalidUID 
)
pure virtual

Draw tag associated with the specified run.

Parameters
INdescription a run description to get a cooresponding ITextRun for
INlineIndex a line index to get access the run
INgPort the port to draw into
OUTrunWidth the width of the tag that is drawn
INflags 0==normal mode (draw top and bottom borders), 1==draw in overlap mode (just draw bottom border)
INtextThreadUID UID of the thread or kInvalidUID if primary story thread
Returns
void
virtual void IDrawTag::DrawPngIcon (const PMPointtopLeft,
const PluginIDpid,
const RsrcID & rid,
IGraphicsPortgPort 
)
pure virtual

Draw png icon.

Parameters
INtopLeft the point at which to draw
INpid plugin id with the png art
INrid resource id of the png art
INgPort the port to draw into
Returns
void
virtual PMReal IDrawTag::GetPngIconHeight (const PluginIDpid,
const RsrcID & rid 
)
pure virtual

Gets the height of the png specified.

Parameters
INpid plugin id with the png art
INrid resource id of the png art
Returns
PMReal height of the png art
virtual PMReal IDrawTag::GetPngIconWidth (const PluginIDpid,
const RsrcID & rid 
)
pure virtual

Gets the width of the png specified.

Parameters
INpid plugin id with the png art
INrid resource id of the png art
Returns
PMReal width of the png art