| 1 |
// -*- mode: C++; indent-tabs-mode: nil; c-basic-offset: 2; -*- |
| 2 |
// Color.hh for Blackbox - an X11 Window manager |
| 3 |
// Copyright (c) 2001 - 2005 Sean 'Shaleh' Perry <shaleh at debian.org> |
| 4 |
// Copyright (c) 1997 - 2000, 2002 - 2005 |
| 5 |
// Bradley T Hughes <bhughes at trolltech.com> |
| 6 |
// |
| 7 |
// Permission is hereby granted, free of charge, to any person obtaining a |
| 8 |
// copy of this software and associated documentation files (the "Software"), |
| 9 |
// to deal in the Software without restriction, including without limitation |
| 10 |
// the rights to use, copy, modify, merge, publish, distribute, sublicense, |
| 11 |
// and/or sell copies of the Software, and to permit persons to whom the |
| 12 |
// Software is furnished to do so, subject to the following conditions: |
| 13 |
// |
| 14 |
// The above copyright notice and this permission notice shall be included in |
| 15 |
// all copies or substantial portions of the Software. |
| 16 |
// |
| 17 |
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 18 |
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 19 |
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL |
| 20 |
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 21 |
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING |
| 22 |
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER |
| 23 |
// DEALINGS IN THE SOFTWARE. |
| 24 |
|
| 25 |
#ifndef __Color_hh |
| 26 |
#define __Color_hh |
| 27 |
|
| 28 |
#include <string> |
| 29 |
|
| 30 |
namespace bt { |
| 31 |
|
| 32 |
// forward declarations |
| 33 |
class Display; |
| 34 |
class PenCache; |
| 35 |
|
| 36 |
/* |
| 37 |
The color object. Colors are stored in rgb format (screen |
| 38 |
independent). Screen dependent pixel values can be obtained using |
| 39 |
the pixel() function. |
| 40 |
*/ |
| 41 |
class Color { |
| 42 |
public: |
| 43 |
/* |
| 44 |
Frees unused colors on all screens. |
| 45 |
*/ |
| 46 |
static void clearCache(void); |
| 47 |
|
| 48 |
/* |
| 49 |
Returns the named color on the specified display and screen. If |
| 50 |
the color couldn't be found, an invalid color is returned. |
| 51 |
*/ |
| 52 |
static Color namedColor(const Display &display, unsigned int screen, |
| 53 |
const std::string &colorname); |
| 54 |
|
| 55 |
explicit inline Color(int r = -1, int g = -1, int b = -1) |
| 56 |
: _red(r), _green(g), _blue(b), |
| 57 |
_screen(~0u), _pixel(0ul) |
| 58 |
{ } |
| 59 |
inline Color(const Color &c) |
| 60 |
: _red(c._red), _green(c._green), _blue(c._blue), |
| 61 |
_screen(~0u), _pixel(0ul) |
| 62 |
{ } |
| 63 |
inline ~Color(void) |
| 64 |
{ deallocate(); } |
| 65 |
|
| 66 |
inline int red(void) const |
| 67 |
{ return _red; } |
| 68 |
inline int green(void) const |
| 69 |
{ return _green; } |
| 70 |
inline int blue(void) const |
| 71 |
{ return _blue; } |
| 72 |
inline void setRGB(int r, int g, int b) |
| 73 |
{ deallocate(); _red = r; _green = g; _blue = b; } |
| 74 |
|
| 75 |
unsigned long pixel(unsigned int screen) const; |
| 76 |
|
| 77 |
inline bool valid(void) const |
| 78 |
{ return _red != -1 && _green != -1 && _blue != -1; } |
| 79 |
|
| 80 |
// operators |
| 81 |
inline Color &operator=(const Color &c) |
| 82 |
{ setRGB(c._red, c._green, c._blue); return *this; } |
| 83 |
inline bool operator==(const Color &c) const |
| 84 |
{ return _red == c._red && _green == c._green && _blue == c._blue; } |
| 85 |
inline bool operator!=(const Color &c) const |
| 86 |
{ return !operator==(c); } |
| 87 |
|
| 88 |
private: |
| 89 |
void deallocate(void); |
| 90 |
|
| 91 |
int _red, _green, _blue; |
| 92 |
mutable unsigned int _screen; |
| 93 |
mutable unsigned long _pixel; |
| 94 |
|
| 95 |
friend class PenCache; |
| 96 |
}; |
| 97 |
|
| 98 |
} // namespace bt |
| 99 |
|
| 100 |
#endif // __Color_hh |