#include <PdfName.h>
Inheritance diagram for PoDoFo::PdfName:
Public Member Functions | |
PdfName () | |
PdfName (const std::string &sName) | |
PdfName (const char *pszName) | |
PdfName (const char *pszName, long lLen) | |
std::string | GetEscapedName () const |
PdfName (const PdfName &rhs) | |
void | Write (PdfOutputDevice *pDevice, EPdfWriteMode eWriteMode, const PdfEncrypt *pEncrypt=NULL) const |
PODOFO_NOTHROW const std::string & | GetName () const |
PODOFO_NOTHROW size_t | GetLength () const |
PODOFO_NOTHROW const PdfName & | operator= (const PdfName &rhs) |
PODOFO_NOTHROW bool | operator== (const PdfName &rhs) const |
bool | operator== (const char *rhs) const |
PODOFO_NOTHROW bool | operator== (const std::string &rhs) const |
PODOFO_NOTHROW bool | operator!= (const PdfName &rhs) const |
bool | operator!= (const char *rhs) const |
PODOFO_NOTHROW bool | operator< (const PdfName &rhs) const |
Static Public Member Functions | |
static PdfName | FromEscaped (const std::string &sName) |
static PdfName | FromEscaped (const char *pszName, pdf_long ilength=0) |
PdfName are required as keys in PdfObject and PdfVariant objects.
PdfName may have a maximum length of 127 characters.
PoDoFo::PdfName::PdfName | ( | ) | [inline] |
Constructor to create NULL strings. use PdfName::KeyNull instead of this constructor
PoDoFo::PdfName::PdfName | ( | const std::string & | sName | ) | [inline] |
Create a new PdfName object.
sName | the unescaped value of this name. Please specify the name without the leading '/'. |
PoDoFo::PdfName::PdfName | ( | const char * | pszName | ) | [inline] |
Create a new PdfName object.
pszName | the unescaped value of this name. Please specify the name without the leading '/'. Has to be a zero terminated string. |
PoDoFo::PdfName::PdfName | ( | const char * | pszName, | |
long | lLen | |||
) | [inline] |
Create a new PdfName object.
pszName | the unescaped value of this name. Please specify the name without the leading '/'. | |
lLen | length of the name |
PoDoFo::PdfName::PdfName | ( | const PdfName & | rhs | ) | [inline] |
PdfName PoDoFo::PdfName::FromEscaped | ( | const char * | pszName, | |
pdf_long | ilength = 0 | |||
) | [static] |
Create a new PdfName object from a string containing an escaped name string without the leading / .
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. |
static PdfName PoDoFo::PdfName::FromEscaped | ( | const std::string & | sName | ) | [static] |
string PoDoFo::PdfName::GetEscapedName | ( | ) | const |
size_t PoDoFo::PdfName::GetLength | ( | ) | const [inline] |
const std::string & PoDoFo::PdfName::GetName | ( | ) | const [inline] |
bool PoDoFo::PdfName::operator!= | ( | const char * | rhs | ) | const [inline] |
overloaded operator for convinience
The string argument is treated as an unescaped name.
rhs | a name |
bool PoDoFo::PdfName::operator!= | ( | const PdfName & | rhs | ) | const [inline] |
compare two PdfName objects.
bool PoDoFo::PdfName::operator< | ( | const PdfName & | rhs | ) | const [inline] |
compare two PdfName objects. Used for sorting in lists
Assign another name to this object
rhs | another PdfName object |
bool PoDoFo::PdfName::operator== | ( | const std::string & | rhs | ) | const [inline] |
overloaded operator for convinience
The string argument is treated as an unescaped name.
rhs | a name |
bool PoDoFo::PdfName::operator== | ( | const char * | rhs | ) | const |
overloaded operator for convinience
The string argument is treated as an unescaped name.
rhs | a name |
bool PoDoFo::PdfName::operator== | ( | const PdfName & | rhs | ) | const [inline] |
compare to PdfName objects.
void PoDoFo::PdfName::Write | ( | PdfOutputDevice * | pDevice, | |
EPdfWriteMode | eWriteMode, | |||
const PdfEncrypt * | pEncrypt = NULL | |||
) | const [virtual] |
Write the name to an output device in PDF format. This is an overloaded member function.
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.