better documentation of DeviceToLogicalXXX() (#9896)

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

diff --git a/interface/wx/window.h b/interface/wx/window.h
index 2161f7dda81a51c0abe63a3a1d15adf076853446..b7b8b22875929d482cdd7e87560a0a26cf387031 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -8,7 +8,6 @@
 
 /**
     @class wxWindow
-    @wxheader{window.h}
 
     wxWindow is the base class for all windows and represents any visible object on
     screen. All controls, top level windows and so on are windows. Sizers and
@@ -1589,6 +1588,21 @@ public:
     bool PopupMenu(wxMenu* menu, int x, int y);
     //@}
 
+    /**
+        Posts a size event to the window.
+
+        This is the same as SendSizeEvent() with @c wxSEND_EVENT_POST argument.
+     */
+    void PostSizeEvent();
+
+    /**
+        Posts a size event to the parent of this window.
+
+        This is the same as SendSizeEventToParent() with @c wxSEND_EVENT_POST
+        argument.
+     */
+    void PostSizeEventToParent();
+
     /**
         Pushes this event handler onto the event stack for the window.
 
@@ -1785,6 +1799,42 @@ public:
     virtual void ScrollWindow(int dx, int dy,
                               const wxRect* rect = NULL);
 
+    /**
+        This function sends a dummy @ref overview_wxsizeevent "size event" to
+        the window allowing it to re-layout its children positions.
+
+        It is sometimes useful to call this function after adding or deleting a
+        children after the frame creation or if a child size changes. Note that
+        if the frame is using either sizers or constraints for the children
+        layout, it is enough to call wxWindow::Layout() directly and this
+        function should not be used in this case.
+
+        If @a flags includes @c wxSEND_EVENT_POST value, this function posts
+        the event, i.e. schedules it for later processing, instead of
+        dispatching it directly. You can also use PostSizeEvent() as a more
+        readable equivalent of calling this function with this flag.
+
+        @param flags
+            May include @c wxSEND_EVENT_POST. Default value is 0.
+    */
+    void SendSizeEvent(int flags = 0);
+
+    /**
+        Safe wrapper for GetParent()->SendSizeEvent().
+
+        This function simply checks that the window has a valid parent which is
+        not in process of being deleted and calls SendSizeEvent() on it. It is
+        used internally by windows such as toolbars changes to whose state
+        should result in parent re-layout (e.g. when a toolbar is added to the
+        top of the window, all the other windows must be shifted down).
+
+        @see PostSizeEventToParent()
+
+        @param flags
+            See description of this parameter in SendSizeEvent() documentation.
+     */
+    void SendSizeEventToParent(int flags = 0);
+
     /**
         Sets the accelerator table for this window. See wxAcceleratorTable.
     */
@@ -2349,8 +2399,16 @@ public:
     //@{
     /**
         Attach a tooltip to the window.
-        See also: GetToolTip(),
-         wxToolTip
+
+        wxToolTip pointer can be @NULL in the overload taking the pointer,
+        meaning to unset any existing tooltips, however UnsetToolTip() provides
+        a more readable alternative to this operation.
+
+        Notice that these methods are always available, even if wxWidgets was
+        compiled with @c wxUSE_TOOLTIPS set to 0, but don't do anything in this
+        case.
+
+        @see GetToolTip(), wxToolTip
     */
     void SetToolTip(const wxString& tip);
     void SetToolTip(wxToolTip* tip);
@@ -2534,6 +2592,15 @@ public:
     */
     static void UnreserveControlId(wxWindowID id, int count = 1);
 
+    /**
+        Unset any existing tooltip.
+
+        @since 2.9.0
+
+        @see SetToolTip()
+     */
+    void UnsetToolTip();
+
     /**
         Calling this method immediately repaints the invalidated area of the window and
         all of its children recursively while this would usually only happen when the