Class representing wxPdfDocument colours. More...

#include <pdfcolour.h>

Public Member Functions
	wxPdfColour ()
	Default constructor.
	wxPdfColour (const unsigned char grayscale)
	Constructor for grayscale colour.
	wxPdfColour (const wxColour &colour)
	Constructor for wxColour colour.
	wxPdfColour (const unsigned char red, const unsigned char green, const unsigned char blue)
	Constructor for RGB colour.
	wxPdfColour (double cyan, double magenta, double yellow, double black)
	Constructor for CMYK colour.
	wxPdfColour (const wxString &name)
	Constructor for named RGB colour.
	wxPdfColour (const wxPdfSpotColour &spotColour, double tint)
	Constructor for named RGB colour.
	wxPdfColour (const wxPdfPattern &pattern)
	Constructor for pattern based colour.
	wxPdfColour (const wxPdfColour &colour)
	Copy constructor.
wxPdfColour &	operator= (const wxPdfColour &colour)
	Assignment operator.
void	SetColour (const unsigned char grayscale=0)
	Set grayscale colour.
void	SetColour (const wxColour &colour)
	Set wxColour colour.
void	SetColour (const unsigned char red, const unsigned char green, const unsigned char blue)
	Set RGB colour.
void	SetColour (double cyan, double magenta, double yellow, double black)
	Set CMYK colour.
void	SetColour (const wxString &name)
	Set a named RGB colour.
void	SetColour (const wxPdfSpotColour &spotColour, double tint)
void	SetColour (const wxPdfPattern &pattern)
const wxString	GetColour (bool drawing) const
wxPdfColourType	GetColourType () const
	Get colour type.
const wxString	GetColourValue () const
bool	Equals (const wxPdfColour &colour) const
	Compare colour.

Protected Member Functions
	wxPdfColour (const wxString &colour, bool intern)
	Constructor for internal colour string representation.

Static Protected Member Functions
static wxColourDatabase *	GetColourDatabase ()
	Get a colour database.

Detailed Description

Class representing wxPdfDocument colours.

Constructor & Destructor Documentation

◆ wxPdfColour() [1/10]

wxPdfColour::wxPdfColour ( )

Default constructor.

Constructs a colour object with an undefined colour

◆ wxPdfColour() [2/10]

wxPdfColour::wxPdfColour ( const unsigned char grayscale )

Constructor for grayscale colour.

Defines a grayscale colour

Parameters

grayscale indicates the gray level. Value between 0 and 255

◆ wxPdfColour() [3/10]

wxPdfColour::wxPdfColour ( const wxColour & colour )

Constructor for wxColour colour.

Defines a wxColour colour.

Parameters

colour defines a wxColour colour composed of a red, green and blue component

◆ wxPdfColour() [4/10]

wxPdfColour::wxPdfColour	(	const unsigned char	red,
		const unsigned char	green,
		const unsigned char	blue )

Constructor for RGB colour.

Defines a RGB colour.

Parameters

red	indicates the red level. Value between 0 and 255
green	indicates the green level. Value between 0 and 255
blue	indicates the blue level. Value between 0 and 255

◆ wxPdfColour() [5/10]

wxPdfColour::wxPdfColour	(	double	cyan,
		double	magenta,
		double	yellow,
		double	black )

Constructor for CMYK colour.

Defines a CMYK colour.

Parameters

cyan	indicates the cyan level. Value between 0 and 100
magenta	indicates the magenta level. Value between 0 and 100
yellow	indicates the yellow level. Value between 0 and 100
black	indicates the black level. Value between 0 and 100

◆ wxPdfColour() [6/10]

wxPdfColour::wxPdfColour ( const wxString & name )

Constructor for named RGB colour.

Defines a named RGB colour.

Parameters

name	is the name of the requested colour. Use of HTML notation #rrggbb as colour name is also supported.

◆ wxPdfColour() [7/10]

wxPdfColour::wxPdfColour	(	const wxPdfSpotColour &	spotColour,
		double	tint )

Constructor for named RGB colour.

Defines a spot colour.

Parameters

spotColour	is the spot colour to be used
tint	indicates the tint level. Value between 0 and 100. Default: 100.

◆ wxPdfColour() [8/10]

wxPdfColour::wxPdfColour ( const wxPdfPattern & pattern )

Constructor for pattern based colour.

Defines a pattern based colour.

Parameters

pattern is the pattern based colour to be used

◆ wxPdfColour() [9/10]

wxPdfColour::wxPdfColour ( const wxPdfColour & colour )

Copy constructor.

Parameters

colour The colour to copy from

◆ wxPdfColour() [10/10]

wxPdfColour::wxPdfColour	(	const wxString &	colour,
		bool	intern )

protected

Constructor for internal colour string representation.

Parameters

colour	Internal colour string
intern	Internal flag

Member Function Documentation

◆ Equals()

bool wxPdfColour::Equals ( const wxPdfColour & colour ) const

Compare colour.

Parameters

colour colour to which the current colour is compared

Returns: true if the colours match, false otherwise

◆ GetColour()

const wxString wxPdfColour::GetColour ( bool drawing ) const

Get internal colour string representation (for internal use only)

Parameters

drawing flag specifying whether the colour is used for drawing operations

Returns: the string representation of the colour

◆ GetColourDatabase()

wxColourDatabase * wxPdfColour::GetColourDatabase ( )

staticprotected

Get a colour database.

Returns: Pointer to the colour database

◆ GetColourType()

wxPdfColourType wxPdfColour::GetColourType ( ) const

inline

Get colour type.

Returns: the colour type of the colour

◆ GetColourValue()

const wxString wxPdfColour::GetColourValue ( ) const

Get internal colour value string representation (for internal use only)

Returns: the string representation of the colour value This method works only for grayscale, rgb and cmyk colours. Don't use it for spot or pattern colours.

◆ operator=()

wxPdfColour & wxPdfColour::operator= ( const wxPdfColour & colour )

Assignment operator.

Parameters

colour The colour to copy from

Returns: A reference to this colour object

◆ SetColour() [1/7]

void wxPdfColour::SetColour ( const unsigned char grayscale = 0 )

Set grayscale colour.

Parameters

grayscale indicates the gray level. Value between 0 and 255. Default: 0 (Black).

◆ SetColour() [2/7]

void wxPdfColour::SetColour	(	const unsigned char	red,
		const unsigned char	green,
		const unsigned char	blue )

Set RGB colour.

Parameters

red	indicates the red level. Value between 0 and 255
green	indicates the green level. Value between 0 and 255
blue	indicates the blue level. Value between 0 and 255

◆ SetColour() [3/7]

void wxPdfColour::SetColour ( const wxColour & colour )

Set wxColour colour.

Parameters

colour defines a wxColour colour composed of a red, green and blue component

◆ SetColour() [4/7]

void wxPdfColour::SetColour ( const wxPdfPattern & pattern )

Set a pattern based colour (internal use only)

Parameters

pattern is the pattern based colour to be used

◆ SetColour() [5/7]

void wxPdfColour::SetColour	(	const wxPdfSpotColour &	spotColour,
		double	tint )

Set a spot colour (internal use only)

Parameters

spotColour	is the spot colour to be used
tint	indicates the tint level. Value between 0 and 100. Default: 100.

◆ SetColour() [6/7]

void wxPdfColour::SetColour ( const wxString & name )

Set a named RGB colour.

Parameters

name	is the name of the requested colour

◆ SetColour() [7/7]

void wxPdfColour::SetColour	(	double	cyan,
		double	magenta,
		double	yellow,
		double	black )

Set CMYK colour.

Parameters

cyan	indicates the cyan level. Value between 0 and 100
magenta	indicates the magenta level. Value between 0 and 100
yellow	indicates the yellow level. Value between 0 and 100
black	indicates the black level. Value between 0 and 100

The documentation for this class was generated from the following file:

E:/github/wxpdfdoc-current/include/wx/pdfcolour.h

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ wxPdfColour() [1/10]

◆ wxPdfColour() [2/10]

◆ wxPdfColour() [3/10]

◆ wxPdfColour() [4/10]

◆ wxPdfColour() [5/10]

◆ wxPdfColour() [6/10]

◆ wxPdfColour() [7/10]

◆ wxPdfColour() [8/10]

◆ wxPdfColour() [9/10]

◆ wxPdfColour() [10/10]

Member Function Documentation

◆ Equals()

◆ GetColour()

◆ GetColourDatabase()

◆ GetColourType()

◆ GetColourValue()

◆ operator=()

◆ SetColour() [1/7]

◆ SetColour() [2/7]

◆ SetColour() [3/7]

◆ SetColour() [4/7]

◆ SetColour() [5/7]

◆ SetColour() [6/7]

◆ SetColour() [7/7]