|
wxPdfDocument 0.9.2
|
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) |
| Set a spot colour (internal use only) | |
| void | SetColour (const wxPdfPattern &pattern) |
| Set a pattern based colour (internal use only) | |
| const wxString | GetColour (bool drawing) const |
| Get internal colour string representation (for internal use only) | |
| wxPdfColourType | GetColourType () const |
| Get colour type. | |
| const wxString | GetColourValue () const |
| Get internal colour value string representation (for internal use only) | |
| 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. | |
Class representing wxPdfDocument colours.
| wxPdfColour::wxPdfColour | ( | ) |
Default constructor.
Constructs a colour object with an undefined colour
| wxPdfColour::wxPdfColour | ( | const unsigned char | grayscale | ) |
Constructor for grayscale colour.
Defines a grayscale colour
| grayscale | indicates the gray level. Value between 0 and 255 |
| wxPdfColour::wxPdfColour | ( | const wxColour & | colour | ) |
Constructor for wxColour colour.
Defines a wxColour colour.
| colour | defines a wxColour colour 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 colour.
Defines a RGB colour.
| 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 colour.
Defines a CMYK colour.
| 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 colour.
Defines a named RGB colour.
| name | is the name of the requested colour. Use of HTML notation #rrggbb as colour name is also supported. |
| wxPdfColour::wxPdfColour | ( | const wxPdfSpotColour & | spotColour, |
| double | tint | ||
| ) |
Constructor for named RGB colour.
Defines a spot colour.
| spotColour | is the spot colour to be used |
| tint | indicates the tint level. Value between 0 and 100. Default: 100. |
| wxPdfColour::wxPdfColour | ( | const wxPdfPattern & | pattern | ) |
Constructor for pattern based colour.
Defines a pattern based colour.
| pattern | is the pattern based colour to be used |
| wxPdfColour::wxPdfColour | ( | const wxPdfColour & | colour | ) |
Copy constructor.
| wxPdfColour::wxPdfColour | ( | const wxString & | colour, |
| bool | intern | ||
| ) | [protected] |
Constructor for internal colour string representation.
| bool wxPdfColour::Equals | ( | const wxPdfColour & | colour | ) | const |
Compare colour.
| colour | colour to which the current colour is compared |
| const wxString wxPdfColour::GetColour | ( | bool | drawing | ) | const |
Get internal colour string representation (for internal use only)
| drawing | flag specifying whether the colour is used for drawing operations |
| static wxColourDatabase* wxPdfColour::GetColourDatabase | ( | ) | [static, protected] |
Get a colour database.
| wxPdfColourType wxPdfColour::GetColourType | ( | ) | const [inline] |
Get colour type.
| const wxString wxPdfColour::GetColourValue | ( | ) | const |
Get internal colour value string representation (for internal use only)
| wxPdfColour& wxPdfColour::operator= | ( | const wxPdfColour & | colour | ) |
Assignment operator.
| void wxPdfColour::SetColour | ( | const wxPdfPattern & | pattern | ) |
Set a pattern based colour (internal use only)
| pattern | is the pattern based colour to be used |
| void wxPdfColour::SetColour | ( | const wxPdfSpotColour & | spotColour, |
| double | tint | ||
| ) |
Set a spot colour (internal use only)
| spotColour | is the spot colour to be used |
| tint | indicates the tint level. Value between 0 and 100. Default: 100. |
| void wxPdfColour::SetColour | ( | const wxColour & | colour | ) |
Set wxColour colour.
| colour | defines a wxColour colour composed of a red, green and blue component |
| void wxPdfColour::SetColour | ( | double | cyan, |
| double | magenta, | ||
| double | yellow, | ||
| double | black | ||
| ) |
Set CMYK colour.
| 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::SetColour | ( | const unsigned char | grayscale = 0 | ) |
Set grayscale colour.
| grayscale | indicates the gray level. Value between 0 and 255. Default: 0 (Black). |
| void wxPdfColour::SetColour | ( | const wxString & | name | ) |
Set a named RGB colour.
| name | is the name of the requested colour |
| void wxPdfColour::SetColour | ( | const unsigned char | red, |
| const unsigned char | green, | ||
| const unsigned char | blue | ||
| ) |
Set RGB colour.
| 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 |
1.7.4