PoDoFo 0.7.0
Public Member Functions | Static Public Member Functions
PoDoFo::PdfName Class Reference

#include <PdfName.h>

Inheritance diagram for PoDoFo::PdfName:
PoDoFo::PdfDataType

List of all members.

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 PdfNameoperator= (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)

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

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.

Parameters:
sNamethe unescaped value of this name. Please specify the name without the leading '/'.
PoDoFo::PdfName::PdfName ( const char *  pszName) [inline]

Create a new PdfName object.

Parameters:
pszNamethe 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.

Parameters:
pszNamethe unescaped value of this name. Please specify the name without the leading '/'.
lLenlength of the name
PoDoFo::PdfName::PdfName ( const PdfName rhs) [inline]

Create a copy of an existing PdfName object.

Parameters:
rhsanother PdfName object

Member Function Documentation

static PdfName PoDoFo::PdfName::FromEscaped ( const std::string &  sName) [static]

Create a new PdfName object from a string containing an escaped name string without the leading / .

Parameters:
sNameA string containing the escaped name
Returns:
A new PdfName
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 / .

Parameters:
pszNameA string containing the escaped name
ilengthlength 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
string PoDoFo::PdfName::GetEscapedName ( ) const
Returns:
an escaped representation of this name without the leading / .

There is no corresponding GetEscapedLength(), since generating the return value is somewhat expensive.

size_t PoDoFo::PdfName::GetLength ( ) const [inline]
Returns:
the unescaped length of this name object
const std::string & PoDoFo::PdfName::GetName ( ) const [inline]
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:
rhsa name
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:
rhsanother 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.

Parameters:
rhsa name
Returns:
true if this objects name is equal to pszName
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:
rhsa name
Returns:
true if this objects name is equal to pszName
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.

Parameters:
pDevicewrite the object to this device
eWriteModeadditional options for writing this object
pEncryptan encryption object which is used to encrypt this object or NULL to not encrypt this object

Implements PoDoFo::PdfDataType.