SignDocProperty Class Reference

One property, without value. More...

#include <SignDocSDK-cpp.h>

Public Types
enum	Type { t_boolean = 1, t_integer = 2, t_string = 4 }
	Property types. More...

Public Member Functions
	SignDocProperty ()
	Constructor. More...
	SignDocProperty (const SignDocProperty &aSource)
	Copy constructor. More...
	~SignDocProperty ()
	Destructor. More...
void	swap (SignDocProperty &aOther)
	Efficiently swap this object with another one. More...
std::string	getName (Encoding aEncoding) const
	Get the name of the property. More...
const char *	getNameUTF8 () const
	Get the name of the property as UTF-8-encoded C string. More...
Type	getType () const
	Get the type of the property. More...
	SignDocProperty (SIGNDOC_Property *aP)
	Internal function. More...
SIGNDOC_Property *	getImpl ()
	Internal function. More...
const SIGNDOC_Property *	getImpl () const
	Internal function. More...
void	setImpl (SIGNDOC_Property *aP)
	Internal function. More...

Detailed Description

One property, without value.

Use SignDocDocument::getBooleanProperty(), SignDocDocument::getIntegerProperty(), or SignDocDocument::getStringProperty() to get the value of a property.

Member Enumeration Documentation

enum Type

Property types.

Enumerator
t_boolean	Boolean.
t_integer	Integer.
t_string	String.

Constructor & Destructor Documentation

SignDocProperty ( )

inline

Constructor.

SignDocProperty ( const SignDocProperty &  aSource )

inline

Copy constructor.

Parameters

[in]

aSource

The object to be copied.

~SignDocProperty ( )

inline

Destructor.

SignDocProperty ( SIGNDOC_Property *  aP )

inline

Internal function.

Member Function Documentation

SIGNDOC_Property* getImpl ( )

inline

Internal function.

const SIGNDOC_Property* getImpl ( ) const

inline

Internal function.

std::string 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.

Parameters

[in]

aEncoding

The encoding to be used for the return value.

Returns

The name of the property.

See also

getNameUTF8()

const char * 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.

Returns

The name of the property. This pointer will become invalid when setName() is called or this object is destroyed.

See also

getName()

SignDocProperty::Type getType ( ) const

inline

Get the type of the property.

Returns

The type of the property.

void setImpl ( SIGNDOC_Property *  aP )

inline

Internal function.

void swap ( SignDocProperty &  aOther )

inline

Efficiently swap this object with another one.

Parameters

[in]

aOther

The other object.

---

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

• SignDocSDK-cpp.h