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 , InitFromName(const wxString& colourName),
 113         "Sets the RGB intensity values using a colour name listed in
 114 ``wx.TheColourDatabase``.", "",
 115         SetFromName);
 116
 117     DocDeclStr(
 118         wxString , GetAsString(long flags = wxC2S_NAME | wxC2S_CSS_SYNTAX) const,
 119         "Return the colour as a string.  Acceptable flags are:
 120
 121             =================== ==================================
 122             wx.C2S_NAME          return colour name, when possible
 123             wx.C2S_CSS_SYNTAX    return colour in rgb(r,g,b) syntax
 124             wx.C2S_HTML_SYNTAX   return colour in #rrggbb syntax
 125             =================== ==================================", "");
 126
 127
 128     DocDeclStr(
 129         long , GetPixel() const,
 130         "Returns a pixel value which is platform-dependent. On Windows, a
 131 COLORREF is returned. On X, an allocated pixel value is returned.  -1
 132 is returned if the pixel is invalid (on X, unallocated).", "");
 133
 134
 135     %extend {
 136         KeepGIL(__eq__);
 137         DocStr(__eq__, "Compare colours for equality.", "");
 138         bool __eq__(PyObject* other) {
 139             wxColour  temp, *obj = &temp;
 140             if ( other == Py_None ) return false;
 141             if ( ! wxColour_helper(other, &obj) ) {
 142                 PyErr_Clear();
 143                 return false;
 144             }
 145             return self->operator==(*obj);
 146         }
 147
 148
 149         KeepGIL(__ne__);
 150         DocStr(__ne__, "Compare colours for inequality.", "");
 151         bool __ne__(PyObject* other) {
 152             wxColour  temp, *obj = &temp;
 153             if ( other == Py_None ) return true;
 154             if ( ! wxColour_helper(other, &obj)) {
 155                 PyErr_Clear();
 156                 return true;
 157             }
 158             return self->operator!=(*obj);
 159         }
 160     }
 161
 162
 163     %extend {
 164         KeepGIL(Get);
 165         DocAStr(Get,
 166                 "Get() -> (r, g, b)",
 167                 "Returns the RGB intensity values as a tuple.", "");
 168         PyObject* Get(bool includeAlpha=false) {
 169             PyObject* rv = PyTuple_New(includeAlpha ? 4 : 3);
 170             int red = -1;
 171             int green = -1;
 172             int blue = -1;
 173             int alpha = wxALPHA_OPAQUE;
 174             if (self->Ok()) {
 175                 red =   self->Red();
 176                 green = self->Green();
 177                 blue =  self->Blue();
 178                 alpha = self->Alpha();
 179             }
 180             PyTuple_SetItem(rv, 0, PyInt_FromLong(red));
 181             PyTuple_SetItem(rv, 1, PyInt_FromLong(green));
 182             PyTuple_SetItem(rv, 2, PyInt_FromLong(blue));
 183             if (includeAlpha)
 184                 PyTuple_SetItem(rv, 3, PyInt_FromLong(alpha));
 185             return rv;
 186         }
 187
 188         KeepGIL(GetRGB);
 189         DocStr(GetRGB,
 190                "Return the colour as a packed RGB value", "");
 191         unsigned long GetRGB() {
 192             return self->Red() | (self->Green() << 8) | (self->Blue() << 16);
 193         }
 194     }
 195
 196
 197     %pythoncode {
 198         asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead")
 199         def __str__(self):                  return str(self.Get(True))
 200         def __repr__(self):                 return 'wx.Colour' + str(self.Get(True))
 201         def __nonzero__(self):              return self.Ok()
 202         __safe_for_unpickling__ = True
 203         def __reduce__(self):               return (Colour, self.Get(True))
 204         }
 205 };
 206
 207 %pythoncode {
 208     Color = Colour
 209     NamedColor = NamedColour
 210     ColorRGB = ColourRGB
 211 }
 212
 213 //---------------------------------------------------------------------------
 214