![]() |
SignDoc SDK (C)
5.0.0
|
Information text found returned by SIGNDOC_Document_findText(). More...
#include <SignDocSDK-c.h>
Information text found returned by SIGNDOC_Document_findText().
void SIGNDOC_FindTextOccurrence_assign | ( | struct SIGNDOC_Exception ** | aEx, |
struct SIGNDOC_FindTextOccurrence * | aObj, | ||
const struct SIGNDOC_FindTextOccurrence * | aSource | ||
) |
SIGNDOC_FindTextOccurrence assignment operator.
[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.
[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.
[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.
[in] | aObj | A pointer to the SIGNDOC_FindTextOccurrence object. |
[in] | aIndex | The 0-based index of the cluster (logical order). |
int SIGNDOC_FindTextOccurrence_getNumberOfClusters | ( | const struct SIGNDOC_FindTextOccurrence * | aObj | ) |
Get the number of clusters making up the hit.
[in] | aObj | A pointer to the SIGNDOC_FindTextOccurrence object. |
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().
[in] | aObj | A pointer to the SIGNDOC_FindTextOccurrence object. |
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().
[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. |
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.
[in] | aObj | A pointer to the SIGNDOC_FindTextOccurrence object. |
struct SIGNDOC_FindTextOccurrence * SIGNDOC_FindTextOccurrence_new | ( | struct SIGNDOC_Exception ** | aEx | ) |
SIGNDOC_FindTextOccurrence constructor.
[out] | aEx | Any exception will be returned in the object pointed to by this parameter. |