docs/latex/wx/colour.tex

   1 \section{\class{wxColour}}\label{wxcolour}
   2
   3 A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values,
   4 and is used to determine drawing colours. See the
   5 entry for \helpref{wxColourDatabase}{wxcolourdatabase} for how a pointer to a predefined,
   6 named colour may be returned instead of creating a new colour.
   7
   8 Valid RGB values are in the range 0 to 255.
   9
  10 You can retrieve the current system colour settings with \helpref{wxSystemSettings}{wxsystemsettings}.
  11
  12 \wxheading{Derived from}
  13
  14 \helpref{wxObject}{wxobject}
  15
  16 \wxheading{Include files}
  17
  18 <wx/colour.h>
  19
  20 \wxheading{Predefined objects}
  21
  22 Objects:
  23
  24 {\bf wxNullColour}
  25
  26 Pointers:
  27
  28 {\bf wxBLACK\\
  29 wxWHITE\\
  30 wxRED\\
  31 wxBLUE\\
  32 wxGREEN\\
  33 wxCYAN\\
  34 wxLIGHT\_GREY}
  35
  36 \wxheading{See also}
  37
  38 \helpref{wxColourDatabase}{wxcolourdatabase}, \helpref{wxPen}{wxpen}, \helpref{wxBrush}{wxbrush},\rtfsp
  39 \helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxSystemSettings}{wxsystemsettings}
  40
  41 \latexignore{\rtfignore{\wxheading{Members}}}
  42
  43
  44 \membersection{wxColour::wxColour}\label{wxcolourconstr}
  45
  46 \func{}{wxColour}{\void}
  47
  48 Default constructor.
  49
  50 \func{}{wxColour}{\param{const unsigned char}{ red}, \param{const unsigned char}{ green}, \param{const unsigned char}{ blue}}
  51
  52 Constructs a colour from red, green and blue values.
  53
  54 \func{}{wxColour}{\param{const wxString\& }{colourNname}}
  55
  56 Constructs a colour object using a colour name
  57 listed in {\bf wxTheColourDatabase}.
  58
  59 \func{}{wxColour}{\param{const wxColour\&}{ colour}}
  60
  61 Copy constructor.
  62
  63 \wxheading{Parameters}
  64
  65 \docparam{red}{The red value.}
  66
  67 \docparam{green}{The green value.}
  68
  69 \docparam{blue}{The blue value.}
  70
  71 \docparam{colourName}{The colour name.}
  72
  73 \docparam{colour}{The colour to copy.}
  74
  75 \wxheading{See also}
  76
  77 \helpref{wxColourDatabase}{wxcolourdatabase}
  78
  79 \pythonnote{Constructors supported by wxPython are:\par
  80 \indented{2cm}{\begin{twocollist}
  81 \twocolitem{{\bf wxColour(red=0, green=0, blue=0)}}{}
  82 \twocolitem{{\bf wxNamedColour(name)}}{}
  83 \end{twocollist}}
  84 }
  85
  86
  87
  88 \membersection{wxColour::Blue}\label{wxcolourblue}
  89
  90 \constfunc{unsigned char}{Blue}{\void}
  91
  92 Returns the blue intensity.
  93
  94
  95 \membersection{wxColour::GetPixel}\label{wxcolourgetpixel}
  96
  97 \constfunc{long}{GetPixel}{\void}
  98
  99 Returns a pixel value which is platform-dependent. On Windows, a COLORREF is returned.
 100 On X, an allocated pixel value is returned.
 101
 102 -1 is returned if the pixel is invalid (on X, unallocated).
 103
 104
 105 \membersection{wxColour::Green}\label{wxcolourgreen}
 106
 107 \constfunc{unsigned char}{Green}{\void}
 108
 109 Returns the green intensity.
 110
 111
 112 \membersection{wxColour::Ok}\label{wxcolourok}
 113
 114 \constfunc{bool}{Ok}{\void}
 115
 116 Returns \true if the colour object is valid (the colour has been initialised with RGB values).
 117
 118
 119 \membersection{wxColour::Red}\label{wxcolourred}
 120
 121 \constfunc{unsigned char}{Red}{\void}
 122
 123 Returns the red intensity.
 124
 125
 126 \membersection{wxColour::Set}\label{wxcolourset}
 127
 128 \func{void}{Set}{\param{const unsigned char}{ red}, \param{const unsigned char}{ green}, \param{const unsigned char}{ blue}}
 129
 130 Sets the RGB intensity values.
 131
 132
 133 \membersection{wxColour::operator $=$}\label{wxcolourassign}
 134
 135 \func{wxColour\&}{operator $=$}{\param{const wxColour\&}{ colour}}
 136
 137 Assignment operator, taking another colour object.
 138
 139 \func{wxColour\&}{operator $=$}{\param{const wxString\&}{ colourName}}
 140
 141 Assignment operator, using a colour name to be found in the colour database.
 142
 143 \wxheading{See also}
 144
 145 \helpref{wxColourDatabase}{wxcolourdatabase}
 146
 147
 148 \membersection{wxColour::operator $==$}\label{wxcolourequality}
 149
 150 \func{bool}{operator $==$}{\param{const wxColour\&}{ colour}}
 151
 152 Tests the equality of two colours by comparing individual red, green blue colours.
 153
 154
 155 \membersection{wxColour::operator $!=$}\label{wxcolourinequality}
 156
 157 \func{bool}{operator $!=$}{\param{const wxColour\&}{ colour}}
 158
 159 Tests the inequality of two colours by comparing individual red, green blue colours.
 160
 161 \section{\class{wxColourData}}\label{wxcolourdata}
 162
 163 This class holds a variety of information related to colour dialogs.
 164
 165 \wxheading{Derived from}
 166
 167 \helpref{wxObject}{wxobject}
 168
 169 \wxheading{Include files}
 170
 171 <wx/cmndata.h>
 172
 173 \wxheading{See also}
 174
 175 \helpref{wxColour}{wxcolour}, \helpref{wxColourDialog}{wxcolourdialog}, \helpref{wxColourDialog overview}{wxcolourdialogoverview}
 176
 177 \latexignore{\rtfignore{\wxheading{Members}}}
 178
 179
 180 \membersection{wxColourData::wxColourData}\label{wxcolourdataconstr}
 181
 182 \func{}{wxColourData}{\void}
 183
 184 Constructor. Initializes the custom colours to {\tt wxNullColour},
 185 the {\it data colour} setting
 186 to black, and the {\it choose full} setting to true.
 187
 188
 189 \membersection{wxColourData::\destruct{wxColourData}}
 190
 191 \func{}{\destruct{wxColourData}}{\void}
 192
 193 Destructor.
 194
 195
 196 \membersection{wxColourData::GetChooseFull}\label{wxcolourdatagetchoosefull}
 197
 198 \constfunc{bool}{GetChooseFull}{\void}
 199
 200 Under Windows, determines whether the Windows colour dialog will display the full dialog
 201 with custom colour selection controls. Has no meaning under other platforms.
 202
 203 The default value is true.
 204
 205
 206 \membersection{wxColourData::GetColour}\label{wxcolourdatagetcolour}
 207
 208 \constfunc{wxColour\&}{GetColour}{\void}
 209
 210 Gets the current colour associated with the colour dialog.
 211
 212 The default colour is black.
 213
 214
 215 \membersection{wxColourData::GetCustomColour}\label{wxcolourdatagetcustomcolour}
 216
 217 \constfunc{wxColour\&}{GetCustomColour}{\param{int}{ i}}
 218
 219 Gets the {\it i}th custom colour associated with the colour dialog. {\it i} should
 220 be an integer between 0 and 15.
 221
 222 The default custom colours are invalid colours.
 223
 224
 225 \membersection{wxColourData::SetChooseFull}\label{wxcolourdatasetchoosefull}
 226
 227 \func{void}{SetChooseFull}{\param{const bool }{flag}}
 228
 229 Under Windows, tells the Windows colour dialog to display the full dialog
 230 with custom colour selection controls. Under other platforms, has no effect.
 231
 232 The default value is true.
 233
 234
 235 \membersection{wxColourData::SetColour}\label{wxcolourdatasetcolour}
 236
 237 \func{void}{SetColour}{\param{const wxColour\&}{ colour}}
 238
 239 Sets the default colour for the colour dialog.
 240
 241 The default colour is black.
 242
 243
 244 \membersection{wxColourData::SetCustomColour}\label{wxcolourdatasetcustomcolour}
 245
 246 \func{void}{SetCustomColour}{\param{int}{ i}, \param{const wxColour\&}{ colour}}
 247
 248 Sets the {\it i}th custom colour for the colour dialog. {\it i} should
 249 be an integer between 0 and 15.
 250
 251 The default custom colours are invalid colours.
 252
 253
 254 \membersection{wxColourData::operator $=$}\label{wxcolourdataassign}
 255
 256 \func{void}{operator $=$}{\param{const wxColourData\&}{ data}}
 257
 258 Assignment operator for the colour data.
 259
 260
 261
 262
 263 \section{\class{wxColourDatabase}}\label{wxcolourdatabase}
 264
 265 wxWidgets maintains a database of standard RGB colours for a predefined
 266 set of named colours (such as ``BLACK'', ``LIGHT GREY''). The
 267 application may add to this set if desired by using
 268 \helpref{AddColour}{wxcolourdatabaseaddcolour} and may use it to look up
 269 colours by names using \helpref{Find}{wxcolourdatabasefind} or find the names
 270 for the standard colour suing \helpref{FindName}{wxcolourdatabasefindname}.
 271
 272 There is one predefined instance of this class called
 273 {\bf wxTheColourDatabase}.
 274
 275 \wxheading{Derived from}
 276
 277 None
 278
 279 \wxheading{Include files}
 280
 281 <wx/gdicmn.h>
 282
 283 \wxheading{Remarks}
 284
 285 The standard database contains at least the following colours:
 286
 287 AQUAMARINE, BLACK, BLUE, BLUE VIOLET, BROWN, CADET BLUE, CORAL,
 288 CORNFLOWER BLUE, CYAN, DARK GREY, DARK GREEN, DARK OLIVE GREEN, DARK
 289 ORCHID, DARK SLATE BLUE, DARK SLATE GREY DARK TURQUOISE, DIM GREY,
 290 FIREBRICK, FOREST GREEN, GOLD, GOLDENROD, GREY, GREEN, GREEN YELLOW,
 291 INDIAN RED, KHAKI, LIGHT BLUE, LIGHT GREY, LIGHT STEEL BLUE, LIME GREEN,
 292 MAGENTA, MAROON, MEDIUM AQUAMARINE, MEDIUM BLUE, MEDIUM FOREST GREEN,
 293 MEDIUM GOLDENROD, MEDIUM ORCHID, MEDIUM SEA GREEN, MEDIUM SLATE BLUE,
 294 MEDIUM SPRING GREEN, MEDIUM TURQUOISE, MEDIUM VIOLET RED, MIDNIGHT BLUE,
 295 NAVY, ORANGE, ORANGE RED, ORCHID, PALE GREEN, PINK, PLUM, PURPLE, RED,
 296 SALMON, SEA GREEN, SIENNA, SKY BLUE, SLATE BLUE, SPRING GREEN, STEEL
 297 BLUE, TAN, THISTLE, TURQUOISE, VIOLET, VIOLET RED, WHEAT, WHITE, YELLOW,
 298 YELLOW GREEN.
 299
 300 \wxheading{See also}
 301
 302 \helpref{wxColour}{wxcolour}
 303
 304 \latexignore{\rtfignore{\wxheading{Members}}}
 305
 306
 307 \membersection{wxColourDatabase::wxColourDatabase}\label{wxcolourdatabaseconstr}
 308
 309 \func{}{wxColourDatabase}{\void}
 310
 311 Constructs the colour database. It will be initialized at the first use.
 312
 313
 314 \membersection{wxColourDatabase::AddColour}\label{wxcolourdatabaseaddcolour}
 315
 316 \func{void}{AddColour}{\param{const wxString\& }{colourName}, \param{const wxColour\&}{colour}}
 317
 318 \func{void}{AddColour}{\param{const wxString\& }{colourName}, \param{wxColour* }{colour}}
 319
 320 Adds a colour to the database. If a colour with the same name already exists,
 321 it is replaced.
 322
 323 Please note that the overload taking a pointer is deprecated and will be
 324 removed in the next wxWidgets version, please don't use it.
 325
 326
 327 \membersection{wxColourDatabase::Find}\label{wxcolourdatabasefind}
 328
 329 \func{wxColour}{FindColour}{\param{const wxString\& }{colourName}}
 330
 331 Finds a colour given the name. Returns an invalid colour object (that is, such
 332 that its \helpref{Ok()}{wxcolourok} method returns \false) if the colour wasn't
 333 found in the database.
 334
 335
 336 \membersection{wxColourDatabase::FindColour}\label{wxcolourdatabasefindcolour}
 337
 338 \func{wxColour*}{FindColour}{\param{const wxString\& }{colourName}}
 339
 340 Finds a colour given the name. Returns {\tt NULL} if not found or a pointer which
 341 must be deleted by the caller otherwise.
 342
 343 Please note that this method is deprecated and will be removed in the next
 344 wxWidgets version, please use \helpref{Find}{wxcolourdatabasefind} instead of
 345 it.
 346
 347
 348 \membersection{wxColourDatabase::FindName}\label{wxcolourdatabasefindname}
 349
 350 \constfunc{wxString}{FindName}{\param{const wxColour\&}{ colour}}
 351
 352 Finds a colour name given the colour. Returns an empty string if the colour is
 353 not found in the database.
 354
 355