Information text found returned by SIGNDOC_Document_findText(). More...

#include <SignDocSDK-c.h>

Public Member Functions
struct SIGNDOC_FindTextOccurrence *	SIGNDOC_FindTextOccurrence_new (struct SIGNDOC_Exception **aEx)
	SIGNDOC_FindTextOccurrence constructor. More...

void	SIGNDOC_FindTextOccurrence_delete (struct SIGNDOC_FindTextOccurrence *aObj)
	SIGNDOC_FindTextOccurrence destructor. More...

struct SIGNDOC_FindTextOccurrence *	SIGNDOC_FindTextOccurrence_clone (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_FindTextOccurrence aSource)
	Clone a SIGNDOC_FindTextOccurrence object. More...

void	SIGNDOC_FindTextOccurrence_assign (struct SIGNDOC_Exception *aEx, struct SIGNDOC_FindTextOccurrence aObj, const struct SIGNDOC_FindTextOccurrence *aSource)
	SIGNDOC_FindTextOccurrence assignment operator. More...

int	SIGNDOC_FindTextOccurrence_getNumberOfClusters (const struct SIGNDOC_FindTextOccurrence *aObj)
	Get the number of clusters making up the hit. More...

const struct SIGNDOC_TextCluster *	SIGNDOC_FindTextOccurrence_getCluster (const struct SIGNDOC_FindTextOccurrence *aObj, int aIndex)
	Get a cluster. More...

int	SIGNDOC_FindTextOccurrence_getPage (const struct SIGNDOC_FindTextOccurrence *aObj)
	Get the page on which the glyphs of this object appear. More...

void	SIGNDOC_FindTextOccurrence_getPages (struct SIGNDOC_Exception *aEx, const struct SIGNDOC_FindTextOccurrence aObj, struct SIGNDOC_IntArray *aOutput)
	Get the pages on which the glyphs of this object appear. More...

int	SIGNDOC_FindTextOccurrence_getUnicodeDirection (const struct SIGNDOC_FindTextOccurrence *aObj)
	Get the direction implied by the Unicode code points. More...

Detailed Description

Information text found returned by SIGNDOC_Document_findText().

Member Function Documentation

void SIGNDOC_FindTextOccurrence_assign	(	struct SIGNDOC_Exception **	aEx,
		struct SIGNDOC_FindTextOccurrence *	aObj,
		const struct SIGNDOC_FindTextOccurrence *	aSource
	)

SIGNDOC_FindTextOccurrence assignment operator.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_FindTextOccurrence object.
[in]	aSource	The source object.

struct SIGNDOC_FindTextOccurrence * SIGNDOC_FindTextOccurrence_clone	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_FindTextOccurrence *	aSource
	)

Clone a SIGNDOC_FindTextOccurrence object.

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aSource	The object to be copied.

void SIGNDOC_FindTextOccurrence_delete ( struct SIGNDOC_FindTextOccurrence * aObj )

SIGNDOC_FindTextOccurrence destructor.

Parameters

[in] aObj A pointer to the SIGNDOC_FindTextOccurrence object, must not be a pointer returned by SIGNDOC_FindTextOccurrenceArray_at().

const struct SIGNDOC_TextCluster * SIGNDOC_FindTextOccurrence_getCluster	(	const struct SIGNDOC_FindTextOccurrence *	aObj,
		int	aIndex
	)

Get a cluster.

Parameters

[in]	aObj	A pointer to the SIGNDOC_FindTextOccurrence object.
[in]	aIndex	The 0-based index of the cluster (logical order).

Returns: A pointer to the object describing the cluster. This SIGNDOC_FindTextOccurrence object holds one reference to the object, therefore SIGNDOC_TextCluster_removeReference() must not be called unless SIGNDOC_TextCluster_addReference() has been called. NULL if aIndex is out of range.

int SIGNDOC_FindTextOccurrence_getNumberOfClusters ( const struct SIGNDOC_FindTextOccurrence * aObj )

Get the number of clusters making up the hit.

Parameters

[in] aObj A pointer to the SIGNDOC_FindTextOccurrence object.

Returns: The number of clusters.

int SIGNDOC_FindTextOccurrence_getPage ( const struct SIGNDOC_FindTextOccurrence * aObj )

Get the page on which the glyphs of this object appear.

The glyphs of a SignDocFindTextOccurrence object can appear on different pages, even on pages outside the range of pages passed to SIGNDOC_Document_findText() or SIGNDOC_Document_createTextIterator().

Parameters

[in] aObj A pointer to the SIGNDOC_FindTextOccurrence object.

Returns: The 1-based page number of the page on which the glyphs appear or 0 if the glyphs appear on two or more different pages.

See also: SIGNDOC_FindTextOccurrence_getPages(), SIGNDOC_TextCluster_getGlyphPage(), SIGNDOC_TextCluster_getPage()

void SIGNDOC_FindTextOccurrence_getPages	(	struct SIGNDOC_Exception **	aEx,
		const struct SIGNDOC_FindTextOccurrence *	aObj,
		struct SIGNDOC_IntArray *	aOutput
	)

Get the pages on which the glyphs of this object appear.

The glyphs of a SignDocFindTextOccurrence object can appear on different pages, even on pages outside the range of pages passed to SIGNDOC_Document_findText() or SIGNDOC_Document_createTextIterator().

Parameters

[out]	aEx	Any exception will be returned in the object pointed to by this parameter.
[in]	aObj	A pointer to the SIGNDOC_FindTextOccurrence object.
[in,out]	aOutput	The 1-based page numbers of the pages on which the glyphs appear will be stored here.

Returns: The 1-based page number of the page on which the glyphs appear.

See also: SIGNDOC_FindTextOccurrence_getPage(), SIGNDOC_TextCluster_getGlyphPage(), SIGNDOC_TextCluster_getPages()

int SIGNDOC_FindTextOccurrence_getUnicodeDirection ( const struct SIGNDOC_FindTextOccurrence * aObj )

Get the direction implied by the Unicode code points.

A lot of characters (such as punctuation characters) do not imply a direction. Unless there is at least one character that defines a direction, 0 will be returned. 0 is also returned if there are conflicting directions.

Parameters

[in] aObj A pointer to the SIGNDOC_FindTextOccurrence object.

Returns: -1 for RTL, 1 for LTR, 0 if the direction cannot be determined unambiguously.

struct SIGNDOC_FindTextOccurrence * SIGNDOC_FindTextOccurrence_new ( struct SIGNDOC_Exception ** aEx )

SIGNDOC_FindTextOccurrence constructor.

Parameters

[out] aEx Any exception will be returned in the object pointed to by this parameter.

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

SignDocSDK-c.h

Public Member Functions

Detailed Description

Member Function Documentation