Add wx.menuBar.UpdateMenus

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

diff --git a/wxPython/src/_sizers.i b/wxPython/src/_sizers.i
index 6f033ef9c6c2f087b20c553d5a1d4a8f5e343a6a..9726d7b4fc245cc2d3ca96f50bfe8ca35c6ec392 100644 (file)
--- a/wxPython/src/_sizers.i
+++ b/wxPython/src/_sizers.i
@@ -23,10 +23,13 @@
 
 DocStr(wxSizerItem,
 "The wx.SizerItem class is used to track the position, size and other
 
 DocStr(wxSizerItem,
 "The wx.SizerItem class is used to track the position, size and other

-attributes of each item managed by a `wx.Sizer`. In normal usage user
-code should never need to deal directly with a wx.SizerItem, but
-custom classes derived from `wx.PySizer` will probably need to use the
-collection of wx.SizerItems held by wx.Sizer when calculating layout.
+attributes of each item managed by a `wx.Sizer`. It is not usually
+necessary to use this class because the sizer elements can also be
+identified by their positions or window or sizer references but
+sometimes it may be more convenient to use wx.SizerItem directly.
+Also, custom classes derived from `wx.PySizer` will probably need to
+use the collection of wx.SizerItems held by wx.Sizer when calculating
+layout.

 
 :see: `wx.Sizer`, `wx.GBSizerItem`", "");
 
 
 :see: `wx.Sizer`, `wx.GBSizerItem`", "");
 


@@ -43,6 +46,8 @@ methods are called.
 
 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`", "");
 
 
 :see: `wx.SizerItemSpacer`, `wx.SizerItemWindow`, `wx.SizerItemSizer`", "");
 

+    
+    ~wxSizerItem();

 
 
     %extend {
 
 
     %extend {


@@ -86,6 +91,7 @@ methods are called.
                          int border, PyObject* userData=NULL ),
             "Constructs a `wx.SizerItem` for tracking a subsizer", "");
 
                          int border, PyObject* userData=NULL ),
             "Constructs a `wx.SizerItem` for tracking a subsizer", "");
 

+        %disownarg( wxSizer *sizer );

         %RenameCtor(SizerItemSizer,  wxSizerItem( wxSizer *sizer, int proportion, int flag,
                                                   int border, PyObject* userData=NULL ))
         {
         %RenameCtor(SizerItemSizer,  wxSizerItem( wxSizer *sizer, int proportion, int flag,
                                                   int border, PyObject* userData=NULL ))
         {


@@ -97,6 +103,7 @@ methods are called.
             }
             return new wxSizerItem(sizer, proportion, flag, border, data);
         }
             }
             return new wxSizerItem(sizer, proportion, flag, border, data);
         }

+        %cleardisown( wxSizer *sizer );

     }
 
 
     }
 
 


@@ -121,7 +128,7 @@ of item.", "");
 needed by borders.", "");
 
     DocDeclStr(
 needed by borders.", "");
 
     DocDeclStr(

-        void , SetDimension( wxPoint pos, wxSize size ),
+        void , SetDimension( const wxPoint& pos, const wxSize& size ),

         "Set the position and size of the space allocated for this item by the
 sizer, and adjust the position and size of the item (window or
 subsizer) to be within that space taking alignment and borders into
         "Set the position and size of the space allocated for this item by the
 sizer, and adjust the position and size of the item (window or
 subsizer) to be within that space taking alignment and borders into


@@ -145,7 +152,7 @@ added, if needed.", "");
     DocStr(SetRatio,
            "Set the ratio item attribute.", "");
     %Rename(SetRatioWH, void, SetRatio( int width, int height ));
     DocStr(SetRatio,
            "Set the ratio item attribute.", "");
     %Rename(SetRatioWH, void, SetRatio( int width, int height ));

-    %Rename(SetRatioSize, void, SetRatio( wxSize size ));
+    %Rename(SetRatioSize, void, SetRatio( const wxSize& size ));

     void SetRatio( float ratio );
 
     DocDeclStr(
     void SetRatio( float ratio );
 
     DocDeclStr(


@@ -214,9 +221,11 @@ added, if needed.", "");
         wxSizer *, GetSizer(),
         "Get the subsizer (if any) that is managed by this sizer item.", "");
 
         wxSizer *, GetSizer(),
         "Get the subsizer (if any) that is managed by this sizer item.", "");
 

+    %disownarg( wxSizer *sizer );

     DocDeclStr(
         void , SetSizer( wxSizer *sizer ),
         "Set the subsizer to be managed by this sizer item.", "");
     DocDeclStr(
         void , SetSizer( wxSizer *sizer ),
         "Set the subsizer to be managed by this sizer item.", "");

+    %cleardisown( wxSizer *sizer );

 
 
     DocDeclStr(
 
 
     DocDeclStr(


@@ -261,6 +270,18 @@ isn't any.", "");
                 return Py_None;
             }
         }
                 return Py_None;
             }
         }

+
+        DocStr(SetUserData,
+               "Associate a Python object with this sizer item.", "");
+        void SetUserData(PyObject* userData) {
+            wxPyUserData* data = NULL;
+            if ( userData ) {
+                wxPyBlock_t blocked = wxPyBeginBlockThreads();
+                data = new wxPyUserData(userData);
+                wxPyEndBlockThreads(blocked);
+            }
+            self->SetUserData(data);
+        }

     }
 };
 
     }
 };
 


@@ -318,14 +339,14 @@ static wxPySizerItemInfo wxPySizerItemTypeHelper(PyObject* item, bool checkSize,
     if ( !(info.window || info.sizer || (checkSize && info.gotSize) || (checkIdx && info.gotPos)) ) {
         // no expected type, figure out what kind of error message to generate
         if ( !checkSize && !checkIdx )
     if ( !(info.window || info.sizer || (checkSize && info.gotSize) || (checkIdx && info.gotPos)) ) {
         // no expected type, figure out what kind of error message to generate
         if ( !checkSize && !checkIdx )

-            PyErr_SetString(PyExc_TypeError, "wxWindow or wxSizer expected for item");
+            PyErr_SetString(PyExc_TypeError, "wx.Window or wx.Sizer expected for item");

         else if ( checkSize && !checkIdx )
         else if ( checkSize && !checkIdx )

-            PyErr_SetString(PyExc_TypeError, "wxWindow, wxSizer, wxSize, or (w,h) expected for item");
+            PyErr_SetString(PyExc_TypeError, "wx.Window, wx.Sizer, wx.Size, or (w,h) expected for item");

         else if ( !checkSize && checkIdx)
         else if ( !checkSize && checkIdx)

-            PyErr_SetString(PyExc_TypeError, "wxWindow, wxSizer or int (position) expected for item");
+            PyErr_SetString(PyExc_TypeError, "wx.Window, wx.Sizer or int (position) expected for item");

         else
             // can this one happen?
         else
             // can this one happen?

-            PyErr_SetString(PyExc_TypeError, "wxWindow, wxSizer, wxSize, or (w,h) or int (position) expected for item");
+            PyErr_SetString(PyExc_TypeError, "wx.Window, wx.Sizer, wx.Size, or (w,h) or int (position) expected for item");

     }
 
     return info;
     }
 
     return info;


@@ -339,8 +360,8 @@ DocStr(wxSizer,
 "wx.Sizer is the abstract base class used for laying out subwindows in
 a window.  You cannot use wx.Sizer directly; instead, you will have to
 use one of the sizer classes derived from it such as `wx.BoxSizer`,
 "wx.Sizer is the abstract base class used for laying out subwindows in
 a window.  You cannot use wx.Sizer directly; instead, you will have to
 use one of the sizer classes derived from it such as `wx.BoxSizer`,

-`wx.StaticBoxSizer`, `wx.NotebookSizer`, `wx.GridSizer`,  `wx.FlexGridSizer`
-and `wx.GridBagSizer`.
+`wx.StaticBoxSizer`, `wx.GridSizer`, `wx.FlexGridSizer` and
+`wx.GridBagSizer`.

 
 The concept implemented by sizers in wxWidgets is closely related to
 layout tools in other GUI toolkits, such as Java's AWT, the GTK
 
 The concept implemented by sizers in wxWidgets is closely related to
 layout tools in other GUI toolkits, such as Java's AWT, the GTK


@@ -364,6 +385,12 @@ standard font as well as the overall design of Mac widgets requires
 more space than on Windows, then the initial size of a dialog using a
 sizer will automatically be bigger on Mac than on Windows.", "
 
 more space than on Windows, then the initial size of a dialog using a
 sizer will automatically be bigger on Mac than on Windows.", "
 

+Sizers may also be used to control the layout of custom drawn items on
+the window.  The `Add`, `Insert`, and `Prepend` functions return a
+pointer to the newly added `wx.SizerItem`. Just add empty space of the
+desired size and attributes, and then use the `wx.SizerItem.GetRect`
+method to determine where the drawing operations should take place.
+

 :note: If you wish to create a custom sizer class in wxPython you
     should derive the class from `wx.PySizer` in order to get
     Python-aware capabilities for the various virtual methods.
 :note: If you wish to create a custom sizer class in wxPython you
     should derive the class from `wx.PySizer` in order to get
     Python-aware capabilities for the various virtual methods.


@@ -377,7 +404,8 @@ sizer will automatically be bigger on Mac than on Windows.", "
 class wxSizer : public wxObject {
 public:
     // wxSizer();      ****  abstract, can't instantiate
 class wxSizer : public wxObject {
 public:
     // wxSizer();      ****  abstract, can't instantiate

-    // ~wxSizer();
+
+    ~wxSizer();

 
     %extend {
         void _setOORInfo(PyObject* _self) {
 
     %extend {
         void _setOORInfo(PyObject* _self) {


@@ -450,7 +478,7 @@ public:
         |- wx.ALL                    |                                          |
         |                            |                                          |
         +----------------------------+------------------------------------------+
         |- wx.ALL                    |                                          |
         |                            |                                          |
         +----------------------------+------------------------------------------+

-        |- wx.EXAPAND                |The item will be expanded to fill         |
+        |- wx.EXPAND                 |The item will be expanded to fill         |

         |                            |the space allotted to the item.           |
         +----------------------------+------------------------------------------+
         |- wx.SHAPED                 |The item will be expanded as much as      |
         |                            |the space allotted to the item.           |
         +----------------------------+------------------------------------------+
         |- wx.SHAPED                 |The item will be expanded as much as      |


@@ -494,6 +522,8 @@ public:
             wxPySizerItemInfo info = wxPySizerItemTypeHelper(item, true, false);
             if ( userData && (info.window || info.sizer || info.gotSize) )
                 data = new wxPyUserData(userData);
             wxPySizerItemInfo info = wxPySizerItemTypeHelper(item, true, false);
             if ( userData && (info.window || info.sizer || info.gotSize) )
                 data = new wxPyUserData(userData);

+            if ( info.sizer )
+                PyObject_SetAttrString(item,"thisown",Py_False);

             wxPyEndBlockThreads(blocked);
 
             // Now call the real Add method if a valid item type was found
             wxPyEndBlockThreads(blocked);
 
             // Now call the real Add method if a valid item type was found


@@ -525,6 +555,8 @@ the item at index *before*.  See `Add` for a description of the parameters.", ""
             wxPySizerItemInfo info = wxPySizerItemTypeHelper(item, true, false);
             if ( userData && (info.window || info.sizer || info.gotSize) )
                 data = new wxPyUserData(userData);
             wxPySizerItemInfo info = wxPySizerItemTypeHelper(item, true, false);
             if ( userData && (info.window || info.sizer || info.gotSize) )
                 data = new wxPyUserData(userData);

+            if ( info.sizer )
+                PyObject_SetAttrString(item,"thisown",Py_False);

             wxPyEndBlockThreads(blocked);
 
             // Now call the real Insert method if a valid item type was found
             wxPyEndBlockThreads(blocked);
 
             // Now call the real Insert method if a valid item type was found


@@ -557,6 +589,8 @@ this sizer.  See `Add` for a description of the parameters.", "");
             wxPySizerItemInfo info = wxPySizerItemTypeHelper(item, true, false);
             if ( userData && (info.window || info.sizer || info.gotSize) )
                 data = new wxPyUserData(userData);
             wxPySizerItemInfo info = wxPySizerItemTypeHelper(item, true, false);
             if ( userData && (info.window || info.sizer || info.gotSize) )
                 data = new wxPyUserData(userData);

+            if ( info.sizer )
+                PyObject_SetAttrString(item,"thisown",Py_False);

             wxPyEndBlockThreads(blocked);
 
             // Now call the real Prepend method if a valid item type was found
             wxPyEndBlockThreads(blocked);
 
             // Now call the real Prepend method if a valid item type was found


@@ -629,7 +663,7 @@ was found and detached.", "");
                 "GetItem(self, item) -> wx.SizerItem",
                 "Returns the `wx.SizerItem` which holds the *item* given.  The *item*
 parameter can be either a window, a sizer, or the zero-based index of
                 "GetItem(self, item) -> wx.SizerItem",
                 "Returns the `wx.SizerItem` which holds the *item* given.  The *item*
 parameter can be either a window, a sizer, or the zero-based index of

-the item to be detached.", "");
+the item to be found.", "");

         wxSizerItem* GetItem(PyObject* item) {
             wxPyBlock_t blocked = wxPyBeginBlockThreads();
             wxPySizerItemInfo info = wxPySizerItemTypeHelper(item, false, true);
         wxSizerItem* GetItem(PyObject* item) {
             wxPyBlock_t blocked = wxPyBeginBlockThreads();
             wxPySizerItemInfo info = wxPySizerItemTypeHelper(item, false, true);


@@ -675,6 +709,9 @@ the item to be detached.", "");
             return self._SetItemMinSize(item, args[0])
     }
 
             return self._SetItemMinSize(item, args[0])
     }
 

+
+    %disownarg( wxSizerItem *item ); 
+

     DocDeclAStrName(
         wxSizerItem* , Add( wxSizerItem *item ),
         "AddItem(self, SizerItem item)",
     DocDeclAStrName(
         wxSizerItem* , Add( wxSizerItem *item ),
         "AddItem(self, SizerItem item)",


@@ -693,6 +730,7 @@ the item to be detached.", "");
         "Prepends a `wx.SizerItem` to the sizer.", "",
         PrependItem);
 
         "Prepends a `wx.SizerItem` to the sizer.", "",
         PrependItem);
 

+    %cleardisown( wxSizerItem *item );

 
 
     %pythoncode {
 
 
     %pythoncode {


@@ -904,7 +942,7 @@ subsizer.  Returns True if the item was found.", "");
 
         DocAStr(IsShown,
                 "IsShown(self, item)",
 
         DocAStr(IsShown,
                 "IsShown(self, item)",

-                "Determines if the item is currently shown. sizer.  To make a sizer
+                "Determines if the item is currently shown. To make a sizer

 item disappear or reappear, use Show followed by `Layout`.  The *item*
 parameter can be either a window, a sizer, or the zero-based index of
 the item.", "");
 item disappear or reappear, use Show followed by `Layout`.  The *item*
 parameter can be either a window, a sizer, or the zero-based index of
 the item.", "");


@@ -926,7 +964,7 @@ the item.", "");
     %pythoncode {
     def Hide(self, item, recursive=False):
         """
     %pythoncode {
     def Hide(self, item, recursive=False):
         """

-        A convenience method for Show(item, False, recursive).
+        A convenience method for `Show` (item, False, recursive).

         """
         return self.Show(item, False, recursive)
     }
         """
         return self.Show(item, False, recursive)
     }


@@ -1144,6 +1182,25 @@ define extra space between all children.", "");
         int , GetHGap(),
         "Returns the horizontal gap (in pixels) between cells in the sizer.", "");
 
         int , GetHGap(),
         "Returns the horizontal gap (in pixels) between cells in the sizer.", "");
 

+    %pythoncode {
+        def CalcRowsCols(self):
+            """
+            CalcRowsCols() -> (rows, cols)
+
+            Calculates how many rows and columns will be in the sizer based
+            on the current number of items and also the rows, cols specified
+            in the constructor.
+            """
+            nitems = len(self.GetChildren())
+            rows = self.GetRows()
+            cols = self.GetCols()
+            assert rows != 0 or cols != 0, "Grid sizer must have either rows or columns fixed"
+            if cols != 0:
+                rows = (nitems + cols - 1) / cols
+            elif rows != 0:
+                cols = (nitems + rows - 1) / rows
+            return (rows, cols)
+    }

 };
 
 //---------------------------------------------------------------------------
 };
 
 //---------------------------------------------------------------------------