JawsMako::IPageLayoutNode Class Reference

Simple data type representing a part of an analyzed page. More...

#include <jawsmako/text.h>

Inheritance diagram for JawsMako::IPageLayoutNode:

Public Member Functions
virtual	~IPageLayoutNode ()
virtual String	getContent () const =0
	Get the unicode string content of the node, if it's of type ePLTTextRun otherwise returns an empty string.
virtual IDOMGlyphsPtr	getContentGlyphs () const =0
	Get the IDOMGlyphsNode that represents the content of the node, if it's of type ePLTTextRun otherwise returns a NULL.
virtual FRect	getPageBounds () const =0
	Gets the page bounds of the node.
virtual ePageLayoutType	getType () const =0
	Get the type of node.
virtual uint32	getColumnNumber () const =0
	Get the column number that the node belongs to. Zero is the root element.
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.

Static Public Member Functions
static JAWSMAKO_API IPageLayoutNodePtr	create (FRect rect, ePageLayoutType type, String content, const IDOMGlyphsPtr &contentGlyphs, uint32 columnNumber)
	Creation function for an IPageLayoutNode, a simple data type representing a part of an analyzed page.

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Simple data type representing a part of an analyzed page.

Constructor & Destructor Documentation

~IPageLayoutNode()

virtual JawsMako::IPageLayoutNode::~IPageLayoutNode ( )

inlinevirtual

Member Function Documentation

create()

JAWSMAKO_API IPageLayoutNodePtr JawsMako::IPageLayoutNode::create ( FRect rect, ePageLayoutType type, String content, const IDOMGlyphsPtr & contentGlyphs, uint32 columnNumber )

static

Creation function for an IPageLayoutNode, a simple data type representing a part of an analyzed page.

Parameters

rect	The bounds of the text area
type	The layout node type
content	The Unicode string content
contentGlyphs	The glyphs node from which the content was obtained
columnNumber	The zero-indexed column number

Returns

IPageLayoutNodePtr The new node

getColumnNumber()

virtual uint32 JawsMako::IPageLayoutNode::getColumnNumber ( ) const

pure virtual

Get the column number that the node belongs to. Zero is the root element.

Returns

uint32 The zero-indexed column number of the node.

getContent()

virtual String JawsMako::IPageLayoutNode::getContent ( ) const

pure virtual

Get the unicode string content of the node, if it's of type ePLTTextRun otherwise returns an empty string.

Returns

String The unicode string content of the node, or an empty string if not applicable.

getContentGlyphs()

virtual IDOMGlyphsPtr JawsMako::IPageLayoutNode::getContentGlyphs ( ) const

pure virtual

Get the IDOMGlyphsNode that represents the content of the node, if it's of type ePLTTextRun otherwise returns a NULL.

Returns

IDOMGlyphsPtr The IDOMGlyphs node that represents the content of the node, or NULL if not applicable.

getPageBounds()

virtual FRect JawsMako::IPageLayoutNode::getPageBounds ( ) const

pure virtual

Gets the page bounds of the node.

Returns

FRect The bounds of the node in page coordinates.

getType()

virtual ePageLayoutType JawsMako::IPageLayoutNode::getType ( ) const

pure virtual

Get the type of node.

Returns

ePageLayoutType The type of the node, which can be ePLTRoot, ePLTColumn or ePLTTextRun.

---

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

• jawsmako/text.h