generate a size event from ShowWithEffect() for consistency with Show()

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

diff --git a/interface/wx/event.h b/interface/wx/event.h
index 8c051f00d882fceb6f2dc1f8555282a46b00783f..ce8f4acf06cedd5b4e891e7fc17e4242fdde12dd 100644 (file)
--- a/interface/wx/event.h
+++ b/interface/wx/event.h
@@ -11,7 +11,6 @@
 
 /**
     @class wxEvent
 
 /**
     @class wxEvent

-    @wxheader{event.h}

 
     An event is a structure holding information about an event passed to a
     callback or member function.
 
     An event is a structure holding information about an event passed to a
     callback or member function.


@@ -172,7 +171,6 @@ protected:
 
 /**
     @class wxEventBlocker
 
 /**
     @class wxEventBlocker

-    @wxheader{event.h}

 
     This class is a special event handler which allows to discard
     any event (or a set of event types) directed to a specific window.
 
     This class is a special event handler which allows to discard
     any event (or a set of event types) directed to a specific window.


@@ -233,7 +231,6 @@ public:
 
 /**
     @class wxEvtHandler
 
 /**
     @class wxEvtHandler

-    @wxheader{event.h}

 
     A class that can handle events from the windowing system.
     wxWindow (and therefore all window classes) are derived from this class.
 
     A class that can handle events from the windowing system.
     wxWindow (and therefore all window classes) are derived from this class.


@@ -635,7 +632,6 @@ public:
 
 /**
     @class wxKeyEvent
 
 /**
     @class wxKeyEvent

-    @wxheader{event.h}

 
     This event class contains information about keypress (character) events.
 
 
     This event class contains information about keypress (character) events.
 


@@ -854,7 +850,6 @@ public:
 
 /**
     @class wxJoystickEvent
 
 /**
     @class wxJoystickEvent

-    @wxheader{event.h}

 
     This event class contains information about joystick events, particularly
     events received by windows.
 
     This event class contains information about joystick events, particularly
     events received by windows.


@@ -967,7 +962,6 @@ public:
 
 /**
     @class wxScrollWinEvent
 
 /**
     @class wxScrollWinEvent

-    @wxheader{event.h}

 
     A scroll event holds information about events sent from scrolling windows.
 
 
     A scroll event holds information about events sent from scrolling windows.
 


@@ -1032,7 +1026,6 @@ public:
 
 /**
     @class wxSysColourChangedEvent
 
 /**
     @class wxSysColourChangedEvent

-    @wxheader{event.h}

 
     This class is used for system colour change events, which are generated
     when the user changes the colour settings using the control panel.
 
     This class is used for system colour change events, which are generated
     when the user changes the colour settings using the control panel.


@@ -1067,7 +1060,6 @@ public:
 
 /**
     @class wxWindowCreateEvent
 
 /**
     @class wxWindowCreateEvent

-    @wxheader{event.h}

 
     This event is sent just after the actual window associated with a wxWindow
     object has been created.
 
     This event is sent just after the actual window associated with a wxWindow
     object has been created.


@@ -1098,7 +1090,6 @@ public:
 
 /**
     @class wxPaintEvent
 
 /**
     @class wxPaintEvent

-    @wxheader{event.h}

 
     A paint event is sent when a window's contents needs to be repainted.
 
 
     A paint event is sent when a window's contents needs to be repainted.
 


@@ -1180,7 +1171,6 @@ public:
 
 /**
     @class wxMaximizeEvent
 
 /**
     @class wxMaximizeEvent

-    @wxheader{event.h}

 
     An event being sent when a top level window is maximized. Notice that it is
     not sent when the window is restored to its original size after it had been
 
     An event being sent when a top level window is maximized. Notice that it is
     not sent when the window is restored to its original size after it had been


@@ -1222,7 +1212,6 @@ enum wxUpdateUIMode
 
 /**
     @class wxUpdateUIEvent
 
 /**
     @class wxUpdateUIEvent

-    @wxheader{event.h}

 
     This class is used for pseudo-events which are called by wxWidgets
     to give an application the chance to update various user interface elements.
 
     This class is used for pseudo-events which are called by wxWidgets
     to give an application the chance to update various user interface elements.


@@ -1422,7 +1411,6 @@ public:
 
 /**
     @class wxClipboardTextEvent
 
 /**
     @class wxClipboardTextEvent

-    @wxheader{event.h}

 
     This class represents the events generated by a control (typically a
     wxTextCtrl but other windows can generate these events as well) when its
 
     This class represents the events generated by a control (typically a
     wxTextCtrl but other windows can generate these events as well) when its


@@ -1475,7 +1463,6 @@ public:
 
 /**
     @class wxMouseEvent
 
 /**
     @class wxMouseEvent

-    @wxheader{event.h}

 
     This event class contains information about the events generated by the mouse:
     they include mouse buttons press and release events and mouse move events.
 
     This event class contains information about the events generated by the mouse:
     they include mouse buttons press and release events and mouse move events.


@@ -1889,7 +1876,6 @@ public:
 
 /**
     @class wxDropFilesEvent
 
 /**
     @class wxDropFilesEvent

-    @wxheader{event.h}

 
     This class is used for drop files events, that is, when files have been dropped
     onto the window. This functionality is currently only available under Windows.
 
     This class is used for drop files events, that is, when files have been dropped
     onto the window. This functionality is currently only available under Windows.


@@ -1943,7 +1929,6 @@ public:
 
 /**
     @class wxCommandEvent
 
 /**
     @class wxCommandEvent

-    @wxheader{event.h}

 
     This event class contains information about command events, which originate
     from a variety of simple controls.
 
     This event class contains information about command events, which originate
     from a variety of simple controls.


@@ -2131,7 +2116,6 @@ public:
 
 /**
     @class wxActivateEvent
 
 /**
     @class wxActivateEvent

-    @wxheader{event.h}

 
     An activate event is sent when a window or application is being activated
     or deactivated.
 
     An activate event is sent when a window or application is being activated
     or deactivated.


@@ -2174,7 +2158,6 @@ public:
 
 /**
     @class wxContextMenuEvent
 
 /**
     @class wxContextMenuEvent

-    @wxheader{event.h}

 
     This class is used for context menu events, sent to give
     the application a chance to show a context (popup) menu.
 
     This class is used for context menu events, sent to give
     the application a chance to show a context (popup) menu.


@@ -2231,7 +2214,6 @@ public:
 
 /**
     @class wxEraseEvent
 
 /**
     @class wxEraseEvent

-    @wxheader{event.h}

 
     An erase event is sent when a window's background needs to be repainted.
 
 
     An erase event is sent when a window's background needs to be repainted.
 


@@ -2278,7 +2260,6 @@ public:
 
 /**
     @class wxFocusEvent
 
 /**
     @class wxFocusEvent

-    @wxheader{event.h}

 
     A focus event is sent when a window's focus changes. The window losing focus
     receives a "kill focus" event while the window gaining it gets a "set focus" one.
 
     A focus event is sent when a window's focus changes. The window losing focus
     receives a "kill focus" event while the window gaining it gets a "set focus" one.


@@ -2321,7 +2302,6 @@ public:
 
 /**
     @class wxChildFocusEvent
 
 /**
     @class wxChildFocusEvent

-    @wxheader{event.h}

 
     A child focus event is sent to a (parent-)window when one of its child windows
     gains focus, so that the window could restore the focus back to its corresponding
 
     A child focus event is sent to a (parent-)window when one of its child windows
     gains focus, so that the window could restore the focus back to its corresponding


@@ -2365,7 +2345,6 @@ public:
 
 /**
     @class wxMouseCaptureLostEvent
 
 /**
     @class wxMouseCaptureLostEvent

-    @wxheader{event.h}

 
     An mouse capture lost event is sent to a window that obtained mouse capture,
     which was subsequently loss due to "external" event, for example when a dialog
 
     An mouse capture lost event is sent to a window that obtained mouse capture,
     which was subsequently loss due to "external" event, for example when a dialog


@@ -2404,7 +2383,6 @@ public:
 
 /**
     @class wxNotifyEvent
 
 /**
     @class wxNotifyEvent

-    @wxheader{event.h}

 
     This class is not used by the event handlers by itself, but is a base class
     for other event classes (such as wxNotebookEvent).
 
     This class is not used by the event handlers by itself, but is a base class
     for other event classes (such as wxNotebookEvent).


@@ -2468,7 +2446,6 @@ enum wxHelpEventOrigin
 
 /**
     @class wxHelpEvent
 
 /**
     @class wxHelpEvent

-    @wxheader{event.h}

 
     A help event is sent when the user has requested context-sensitive help.
     This can either be caused by the application requesting context-sensitive help mode
 
     A help event is sent when the user has requested context-sensitive help.
     This can either be caused by the application requesting context-sensitive help mode


@@ -2545,7 +2522,6 @@ public:
 
 /**
     @class wxScrollEvent
 
 /**
     @class wxScrollEvent

-    @wxheader{event.h}

 
     A scroll event holds information about events sent from stand-alone
     scrollbars (see wxScrollBar) and sliders (see wxSlider).
 
     A scroll event holds information about events sent from stand-alone
     scrollbars (see wxScrollBar) and sliders (see wxSlider).


@@ -2664,7 +2640,6 @@ enum wxIdleMode
 
 /**
     @class wxIdleEvent
 
 /**
     @class wxIdleEvent

-    @wxheader{event.h}

 
     This class is used for idle events, which are generated when the system becomes
     idle. Note that, unless you do something specifically, the idle events are not
 
     This class is used for idle events, which are generated when the system becomes
     idle. Note that, unless you do something specifically, the idle events are not


@@ -2764,7 +2739,6 @@ public:
 
 /**
     @class wxInitDialogEvent
 
 /**
     @class wxInitDialogEvent

-    @wxheader{event.h}

 
     A wxInitDialogEvent is sent as a dialog or panel is being initialised.
     Handlers for this event can transfer data to the window.
 
     A wxInitDialogEvent is sent as a dialog or panel is being initialised.
     Handlers for this event can transfer data to the window.


@@ -2794,7 +2768,6 @@ public:
 
 /**
     @class wxWindowDestroyEvent
 
 /**
     @class wxWindowDestroyEvent

-    @wxheader{event.h}

 
     This event is sent from the wxWindow destructor wxWindow::~wxWindow() when a
     window is destroyed.
 
     This event is sent from the wxWindow destructor wxWindow::~wxWindow() when a
     window is destroyed.


@@ -2837,7 +2810,6 @@ enum wxNavigationKeyEventFlags
 
 /**
     @class wxNavigationKeyEvent
 
 /**
     @class wxNavigationKeyEvent

-    @wxheader{event.h}

 
     This event class contains information about navigation events,
     generated by navigation keys such as tab and page down.
 
     This event class contains information about navigation events,
     generated by navigation keys such as tab and page down.


@@ -2917,7 +2889,6 @@ public:
 
 /**
     @class wxMouseCaptureChangedEvent
 
 /**
     @class wxMouseCaptureChangedEvent

-    @wxheader{event.h}

 
     An mouse capture changed event is sent to a window that loses its
     mouse capture. This is called even if wxWindow::ReleaseCapture
 
     An mouse capture changed event is sent to a window that loses its
     mouse capture. This is called even if wxWindow::ReleaseCapture


@@ -2958,7 +2929,6 @@ public:
 
 /**
     @class wxCloseEvent
 
 /**
     @class wxCloseEvent

-    @wxheader{event.h}

 
     This event class contains information about window and session close events.
 
 
     This event class contains information about window and session close events.
 


@@ -3058,7 +3028,6 @@ public:
 
 /**
     @class wxMenuEvent
 
 /**
     @class wxMenuEvent

-    @wxheader{event.h}

 
     This class is used for a variety of menu-related events. Note that
     these do not include menu command events, which are
 
     This class is used for a variety of menu-related events. Note that
     these do not include menu command events, which are


@@ -3117,7 +3086,6 @@ public:
 
 /**
     @class wxShowEvent
 
 /**
     @class wxShowEvent

-    @wxheader{event.h}

 
     An event being sent when the window is shown or hidden.
 
 
     An event being sent when the window is shown or hidden.
 


@@ -3166,7 +3134,6 @@ public:
 
 /**
     @class wxIconizeEvent
 
 /**
     @class wxIconizeEvent

-    @wxheader{event.h}

 
     An event being sent when the frame is iconized (minimized) or restored.
 
 
     An event being sent when the frame is iconized (minimized) or restored.
 


@@ -3209,7 +3176,6 @@ public:
 
 /**
     @class wxMoveEvent
 
 /**
     @class wxMoveEvent

-    @wxheader{event.h}

 
     A move event holds information about move change events.
 
 
     A move event holds information about move change events.
 


@@ -3246,7 +3212,6 @@ public:
 
 /**
     @class wxSizeEvent
 
 /**
     @class wxSizeEvent

-    @wxheader{event.h}

 
     A size event holds information about size change events.
 
 
     A size event holds information about size change events.
 


@@ -3290,7 +3255,6 @@ public:
 
 /**
     @class wxSetCursorEvent
 
 /**
     @class wxSetCursorEvent

-    @wxheader{event.h}

 
     A SetCursorEvent is generated when the mouse cursor is about to be set as a
     result of mouse motion.
 
     A SetCursorEvent is generated when the mouse cursor is about to be set as a
     result of mouse motion.