Add *wxTopLevelWindowGTK*RequestUserAttention*int*;

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

diff --git a/wxPython/src/_window.i b/wxPython/src/_window.i
index 7386f5e087de5841b81d072e8f3b9eeeb68bc91a..b67890b39e9ca1d7c8402e13c2434b51796f6a3d 100644 (file)
--- a/wxPython/src/_window.i
+++ b/wxPython/src/_window.i
@@ -175,12 +175,12 @@ Extra Styles
 
     wx.WS_EX_PROCESS_IDLE           This window should always process idle
                                     events, even if the mode set by
 
     wx.WS_EX_PROCESS_IDLE           This window should always process idle
                                     events, even if the mode set by

-                                    wx.IdleEvent.SetMode is
+                                    `wx.IdleEvent.SetMode` is

                                     wx.IDLE_PROCESS_SPECIFIED.
 
     wx.WS_EX_PROCESS_UI_UPDATES     This window should always process UI
                                     update events, even if the mode
                                     wx.IDLE_PROCESS_SPECIFIED.
 
     wx.WS_EX_PROCESS_UI_UPDATES     This window should always process UI
                                     update events, even if the mode

-                                    set by wxUpdateUIEvent::SetMode is
+                                    set by `wx.UpdateUIEvent.SetMode` is

                                     wxUPDATE_UI_PROCESS_SPECIFIED.
     =============================   =====================================
 
                                     wxUPDATE_UI_PROCESS_SPECIFIED.
     =============================   =====================================
 


@@ -389,11 +389,18 @@ autogenerated) id", "");
                         int sizeFlags = wxSIZE_AUTO ),
         "Sets the position and size of the window in pixels.  The sizeFlags
 parameter indicates the interpretation of the other params if they are
                         int sizeFlags = wxSIZE_AUTO ),
         "Sets the position and size of the window in pixels.  The sizeFlags
 parameter indicates the interpretation of the other params if they are

--1.  wx.SIZE_AUTO*: a -1 indicates that a class-specific default
-shoudl be used.  wx.SIZE_USE_EXISTING: existing dimensions should be
-used if -1 values are supplied.  wxSIZE_ALLOW_MINUS_ONE: allow
-dimensions of -1 and less to be interpreted as real dimensions, not
-default values.", "",
+equal to -1.
+
+    ========================  ======================================
+    wx.SIZE_AUTO              A -1 indicates that a class-specific
+                              default should be used.
+    wx.SIZE_USE_EXISTING      Axisting dimensions should be used if
+                              -1 values are supplied.
+    wxSIZE_ALLOW_MINUS_ONE    Allow dimensions of -1 and less to be
+                              interpreted as real dimensions, not
+                              default values.
+    ========================  ======================================
+", "",

         SetDimensions);
     
 
         SetDimensions);
     
 


@@ -520,6 +527,10 @@ after calling Fit.", "");
         "Reset the cached best size value so it will be recalculated the next
 time it is needed.", "");
 
         "Reset the cached best size value so it will be recalculated the next
 time it is needed.", "");
 

+    DocDeclStr(
+        void , CacheBestSize(const wxSize& size) const,
+        "Cache the best size so it doesn't need to be calculated again, (at least until
+some properties of the window change.)", "");

 
     
     DocDeclStr(
 
     
     DocDeclStr(


@@ -1208,7 +1219,7 @@ to the window.", "");
     
 
     DocDeclStr(
     
 
     DocDeclStr(

-        void , RefreshRect(const wxRect& rect),
+        void , RefreshRect(const wxRect& rect, bool eraseBackground = true),

         "Redraws the contents of the given rectangle: the area inside it will
 be repainted.  This is the same as Refresh but has a nicer syntax.", "");
     
         "Redraws the contents of the given rectangle: the area inside it will
 be repainted.  This is the same as Refresh but has a nicer syntax.", "");
     


@@ -1356,6 +1367,15 @@ not be used at all.", "");
 foreground colour is dependent on the window class; it may be the text
 colour or other colour, or it may not be used at all.", "");
 
 foreground colour is dependent on the window class; it may be the text
 colour or other colour, or it may not be used at all.", "");
 

+    DocDeclStr(
+        bool , InheritsBackgroundColour() const,
+        "", "");
+    
+    DocDeclStr(
+        bool , UseBgCol() const,
+        "", "");
+    
+    

 // TODO:
 //     // if the window shouldn't inherit its colour from the parent, override
 //     // this function to return true
 // TODO:
 //     // if the window shouldn't inherit its colour from the parent, override
 //     // this function to return true


@@ -1391,8 +1411,19 @@ no effect on other platforms.
         "Returns the background style of the window.
 
 :see: `SetBackgroundStyle`", "");
         "Returns the background style of the window.
 
 :see: `SetBackgroundStyle`", "");

+

     
     

+    DocDeclStr(
+        bool , HasTransparentBackground(),
+        "Returns True if this window's background is transparent (as, for
+example, for `wx.StaticText`) and should show the parent window's
+background.

 
 

+This method is mostly used internally by the library itself and you
+normally shouldn't have to call it. You may, however, have to override
+it in your custom control classes to ensure that background is painted
+correctly.", "");
+    

     
     DocDeclStr(
         virtual bool , SetCursor( const wxCursor &cursor ),
     
     DocDeclStr(
         virtual bool , SetCursor( const wxCursor &cursor ),


@@ -1528,7 +1559,7 @@ send an update UI event for each menubar menu item. You can call this
 function from your application to ensure that your UI is up-to-date at
 a particular point in time (as far as your EVT_UPDATE_UI handlers are
 concerned). This may be necessary if you have called
 function from your application to ensure that your UI is up-to-date at
 a particular point in time (as far as your EVT_UPDATE_UI handlers are
 concerned). This may be necessary if you have called

-wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
+`wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to

 limit the overhead that wxWindows incurs by sending update UI events
 in idle time.",
 "
 limit the overhead that wxWindows incurs by sending update UI events
 in idle time.",
 "


@@ -1659,8 +1690,8 @@ toplevel parent of the window.", "");
         "Physically scrolls the pixels in the window and move child windows
 accordingly.  Use this function to optimise your scrolling
 implementations, to minimise the area that must be redrawn. Note that
         "Physically scrolls the pixels in the window and move child windows
 accordingly.  Use this function to optimise your scrolling
 implementations, to minimise the area that must be redrawn. Note that

-it is rarely required to call this function from a user program.",
-"
+it is rarely required to call this function from a user program.","
+

     :param dx:   Amount to scroll horizontally.
 
     :param dy:   Amount to scroll vertically.
     :param dx:   Amount to scroll horizontally.
 
     :param dy:   Amount to scroll vertically.


@@ -1769,11 +1800,15 @@ a drop target, it is deleted.", "");
         "Returns the associated drop target, which may be None.", "");
     
 
         "Returns the associated drop target, which may be None.", "");
     
 

-#ifdef __WXMSW__  // TODO:  should I drop-kick this?
-    DocDeclStr(
-        void , DragAcceptFiles(bool accept),
+    DocStr(DragAcceptFiles,

         "Enables or disables eligibility for drop file events, EVT_DROP_FILES.
         "Enables or disables eligibility for drop file events, EVT_DROP_FILES.

-Only available on Windows.", "");    
+Only functional on Windows.", "");
+#ifdef __WXMSW__  
+    void DragAcceptFiles(bool accept);
+#else
+    %extend {
+        void DragAcceptFiles(bool accept) {}
+    }

 #endif
 #endif
     
 #endif
 #endif
     


@@ -2041,6 +2076,20 @@ wxWindow* wxFindWindowByLabel( const wxString& label,
     }
 %}
 
     }
 %}
 

+//---------------------------------------------------------------------------
+
+DocStr(GetTopLevelWindows,
+"Returns a list of the the application's top-level windows, (frames,
+dialogs, etc.)  NOTE: Currently this is a copy of the list maintained
+by wxWidgets, and so it is only valid as long as no top-level windows
+are closed or new top-level windows are created.
+", "");
+%inline %{
+    PyObject* GetTopLevelWindows() {
+        return wxPy_ConvertList(&wxTopLevelWindows);
+    }
+%}
+

 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------
 
 //---------------------------------------------------------------------------
 //---------------------------------------------------------------------------