Correct wxEVT_AUXn_XXX event types names.

[wxWidgets.git] / interface / wx / window.h

diff --git a/interface/wx/window.h b/interface/wx/window.h
index 0335e85abe56807cdcea19334b443e0bc3450cd3..548752f7c97f8aeb74b23a40f65a5d67a4d8bcb0 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -1423,8 +1423,14 @@ public:
     //@{
 
     /**
-        Clears the window by filling it with the current background colour. Does not
-        cause an erase background event to be generated.
+        Clears the window by filling it with the current background colour.
+
+        Does not cause an erase background event to be generated.
+
+        Notice that this uses wxClientDC to draw on the window and the results
+        of doing it while also drawing on wxPaintDC for this window are
+        undefined. Hence this method shouldn't be used from EVT_PAINT handlers,
+        just use wxDC::Clear() on the wxPaintDC you already use there instead.
     */
     virtual void ClearBackground();
 
@@ -1840,6 +1846,19 @@ public:
     */
     bool ProcessWindowEvent(wxEvent& event);
 
+    /**
+        Wrapper for wxEvtHandler::ProcessEventLocally().
+
+        This method is similar to ProcessWindowEvent() but can be used to
+        search for the event handler only in this window and any event handlers
+        pushed on top of it. Unlike ProcessWindowEvent() it won't propagate the
+        event upwards. But it will use the validator and event handlers
+        associated with this window, if any.
+
+        @since 2.9.1
+     */
+    bool ProcessWindowEventLocally(wxEvent& event);
+
     /**
         Removes and returns the top-most event handler on the event handler stack.
 
@@ -2099,6 +2118,12 @@ public:
     /**
         Raises the window to the top of the window hierarchy (Z-order).
 
+        Notice that this function only requests the window manager to raise
+        this window to the top of Z-order. Depending on its configuration, the
+        window manager may raise the window, not do it at all or indicate that
+        a window requested to be raised in some other way, e.g. by flashing its
+        icon if it is minimized.
+
         @remarks
         This function only works for wxTopLevelWindow-derived classes.
 
@@ -3147,6 +3172,8 @@ public:
         The search is recursive in both cases.
 
         @see FindWindow()
+
+        @return Window with the given @a id or @NULL if not found.
     */
     static wxWindow* FindWindowById(long id, const wxWindow* parent = 0);
 
@@ -3160,6 +3187,8 @@ public:
         The search is recursive in both cases.
 
         @see FindWindow()
+
+        @return Window with the given @a label or @NULL if not found.
     */
     static wxWindow* FindWindowByLabel(const wxString& label,
                                        const wxWindow* parent = 0);
@@ -3176,6 +3205,8 @@ public:
         FindWindowByLabel() is called.
 
         @see FindWindow()
+
+        @return Window with the given @a name or @NULL if not found.
     */
     static wxWindow* FindWindowByName(const wxString& name,
                                       const wxWindow* parent = 0);