InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
SLCInlineGraphicGlyphNode Class Reference

#include <SLCInlineGraphicGlyphNode.h>

Inheritance diagram for SLCInlineGraphicGlyphNode:
SLCGlyphNode

Public Member Functions

 SLCInlineGraphicGlyphNode (IComposeScanner *composeScanner, IDrawingStyle *drawingStyle, TextIndex startingIndex, const PMReal &xOffset)
 
virtual ~SLCInlineGraphicGlyphNode (void)
 
virtual SLComposerStatusCode GetGlyph (const UTF32TextChar &character, Text::GlyphID &glyphID, PMReal &glyphWidth)
 
virtual SLComposerStatusCode BufferGlyph (const UTF32TextChar &character, const Text::GlyphID &glyphID, const PMReal &glyphWidth)
 
virtual PMReal GetWidth (void) const
 
virtual SLComposerStatusCode FindTextBreak (void)
 
virtual bool16 GetTrailingWhiteSpaceWidth (PMReal &width) const
 
virtual bool16 FitTrailingWhiteSpace (const PMReal &widthScaleFactor)
 
virtual SLComposerStatusCode CreateWax (const IWaxLine *waxLine) const
 
virtual IWaxRunCreateWaxRun (void) const
 
- Public Member Functions inherited from SLCGlyphNode
 SLCGlyphNode (IComposeScanner *composeScanner, IDrawingStyle *drawingStyle, TextIndex startingIndex, const PMReal &xOffset, GlyphNodeType glyphNodeType)
 
virtual SLComposerStatusCode GetStatus () const
 
virtual ~SLCGlyphNode ()
 
virtual IDrawingStyleGetDrawingStyle () const
 
virtual const int32 & GetTextSpan () const
 
const PMRealGetLeading () const
 
const PMRealGetAscent () const
 
const PMRealGetCapHeight () const
 
const PMRealGetXHeight () const
 
const TextIndex & GetTextIndex () const
 
bool16 IsTrailingWhiteSpace (const UTF32TextChar &character) const
 
virtual void Dump (const char *msg) const
 
void SetTextSpan (int32 count)
 

Additional Inherited Members

- Public Types inherited from SLCGlyphNode
enum  GlyphNodeType { kGNTText = 0, kGNTInlineGraphic }
 
- Protected Attributes inherited from SLCGlyphNode
SLComposerStatusCode fStatus
 
IComposeScannerfComposeScanner
 
IDrawingStylefDrawingStyle
 
PMReal fXOffset
 
TextIndex fTextIndex
 
PMReal fLeading
 
PMReal fAscent
 
PMReal fCapHeight
 
PMReal fXHeight
 
int32 fTextSpan
 
const GlyphNodeType fGlyphNodeType
 

Detailed Description

Represents an inline and generates its wax run object (kWaxILGRunBoss).

This object can only represent a single inline. If there are several consecutive inline characters (kTextChar_ObjectReplacementCharacter) in the text a glyph node is required for each.

Constructor & Destructor Documentation

SLCInlineGraphicGlyphNode::SLCInlineGraphicGlyphNode (IComposeScannercomposeScanner,
IDrawingStyledrawingStyle,
TextIndex startingIndex,
const PMRealxOffset 
)

Constructor.

Parameters
composeScanner
drawingStyle
startingIndex
xOffset
SLCInlineGraphicGlyphNode::~SLCInlineGraphicGlyphNode (void )
virtual

Releases references and memory.

Member Function Documentation

SLComposerStatusCode SLCInlineGraphicGlyphNode::BufferGlyph (const UTF32TextCharcharacter,
const Text::GlyphID & glyphID,
const PMRealglyphWidth 
)
virtual

See SLCGlyphNode. Note this method can only be called once only one inline can be stored per instance of this object.

Implements SLCGlyphNode.

SLComposerStatusCode SLCInlineGraphicGlyphNode::CreateWax (const IWaxLinewaxLine) const
virtual

See SLCGlyphNode.

Implements SLCGlyphNode.

IWaxRun * SLCInlineGraphicGlyphNode::CreateWaxRun (void ) const
virtual

Adds a kWaxILGRunBoss object to the line.

Implements SLCGlyphNode.

virtual SLComposerStatusCode SLCInlineGraphicGlyphNode::FindTextBreak (void )
inlinevirtual

See SLCGlyphNode.

Returns
kCompSuccess since lines can always break after an inline.

Implements SLCGlyphNode.

virtual bool16 SLCInlineGraphicGlyphNode::FitTrailingWhiteSpace (const PMRealwidthScaleFactor)
inlinevirtual

See SLCGlyphNode.

Returns
kFalse inline glyph nodes never store trailing white space.

Implements SLCGlyphNode.

SLComposerStatusCode SLCInlineGraphicGlyphNode::GetGlyph (const UTF32TextCharcharacter,
Text::GlyphID & glyphID,
PMRealglyphWidth 
)
virtual

See SLCGlyphNode.

Parameters
charactermust be kTextChar_ObjectReplacementCharacter
glyphIDreturned as kInvalidGlyphID.
glyphWidthwidth of the inline.

Implements SLCGlyphNode.

virtual bool16 SLCInlineGraphicGlyphNode::GetTrailingWhiteSpaceWidth (PMRealwidth) const
inlinevirtual

See SLCGlyphNode.

Returns
kFalse inline glyph nodes never store trailing white space.

Implements SLCGlyphNode.

virtual PMReal SLCInlineGraphicGlyphNode::GetWidth (void ) const
inlinevirtual

See SLCGlyphNode.

Implements SLCGlyphNode.