Improved documentation for wxPGProperty::DoSetAttribute()

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

diff --git a/interface/wx/event.h b/interface/wx/event.h
index cc24d5bcb4502644092c2f5968d5f0725ac51076..baa35fc9c3667229c3c7950bb2c0cd4fa1fe8ea6 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -467,11 +467,11 @@ public:
            the function skips to step (7).
         -# TryBefore() is called (this is where wxValidator are taken into
            account for wxWindow objects). If this returns @true, the function exits.
-        -# Dynamic event table of the handlers binded using Bind<>() is
+        -# Dynamic event table of the handlers bound using Bind<>() is
            searched. If a handler is found, it is executed and the function
            returns @true unless the handler used wxEvent::Skip() to indicate
            that it didn't handle the event in which case the search continues.
-        -# Static events table of the handlers binded using event table
+        -# Static events table of the handlers bound using event table
            macros is searched for this event handler. If this fails, the base
            class event table table is tried, and so on until no more tables
            exist or an appropriate function was found. If a handler is found,
@@ -790,6 +790,8 @@ public:
         @param userData
             Data to be associated with the event table entry.
 
+        @see @ref overview_cpp_rtti_disabled
+
         @since 2.9.0
     */
     template <typename EventTag, typename Functor>
@@ -823,6 +825,8 @@ public:
         @param userData
             Data to be associated with the event table entry.
 
+        @see @ref overview_cpp_rtti_disabled
+
         @since 2.9.0
     */
     template <typename EventTag, typename Class, typename EventArg, typename EventHandler>
@@ -839,7 +843,7 @@ public:
 
         This method can only unbind functions, functors or methods which have
         been added using the Bind<>() method. There is no way to unbind
-        functions binded using the (static) event tables.
+        functions bound using the (static) event tables.
 
         @param eventType
             The event type associated with this event handler.
@@ -855,6 +859,8 @@ public:
         @param userData
             Data associated with the event table entry.
 
+        @see @ref overview_cpp_rtti_disabled
+
         @since 2.9.0
     */
     template <typename EventTag, typename Functor>
@@ -885,6 +891,8 @@ public:
         @param userData
             Data associated with the event table entry.
 
+        @see @ref overview_cpp_rtti_disabled
+
         @since 2.9.0
     */
     template <typename EventTag, typename Class, typename EventArg, typename EventHandler>
@@ -3409,13 +3417,13 @@ public:
 
     @beginEventTable{wxCloseEvent}
     @event{EVT_CLOSE(func)}
-        Process a close event, supplying the member function.
+        Process a @c wxEVT_CLOSE_WINDOW command event, supplying the member function.
         This event applies to wxFrame and wxDialog classes.
     @event{EVT_QUERY_END_SESSION(func)}
-        Process a query end session event, supplying the member function.
+        Process a @c wxEVT_QUERY_END_SESSION session event, supplying the member function.
         This event can be handled in wxApp-derived class only.
     @event{EVT_END_SESSION(func)}
-        Process an end session event, supplying the member function.
+        Process a @c wxEVT_END_SESSION session event, supplying the member function.
         This event can be handled in wxApp-derived class only.
     @endEventTable
 
@@ -3660,7 +3668,7 @@ public:
 
     You may wish to use this for frames to resize their child windows as appropriate.
 
-    Note that the size passed is of the whole window: call wxWindow::GetClientSize
+    Note that the size passed is of the whole window: call wxWindow::GetClientSize()
     for the area which may be used by the application.
 
     When a window is resized, usually only a small part of the window is damaged
@@ -3688,6 +3696,11 @@ public:
 
     /**
         Returns the entire size of the window generating the size change event.
+
+        This is the new total size of the window, i.e. the same size as would
+        be returned by wxWindow::GetSize() if it were called now. Use
+        wxWindow::GetClientSize() if you catch this event in a top level window
+        such as wxFrame to find the size available for the window contents.
     */
     wxSize GetSize() const;
 };