JawsMako::IPageLayoutData Class Reference

Provides a representation of the analyzed page layout by organizing and allowing access to collections of IPageLayoutNodes. More...

#include <text.h>

Inheritance diagram for JawsMako::IPageLayoutData:

Public Member Functions
virtual IPageLayoutNodeCollection	getColumn (uint32 columnNumber)=0
	Get a collection of IPageLayoutNodes, representing the content of the specified column number. A columnNumber of zero will return the root content.
virtual uint32	getNumberOfColumns () const =0
	Get the number of columns (this includes the root item)
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 IPageLayoutDataPtr	create (IPageLayoutNodeCollection data)
	Creation function for IPageLayoutData that provides a representation of the analyzed page layout, by organizing and allowing access to collections of IPageLayoutNodes.

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

Detailed Description

Provides a representation of the analyzed page layout by organizing and allowing access to collections of IPageLayoutNodes.

Member Function Documentation

create()

static JAWSMAKO_API IPageLayoutDataPtr JawsMako::IPageLayoutData::create ( IPageLayoutNodeCollection data )

static

Creation function for IPageLayoutData that provides a representation of the analyzed page layout, by organizing and allowing access to collections of IPageLayoutNodes.

Parameters

data	The collection of IPageLayoutNodes

Returns

IPageLayoutDataPtr The new representation

getColumn()

virtual IPageLayoutNodeCollection JawsMako::IPageLayoutData::getColumn ( uint32 columnNumber )

pure virtual

Get a collection of IPageLayoutNodes, representing the content of the specified column number. A columnNumber of zero will return the root content.

Parameters

columnNumber

The zero-indexed column number to retrieve.

Returns

IPageLayoutNodeCollection The collection of IPageLayoutNodes for the specified column.

getNumberOfColumns()

virtual uint32 JawsMako::IPageLayoutData::getNumberOfColumns ( ) const

pure virtual

Get the number of columns (this includes the root item)

Returns

uint32 The number of columns in the layout data.

---

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

• text.h