SignDoc SDK (C++)  5.0.0
SignDocTextIterator Class Reference

An iterator for the text of a document. More...

#include <SignDocSDK-cpp.h>

Public Member Functions

 SignDocTextIterator ()
 Constructor. More...
 
 ~SignDocTextIterator ()
 Destructor. More...
 
bool next (SignDocTextCluster &aCluster)
 Get the next cluster. More...
 
 SignDocTextIterator (SIGNDOC_TextIterator *aP)
 Internal function. More...
 
SIGNDOC_TextIterator * getImpl ()
 Internal function. More...
 
const SIGNDOC_TextIterator * getImpl () const
 Internal function. More...
 
void setImpl (SIGNDOC_TextIterator *aP)
 Internal function. More...
 

Detailed Description

An iterator for the text of a document.

Use SignDocDocument::createTextIterator() to create objects of this type.

Constructor & Destructor Documentation

SignDocTextIterator ( )
inline

Constructor.

Use SignDocDocument::createTextIterator() instead.

~SignDocTextIterator ( )
inline

Destructor.

SignDocTextIterator ( SIGNDOC_TextIterator *  aP)
inline

Internal function.

Member Function Documentation

SIGNDOC_TextIterator* getImpl ( )
inline

Internal function.

const SIGNDOC_TextIterator* getImpl ( ) const
inline

Internal function.

bool next ( SignDocTextCluster aCluster)
inline

Get the next cluster.

Parameters
[out]aClusterThe cluster will be stored here.
Returns
true if successful, false if there is no more text.
void setImpl ( SIGNDOC_TextIterator *  aP)
inline

Internal function.


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