wxPython/src/_colour.i

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        _colour.i
   3 // Purpose:     SWIG interface for wxColour
   4 //
   5 // Author:      Robin Dunn
   6 //
   7 // Created:     7-July-1997
   8 // RCS-ID:      $Id$
   9 // Copyright:   (c) 2003 by Total Control Software
  10 // Licence:     wxWindows license
  11 /////////////////////////////////////////////////////////////////////////////
  12
  13 // Not a %module
  14
  15
  16 //---------------------------------------------------------------------------
  17 %newgroup;
  18
  19
  20 enum {
  21     wxC2S_NAME,             // return colour name, when possible
  22     wxC2S_CSS_SYNTAX,       // return colour in rgb(r,g,b) syntax
  23     wxC2S_HTML_SYNTAX,      // return colour in #rrggbb syntax
  24 };
  25
  26 enum {
  27     wxALPHA_TRANSPARENT,
  28     wxALPHA_OPAQUE
  29 };
  30
  31
  32 DocStr(wxColour,
  33 "A colour is an object representing a combination of Red, Green, and
  34 Blue (RGB) intensity values, and is used to determine drawing colours,
  35 window colours, etc.  Valid RGB values are in the range 0 to 255.
  36
  37 In wxPython there are typemaps that will automatically convert from a
  38 colour name, from a '#RRGGBB' colour hex value string, or from a 3
  39 integer tuple to a wx.Colour object when calling C++ methods that
  40 expect a wxColour.  This means that the following are all
  41 equivallent::
  42
  43     win.SetBackgroundColour(wxColour(0,0,255))
  44     win.SetBackgroundColour('BLUE')
  45     win.SetBackgroundColour('#0000FF')
  46     win.SetBackgroundColour((0,0,255))
  47
  48 Additional colour names and their coresponding values can be added
  49 using `wx.ColourDatabase`.  Various system colours (as set in the
  50 user's system preferences) can be retrieved with
  51 `wx.SystemSettings.GetColour`.
  52 ", "");
  53
  54
  55 MustHaveApp( wxColour(const wxString& colorName) );
  56
  57 class wxColour : public wxObject {
  58 public:
  59
  60     DocCtorStr(
  61         wxColour(byte red=0, byte green=0, byte blue=0, byte alpha=wxALPHA_OPAQUE),
  62         "Constructs a colour from red, green and blue values.
  63
  64 :see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`.
  65 ", "");
  66
  67     DocCtorStrName(
  68         wxColour( const wxString& colorName),
  69         "Constructs a colour object using a colour name listed in
  70 ``wx.TheColourDatabase``.", "",
  71         NamedColour);
  72
  73     DocCtorStrName(
  74         wxColour( unsigned long colRGB ),
  75         "Constructs a colour from a packed RGB value.", "",
  76         ColourRGB);
  77
  78     ~wxColour();
  79
  80
  81     DocDeclStr(
  82         byte , Red(),
  83         "Returns the red intensity.", "");
  84
  85     DocDeclStr(
  86         byte , Green(),
  87         "Returns the green intensity.", "");
  88
  89     DocDeclStr(
  90         byte , Blue(),
  91         "Returns the blue intensity.", "");
  92
  93     DocDeclStr(
  94         byte , Alpha(),
  95         "Returns the Alpha value.", "");
  96
  97     DocDeclStr(
  98         bool , Ok(),
  99         "Returns True if the colour object is valid (the colour has been
 100 initialised with RGB values).", "");
 101
 102     DocDeclStr(
 103         void , Set(byte red, byte green, byte blue, byte alpha=wxALPHA_OPAQUE),
 104         "Sets the RGB intensity values.", "");
 105
 106     DocDeclStrName(
 107         void , Set(unsigned long colRGB),
 108         "Sets the RGB intensity values from a packed RGB value.", "",
 109         SetRGB);
 110
 111     DocDeclStrName(
 112         void , Set(const wxString& colourName),
 113         "Sets the RGB intensity values using a colour name listed in
 114 ``wx.TheColourDatabase``.", "",
 115         SetFromName);
 116
 117
 118     DocDeclStr(
 119         wxString , GetAsString(long flags = wxC2S_NAME | wxC2S_CSS_SYNTAX) const,
 120         "Return the colour as a string.  Acceptable flags are:
 121
 122             =================== ==================================
 123             wx.C2S_NAME          return colour name, when possible
 124             wx.C2S_CSS_SYNTAX    return colour in rgb(r,g,b) syntax
 125             wx.C2S_HTML_SYNTAX   return colour in #rrggbb syntax
 126             =================== ==================================", "");
 127
 128
 129     DocDeclStr(
 130         long , GetPixel() const,
 131         "Returns a pixel value which is platform-dependent. On Windows, a
 132 COLORREF is returned. On X, an allocated pixel value is returned.  -1
 133 is returned if the pixel is invalid (on X, unallocated).", "");
 134
 135
 136     %extend {
 137         KeepGIL(__eq__);
 138         DocStr(__eq__, "Compare colours for equality.", "");
 139         bool __eq__(PyObject* other) {
 140             wxColour  temp, *obj = &temp;
 141             if ( other == Py_None ) return false;
 142             if ( ! wxColour_helper(other, &obj) ) {
 143                 PyErr_Clear();
 144                 return false;
 145             }
 146             return self->operator==(*obj);
 147         }
 148
 149
 150         KeepGIL(__ne__);
 151         DocStr(__ne__, "Compare colours for inequality.", "");
 152         bool __ne__(PyObject* other) {
 153             wxColour  temp, *obj = &temp;
 154             if ( other == Py_None ) return true;
 155             if ( ! wxColour_helper(other, &obj)) {
 156                 PyErr_Clear();
 157                 return true;
 158             }
 159             return self->operator!=(*obj);
 160         }
 161     }
 162
 163
 164     %extend {
 165         KeepGIL(Get);
 166         DocAStr(Get,
 167                 "Get() -> (r, g, b)",
 168                 "Returns the RGB intensity values as a tuple.", "");
 169         PyObject* Get(bool includeAlpha=false) {
 170             PyObject* rv = PyTuple_New(includeAlpha ? 4 : 3);
 171             int red = -1;
 172             int green = -1;
 173             int blue = -1;
 174             int alpha = wxALPHA_OPAQUE;
 175             if (self->Ok()) {
 176                 red =   self->Red();
 177                 green = self->Green();
 178                 blue =  self->Blue();
 179                 alpha = self->Alpha();
 180             }
 181             PyTuple_SetItem(rv, 0, PyInt_FromLong(red));
 182             PyTuple_SetItem(rv, 1, PyInt_FromLong(green));
 183             PyTuple_SetItem(rv, 2, PyInt_FromLong(blue));
 184             if (includeAlpha)
 185                 PyTuple_SetItem(rv, 3, PyInt_FromLong(alpha));
 186             return rv;
 187         }
 188
 189         KeepGIL(GetRGB);
 190         DocStr(GetRGB,
 191                "Return the colour as a packed RGB value", "");
 192         unsigned long GetRGB() {
 193             return self->Red() | (self->Green() << 8) | (self->Blue() << 16);
 194         }
 195     }
 196
 197
 198     %pythoncode {
 199         asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
 200         def __str__(self):                  return str(self.Get(True))
 201         def __repr__(self):                 return 'wx.Colour' + str(self.Get(True))
 202         def __nonzero__(self):              return self.Ok()
 203         __safe_for_unpickling__ = True
 204         def __reduce__(self):               return (Colour, self.Get(True))
 205         }
 206
 207     %property(Pixel, GetPixel, doc="See `GetPixel`");
 208     %property(RGB, GetRGB, SetRGB, doc="See `GetRGB` and `SetRGB`");
 209
 210 };
 211
 212 %pythoncode {
 213     Color = Colour
 214     NamedColor = NamedColour
 215     ColorRGB = ColourRGB
 216 }
 217
 218 //---------------------------------------------------------------------------
 219