PoDoFo::PdfNamedColor Class Reference

List of all members.

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

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

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)

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 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 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.

---