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 PdfColor &	GetColor () const
const char *	GetName () const

Detailed Description

A PdfNamedColor holds a PdfColor object and a name.

Constructor & Destructor Documentation

PdfNamedColor() [1/3]

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

inline

Create a PdfNamedColor object.

Parameters

pszName	the name. The string must be allocated as static memory somewhere The string data will not be copied!
rColor	a PdfColor object

PdfNamedColor() [2/3]

PoDoFo::PdfNamedColor::PdfNamedColor ( const char * pszName, const char * rColorName )

inline

Create a PdfNamedColor object.

Parameters

pszName	the name. The string must be allocated as static memory somewhere The string data will not be copied!
rColorName	RGB hex value (e.g. #FFABCD)

PdfNamedColor() [3/3]

PoDoFo::PdfNamedColor::PdfNamedColor ( const PdfNamedColor & rhs )

inline

Copy constructor

~PdfNamedColor()

PoDoFo::PdfNamedColor::~PdfNamedColor ( )

inline

Class destructor.

Member Function Documentation

GetColor()

const PdfColor & PoDoFo::PdfNamedColor::GetColor ( ) const

inline

Returns

a reference to the internal color object

GetName()

const char * PoDoFo::PdfNamedColor::GetName ( ) const

inline

Returns

a pointer to the name of the color

operator<() [1/2]

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.

operator<() [2/2]

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.

operator==()

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.