X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/c4f8516517e13bf164809c9d58d701413807f8c1..df16c649d21716a3e54eb2598477fa9ed970f278:/wxPython/src/_colour.i

diff --git a/wxPython/src/_colour.i b/wxPython/src/_colour.i
index 55af312eef..c0a53a5a03 100644
--- a/wxPython/src/_colour.i
+++ b/wxPython/src/_colour.i
@@ -17,27 +17,105 @@
 %newgroup;
 
 
+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::
+
+    win.SetBackgroundColour(wxColour(0,0,255))
+    win.SetBackgroundColour('BLUE')
+    win.SetBackgroundColour('#0000FF')
+
+Additional colour names and their coresponding values can be added
+using `wx.ColourDatabase`.  Various system colours (as set in the
+user's system preferences) can be retrieved with
+`wx.SystemSettings.GetColour`.
+", "");
+
+
 class wxColour : public wxObject {
 public:
-    wxColour(unsigned char red=0, unsigned char green=0, unsigned char blue=0);
+    
+    DocCtorStr(
+        wxColour(byte red=0, byte green=0, byte blue=0),
+        "Constructs a colour from red, green and blue values.
+
+:see: Alternate constructors `wx.NamedColour` and `wx.ColourRGB`.
+", "");
+    
+    DocCtorStrName(
+        wxColour( const wxString& colorName),
+        "Constructs a colour object using a colour name listed in
+``wx.TheColourDatabase``.", "",
+        NamedColour);
+    
+    DocCtorStrName(
+        wxColour( unsigned long colRGB ),
+        "Constructs a colour from a packed RGB value.", "",
+        ColourRGB);
+
     ~wxColour();
 
-    %name(NamedColour) wxColour( const wxString& colorName);
-    %name(ColourRGB) wxColour( unsigned long colRGB );
+    
+    DocDeclStr(
+        byte , Red(),
+        "Returns the red intensity.", "");
+    
+    DocDeclStr(
+        byte , Green(),
+        "Returns the green intensity.", "");
+    
+    DocDeclStr(
+        byte , Blue(),
+        "Returns the blue intensity.", "");
+    
+    DocDeclStr(
+        bool , Ok(),
+        "Returns True if the colour object is valid (the colour has been
+initialised with RGB values).", "");
+    
+    DocDeclStr(
+        void , Set(byte red, byte green, byte blue),
+        "Sets the RGB intensity values.", "");
 
-    unsigned char Red();
-    unsigned char Green();
-    unsigned char Blue();
-    bool Ok();
-    void Set(unsigned char red, unsigned char green, unsigned char blue);
-    %name(SetRGB) void Set(unsigned long colRGB);
+    DocDeclStrName(
+        void , Set(unsigned long colRGB),
+        "Sets the RGB intensity values from a packed RGB value.", "",
+        SetRGB);
 
-    bool operator==(const wxColour& colour) const;
-    bool operator != (const wxColour& colour) const;
+    DocDeclStrName(
+        void , InitFromName(const wxString& colourName),
+        "Sets the RGB intensity values using a colour name listed in
+``wx.TheColourDatabase``.", "",
+        SetFromName);
+    
+    
+    DocDeclStr(
+        long , GetPixel() const,
+        "Returns a pixel value which is platform-dependent. On Windows, a
+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", "");
+    
 
-    void InitFromName(const wxString& colourName);
 
     %extend {
+        DocAStr(Get,
+                "Get() -> (r, g, b)",
+                "Returns the RGB intensity values as a tuple.", "");
         PyObject* Get() {
             PyObject* rv = PyTuple_New(3);
             int red = -1;
@@ -53,39 +131,30 @@ public:
             PyTuple_SetItem(rv, 2, PyInt_FromLong(blue));
             return rv;
         }
-//         bool __eq__(PyObject* obj) {
-//             wxColour  tmp;
-//             wxColour* ptr = &tmp;
-//             if (obj == Py_None)    return False;
-//             wxPyBLOCK_THREADS(bool success = wxColour_helper(obj, &ptr); PyErr_Clear());
-//             if (! success)         return False;
-//             return *self == *ptr;
-//         }
-//         bool __ne__(PyObject* obj) {
-//             wxColour  tmp;
-//             wxColour* ptr = &tmp;
-//             if (obj == Py_None)    return True;
-//             wxPyBLOCK_THREADS(bool success = wxColour_helper(obj, &ptr); PyErr_Clear());
-//             if (! success)         return True;
-//             return *self != *ptr;
-//         }
+
+        DocStr(GetRGB,
+               "Return the colour as a packed RGB value", "");
+        unsigned long GetRGB() {
+            return self->Red() | (self->Green() << 8) | (self->Blue() << 16);
+        }
     }
 
 
     %pythoncode {
-        asTuple = Get
-        def __str__(self):                  return str(self.asTuple())
-        def __repr__(self):                 return 'wx.Colour' + str(self.asTuple())
+        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 __getinitargs__(self):          return ()
-        def __getstate__(self):             return self.asTuple()
-        def __setstate__(self, state):      self.Set(*state)
+        __safe_for_unpickling__ = True
+        def __reduce__(self):               return (Colour, self.Get())
         }
 };
 
 %pythoncode {
     Color = Colour
-    NamedColor = NamedColour    
+    NamedColor = NamedColour
+    ColorRGB = ColourRGB
 }
+
 //---------------------------------------------------------------------------