Improve EVT_SHOW documentation.

Mention that it applies to the TLWs only and explain when it is generated (and
not generated).

Closes #12353.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@65316 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/interface/wx/event.h b/interface/wx/event.h
index 5d95b9b29a92e63d292449e707904dcd771001a6..ce3793bd082399d36043e86c4bc4c2d4e6a411f8 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -3616,6 +3616,11 @@ public:
     @class wxShowEvent
 
     An event being sent when the window is shown or hidden.
+    The event is triggered by calls to wxWindow::Show(), and any user
+    action showing a previously hidden window or vice versa (if allowed by
+    the current platform and/or window manager).
+    Notice that the event is not triggered when the application is iconized
+    (minimized) or restored under wxMSW.
 
     Currently only wxMSW, wxGTK and wxOS2 generate such events.
 

diff --git a/interface/wx/toplevel.h b/interface/wx/toplevel.h
index 5afa28037fbaf9afa196c0fb582e4448785eb689..bb8bdea42f415ee3c1110dd4a57a0d565b6f706b 100644 (file)
--- a/interface/wx/toplevel.h
+++ b/interface/wx/toplevel.h
@@ -59,6 +59,8 @@ enum
         Process a @c wxEVT_MOVE_END event, which is generated when the user stops
         moving or sizing a window. wxMSW only.
         See wxMoveEvent.
+    @event{EVT_SHOW(func)}
+        Process a @c wxEVT_SHOW event. See wxShowEvent.
     @endEventTable
 
     @library{wxcore}

diff --git a/interface/wx/window.h b/interface/wx/window.h
index 6a2cc7216c8296cbbc8ffffe409f9cc78b5edb6e..180aef5b63a34faf6b3d8c7d6b8b6292aad41bc8 100644 (file)
--- a/interface/wx/window.h
+++ b/interface/wx/window.h
@@ -235,8 +235,6 @@ enum wxWindowVariant
         Process scroll events. See wxScrollWinEvent.
     @event{EVT_SET_CURSOR(func)}
         Process a @c wxEVT_SET_CURSOR event. See wxSetCursorEvent.
-    @event{EVT_SHOW(func)}
-        Process a @c wxEVT_SHOW event. See wxShowEvent.
     @event{EVT_SIZE(func)}
         Process a @c wxEVT_SIZE event. See wxSizeEvent.
     @event{EVT_SYS_COLOUR_CHANGED(func)}
@@ -2235,6 +2233,11 @@ public:
         for a top level window if you want to bring it to top, although this is not
         needed if Show() is called immediately after the frame creation.
 
+        Notice that the default state of newly created top level windows is hidden
+        (to allow you to create their contents without flicker) unlike for
+        all the other, not derived from wxTopLevelWindow, windows that
+        are by default created in the shown state.
+
         @param show
             If @true displays the window. Otherwise, hides it.