From 5fafec4d9f3b7e31688cb0162b7c5db751314d01 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Thu, 8 Dec 2011 13:07:53 +0000 Subject: [PATCH] Document that wxEraseEvent::GetDC() never returns NULL. This makes implementation of EVT_ERASE_BACKGROUND handlers simpler. Closes #13736. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@69954 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/wx/event.h | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/interface/wx/event.h b/interface/wx/event.h index afc71acc7d..31b9606d71 100644 --- a/interface/wx/event.h +++ b/interface/wx/event.h @@ -2852,12 +2852,8 @@ public: To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table definition. - You must call wxEraseEvent::GetDC and use the returned device context if it is - non-@NULL. If it is @NULL, create your own temporary wxClientDC object. - - @remarks - Use the device context returned by GetDC to draw on, don't create - a wxPaintDC in the event handler. + You must use the device context returned by GetDC() to draw on, don't create + a wxPaintDC in the event handler. @beginEventTable{wxEraseEvent} @event{EVT_ERASE_BACKGROUND(func)} @@ -2879,6 +2875,8 @@ public: /** Returns the device context associated with the erase event to draw on. + + The returned pointer is never @NULL. */ wxDC* GetDC() const; };