SignDoc SDK (C++)
5.0.0
|
Actions and parameters for SignDocImage::clean(). More...
#include <SignDocSDK-cpp.h>
Public Types | |
enum | Type { t_undefined = 0, t_boolean = 1, t_integer = 2, t_number = 3, t_void = 7 } |
Return values of getType() and getTypeAt(). More... | |
Public Member Functions | |
SignDocCleanParameters () | |
Constructor. More... | |
SignDocCleanParameters (const SignDocCleanParameters &aSource) | |
Copy constructor. More... | |
~SignDocCleanParameters () | |
Destructor. More... | |
SignDocCleanParameters & | operator= (const SignDocCleanParameters &aSource) |
Assignment operator. More... | |
void | swap (SignDocCleanParameters &aOther) |
Efficiently swap this object with another one. More... | |
void | clear () |
Remove all actions. More... | |
ReturnCode | add (const std::string &aName) |
Add an action without parameter. More... | |
ReturnCode | addBoolean (const std::string &aName, bool aValue) |
Add an action with a boolean parameter. More... | |
ReturnCode | addInteger (const std::string &aName, int aValue) |
Add an action with an integer parameter. More... | |
ReturnCode | addNumber (const std::string &aName, double aValue) |
Add an action with a floating-point number parameter. More... | |
int | getNumberOfActions () const |
Get the number of actions. More... | |
Type | getTypeAt (int aIndex) const |
Get the type of the parameter of an action. More... | |
const char * | getNameAt (int aIndex) const |
Get the name of an action. More... | |
const int * | getBooleanAt (int aIndex) const |
Get the value of a boolean parameter. More... | |
const int * | getIntegerAt (int aIndex) const |
Get the value of an integer parameter. More... | |
const double * | getNumberAt (int aIndex) const |
Get the value of a floating-point number parameter. More... | |
const char * | getErrorMessage (Encoding aEncoding) const |
Get an error message for the last function call. More... | |
const wchar_t * | getErrorMessageW () const |
Get an error message for the last function call. More... | |
SignDocCleanParameters (SIGNDOC_CleanParameters *aP) | |
Internal function. More... | |
SIGNDOC_CleanParameters * | getImpl () |
Internal function. More... | |
const SIGNDOC_CleanParameters * | getImpl () const |
Internal function. More... | |
void | setImpl (SIGNDOC_CleanParameters *aP) |
Internal function. More... | |
Static Public Member Functions | |
static Type | getType (const std::string &aName) |
Get the type of the parameter of an action. More... | |
Actions and parameters for SignDocImage::clean().
enum Type |
Return values of getType() and getTypeAt().
Enumerator | |
---|---|
t_undefined |
The specified action is not defined. |
t_boolean |
Boolean.
|
t_integer |
Integer.
|
t_number |
Floating-point number.
|
t_void |
No value.
|
|
inline |
Constructor.
No actions will be set.
|
inline |
Copy constructor.
[in] | aSource | The object to be copied. |
|
inline |
Destructor.
|
inline |
Internal function.
|
inline |
Add an action without parameter.
The following actions without parameter are available:
[in] | aName | The name of the action (case-sensitive). |
|
inline |
Add an action with a boolean parameter.
The following action with boolean parameter is available:
[in] | aName | The name of the action (case-sensitive). |
[in] | aValue | The value of the parameter. |
|
inline |
Add an action with an integer parameter.
The following actions with integer parameter are available:
[in] | aName | The name of the action (case-sensitive). |
[in] | aValue | The value of the parameter. |
|
inline |
Add an action with a floating-point number parameter.
The following action with a floating-point number parameter is available:
[in] | aName | The name of the action (case-sensitive). |
[in] | aValue | The value of the parameter. |
|
inline |
Remove all actions.
|
inline |
Get the value of a boolean parameter.
This function does not set an error message.
[in] | aIndex | The zero-based index of the action. |
|
inline |
Get an error message for the last function call.
[in] | aEncoding | The encoding to be used for the error message. |
|
inline |
Get an error message for the last function call.
|
inline |
Internal function.
|
inline |
Internal function.
|
inline |
Get the value of an integer parameter.
This function does not set an error message.
[in] | aIndex | The zero-based index of the action. |
|
inline |
Get the name of an action.
[in] | aIndex | The zero-based index of the action. |
|
inline |
Get the value of a floating-point number parameter.
This function does not set an error message.
[in] | aIndex | The zero-based index of the action. |
|
inline |
Get the number of actions.
|
inlinestatic |
Get the type of the parameter of an action.
[in] | aName | The name of the action (case-sensitive). |
|
inline |
Get the type of the parameter of an action.
[in] | aIndex | The zero-based index of the action. |
|
inline |
Assignment operator.
[in] | aSource | The source object. |
|
inline |
Internal function.
|
inline |
Efficiently swap this object with another one.
[in] | aOther | The other object. |