Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Improve EVT_SHOW documentation.

Browse Source 
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
This commit is contained in:
Vadim Zeitlin
2010-08-15 21:14:11 +00:00
parent 9106ea703c
commit a183ec7094
3 changed files with 12 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
interface/wx/event.h
View File

@@ -3616,6 +3616,11 @@ public:
@class wxShowEvent @class wxShowEvent
An event being sent when the window is shown or hidden. 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. Currently only wxMSW, wxGTK and wxOS2 generate such events.

2
interface/wx/toplevel.h
View File

@@ -59,6 +59,8 @@ enum
Process a @c wxEVT_MOVE_END event, which is generated when the user stops Process a @c wxEVT_MOVE_END event, which is generated when the user stops
moving or sizing a window. wxMSW only. moving or sizing a window. wxMSW only.
See wxMoveEvent. See wxMoveEvent.
@event{EVT_SHOW(func)}
Process a @c wxEVT_SHOW event. See wxShowEvent.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}

7
interface/wx/window.h
View File

@@ -235,8 +235,6 @@ enum wxWindowVariant
Process scroll events. See wxScrollWinEvent. Process scroll events. See wxScrollWinEvent.
@event{EVT_SET_CURSOR(func)} @event{EVT_SET_CURSOR(func)}
Process a @c wxEVT_SET_CURSOR event. See wxSetCursorEvent. 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)} @event{EVT_SIZE(func)}
Process a @c wxEVT_SIZE event. See wxSizeEvent. Process a @c wxEVT_SIZE event. See wxSizeEvent.
@event{EVT_SYS_COLOUR_CHANGED(func)} @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 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. 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 @param show
If @true displays the window. Otherwise, hides it. If @true displays the window. Otherwise, hides it.