Add wxVectorSort function for sorting wxVector<T> containers. Closes #11889

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

diff --git a/interface/wx/event.h b/interface/wx/event.h
index baa35fc9c3667229c3c7950bb2c0cd4fa1fe8ea6..07f56d82c86baedd953c61db5d6036eca796eb28 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -1547,16 +1547,8 @@ public:
 
     A paint event is sent when a window's contents needs to be repainted.
 
-    Please notice that in general it is impossible to change the drawing of a
-    standard control (such as wxButton) and so you shouldn't attempt to handle
-    paint events for them as even if it might work on some platforms, this is
-    inherently not portable and won't work everywhere.
-
-    @remarks
-    Note that in a paint event handler, the application must always create a
-    wxPaintDC object, even if you do not use it. Otherwise, under MS Windows,
-    refreshing for this and other windows will go wrong.
-    For example:
+    The handler of this event must create a wxPaintDC object and use it for
+    painting the window contents. For example:
     @code
     void MyWindow::OnPaint(wxPaintEvent& event)
     {
@@ -1565,6 +1557,12 @@ public:
         DrawMyDocument(dc);
     }
     @endcode
+
+    Notice that you must @e not create other kinds of wxDC (e.g. wxClientDC or
+    wxWindowDC) in EVT_PAINT handlers and also don't create wxPaintDC outside
+    of this event handlers.
+
+
     You can optimize painting by retrieving the rectangles that have been damaged
     and only repainting these. The rectangles are in terms of the client area,
     and are unscrolled, so you will need to do some calculations using the current
@@ -1601,6 +1599,12 @@ public:
     }
     @endcode
 
+    @remarks
+    Please notice that in general it is impossible to change the drawing of a
+    standard control (such as wxButton) and so you shouldn't attempt to handle
+    paint events for them as even if it might work on some platforms, this is
+    inherently not portable and won't work everywhere.
+
 
     @beginEventTable{wxPaintEvent}
     @event{EVT_PAINT(func)}
@@ -2853,6 +2857,37 @@ public:
         when calling wxEventLoopBase::YieldFor().
     */
     virtual wxEventCategory GetEventCategory() const;
+
+    /**
+        Sets custom data payload.
+
+        The @a payload argument may be of any type that wxAny can handle
+        (i.e. pretty much anything). Note that T's copy constructor must be
+        thread-safe, i.e. create a copy that doesn't share anything with
+        the original (see Clone()).
+
+        @note This method is not available with Visual C++ 6.
+
+        @since 2.9.1
+
+        @see GetPayload(), wxAny
+     */
+    template<typename T>
+    void SetPayload(const T& payload);
+
+    /**
+        Get custom data payload.
+
+        Correct type is checked in debug builds.
+
+        @note This method is not available with Visual C++ 6.
+
+        @since 2.9.1
+
+        @see SetPayload(), wxAny
+     */
+    template<typename T>
+    T GetPayload() const;
 };