X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d07d2bc9d05408c58b76c53a0a291915b88e5064..0a5bb138a71dfc1c706fc0858fb2801500e2c2e8:/wxPython/src/_colour.i diff --git a/wxPython/src/_colour.i b/wxPython/src/_colour.i index c0a53a5a03..23ddd08c3c 100644 --- a/wxPython/src/_colour.i +++ b/wxPython/src/_colour.i @@ -17,19 +17,33 @@ %newgroup; +enum { + wxC2S_NAME, // return colour name, when possible + wxC2S_CSS_SYNTAX, // return colour in rgb(r,g,b) syntax + wxC2S_HTML_SYNTAX, // return colour in #rrggbb syntax +}; + +enum { + wxALPHA_TRANSPARENT, + wxALPHA_OPAQUE +}; + + DocStr(wxColour, "A colour is an object representing a combination of Red, Green, and Blue (RGB) intensity values, and is used to determine drawing colours, window colours, etc. Valid RGB values are in the range 0 to 255. In wxPython there are typemaps that will automatically convert from a -colour name, or from a '#RRGGBB' colour hex value string to a -wx.Colour object when calling C++ methods that expect a wxColour. -This means that the following are all equivallent:: +colour name, from a '#RRGGBB' colour hex value string, or from a 3 +integer tuple to a wx.Colour object when calling C++ methods that +expect a wxColour. This means that the following are all +equivallent:: win.SetBackgroundColour(wxColour(0,0,255)) win.SetBackgroundColour('BLUE') win.SetBackgroundColour('#0000FF') + win.SetBackgroundColour((0,0,255)) Additional colour names and their coresponding values can be added using `wx.ColourDatabase`. Various system colours (as set in the @@ -38,11 +52,13 @@ user's system preferences) can be retrieved with ", ""); +MustHaveApp( wxColour(const wxString& colorName) ); + class wxColour : public wxObject { public: DocCtorStr( - wxColour(byte red=0, byte green=0, byte blue=0), + wxColour(byte red=0, byte green=0, byte blue=0, byte alpha=wxALPHA_OPAQUE), "Constructs a colour from red, green and blue values. :see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`. @@ -75,12 +91,17 @@ public: "Returns the blue intensity.", ""); DocDeclStr( - bool , Ok(), + byte , Alpha(), + "Returns the Alpha value.", ""); + + DocDeclStr( + bool , IsOk(), "Returns True if the colour object is valid (the colour has been initialised with RGB values).", ""); + %pythoncode { Ok = IsOk } DocDeclStr( - void , Set(byte red, byte green, byte blue), + void , Set(byte red, byte green, byte blue, byte alpha=wxALPHA_OPAQUE), "Sets the RGB intensity values.", ""); DocDeclStrName( @@ -89,12 +110,23 @@ initialised with RGB values).", ""); SetRGB); DocDeclStrName( - void , InitFromName(const wxString& colourName), + void , Set(const wxString& colourName), "Sets the RGB intensity values using a colour name listed in ``wx.TheColourDatabase``.", "", SetFromName); + DocDeclStr( + wxString , GetAsString(long flags = wxC2S_NAME | wxC2S_CSS_SYNTAX) const, + "Return the colour as a string. Acceptable flags are: + + =================== ================================== + wx.C2S_NAME return colour name, when possible + wx.C2S_CSS_SYNTAX return colour in rgb(r,g,b) syntax + wx.C2S_HTML_SYNTAX return colour in #rrggbb syntax + =================== ==================================", ""); + + DocDeclStr( long , GetPixel() const, "Returns a pixel value which is platform-dependent. On Windows, a @@ -102,36 +134,60 @@ COLORREF is returned. On X, an allocated pixel value is returned. -1 is returned if the pixel is invalid (on X, unallocated).", ""); - DocDeclStr( - bool , operator==(const wxColour& colour) const, - "Compare colours for equality", ""); - - DocDeclStr( - bool , operator!=(const wxColour& colour) const, - "Compare colours for inequality", ""); - + %extend { + KeepGIL(__eq__); + DocStr(__eq__, "Compare colours for equality.", ""); + bool __eq__(PyObject* other) { + wxColour temp, *obj = &temp; + if ( other == Py_None ) return false; + if ( ! wxColour_helper(other, &obj) ) { + PyErr_Clear(); + return false; + } + return self->operator==(*obj); + } + + + KeepGIL(__ne__); + DocStr(__ne__, "Compare colours for inequality.", ""); + bool __ne__(PyObject* other) { + wxColour temp, *obj = &temp; + if ( other == Py_None ) return true; + if ( ! wxColour_helper(other, &obj)) { + PyErr_Clear(); + return true; + } + return self->operator!=(*obj); + } + } %extend { + KeepGIL(Get); DocAStr(Get, "Get() -> (r, g, b)", "Returns the RGB intensity values as a tuple.", ""); - PyObject* Get() { - PyObject* rv = PyTuple_New(3); + PyObject* Get(bool includeAlpha=false) { + PyObject* rv = PyTuple_New(includeAlpha ? 4 : 3); int red = -1; int green = -1; int blue = -1; - if (self->Ok()) { + int alpha = wxALPHA_OPAQUE; + if (self->IsOk()) { red = self->Red(); green = self->Green(); blue = self->Blue(); + alpha = self->Alpha(); } PyTuple_SetItem(rv, 0, PyInt_FromLong(red)); PyTuple_SetItem(rv, 1, PyInt_FromLong(green)); PyTuple_SetItem(rv, 2, PyInt_FromLong(blue)); + if (includeAlpha) + PyTuple_SetItem(rv, 3, PyInt_FromLong(alpha)); return rv; } + KeepGIL(GetRGB); DocStr(GetRGB, "Return the colour as a packed RGB value", ""); unsigned long GetRGB() { @@ -142,12 +198,18 @@ is returned if the pixel is invalid (on X, unallocated).", ""); %pythoncode { asTuple = wx._deprecated(Get, "asTuple is deprecated, use `Get` instead") - def __str__(self): return str(self.Get()) - def __repr__(self): return 'wx.Colour' + str(self.Get()) - def __nonzero__(self): return self.Ok() + def __str__(self): return str(self.Get(True)) + def __repr__(self): return 'wx.Colour' + str(self.Get(True)) + def __len__(self): return len(self.Get()) + def __getitem__(self, index): return self.Get()[index] + def __nonzero__(self): return self.IsOk() __safe_for_unpickling__ = True - def __reduce__(self): return (Colour, self.Get()) + def __reduce__(self): return (Colour, self.Get(True)) } + + %property(Pixel, GetPixel, doc="See `GetPixel`"); + %property(RGB, GetRGB, SetRGB, doc="See `GetRGB` and `SetRGB`"); + }; %pythoncode {