JawsMako::ITextSearch Class Reference

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

#include <jawsmako/text.h>

Inheritance diagram for JawsMako::ITextSearch:

Public Member Functions
virtual	~ITextSearch ()
virtual CFPointVectVect	search (const String &targetText, CEDLStringVect &found, bool caseSensitive, bool ignoreSpaces) const =0
	Return a collection of quadpoint data covering all found text. Each entry in the CFPointVectVect represents a unique search 'hit'.
virtual CFPointVectVect	search (const String &targetText, CEDLSysStringVect &found, bool caseSensitive, bool ignoreSpaces) const =0
	Return a collection of quadpoint data covering all found text. Each entry in the CFPointVectVect represents a unique search 'hit'.
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 ITextSearchPtr	create (IEDLClassFactory *factory, const IPageLayoutPtr &pageLayout)
	Creation function for ITextSearch that performs text searching 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 searching using the page information obtained from an IPageLayout.

Constructor & Destructor Documentation

~ITextSearch()

virtual JawsMako::ITextSearch::~ITextSearch ( )

inlinevirtual

Member Function Documentation

create()

JAWSMAKO_API ITextSearchPtr JawsMako::ITextSearch::create ( IEDLClassFactory * factory, const IPageLayoutPtr & pageLayout )

static

Creation function for ITextSearch that performs text searching 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

ITextSearchPtr The new text searcher

search() [1/2]

virtual CFPointVectVect JawsMako::ITextSearch::search ( const String & targetText, CEDLStringVect & found, bool caseSensitive, bool ignoreSpaces ) const

pure virtual

Return a collection of quadpoint data covering all found text. Each entry in the CFPointVectVect represents a unique search 'hit'.

Parameters

[in]	targetText	The text to search for.
[out]	found	A vector of EDLString (wide char) to store the found text strings.
[in]	caseSensitive	Whether the search should be case-sensitive.
[in]	ignoreSpaces	Whether to ignore spaces in the search.

Returns

CFPointVectVect A collection of quadpoint data covering all found text.

search() [2/2]

virtual CFPointVectVect JawsMako::ITextSearch::search ( const String & targetText, CEDLSysStringVect & found, bool caseSensitive, bool ignoreSpaces ) const

pure virtual

Return a collection of quadpoint data covering all found text. Each entry in the CFPointVectVect represents a unique search 'hit'.

Parameters

[in]	targetText	The text to search for.
[out]	found	A vector of EDLSysString (UTF-8) to store the found text strings.
[in]	caseSensitive	Whether the search should be case-sensitive.
[in]	ignoreSpaces	Whether to ignore spaces in the search.

Returns

CFPointVectVect A collection of quadpoint data covering all found text.

---

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

• jawsmako/text.h