wxListCtrl --> wx.ListCtrl

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

diff --git a/wxPython/src/_window.i b/wxPython/src/_window.i
index 3c8958510126f3f2945bdbe5f824011d2e1059c7..be6b0561d01a6a3d865aa9797c75aa3408532438 100644 (file)
--- a/wxPython/src/_window.i
+++ b/wxPython/src/_window.i
@@ -32,7 +32,7 @@ struct wxVisualAttributes
     %extend {
         wxVisualAttributes() { return new wxVisualAttributes; }
         ~wxVisualAttributes() { delete self; }
     %extend {
         wxVisualAttributes() { return new wxVisualAttributes; }
         ~wxVisualAttributes() { delete self; }

-    }
+    } 

     
     // the font used for control label/text inside it
     wxFont font;
     
     // the font used for control label/text inside it
     wxFont font;


@@ -190,13 +190,16 @@ Extra Styles
 MustHaveApp(wxWindow);
 MustHaveApp(wxWindow::FindFocus);
 MustHaveApp(wxWindow::GetCapture);
 MustHaveApp(wxWindow);
 MustHaveApp(wxWindow::FindFocus);
 MustHaveApp(wxWindow::GetCapture);

-MustHaveApp(wxWindow::GetClassDefaultAttributes);
+
+// This one is not restricted to wxWindow
+MustHaveApp(GetClassDefaultAttributes);

 
 class wxWindow : public wxEvtHandler
 {
 public:
     %pythonAppend wxWindow         "self._setOORInfo(self)"
     %pythonAppend wxWindow()       ""
 
 class wxWindow : public wxEvtHandler
 {
 public:
     %pythonAppend wxWindow         "self._setOORInfo(self)"
     %pythonAppend wxWindow()       ""

+    %typemap(out) wxWindow*;    // turn off this typemap

 
     DocCtorStr(
         wxWindow(wxWindow* parent, const wxWindowID id=-1,
 
     DocCtorStr(
         wxWindow(wxWindow* parent, const wxWindowID id=-1,


@@ -211,7 +214,10 @@ public:
         "Precreate a Window for 2-phase creation.", "",
         PreWindow);
     
         "Precreate a Window for 2-phase creation.", "",
         PreWindow);
     

+    // Turn it back on again
+    %typemap(out) wxWindow* { $result = wxPyMake_wxObject($1, $owner); }

 
 

+    

     DocDeclStr(
         bool , Create(wxWindow* parent, const wxWindowID id=-1,
                 const wxPoint& pos = wxDefaultPosition,
     DocDeclStr(
         bool , Create(wxWindow* parent, const wxWindowID id=-1,
                 const wxPoint& pos = wxDefaultPosition,


@@ -415,8 +421,13 @@ default values.", "",
         "Moves the window to the given position.", "",
         MoveXY);
     
         "Moves the window to the given position.", "",
         MoveXY);
     

+    DocDeclStr(
+        void , SetBestFittingSize(const wxSize& size=wxDefaultSize),
+        "A 'Smart' SetSize that will fill in default size components with the
+window's *best size* values.  Also set's the minsize for use with sizers.", "");
+    

 
 

-
+    

     DocDeclStr(
         virtual void , Raise(),
         "Raises the window to the top of the window hierarchy if it is a
     DocDeclStr(
         virtual void , Raise(),
         "Raises the window to the top of the window hierarchy if it is a


@@ -504,6 +515,21 @@ after calling Fit.", "");
         GetBestSizeTuple);
     
 
         GetBestSizeTuple);
     
 

+    DocDeclStr(
+        void , InvalidateBestSize(),
+        "Reset the cached best size value so it will be recalculated the next
+time it is needed.", "");
+
+
+    
+    DocDeclStr(
+        wxSize , GetBestFittingSize() const,
+        "This function will merge the window's best size into the window's
+minimum size, giving priority to the min size components, and returns
+the results.
+", "");
+    
+

     DocDeclStr(
         wxSize , GetAdjustedBestSize() const,
         "This method is similar to GetBestSize, except in one
     DocDeclStr(
         wxSize , GetAdjustedBestSize() const,
         "This method is similar to GetBestSize, except in one


@@ -562,7 +588,6 @@ anything if there are no subwindows.", "");
     
 
     
     
 
     

-    %nokwargs SetSizeHints;

     DocStr(SetSizeHints,
         "Allows specification of minimum and maximum window sizes, and window
 size increments. If a pair of values is not set (or set to -1), the
     DocStr(SetSizeHints,
         "Allows specification of minimum and maximum window sizes, and window
 size increments. If a pair of values is not set (or set to -1), the


@@ -575,24 +600,25 @@ The resizing increments are only significant under Motif or Xt.", "
 
 :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
 ");
 
 :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
 ");

-    void SetSizeHints( const wxSize& minSize,
-                       const wxSize& maxSize=wxDefaultSize,
-                       const wxSize& incSize=wxDefaultSize);

     virtual void SetSizeHints( int minW, int minH,
                                int maxW = -1, int maxH = -1,
                                int incW = -1, int incH = -1 );
     virtual void SetSizeHints( int minW, int minH,
                                int maxW = -1, int maxH = -1,
                                int incW = -1, int incH = -1 );

+    %name(SetSizeHintsSz) void SetSizeHints( const wxSize& minSize,
+                                             const wxSize& maxSize=wxDefaultSize,
+                                             const wxSize& incSize=wxDefaultSize);

 
     
 
     

-    %nokwargs SetVirtualSizeHints;

     DocStr(SetVirtualSizeHints,
         "Allows specification of minimum and maximum virtual window sizes. If a
 pair of values is not set (or set to -1), the default values will be
 used.  If this function is called, the user will not be able to size
 the virtual area of the window outside the given bounds.", "");
     DocStr(SetVirtualSizeHints,
         "Allows specification of minimum and maximum virtual window sizes. If a
 pair of values is not set (or set to -1), the default values will be
 used.  If this function is called, the user will not be able to size
 the virtual area of the window outside the given bounds.", "");

-    void SetVirtualSizeHints( const wxSize& minSize,
-                              const wxSize& maxSize=wxDefaultSize);

     virtual void SetVirtualSizeHints( int minW, int minH,
                                       int maxW = -1, int maxH = -1 );
     virtual void SetVirtualSizeHints( int minW, int minH,
                                       int maxW = -1, int maxH = -1 );

+    %name(SetVirtualSizeHintsSz)void SetVirtualSizeHints(
+        const wxSize& minSize, const wxSize& maxSize=wxDefaultSize);
+
+

     
     DocDeclStr(
         virtual wxSize , GetMaxSize() const,
     
     DocDeclStr(
         virtual wxSize , GetMaxSize() const,


@@ -835,22 +861,44 @@ by pressing <Enter> such as the OK button on a wx.Dialog.", "");
         "Does keyboard navigation from this window to another, by sending a
 `wx.NavigationKeyEvent`.", "
  
         "Does keyboard navigation from this window to another, by sending a
 `wx.NavigationKeyEvent`.", "
  

-    :param flags: A combination of the ``IsForward`` and ``WinChange``
-        values in the `wx.NavigationKeyEvent` class, which determine
-        if the navigation should be in forward or reverse order, and
-        if it should be able to cross parent window boundaries, such
-        as between notebook pages or MDI child frames.  Typically the
-        status of the Shift key (for forward or reverse) or the
-        Control key (for WinChange) would be used to determine how to
-        set the flags.
+    :param flags: A combination of the ``IsForward`` or ``IsBackward``
+        and the ``WinChange`` values in the `wx.NavigationKeyEvent`
+        class, which determine if the navigation should be in forward
+        or reverse order, and if it should be able to cross parent
+        window boundaries, such as between notebook pages or MDI child
+        frames.  Typically the status of the Shift key (for forward or
+        backward) or the Control key (for WinChange) would be used to
+        determine how to set the flags.

 
 One situation in which you may wish to call this method is from a text
 control custom keypress handler to do the default navigation behaviour
 for the tab key, since the standard default behaviour for a multiline
 text control with the wx.TE_PROCESS_TAB style is to insert a tab and
 not navigate to the next control.");
 
 One situation in which you may wish to call this method is from a text
 control custom keypress handler to do the default navigation behaviour
 for the tab key, since the standard default behaviour for a multiline
 text control with the wx.TE_PROCESS_TAB style is to insert a tab and
 not navigate to the next control.");

+
+    
+
+    DocDeclStr(
+        void , MoveAfterInTabOrder(wxWindow *win),
+        "Moves this window in the tab navigation order after the specified
+sibling window.  This means that when the user presses the TAB key on
+that other window, the focus switches to this window.
+
+The default tab order is the same as creation order.  This function
+and `MoveBeforeInTabOrder` allow to change it after creating all the
+windows.
+", "");
+
+    
+    DocDeclStr(
+        void , MoveBeforeInTabOrder(wxWindow *win),
+        "Same as `MoveAfterInTabOrder` except that it inserts this window just
+before win instead of putting it right after it.", "");

     
 
     
 

+    
+
+

 
 
 
 
 
 


@@ -1267,19 +1315,20 @@ this.", "");
         "Sets the background colour of the window.  Returns True if the colour
 was changed.  The background colour is usually painted by the default
 EVT_ERASE_BACKGROUND event handler function under Windows and
         "Sets the background colour of the window.  Returns True if the colour
 was changed.  The background colour is usually painted by the default
 EVT_ERASE_BACKGROUND event handler function under Windows and

-automatically under GTK.
+automatically under GTK.  Using `wx.NullColour` will reset the window
+to the default background colour.

 
 Note that setting the background colour may not cause an immediate
 
 Note that setting the background colour may not cause an immediate

-refresh, so you may wish to call ClearBackground or Refresh after
+refresh, so you may wish to call `ClearBackground` or `Refresh` after

 calling this function.
 
 calling this function.
 

-Use this function with care under GTK+ as the new appearance of the
-window might not look equally well when used with themes, i.e GTK+'s
-ability to change its look as the user wishes with run-time loadable
-modules.", "");
+Using this function will disable attempts to use themes for this
+window, if the system supports them.  Use with care since usually the
+themes represent the appearance chosen by the user to be used for all
+applications on the system.", "");

 
     DocDeclStr(
 
     DocDeclStr(

-        void , SetDefaultBackgroundColour(const wxColour& colour),
+        void , SetOwnBackgroundColour(const wxColour& colour),

         "", "");
     
 
         "", "");
     
 


@@ -1292,7 +1341,7 @@ the window class; it may be the text colour or other colour, or it may
 not be used at all.", "");
 
     DocDeclStr(
 not be used at all.", "");
 
     DocDeclStr(

-        void , SetDefaultForegroundColour(const wxColour& colour),
+        void , SetOwnForegroundColour(const wxColour& colour),

         "", "");
     
 
         "", "");
     
 


@@ -1319,7 +1368,7 @@ The cursor may be wx.NullCursor in which case the window cursor will
 be reset back to default.", "");
     
     DocDeclStr(
 be reset back to default.", "");
     
     DocDeclStr(

-        wxCursor& , GetCursor(),
+        wxCursor , GetCursor(),

         "Return the cursor associated with this window.", "");
     
 
         "Return the cursor associated with this window.", "");
     
 


@@ -1329,13 +1378,13 @@ be reset back to default.", "");
         "Sets the font for this window.", "");
     
     DocDeclStr(
         "Sets the font for this window.", "");
     
     DocDeclStr(

-        void , SetDefaultFont(const wxFont& font),
+        void , SetOwnFont(const wxFont& font),

         "", "");
     
 
     
     DocDeclStr(
         "", "");
     
 
     
     DocDeclStr(

-        wxFont& , GetFont(),
+        wxFont , GetFont(),

         "Returns the default font used for this window.", "");
 
     
         "Returns the default font used for this window.", "");
 
     


@@ -1787,7 +1836,7 @@ colours.
 By 'intelligently' the following is meant: by default, all windows use
 their own default attributes. However if some of the parent's
 attributes are explicitly changed (that is, using SetFont and not
 By 'intelligently' the following is meant: by default, all windows use
 their own default attributes. However if some of the parent's
 attributes are explicitly changed (that is, using SetFont and not

-SetDefaultFont) and if the corresponding attribute hadn't been
+SetOwnFont) and if the corresponding attribute hadn't been

 explicitly set for this window itself, then this window takes the same
 value as used by the parent. In addition, if the window overrides
 ShouldInheritColours to return false, the colours will not be changed
 explicitly set for this window itself, then this window takes the same
 value as used by the parent. In addition, if the window overrides
 ShouldInheritColours to return false, the colours will not be changed