wxPdfColour Class Reference

Class representing wxPdfDocument colors. More...

#include <pdfproperties.h>

List of all members.

Public Member Functions

 wxPdfColour ()
 Default constructor.
 wxPdfColour (const unsigned char grayscale)
 Constructor for grayscale color.
 wxPdfColour (const wxColour &color)
 Constructor for wxColour color.
 wxPdfColour (const unsigned char red, const unsigned char green, const unsigned char blue)
 Constructor for RGB color.
 wxPdfColour (double cyan, double magenta, double yellow, double black)
 Constructor for CMYK color.
 wxPdfColour (const wxString &name)
 Constructor for named RGB color.
 wxPdfColour (const wxPdfSpotColour &spotColor, double tint)
 Constructor for named RGB color.
 wxPdfColour (const wxPdfColour &color)
 Copy constructor.
wxPdfColouroperator= (const wxPdfColour &color)
 Assignment operator.
void SetColor (const unsigned char grayscale=0)
 Set grayscale color.
void SetColor (const wxColour &color)
 Set wxColour color.
void SetColor (const unsigned char red, const unsigned char green, const unsigned char blue)
 Set RGB color.
void SetColor (double cyan, double magenta, double yellow, double black)
 Set CMYK color.
void SetColor (const wxString &name)
 Set a named RGB color.
void SetColor (const wxPdfSpotColour &spotColor, double tint)
 Set a spot color (internal use only).
const wxString GetColor (bool drawing) const
 Get internal color string representation (for internal use only).
wxPdfColourType GetColorType () const
 Get color type.
const wxString GetColorValue () const
 Get internal color value string representation (for internal use only).
bool Equals (const wxPdfColour &color) const
 Compare color.

Protected Member Functions

 wxPdfColour (const wxString &color, bool WXUNUSED(internal))
 Constructor for internal color string representation.

Static Protected Member Functions

static wxColourDatabase * GetColorDatabase ()
 Get a color database.


Detailed Description

Class representing wxPdfDocument colors.


Constructor & Destructor Documentation

wxPdfColour::wxPdfColour (  ) 

Default constructor.

Constructs a color object with an undefined color

wxPdfColour::wxPdfColour ( const unsigned char  grayscale  ) 

Constructor for grayscale color.

Defines a grayscale color

Parameters:
grayscale indicates the gray level. Value between 0 and 255

wxPdfColour::wxPdfColour ( const wxColour &  color  ) 

Constructor for wxColour color.

Defines a wxColour color.

Parameters:
color defines a wxColour color composed of a red, green and blue component

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

Constructor for RGB color.

Defines a RGB color.

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::wxPdfColour ( double  cyan,
double  magenta,
double  yellow,
double  black 
)

Constructor for CMYK color.

Defines a CMYK color.

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::wxPdfColour ( const wxString &  name  ) 

Constructor for named RGB color.

Defines a named RGB color.

Parameters:
name is the name of the requested color. Use of HTML notation #rrggbb as color name is also supported.

wxPdfColour::wxPdfColour ( const wxPdfSpotColour spotColor,
double  tint 
)

Constructor for named RGB color.

Defines a spot color.

Parameters:
spotColor is the spot color to be used
tint indicates the tint level. Value between 0 and 100. Default: 100.

wxPdfColour::wxPdfColour ( const wxPdfColour color  ) 

Copy constructor.

wxPdfColour::wxPdfColour ( const wxString &  color,
bool   WXUNUSED(internal) 
) [protected]

Constructor for internal color string representation.


Member Function Documentation

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

Assignment operator.

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

Set grayscale color.

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

void wxPdfColour::SetColor ( const wxColour &  color  ) 

Set wxColour color.

Parameters:
color defines a wxColour color composed of a red, green and blue component

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

Set RGB color.

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

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

Set CMYK color.

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

void wxPdfColour::SetColor ( const wxString &  name  ) 

Set a named RGB color.

Parameters:
name is the name of the requested color

void wxPdfColour::SetColor ( const wxPdfSpotColour spotColor,
double  tint 
)

Set a spot color (internal use only).

Parameters:
spotColor is the spot color to be used
tint indicates the tint level. Value between 0 and 100. Default: 100.

const wxString wxPdfColour::GetColor ( bool  drawing  )  const

Get internal color string representation (for internal use only).

Parameters:
drawing flag specifying whether the color is used for drawing operations

wxPdfColourType wxPdfColour::GetColorType (  )  const [inline]

Get color type.

const wxString wxPdfColour::GetColorValue (  )  const

Get internal color value string representation (for internal use only).

bool wxPdfColour::Equals ( const wxPdfColour color  )  const

Compare color.

wxColourDatabase * wxPdfColour::GetColorDatabase (  )  [static, protected]

Get a color database.


The documentation for this class was generated from the following files:
Generated on Fri Dec 15 21:30:37 2006 for wxPdfDocument by  doxygen 1.5.1-p1