PoDoFo 0.9.20
PdfNamedColor Class Reference

Public Member Functions

 PdfNamedColor (const string_view &name, const PdfColor &color)
 
 PdfNamedColor (const string_view &name, const string_view &colorCode)
 
 PdfNamedColor (const PdfNamedColor &rhs)
 
bool operator< (const string_view &name) const
 
bool operator< (const PdfNamedColor &rhs) const
 
bool operator== (const string_view &name) const
 
const PdfColorGetColor () const
 
const string & GetName () const
 

Detailed Description

A PdfNamedColor holds a PdfColor object and a name.

Constructor & Destructor Documentation

◆ PdfNamedColor() [1/3]

PdfNamedColor::PdfNamedColor ( const string_view & name,
const PdfColor & color )
inline

Create a PdfNamedColor object.

Parameters
namethe name. The string must be allocated as static memory somewhere The string data will not be copied!
colora PdfColor object

◆ PdfNamedColor() [2/3]

PdfNamedColor::PdfNamedColor ( const string_view & name,
const string_view & colorCode )
inline

Create a PdfNamedColor object.

Parameters
namethe name. The string must be allocated as static memory somewhere The string data will not be copied!
colorNameRGB hex value (e.g. #FFABCD)

◆ PdfNamedColor() [3/3]

PdfNamedColor::PdfNamedColor ( const PdfNamedColor & rhs)
inline

Copy constructor

Member Function Documentation

◆ GetColor()

const PdfColor & PdfNamedColor::GetColor ( ) const
inline
Returns
a reference to the internal color object

◆ GetName()

const string & PdfNamedColor::GetName ( ) const
inline
Returns
a pointer to the name of the color

◆ operator<() [1/2]

bool 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<() [2/2]

bool PdfNamedColor::operator< ( const string_view & name) 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==()

bool PdfNamedColor::operator== ( const string_view & name) 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.