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

#include <jawsmako/text.h>

Inheritance diagram for JawsMako::ITextRun:

Public Member Functions
virtual	~ITextRun ()
virtual const String &	getUnicode () 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.
virtual 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.
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.
virtual double	getFontHeightOnPage () const =0
	Determine the height of the font used for this run.
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.

Constructor & Destructor Documentation

◆ ~ITextRun()

virtual JawsMako::ITextRun::~ITextRun ( )

inlinevirtual

Member Function Documentation

◆ getBoundsOnPage()

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

inlinevirtual

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

Parameters

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

Returns: FRect The bounds of the run, in page coordinates.

◆ getCornersOnPage()

virtual void JawsMako::ITextRun::getCornersOnPage	(	FPoint &	p1,
		FPoint &	p2,
		FPoint &	p3,
		FPoint &	p4,
		bool	tight ) const

pure virtual

Get the corner points of the run (in the clockwise order), in page coordinates.

Parameters

[out]	p1	The first corner point (top-left).
[out]	p2	The second corner point (top-right).
[out]	p3	The third corner point (bottom-right).
[out]	p4	The fourth corner point (bottom-left).
[in]	tight	Whether the bounding box should be 'tight' around the actual glyph markup, or expanded to include the full em height.

◆ getFontHeightOnPage()

virtual double JawsMako::ITextRun::getFontHeightOnPage ( ) const

pure virtual

Determine the height of the font used for this run.

    The returned value will be in page units.

Returns: double The height of the font used for this run, in page units.

◆ getGlyphs()

virtual IDOMGlyphsPtr JawsMako::ITextRun::getGlyphs ( ) const

pure virtual

Get the IDOMGlyphs node that represents this run.

Returns: IDOMGlyphsPtr The IDOMGlyphs node that represents this run.

◆ getLocalBounds()

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

pure virtual

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

Parameters

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

Returns: FRect The bounds of the run, in glyph-local coordinates.

◆ getLocalOrigin()

virtual FPoint JawsMako::ITextRun::getLocalOrigin ( ) const

pure virtual

Get the origin of the first character, in glyph-local coordinates.

Returns: FPoint The origin of the first character in glyph-local coordinates.

◆ getOriginOnPage()

FPoint JawsMako::ITextRun::getOriginOnPage ( ) const

inline

Get the origin of the first character, in page coordinates. Convenience.

Returns: FPoint The origin of the first character in page coordinates.

◆ getSpaceWidth()

virtual double JawsMako::ITextRun::getSpaceWidth ( ) const

pure virtual

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.

Returns: double The width of a space in the font used for this run, in ems.

◆ getSpaceWidthOnPage()

virtual double JawsMako::ITextRun::getSpaceWidthOnPage ( ) const

pure virtual

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.

Returns: double The width of a space in the font used for this run, in page units.

◆ getTransform()

virtual FMatrix JawsMako::ITextRun::getTransform ( ) const

pure virtual

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.

Returns: FMatrix The transformation matrix for the run.

◆ getUnicode()

virtual const String & JawsMako::ITextRun::getUnicode ( ) const

pure virtual

Get the Unicode string for the run as available.

Returns: String The Unicode string for the run.

◆ getUTF8()

virtual U8String JawsMako::ITextRun::getUTF8 ( ) const

pure virtual

Get the Unicode string for the run as available, in UTF-8.

Returns: U8String The Unicode string for the run in UTF-8 encoding.

◆ split()

virtual CTextRunVect JawsMako::ITextRun::split ( )

pure virtual

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.

Returns: CTextRunVect A vector of text runs, which may contain this run

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

jawsmako/text.h

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ~ITextRun()

Member Function Documentation

◆ getBoundsOnPage()

◆ getCornersOnPage()

◆ getFontHeightOnPage()

◆ getGlyphs()

◆ getLocalBounds()

◆ getLocalOrigin()

◆ getOriginOnPage()

◆ getSpaceWidth()

◆ getSpaceWidthOnPage()

◆ getTransform()

◆ getUnicode()

◆ getUTF8()

◆ split()