Attributes of a text field, list box field or combo box field used for the construction of the appearance (PDF documents only).
More...
#include <SignDocSDK-cpp.h>
Attributes of a text field, list box field or combo box field used for the construction of the appearance (PDF documents only).
This class represents a PDF default appearance string.
Modifying an object of this type does not modify the underlying field or document. Use SignDocDocument::setTextFieldAttributes() or SignDocField::setTextFieldAttributes() to update the text attributes of a field or of the document.
- See also
- SignDocDocument::getTextFieldAttributes(), SignDocDocument::setTextFieldAttributes(), SignDocField::getTextFieldAttributes(), SignDocField::setTextFieldAttributes()
Copy constructor.
- Parameters
-
[in] | aSource | The object to be copied. |
Unset all attributes.
isSet() will return false.
std::string getFontName |
( |
Encoding |
aEncoding | ) |
const |
|
inline |
Get the name of the font.
This function returns an empty string if isSet() would return false.
- Parameters
-
[in] | aEncoding | The encoding to be used for the return value. |
- Returns
- The name of the font, "?" if the font is invalid.
- See also
- getFontResourceName(), getFontSize(), setFontName()
std::string getFontResourceName |
( |
Encoding |
aEncoding | ) |
const |
|
inline |
Get the resource name of the font.
This function returns an empty string if isSet() would return false.
Note that setting the resource name is not possible.
- Parameters
-
[in] | aEncoding | The encoding to be used for the return value. |
- Returns
- The resource name of the font.
- See also
- getFontName()
double getFontSize |
( |
| ) |
const |
|
inline |
Get the font size.
This function returns 0 if isSet() would return false.
- Returns
- The font size (in user space units). If the font size is 0, the default font size (which depends on the field size) will be used.
- See also
- getFontName(), setFontSize()
SIGNDOC_TextFieldAttributes* getImpl |
( |
| ) |
|
|
inline |
const SIGNDOC_TextFieldAttributes* getImpl |
( |
| ) |
const |
|
inline |
std::string getRest |
( |
Encoding |
aEncoding | ) |
const |
|
inline |
Get unparsed parts of default appearance string.
If this function returns a non-empty string, there are unsupported operators in the default appearance string.
- Parameters
-
[in] | aEncoding | The encoding to be used for the return value. |
- Returns
- Concatenated unparsed parts of the default appearance string, ie, the default appearance string sans font name, font size, and text color. If this function returns a non-empty string, it will start with a space character.
- See also
- setRest()
Get the text color.
This function returns nullptr if isSet() would return false.
- Returns
- A pointer to an object describing the text color or nullptr if the text color is not available. The caller is responsible for destroying the object.
- See also
- setTextColor()
Check if text field attributes are set or not.
If this function returns false for a SignDocTextFieldAttributes object retrieved from a text field, the document's natural text field attributes will be used (if present).
This function returns false for all SignDocTextFieldAttributes objects retrieved from TIFF documents (but you can set the attributes anyway, making isSet() return true).
- Returns
- true if any attribute is set, false if no attributes are set.
- See also
- isValid()
Check if the text field attributes are valid.
This function does not check if the font name refers to a valid font. This function does not check the string set by setRest().
- Returns
- true if isSet() would return false or if all attributes are set and are valid, false otherwise.
- See also
- isSet(), setRest()
Assignment operator.
- Parameters
-
[in] | aSource | The source object. |
- Returns
- This object.
void setFontName |
( |
Encoding |
aEncoding, |
|
|
const std::string & |
aFontName |
|
) |
| |
|
inline |
void setFontSize |
( |
double |
aFontSize | ) |
|
|
inline |
void setImpl |
( |
SIGNDOC_TextFieldAttributes * |
aP | ) |
|
|
inline |
void setRest |
( |
Encoding |
aEncoding, |
|
|
const std::string & |
aInput |
|
) |
| |
|
inline |
Set unparsed parts of default appearance string.
- Parameters
-
[in] | aEncoding | The encoding of aInput. |
[in] | aInput | The new string of unparsed operators. If this string is non-empty and does not start with a space character, a space character will be prepended automatically. |
Set the text color.
- Parameters
-
[in] | aTextColor | The text color. |
Efficiently swap this object with another one.
- Parameters
-
[in] | aOther | The other object. |
The documentation for this class was generated from the following file: