Mako 7.4.0 API
Loading...
Searching...
No Matches
JawsMako::ITextRun Class Referenceabstract

A run of text, containing unicode information, the position, transformation and bounds of the text. More...

#include <text.h>

Inheritance diagram for JawsMako::ITextRun:

Public Member Functions

virtual const StringgetUnicode () const =0
 Get the Unicode string for the run as available.
 
virtual U8String getUTF8 () const =0
 Get the Unicode string for the run as available, in UTF-8.
 
virtual FMatrix getTransform () const =0
 Get the transformation active where the glyph run is positioned, relative to the page. The transformation includes any transformation present in the IDOMGlyphs node where the text is represented.
 
virtual FPoint getLocalOrigin () const =0
 Get the origin of the first character, in glyph-local coordinates.
 
FPoint getOriginOnPage () const
 Get the origin of the first character, in page coordinates. Convenience.
 
virtual FRect getLocalBounds (bool tight=true) const =0
 Get the bounds of the run, in glyph-local coordinates.
 
FRect getBoundsOnPage (bool tight=true) const
 Get the bounds of the run, in page coordinates. Convenience.
 
virtual void getCornersOnPage (FPoint &p1, FPoint &p2, FPoint &p3, FPoint &p4, bool tight) const =0
 Get the corner points of the run (in the clockwise order), in page coordinates.
 
virtual CTextRunVect split ()=0
 Split the run into the smallest possible units, returning the split runs. If the run cannot be split, the result will be a vector containing this run.
 
virtual double getSpaceWidth () const =0
 Determine the width of a space in the font used for this run. If the font does not have a space character then an estimate will be returned. The returned value will be in ems.
 
virtual double getSpaceWidthOnPage () const =0
 Determine the width of a space in the font used for this run. If the font does not have a space character then an estimate will be returned. The returned value will be in page units.
 
virtual double getFontHeightOnPage () const =0
 Determine the height of the font used for this run. The returned value will be in page units.
 
virtual IDOMGlyphsPtr getGlyphs () const =0
 Get the IDOMGlyphs node that represents this run.
 
- Public Member Functions inherited from IRCObject
virtual void addRef () const =0
 Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
 
virtual bool decRef () const =0
 Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to.
 
virtual int32 getRefCount () const =0
 Retrieve the current reference count of the actual object pointed to.
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

A run of text, containing unicode information, the position, transformation and bounds of the text.

Member Function Documentation

◆ getBoundsOnPage()

FRect JawsMako::ITextRun::getBoundsOnPage ( bool tight = true) const
inline

Get the bounds of the run, in page coordinates. Convenience.

Parameters
tightWhether the bounding box should be 'tight' around the actual glyph markup, or expanded to include the full em height.

◆ getLocalBounds()

virtual FRect JawsMako::ITextRun::getLocalBounds ( bool tight = true) const
pure virtual

Get the bounds of the run, in glyph-local coordinates.

Parameters
tightWhether the bounding box should be 'tight' around the actual glyph markup, or expanded to include the full em height.

The documentation for this class was generated from the following file: