]> git.saurik.com Git - wxWidgets.git/blob - include/wx/gtk/colour.h
Doc corrections
[wxWidgets.git] / include / wx / gtk / colour.h
1 /////////////////////////////////////////////////////////////////////////////
2 // Name: colour.h
3 // Purpose:
4 // Author: Robert Roebling
5 // Id: $Id$
6 // Copyright: (c) 1998 Robert Roebling
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
9
10
11 #ifndef __GTKCOLOURH__
12 #define __GTKCOLOURH__
13
14 #ifdef __GNUG__
15 #pragma interface
16 #endif
17
18 #include "wx/defs.h"
19 #include "wx/object.h"
20 #include "wx/string.h"
21 #include "wx/gdiobj.h"
22 #include "wx/palette.h"
23
24 //-----------------------------------------------------------------------------
25 // classes
26 //-----------------------------------------------------------------------------
27
28 class wxDC;
29 class wxPaintDC;
30 class wxBitmap;
31 class wxWindow;
32
33 class wxColour;
34
35 //-----------------------------------------------------------------------------
36 // wxColour
37 //-----------------------------------------------------------------------------
38
39 class wxColour: public wxGDIObject
40 {
41 public:
42 // ctors
43 // default
44 wxColour();
45 // from RGB
46 wxColour( unsigned char red, unsigned char green, unsigned char blue );
47 // implicit conversion from the colour name
48 wxColour( const wxString &colourName ) { InitFromName(colourName); }
49 wxColour( const char *colourName ) { InitFromName(colourName); }
50
51 // copy ctors and assignment operators
52 wxColour( const wxColour& col );
53 wxColour( const wxColour* col );
54 wxColour& operator = ( const wxColour& col );
55
56 // dtor
57 ~wxColour();
58
59 // comparison
60 bool operator == ( const wxColour& col );
61 bool operator != ( const wxColour& col );
62
63 // accessors
64 void Set( unsigned char red, unsigned char green, unsigned char blue );
65 unsigned char Red() const;
66 unsigned char Green() const;
67 unsigned char Blue() const;
68 bool Ok() const;
69
70 // implementation
71 void CalcPixel( GdkColormap *cmap );
72 int GetPixel() const;
73 GdkColor *GetColor() const;
74
75 protected:
76 // helper functions
77 void InitFromName(const wxString& colourName);
78
79 private:
80 DECLARE_DYNAMIC_CLASS(wxColour)
81 };
82
83 #endif // __GTKCOLOURH__