JawsMako::ITextSelect Class Reference

Perform text selection using the page information obtained from an IPageLayout. More...

#include <jawsmako/text.h>

Inheritance diagram for JawsMako::ITextSelect:

Public Member Functions
virtual	~ITextSelect ()
virtual String	getTextAtRect (const FRect &pageArea, eLanguageType language=eLTArabic) const =0
	Return the unicode string located within the bounds of 'pageArea', using the specified 'language' unicode helper. Result will be empty if no string is found.
virtual CFPointVect	selectArea (const FRect &pageArea, String *selectedText) const =0
	Return quadpoint data covering all text within the specified page area, optionally returning the actual text as well.
virtual CFPointVect	selectLines (const FPoint &startPoint, const FPoint &endPoint, String *selectedText) const =0
	Return quadpoint data covering all text within the specified page start/end points, optionally returning the actual text as well.
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 ITextSelectPtr	create (IEDLClassFactory *factory, const IPageLayoutPtr &pageLayout)
	Creation function for an ITextSelect that performs text selection using page information obtained from an IPageLayout. Throws an IEDLError on failure.

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

Detailed Description

Perform text selection using the page information obtained from an IPageLayout.

Constructor & Destructor Documentation

~ITextSelect()

virtual JawsMako::ITextSelect::~ITextSelect ( )

inlinevirtual

Member Function Documentation

create()

JAWSMAKO_API ITextSelectPtr JawsMako::ITextSelect::create ( IEDLClassFactory * factory, const IPageLayoutPtr & pageLayout )

static

Creation function for an ITextSelect that performs text selection using page information obtained from an IPageLayout. Throws an IEDLError on failure.

Parameters

factory	The EDL factory to use
pageLayout	The page layout to use

Returns

ITextSelectPtr The new text selector

getTextAtRect()

virtual String JawsMako::ITextSelect::getTextAtRect ( const FRect & pageArea, eLanguageType language = eLTArabic ) const

pure virtual

Return the unicode string located within the bounds of 'pageArea', using the specified 'language' unicode helper. Result will be empty if no string is found.

Parameters

pageArea	The area of the page to search for text.
language	The language type to use for the unicode helper, defaults to eLTArabic.

Returns

String The unicode string found within the specified page area.

selectArea()

virtual CFPointVect JawsMako::ITextSelect::selectArea ( const FRect & pageArea, String * selectedText ) const

pure virtual

Return quadpoint data covering all text within the specified page area, optionally returning the actual text as well.

Parameters

[in]	pageArea	The area of the page to select text from.
[out]	selectedText	A pointer to a String that will be filled with the selected text, if any.

Returns

CFPointVect A vector of quadpoints covering the selected text area.

selectLines()

virtual CFPointVect JawsMako::ITextSelect::selectLines ( const FPoint & startPoint, const FPoint & endPoint, String * selectedText ) const

pure virtual

Return quadpoint data covering all text within the specified page start/end points, optionally returning the actual text as well.

Parameters

[in]	startPoint	The starting point of the selection.
[in]	endPoint	The ending point of the selection.
[out]	selectedText	A pointer to a String that will be filled with the selected text, if any.

Returns

CFPointVect A vector of quadpoints covering the selected text area.

---

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

• jawsmako/text.h