One property, without value. More...
#include <SignDocSDK-cpp.h>
Public Types | |
enum | Type { t_string, t_integer, t_boolean } |
Property types. More... | |
Public Member Functions | |
SignDocProperty () | |
Constructor. | |
SignDocProperty (const SignDocProperty &aSource) | |
Copy constructor. | |
~SignDocProperty () | |
Destructor. | |
void | swap (SignDocProperty &aOther) |
Efficiently swap this object with another one. | |
std::string | getName (Encoding aEncoding) const |
Get the name of the property. | |
const char * | getNameUTF8 () const |
Get the name of the property as UTF-8-encoded C string. | |
Type | getType () const |
Get the type of the property. | |
SignDocProperty (SIGNDOC_Property *aP) | |
Internal function. | |
SIGNDOC_Property * | getImpl () |
Internal function. | |
const SIGNDOC_Property * | getImpl () const |
Internal function. | |
void | setImpl (SIGNDOC_Property *aP) |
Internal function. |
One property, without value.
Use SignDocDocument::getBooleanProperty(), SignDocDocument::getIntegerProperty(), or SignDocDocument::getStringProperty() to get the value of a property.
de::softpro::doc::SignDocProperty::SignDocProperty | ( | ) | [inline] |
Constructor.
de::softpro::doc::SignDocProperty::SignDocProperty | ( | const SignDocProperty & | aSource ) | [inline] |
Copy constructor.
[in] | aSource | The object to be copied. |
de::softpro::doc::SignDocProperty::~SignDocProperty | ( | ) | [inline] |
Destructor.
de::softpro::doc::SignDocProperty::SignDocProperty | ( | SIGNDOC_Property * | aP ) | [inline] |
Internal function.
SIGNDOC_Property* de::softpro::doc::SignDocProperty::getImpl | ( | ) | [inline] |
Internal function.
const SIGNDOC_Property* de::softpro::doc::SignDocProperty::getImpl | ( | ) | const [inline] |
Internal function.
std::string de::softpro::doc::SignDocProperty::getName | ( | Encoding | aEncoding ) | const [inline] |
Get the name of the property.
Property names are compared under Unicode simple case folding, that is, lower case and upper case is not distinguished.
This function throws std::runtime_error if the name cannot be represented using the specified encoding.
[in] | aEncoding | The encoding to be used for the return value. |
const char* de::softpro::doc::SignDocProperty::getNameUTF8 | ( | ) | const [inline] |
Get the name of the property as UTF-8-encoded C string.
Property names are compared under Unicode simple case folding, that is, lower case and upper case is not distinguished.
Type de::softpro::doc::SignDocProperty::getType | ( | ) | const [inline] |
Get the type of the property.
void de::softpro::doc::SignDocProperty::setImpl | ( | SIGNDOC_Property * | aP ) | [inline] |
Internal function.
void de::softpro::doc::SignDocProperty::swap | ( | SignDocProperty & | aOther ) | [inline] |
Efficiently swap this object with another one.
[in] | aOther | The other object. |