#include <PdfName.h>
List of all members.
Detailed Description
This class represents a PdfName. Whenever a key is required you have to use a PdfName object.
PdfName are required as keys in PdfObject and PdfVariant objects.
PdfName may have a maximum length of 127 characters.
- See also:
- PdfObject
-
PdfVariant
Constructor & Destructor Documentation
Constructor to create NULL strings. use PdfName::KeyNull instead of this constructor
Create a new PdfName object.
- Parameters:
-
sName | the unescaped value of this name. Please specify the name without the leading '/'. |
Create a new PdfName object.
- Parameters:
-
pszName | the unescaped value of this name. Please specify the name without the leading '/'. Has to be a zero terminated string. |
Create a new PdfName object.
- Parameters:
-
pszName | the unescaped value of this name. Please specify the name without the leading '/'. |
lLen | length of the name |
Create a copy of an existing PdfName object.
- Parameters:
-
Member Function Documentation
Create a new PdfName object from a string containing an escaped name string without the leading / .
- Parameters:
-
sName | A string containing the escaped name |
- Returns:
- A new PdfName
Create a new PdfName object from a string containing an escaped name string without the leading / .
- Parameters:
-
pszName | A string containing the escaped name |
ilength | length of the escaped string data. If a length of 0 is passed, the string data is expected to be a zero terminated string. |
- Returns:
- A new PdfName
- Returns:
- an escaped representation of this name without the leading / .
There is no corresponding GetEscapedLength(), since generating the return value is somewhat expensive.
- Returns:
- the unescaped length of this name object
- Returns:
- the unescaped value of this name object without the leading slash
bool PoDoFo::PdfName::operator!= |
( |
const PdfName & |
rhs | ) |
const [inline] |
compare two PdfName objects.
- Returns:
- true if both PdfNames have different values.
bool PoDoFo::PdfName::operator!= |
( |
const char * |
rhs | ) |
const [inline] |
overloaded operator for convinience
The string argument is treated as an unescaped name.
- Parameters:
-
- Returns:
- true if this objects name is not equal to pszName
bool PoDoFo::PdfName::operator< |
( |
const PdfName & |
rhs | ) |
const [inline] |
compare two PdfName objects. Used for sorting in lists
- Returns:
- true if this object is smaller than rhs
const PdfName & PoDoFo::PdfName::operator= |
( |
const PdfName & |
rhs | ) |
[inline] |
Assign another name to this object
- Parameters:
-
bool PoDoFo::PdfName::operator== |
( |
const PdfName & |
rhs | ) |
const [inline] |
compare to PdfName objects.
- Returns:
- true if both PdfNames have the same value.
bool PoDoFo::PdfName::operator== |
( |
const char * |
rhs | ) |
const |
overloaded operator for convinience
The string argument is treated as an unescaped name.
- Parameters:
-
- Returns:
- true if this objects name is equal to pszName
bool PoDoFo::PdfName::operator== |
( |
const std::string & |
rhs | ) |
const [inline] |
overloaded operator for convinience
The string argument is treated as an unescaped name.
- Parameters:
-
- Returns:
- true if this objects name is equal to pszName
Write the name to an output device in PDF format. This is an overloaded member function.
- Parameters:
-
pDevice | write the object to this device |
eWriteMode | additional options for writing this object |
pEncrypt | an encryption object which is used to encrypt this object or NULL to not encrypt this object |
Implements PoDoFo::PdfDataType.