]> git.saurik.com Git - wxWidgets.git/blame - include/wx/motif/colour.h
Fixed return code of GetSelectionCount()
[wxWidgets.git] / include / wx / motif / colour.h
CommitLineData
9b6dbb09
JS
1/////////////////////////////////////////////////////////////////////////////
2// Name: colour.h
3// Purpose: wxColour class
4// Author: Julian Smart
5// Modified by:
6// Created: 17/09/98
7// RCS-ID: $Id$
8// Copyright: (c) Julian Smart
9// Licence: wxWindows licence
10/////////////////////////////////////////////////////////////////////////////
11
12#ifndef _WX_COLOUR_H_
13#define _WX_COLOUR_H_
14
15#ifdef __GNUG__
16#pragma interface "colour.h"
17#endif
18
19#include "wx/object.h"
20#include "wx/string.h"
21
22// Colour
e4a81a2e 23class WXDLLEXPORT wxColour : public wxObject
9b6dbb09 24{
0d57be45 25DECLARE_DYNAMIC_CLASS(wxColour)
9b6dbb09 26public:
e4a81a2e
VZ
27 // ctors
28 // default
9b6dbb09 29 wxColour();
e4a81a2e 30 // from RGB
87832b70 31 wxColour( unsigned char red, unsigned char green, unsigned char blue );
e4a81a2e
VZ
32 // implicit conversion from the colour name
33 wxColour( const wxString &colourName ) { InitFromName(colourName); }
34 wxColour( const char *colourName ) { InitFromName(colourName); }
35
36 // copy ctors and assignment operators
37 wxColour( const wxColour& col );
38 wxColour( const wxColour* col );
39 wxColour& operator = ( const wxColour& col );
40
41 // dtor
42 ~wxColour();
43
44 // Set() functions
45 void Set( unsigned char red, unsigned char green, unsigned char blue );
46 void Set( unsigned long colRGB )
47 {
9b6dbb09
JS
48 // we don't need to know sizeof(long) here because we assume that the three
49 // least significant bytes contain the R, G and B values
e4a81a2e 50 Set((unsigned char)colRGB,
9b6dbb09 51 (unsigned char)(colRGB >> 8),
e4a81a2e 52 (unsigned char)(colRGB >> 16));
9b6dbb09
JS
53 }
54
e4a81a2e
VZ
55 // accessors
56 bool Ok() const {return m_isInit; }
0d57be45
JS
57 unsigned char Red() const { return m_red; }
58 unsigned char Green() const { return m_green; }
59 unsigned char Blue() const { return m_blue; }
9b6dbb09 60
e4a81a2e
VZ
61 int GetPixel() const { return m_pixel; };
62 void SetPixel(int pixel) { m_pixel = pixel; m_isInit = TRUE; };
dfc54541 63
0d57be45
JS
64 inline bool operator == (const wxColour& colour) { return (m_red == colour.m_red && m_green == colour.m_green && m_blue == colour.m_blue); }
65
66 inline bool operator != (const wxColour& colour) { return (!(m_red == colour.m_red && m_green == colour.m_green && m_blue == colour.m_blue)); }
67
dfc54541
JS
68 // Allocate a colour, or nearest colour, using the given display.
69 // If realloc is TRUE, ignore the existing pixel, otherwise just return
70 // the existing one.
16c1f7f3 71 // Returns the allocated pixel.
dfc54541
JS
72
73 // TODO: can this handle mono displays? If not, we should have an extra
74 // flag to specify whether this should be black or white by default.
75
16c1f7f3 76 int AllocColour(WXDisplay* display, bool realloc = FALSE);
9b6dbb09 77
0d57be45
JS
78 void InitFromName(const wxString& col);
79
e4a81a2e 80private:
dfc54541 81 bool m_isInit;
9b6dbb09
JS
82 unsigned char m_red;
83 unsigned char m_blue;
84 unsigned char m_green;
dfc54541 85
e4a81a2e
VZ
86public:
87 int m_pixel;
9b6dbb09
JS
88};
89
9b6dbb09
JS
90#endif
91 // _WX_COLOUR_H_