PoDoFo  0.9.4
Public Member Functions | List of all members
PoDoFo::PdfNamedColor Class Reference

Public Member Functions

 PdfNamedColor (const char *pszName, const PdfColor &rColor)
 
 PdfNamedColor (const char *pszName, const char *rColorName)
 
 PdfNamedColor (const PdfNamedColor &rhs)
 
 ~PdfNamedColor ()
 
bool operator< (const char *pszName) const
 
bool operator< (const PdfNamedColor &rhs) const
 
bool operator== (const char *pszName) const
 
const PdfColorGetColor () const
 
const char * GetName () const
 

Detailed Description

A PdfNamedColor holds a PdfColor object and a name.

Constructor & Destructor Documentation

PoDoFo::PdfNamedColor::PdfNamedColor ( const char *  pszName,
const PdfColor rColor 
)
inline

Create a PdfNamedColor object.

Parameters
pszNamethe name. The string must be allocated as static memory somewhere The string data will not be copied!
rColora PdfColor object
PoDoFo::PdfNamedColor::PdfNamedColor ( const char *  pszName,
const char *  rColorName 
)
inline

Create a PdfNamedColor object.

Parameters
pszNamethe name. The string must be allocated as static memory somewhere The string data will not be copied!
rColorNameRGB hex value (e.g. #FFABCD)
PoDoFo::PdfNamedColor::PdfNamedColor ( const PdfNamedColor rhs)
inline

Copy constructor

PoDoFo::PdfNamedColor::~PdfNamedColor ( )
inline

Class destructor.

Member Function Documentation

const PdfColor& PoDoFo::PdfNamedColor::GetColor ( ) const
inline
Returns
a reference to the internal color object
const char* PoDoFo::PdfNamedColor::GetName ( ) const
inline
Returns
a pointer to the name of the color
bool PoDoFo::PdfNamedColor::operator< ( const char *  pszName) const
inline

Compare this color object to a name The comparison is case insensitive!

Returns
true if the passed string is smaller than the name of this color object.
bool PoDoFo::PdfNamedColor::operator< ( const PdfNamedColor rhs) const
inline

Compare this color object to a PdfNamedColor comparing only the name. The comparison is case insensitive!

Returns
true if the passed string is smaller than the name of this color object.
bool PoDoFo::PdfNamedColor::operator== ( const char *  pszName) const
inline

Compare this color object to a name The comparison is case insensitive!

Returns
true if the passed string is the name of this color object.