Get/SetTitle only for wxTopLevelWindow (wxMGL part).

[wxWidgets.git] / wxPython / src / _colour.i

diff --git a/wxPython/src/_colour.i b/wxPython/src/_colour.i
index 245eed2067362ca13aeecf1bfeb15baea0ad5bba..630d1069903337c6e8193747e7504a8b3c3b6f55 100644 (file)
--- a/wxPython/src/_colour.i
+++ b/wxPython/src/_colour.i
@@ -18,96 +18,106 @@
 
 
 DocStr(wxColour,
 
 
 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.
+"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:
+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')
 
 
     win.SetBackgroundColour(wxColour(0,0,255))
     win.SetBackgroundColour('BLUE')
     win.SetBackgroundColour('#0000FF')
 

-You can retrieve the various current system colour settings with
-wx.SystemSettings.GetColour.");
+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`.
+", "");

 
 
 
 

+MustHaveApp( wxColour(const wxString& colorName) );
+

 class wxColour : public wxObject {
 public:
     
     DocCtorStr(
 class wxColour : public wxObject {
 public:
     
     DocCtorStr(

-        wxColour(unsigned char red=0, unsigned char green=0, unsigned char blue=0),
-        "Constructs a colour from red, green and blue values.");
+        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),
     
     DocCtorStrName(
         wxColour( const wxString& colorName),

-        "Constructs a colour object using a colour name listed in wx.TheColourDatabase.",
+        "Constructs a colour object using a colour name listed in
+``wx.TheColourDatabase``.", "",

         NamedColour);
     
     DocCtorStrName(
         wxColour( unsigned long colRGB ),
         NamedColour);
     
     DocCtorStrName(
         wxColour( unsigned long colRGB ),

-        "Constructs a colour from a packed RGB value.",
+        "Constructs a colour from a packed RGB value.", "",

         ColourRGB);
 
     ~wxColour();
 
     
     DocDeclStr(
         ColourRGB);
 
     ~wxColour();
 
     
     DocDeclStr(

-        unsigned char , Red(),
-        "Returns the red intensity.");
+        byte , Red(),
+        "Returns the red intensity.", "");

     
     DocDeclStr(
     
     DocDeclStr(

-        unsigned char , Green(),
-        "Returns the green intensity.");
+        byte , Green(),
+        "Returns the green intensity.", "");

     
     DocDeclStr(
     
     DocDeclStr(

-        unsigned char , Blue(),
-        "Returns the blue intensity.");
+        byte , Blue(),
+        "Returns the blue intensity.", "");

     
     DocDeclStr(
         bool , Ok(),
     
     DocDeclStr(
         bool , Ok(),

-        "Returns True if the colour object is valid (the colour has been\n"
-        "initialised with RGB values).");
+        "Returns True if the colour object is valid (the colour has been
+initialised with RGB values).", "");

     
     DocDeclStr(
     
     DocDeclStr(

-        void , Set(unsigned char red, unsigned char green, unsigned char blue),
-        "Sets the RGB intensity values.");
+        void , Set(byte red, byte green, byte blue),
+        "Sets the RGB intensity values.", "");

 
     DocDeclStrName(
         void , Set(unsigned long colRGB),
 
     DocDeclStrName(
         void , Set(unsigned long colRGB),

-        "Sets the RGB intensity values from a packed RGB value.",
+        "Sets the RGB intensity values from a packed RGB value.", "",

         SetRGB);
 
     DocDeclStrName(
         void , InitFromName(const wxString& colourName),
         SetRGB);
 
     DocDeclStrName(
         void , InitFromName(const wxString& colourName),

-        "Sets the RGB intensity values using a colour name listed in wx.TheColourDatabase.",
+        "Sets the RGB intensity values using a colour name listed in
+``wx.TheColourDatabase``.", "",

         SetFromName);
     
     
     DocDeclStr(
         long , GetPixel() const,
         SetFromName);
     
     
     DocDeclStr(
         long , GetPixel() const,

-        "Returns a pixel value which is platform-dependent. On Windows, a\n"
-        "COLORREF is returned. On X, an allocated pixel value is returned.\n"
-        "-1 is returned if the pixel is invalid (on X, unallocated).");
+        "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,
     
     
     DocDeclStr(
         bool , operator==(const wxColour& colour) const,

-        "Compare colours for equality");
+        "Compare colours for equality", "");

     
     DocDeclStr(
         bool , operator!=(const wxColour& colour) const,
     
     DocDeclStr(
         bool , operator!=(const wxColour& colour) const,

-        "Compare colours for inequality");
+        "Compare colours for inequality", "");

     
 
 
     %extend {
         DocAStr(Get,
                 "Get() -> (r, g, b)",
     
 
 
     %extend {
         DocAStr(Get,
                 "Get() -> (r, g, b)",

-                "Returns the RGB intensity values as a tuple.");
+                "Returns the RGB intensity values as a tuple.", "");

         PyObject* Get() {
             PyObject* rv = PyTuple_New(3);
             int red = -1;
         PyObject* Get() {
             PyObject* rv = PyTuple_New(3);
             int red = -1;


@@ -125,7 +135,7 @@ public:
         }
 
         DocStr(GetRGB,
         }
 
         DocStr(GetRGB,

-               "Return the colour as a packed RGB value");
+               "Return the colour as a packed RGB value", "");

         unsigned long GetRGB() {
             return self->Red() | (self->Green() << 8) | (self->Blue() << 16);
         }
         unsigned long GetRGB() {
             return self->Red() | (self->Green() << 8) | (self->Blue() << 16);
         }


@@ -133,9 +143,9 @@ public:
 
 
     %pythoncode {
 
 
     %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()
         __safe_for_unpickling__ = True
         def __reduce__(self):               return (Colour, self.Get())
         def __nonzero__(self):              return self.Ok()
         __safe_for_unpickling__ = True
         def __reduce__(self):               return (Colour, self.Get())