Docstring updates and tweaks for epydoc

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

diff --git a/wxPython/src/_gdicmn.i b/wxPython/src/_gdicmn.i
index 7af7fe9386487dffd56a95c75028b97855758bde..5b86c9a6e0dafbb4e14d42d8fe6bd734dbf3b28e 100644 (file)
--- a/wxPython/src/_gdicmn.i
+++ b/wxPython/src/_gdicmn.i
@@ -21,36 +21,38 @@ enum wxBitmapType
 {
     wxBITMAP_TYPE_INVALID,          // should be == 0 for compatibility!
     wxBITMAP_TYPE_BMP,
 {
     wxBITMAP_TYPE_INVALID,          // should be == 0 for compatibility!
     wxBITMAP_TYPE_BMP,

-    wxBITMAP_TYPE_BMP_RESOURCE,
-    wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,

     wxBITMAP_TYPE_ICO,
     wxBITMAP_TYPE_ICO,

-    wxBITMAP_TYPE_ICO_RESOURCE,

     wxBITMAP_TYPE_CUR,
     wxBITMAP_TYPE_CUR,

-    wxBITMAP_TYPE_CUR_RESOURCE,

     wxBITMAP_TYPE_XBM,
     wxBITMAP_TYPE_XBM_DATA,
     wxBITMAP_TYPE_XPM,
     wxBITMAP_TYPE_XPM_DATA,
     wxBITMAP_TYPE_TIF,
     wxBITMAP_TYPE_XBM,
     wxBITMAP_TYPE_XBM_DATA,
     wxBITMAP_TYPE_XPM,
     wxBITMAP_TYPE_XPM_DATA,
     wxBITMAP_TYPE_TIF,

-    wxBITMAP_TYPE_TIF_RESOURCE,

     wxBITMAP_TYPE_GIF,
     wxBITMAP_TYPE_GIF,

-    wxBITMAP_TYPE_GIF_RESOURCE,

     wxBITMAP_TYPE_PNG,
     wxBITMAP_TYPE_PNG,

-    wxBITMAP_TYPE_PNG_RESOURCE,

     wxBITMAP_TYPE_JPEG,
     wxBITMAP_TYPE_JPEG,

-    wxBITMAP_TYPE_JPEG_RESOURCE,

     wxBITMAP_TYPE_PNM,
     wxBITMAP_TYPE_PNM,

-    wxBITMAP_TYPE_PNM_RESOURCE,

     wxBITMAP_TYPE_PCX,
     wxBITMAP_TYPE_PCX,

-    wxBITMAP_TYPE_PCX_RESOURCE,

     wxBITMAP_TYPE_PICT,
     wxBITMAP_TYPE_PICT,

-    wxBITMAP_TYPE_PICT_RESOURCE,

     wxBITMAP_TYPE_ICON,
     wxBITMAP_TYPE_ICON,

-    wxBITMAP_TYPE_ICON_RESOURCE,

     wxBITMAP_TYPE_ANI,
     wxBITMAP_TYPE_IFF,
     wxBITMAP_TYPE_MACCURSOR,
     wxBITMAP_TYPE_ANI,
     wxBITMAP_TYPE_IFF,
     wxBITMAP_TYPE_MACCURSOR,

-    wxBITMAP_TYPE_MACCURSOR_RESOURCE,
+
+//    wxBITMAP_TYPE_BMP_RESOURCE,
+//    wxBITMAP_TYPE_RESOURCE = wxBITMAP_TYPE_BMP_RESOURCE,
+//    wxBITMAP_TYPE_ICO_RESOURCE,
+//    wxBITMAP_TYPE_CUR_RESOURCE,
+//    wxBITMAP_TYPE_TIF_RESOURCE,
+//    wxBITMAP_TYPE_GIF_RESOURCE,
+//    wxBITMAP_TYPE_PNG_RESOURCE,
+//    wxBITMAP_TYPE_JPEG_RESOURCE,
+//    wxBITMAP_TYPE_PNM_RESOURCE,
+//    wxBITMAP_TYPE_PCX_RESOURCE,
+//    wxBITMAP_TYPE_PICT_RESOURCE,
+//    wxBITMAP_TYPE_ICON_RESOURCE,
+//    wxBITMAP_TYPE_MACCURSOR_RESOURCE,
+

     wxBITMAP_TYPE_ANY = 50
 };
 
     wxBITMAP_TYPE_ANY = 50
 };
 


@@ -120,13 +122,20 @@ class wxSize
 public:
     %name(width) int x;
     %name(height)int y;
 public:
     %name(width) int x;
     %name(height)int y;

-
+    %pythoncode { x = width; y = height }
+    

     DocCtorStr(
         wxSize(int w=0, int h=0),
         "Creates a size object.");
 
     ~wxSize();
 
     DocCtorStr(
         wxSize(int w=0, int h=0),
         "Creates a size object.");
 
     ~wxSize();
 

+// None/NULL is now handled properly by the typemap, so these are not needed.
+//     %extend {
+//         bool __eq__(const wxSize* other) { return other ? (*self == *other) : False; }
+//         bool __ne__(const wxSize* other) { return other ? (*self != *other) : True;  }
+//     }
+

     DocDeclStr(
         bool, operator==(const wxSize& sz),
         "Test for equality of wx.Size objects.");
     DocDeclStr(
         bool, operator==(const wxSize& sz),
         "Test for equality of wx.Size objects.");


@@ -162,6 +171,19 @@ public:
     int GetWidth() const;
     int GetHeight() const;
 
     int GetWidth() const;
     int GetHeight() const;
 

+    
+    DocDeclStr(
+        bool , IsFullySpecified() const,
+        "Returns True if both components of the size are non-default values.");
+    
+
+    DocDeclStr(
+        void , SetDefaults(const wxSize& size),
+        "Combine this size with the other one replacing the default
+components of this object (i.e. equal to -1) with those of the
+other.");
+    
+   

     //int GetX() const;
     //int GetY() const;
 
     //int GetX() const;
     //int GetY() const;
 


@@ -170,11 +192,11 @@ public:
                "Get() -> (width,height)",
                "Returns the width and height properties as a tuple.");
         PyObject* Get() {
                "Get() -> (width,height)",
                "Returns the width and height properties as a tuple.");
         PyObject* Get() {

-            wxPyBeginBlockThreads();
+            bool blocked = wxPyBeginBlockThreads();

             PyObject* tup = PyTuple_New(2);
             PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->x));
             PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->y));
             PyObject* tup = PyTuple_New(2);
             PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->x));
             PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->y));

-            wxPyEndBlockThreads();
+            wxPyEndBlockThreads(blocked);

             return tup;
         }
     }
             return tup;
         }
     }


@@ -189,9 +211,8 @@ public:
         elif index == 1: self.height = val
         else: raise IndexError
     def __nonzero__(self):               return self.Get() != (0,0)
         elif index == 1: self.height = val
         else: raise IndexError
     def __nonzero__(self):               return self.Get() != (0,0)

-    def __getinitargs__(self):           return ()
-    def __getstate__(self):              return self.Get()
-    def __setstate__(self, state):       self.Set(*state)
+    __safe_for_unpickling__ = True
+    def __reduce__(self):                return (wx.Size, self.Get())

     }
 
 };
     }
 
 };


@@ -244,11 +265,11 @@ public:
                "Get() -> (x,y)",
                "Return the x and y properties as a tuple. ");
         PyObject* Get() {
                "Get() -> (x,y)",
                "Return the x and y properties as a tuple. ");
         PyObject* Get() {

-            wxPyBeginBlockThreads();
+            bool blocked = wxPyBeginBlockThreads();

             PyObject* tup = PyTuple_New(2);
             PyTuple_SET_ITEM(tup, 0, PyFloat_FromDouble(self->x));
             PyTuple_SET_ITEM(tup, 1, PyFloat_FromDouble(self->y));
             PyObject* tup = PyTuple_New(2);
             PyTuple_SET_ITEM(tup, 0, PyFloat_FromDouble(self->x));
             PyTuple_SET_ITEM(tup, 1, PyFloat_FromDouble(self->y));

-            wxPyEndBlockThreads();
+            wxPyEndBlockThreads(blocked);

             return tup;
         }
     }
             return tup;
         }
     }


@@ -264,9 +285,8 @@ public:
         elif index == 1: self.y = val
         else: raise IndexError
     def __nonzero__(self):               return self.Get() != (0.0, 0.0)
         elif index == 1: self.y = val
         else: raise IndexError
     def __nonzero__(self):               return self.Get() != (0.0, 0.0)

-    def __getinitargs__(self):           return ()
-    def __getstate__(self):              return self.Get()
-    def __setstate__(self, state):       self.Set(*state)
+    __safe_for_unpickling__ = True
+    def __reduce__(self):                return (wx.RealPoint, self.Get())

     }
 };
 
     }
 };
 


@@ -300,11 +320,18 @@ public:
         bool, operator!=(const wxPoint& pt),
         "Test for inequality of wx.Point objects.");
 
         bool, operator!=(const wxPoint& pt),
         "Test for inequality of wx.Point objects.");
 

+
+
+//     %nokwargs operator+;
+//     %nokwargs operator-;
+//     %nokwargs operator+=;
+//     %nokwargs operator-=;

     
     DocDeclStr(
         wxPoint, operator+(const wxPoint& pt),
         "Add pt's proprties to this and return the result.");
 
     
     DocDeclStr(
         wxPoint, operator+(const wxPoint& pt),
         "Add pt's proprties to this and return the result.");
 

+   

     DocDeclStr(
         wxPoint, operator-(const wxPoint& pt),
         "Subtract pt's proprties from this and return the result");
     DocDeclStr(
         wxPoint, operator-(const wxPoint& pt),
         "Subtract pt's proprties from this and return the result");


@@ -318,6 +345,27 @@ public:
         wxPoint&, operator-=(const wxPoint& pt),
         "Subtract pt from this object.");
 
         wxPoint&, operator-=(const wxPoint& pt),
         "Subtract pt from this object.");
 

+
+    
+//     DocDeclStr(
+//         wxPoint, operator+(const wxSize& sz),
+//         "Add sz to this Point and return the result.");
+
+//     DocDeclStr(
+//         wxPoint, operator-(const wxSize& sz),
+//         "Subtract sz from this Point and return the result");
+
+
+//     DocDeclStr(
+//         wxPoint&, operator+=(const wxSize& sz),
+//         "Add sz to this object.");
+
+//     DocDeclStr(
+//         wxPoint&, operator-=(const wxSize& sz),
+//         "Subtract sz from this object.");
+
+
+    

     
     %extend {
         DocStr(Set, "Set both the x and y properties");
     
     %extend {
         DocStr(Set, "Set both the x and y properties");


@@ -330,11 +378,11 @@ public:
                "Get() -> (x,y)",
                "Return the x and y properties as a tuple. ");
         PyObject* Get() {
                "Get() -> (x,y)",
                "Return the x and y properties as a tuple. ");
         PyObject* Get() {

-            wxPyBeginBlockThreads();
+            bool blocked = wxPyBeginBlockThreads();

             PyObject* tup = PyTuple_New(2);
             PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->x));
             PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->y));
             PyObject* tup = PyTuple_New(2);
             PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->x));
             PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->y));

-            wxPyEndBlockThreads();
+            wxPyEndBlockThreads(blocked);

             return tup;
         }
     }
             return tup;
         }
     }


@@ -350,9 +398,8 @@ public:
         elif index == 1: self.y = val
         else: raise IndexError
     def __nonzero__(self):               return self.Get() != (0,0)
         elif index == 1: self.y = val
         else: raise IndexError
     def __nonzero__(self):               return self.Get() != (0,0)

-    def __getinitargs__(self):           return ()
-    def __getstate__(self):              return self.Get()
-    def __setstate__(self, state):       self.Set(*state)
+    __safe_for_unpickling__ = True
+    def __reduce__(self):                return (wx.Point, self.Get())

     }
 };
 
     }
 };
 


@@ -402,6 +449,16 @@ public:
     wxSize GetSize() const;
     void SetSize( const wxSize &s );
 
     wxSize GetSize() const;
     void SetSize( const wxSize &s );
 

+    wxPoint GetTopLeft() const;
+    void SetTopLeft(const wxPoint &p);
+    wxPoint GetBottomRight() const;
+    void SetBottomRight(const wxPoint &p);
+
+//    wxPoint GetLeftTop() const;
+//    void SetLeftTop(const wxPoint &p);
+//    wxPoint GetRightBottom() const;
+//    void SetRightBottom(const wxPoint &p);
+

     int GetLeft()   const;
     int GetTop()    const;
     int GetBottom() const;
     int GetLeft()   const;
     int GetTop()    const;
     int GetBottom() const;


@@ -489,13 +546,13 @@ public:
                "Get() -> (x,y,width,height)",
                "Return the rectangle properties as a tuple.");
         PyObject* Get() {
                "Get() -> (x,y,width,height)",
                "Return the rectangle properties as a tuple.");
         PyObject* Get() {

-            wxPyBeginBlockThreads();
+            bool blocked = wxPyBeginBlockThreads();

             PyObject* tup = PyTuple_New(4);
             PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->x));
             PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->y));
             PyTuple_SET_ITEM(tup, 2, PyInt_FromLong(self->width));
             PyTuple_SET_ITEM(tup, 3, PyInt_FromLong(self->height));
             PyObject* tup = PyTuple_New(4);
             PyTuple_SET_ITEM(tup, 0, PyInt_FromLong(self->x));
             PyTuple_SET_ITEM(tup, 1, PyInt_FromLong(self->y));
             PyTuple_SET_ITEM(tup, 2, PyInt_FromLong(self->width));
             PyTuple_SET_ITEM(tup, 3, PyInt_FromLong(self->height));

-            wxPyEndBlockThreads();
+            wxPyEndBlockThreads(blocked);

             return tup;
         }
     }
             return tup;
         }
     }


@@ -513,9 +570,8 @@ public:
         elif index == 3: self.height = val
         else: raise IndexError
     def __nonzero__(self):               return self.Get() != (0,0,0,0)
         elif index == 3: self.height = val
         else: raise IndexError
     def __nonzero__(self):               return self.Get() != (0,0,0,0)

-    def __getinitargs__(self):           return ()
-    def __getstate__(self):              return self.Get()
-    def __setstate__(self, state):       self.Set(*state)
+    __safe_for_unpickling__ = True
+    def __reduce__(self):                return (wx.Rect, self.Get())

     }
 };
 
     }
 };
 


@@ -534,10 +590,10 @@ DocAStr(wxIntersectRect,
         dest = reg1.GetBox();
 
         if (dest != wxRect(0,0,0,0)) {
         dest = reg1.GetBox();
 
         if (dest != wxRect(0,0,0,0)) {

-            wxPyBeginBlockThreads();
+            bool blocked = wxPyBeginBlockThreads();

             wxRect* newRect = new wxRect(dest);
             obj = wxPyConstructObject((void*)newRect, wxT("wxRect"), True);
             wxRect* newRect = new wxRect(dest);
             obj = wxPyConstructObject((void*)newRect, wxT("wxRect"), True);

-            wxPyEndBlockThreads();
+            wxPyEndBlockThreads(blocked);

             return obj;
         }
         Py_INCREF(Py_None);
             return obj;
         }
         Py_INCREF(Py_None);


@@ -621,11 +677,11 @@ public:
                "Get() -> (x,y)",
                "Return x and y properties as a tuple.");               
         PyObject* Get() {
                "Get() -> (x,y)",
                "Return x and y properties as a tuple.");               
         PyObject* Get() {

-            wxPyBeginBlockThreads();
+            bool blocked = wxPyBeginBlockThreads();

             PyObject* tup = PyTuple_New(2);
             PyTuple_SET_ITEM(tup, 0, PyFloat_FromDouble(self->m_x));
             PyTuple_SET_ITEM(tup, 1, PyFloat_FromDouble(self->m_y));
             PyObject* tup = PyTuple_New(2);
             PyTuple_SET_ITEM(tup, 0, PyFloat_FromDouble(self->m_x));
             PyTuple_SET_ITEM(tup, 1, PyFloat_FromDouble(self->m_y));

-            wxPyEndBlockThreads();
+            wxPyEndBlockThreads(blocked);

             return tup;
         }
     }
             return tup;
         }
     }


@@ -641,10 +697,8 @@ public:
         elif index == 1: self.y = val
         else: raise IndexError
     def __nonzero__(self):               return self.Get() != (0.0, 0.0)
         elif index == 1: self.y = val
         else: raise IndexError
     def __nonzero__(self):               return self.Get() != (0.0, 0.0)

-    def __getinitargs__(self):           return ()
-    def __getstate__(self):              return self.Get()
-    def __setstate__(self, state):       self.Set(*state)
-
+    __safe_for_unpickling__ = True
+    def __reduce__(self):                return (wx.Point2D, self.Get())

     }
 };
 
     }
 };