]> git.saurik.com Git - wxWidgets.git/blame_incremental - include/wx/motif/colour.h
Fixed MinGW/configure/Unicode compilation: MinGW/MSVCRT vswprintf does not
[wxWidgets.git] / include / wx / motif / colour.h
... / ...
CommitLineData
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
23class WXDLLEXPORT wxColour : public wxObject
24{
25 DECLARE_DYNAMIC_CLASS(wxColour)
26public:
27 // ctors
28 // default
29 wxColour();
30 // from RGB
31 wxColour( unsigned char red, unsigned char green, unsigned char blue );
32 wxColour( unsigned long colRGB ) { Set(colRGB); }
33
34 // implicit conversion from the colour name
35 wxColour( const wxString &colourName ) { InitFromName(colourName); }
36 wxColour( const char *colourName ) { InitFromName(colourName); }
37
38 // copy ctors and assignment operators
39 wxColour( const wxColour& col );
40 wxColour& operator = ( const wxColour& col );
41
42 // dtor
43 ~wxColour();
44
45 // Set() functions
46 void Set( unsigned char red, unsigned char green, unsigned char blue );
47 void Set( unsigned long colRGB )
48 {
49 // we don't need to know sizeof(long) here because we assume that the three
50 // least significant bytes contain the R, G and B values
51 Set((unsigned char)colRGB,
52 (unsigned char)(colRGB >> 8),
53 (unsigned char)(colRGB >> 16));
54 }
55
56 // accessors
57 bool Ok() const {return m_isInit; }
58 unsigned char Red() const { return m_red; }
59 unsigned char Green() const { return m_green; }
60 unsigned char Blue() const { return m_blue; }
61
62 int GetPixel() const { return m_pixel; };
63 void SetPixel(int pixel) { m_pixel = pixel; m_isInit = TRUE; };
64
65 inline bool operator == (const wxColour& colour) const { return (m_red == colour.m_red && m_green == colour.m_green && m_blue == colour.m_blue); }
66
67 inline bool operator != (const wxColour& colour) const { return (!(m_red == colour.m_red && m_green == colour.m_green && m_blue == colour.m_blue)); }
68
69 // Allocate a colour, or nearest colour, using the given display.
70 // If realloc is TRUE, ignore the existing pixel, otherwise just return
71 // the existing one.
72 // Returns the allocated pixel.
73
74 // TODO: can this handle mono displays? If not, we should have an extra
75 // flag to specify whether this should be black or white by default.
76
77 int AllocColour(WXDisplay* display, bool realloc = FALSE);
78
79 void InitFromName(const wxString& col);
80
81private:
82 bool m_isInit;
83 unsigned char m_red;
84 unsigned char m_blue;
85 unsigned char m_green;
86
87public:
88 int m_pixel;
89};
90
91#endif
92// _WX_COLOUR_H_