]> git.saurik.com Git - wxWidgets.git/commitdiff
make distinction between classes which send events (use @beginEventEmissionTable...
authorFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Wed, 18 Feb 2009 17:58:51 +0000 (17:58 +0000)
committerFrancesco Montorsi <f18m_cpp217828@yahoo.it>
Wed, 18 Feb 2009 17:58:51 +0000 (17:58 +0000)
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59000 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

64 files changed:
docs/doxygen/Doxyfile_inc
interface/wx/app.h
interface/wx/aui/auibook.h
interface/wx/aui/framemanager.h
interface/wx/bmpbuttn.h
interface/wx/bmpcbox.h
interface/wx/button.h
interface/wx/calctrl.h
interface/wx/checkbox.h
interface/wx/checklst.h
interface/wx/choice.h
interface/wx/choicebk.h
interface/wx/clrpicker.h
interface/wx/collpane.h
interface/wx/combo.h
interface/wx/combobox.h
interface/wx/control.h
interface/wx/dataview.h
interface/wx/datectrl.h
interface/wx/dialog.h
interface/wx/dialup.h
interface/wx/event.h
interface/wx/fdrepdlg.h
interface/wx/filectrl.h
interface/wx/filepicker.h
interface/wx/fontpicker.h
interface/wx/frame.h
interface/wx/headerctrl.h
interface/wx/html/htmlwin.h
interface/wx/htmllbox.h
interface/wx/hyperlink.h
interface/wx/laywin.h
interface/wx/listbook.h
interface/wx/listbox.h
interface/wx/listctrl.h
interface/wx/menuitem.h
interface/wx/notebook.h
interface/wx/odcombo.h
interface/wx/panel.h
interface/wx/power.h
interface/wx/process.h
interface/wx/propgrid/propgrid.h
interface/wx/radiobox.h
interface/wx/radiobut.h
interface/wx/sashwin.h
interface/wx/scrolbar.h
interface/wx/slider.h
interface/wx/socket.h
interface/wx/spinbutt.h
interface/wx/spinctrl.h
interface/wx/splitter.h
interface/wx/srchctrl.h
interface/wx/stc/stc.h
interface/wx/taskbar.h
interface/wx/textctrl.h
interface/wx/tglbtn.h
interface/wx/timer.h
interface/wx/toolbar.h
interface/wx/toolbook.h
interface/wx/toplevel.h
interface/wx/treebook.h
interface/wx/treectrl.h
interface/wx/window.h
interface/wx/wizard.h

index 8afbd597c60ae5a563dfe81ab1e394db6b3c348d..2a695611ef79b36a8d022d3f6f77ad57e58dcada 100644 (file)
@@ -52,9 +52,16 @@ SYMBOL_CACHE_SIZE      = 0
 # Aliases - for use when documenting C++ classes
 #---------------------------------------------------------------------------
 
-# event aliases
-ALIASES = beginEventTable{1}="\n<h2>Events</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros:<div>"
-ALIASES += beginEventTable{2}="\n<h2>Events</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros:<div>"
+# aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc):
+ALIASES = beginEventEmissionTable="\n<h2>Events emitted by this class</h2><p>Event macros for events emitted by this class:</p><div>"
+ALIASES += beginEventEmissionTable{1}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros for events emitted by this class:<div>"
+ALIASES += beginEventEmissionTable{2}="\n<h2>Events emitted by this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros for events emitted by this class:<div>"
+
+# aliases to be used in wxEvent-derived classes:
+ALIASES += beginEventTable{1}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span></div></p>Event macros:<div>"
+ALIASES += beginEventTable{2}="\n<h2>Events using this class</h2><p>The following event handler macros redirect the events to member function handlers '<b>func</b>' with prototypes like: <div class='eventHandler'><span>void&nbsp;handlerFuncName(\1&&nbsp;event)</span> or <span>void&nbsp;handlerFuncName(\2&&nbsp;event)</span></div></p>Event macros:<div>"
+
+# common event aliases:
 ALIASES += event{1}="</div>\li <span class='event'>\1</span>:<div class='eventDesc'>"
 ALIASES += event{2}="</div>\li <span class='event'>\1, \2</span>:<div class='eventDesc'>"
 ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"
@@ -314,10 +321,10 @@ GENERATE_CHI           = NO
 BINARY_TOC             = NO
 TOC_EXPAND             = NO
 GENERATE_QHP           = NO
-QCH_FILE               = 
+QCH_FILE               =
 QHP_NAMESPACE          = org.wxwidgets.doxygen
 QHP_VIRTUAL_FOLDER     = doc
-QHG_LOCATION           = 
+QHG_LOCATION           =
 DISABLE_INDEX          = NO
 ENUM_VALUES_PER_LINE   = 1
 GENERATE_TREEVIEW      = NONE
@@ -420,7 +427,7 @@ HIDE_UNDOC_RELATIONS   = YES
 HAVE_DOT               = YES
 DOT_FONTNAME           = FreeSans
 DOT_FONTSIZE           = 10
-DOT_FONTPATH           = 
+DOT_FONTPATH           =
 CLASS_GRAPH            = YES
 COLLABORATION_GRAPH    = NO
 GROUP_GRAPHS           = NO
index a67a414d695f30b8d46999b962e045b809e64a89..3e6fa3a054c06b847c8a27c55f98a5503806ce72 100644 (file)
@@ -493,6 +493,25 @@ public:
     In general, application-wide settings for GUI-only apps are accessible
     from wxApp (or from wxSystemSettings or wxSystemOptions classes).
 
+    @beginEventEmissionTable
+    @event{EVT_QUERY_END_SESSION(func)}
+        Process a query end session event, supplying the member function.
+        See wxCloseEvent.
+    @event{EVT_END_SESSION(func)}
+        Process an end session event, supplying the member function.
+        See wxCloseEvent.
+    @event{EVT_ACTIVATE_APP(func)}
+        Process a @c wxEVT_ACTIVATE_APP event. See wxActivateEvent.
+    @event{EVT_HIBERNATE(func)}
+        Process a hibernate event. See wxActivateEvent.
+    @event{EVT_DIALUP_CONNECTED(func)}
+        A connection with the network was established. See wxDialUpEvent.
+    @event{EVT_DIALUP_DISCONNECTED(func)}
+        The connection with the network was lost. See wxDialUpEvent.
+    @event{EVT_IDLE(func)}
+        Process a @c wxEVT_IDLE event. See wxIdleEvent.
+    @endEventTable
+
     @library{wxbase}
     @category{appmanagement}
 
index 0d0eb541400883545db6bea7f75f3068e5bea9ac..23812d65da282a95331b9c6e520329ecd314e88b 100644 (file)
@@ -55,7 +55,7 @@
     @endStyleTable
 
 
-    @beginEventTable{wxAuiNotebookEvent}
+    @beginEventEmissionTable{wxAuiNotebookEvent}
     @event{EVT_AUINOTEBOOK_PAGE_CLOSE(id, func)}
         Provide description.
     @event{EVT_AUINOTEBOOK_PAGE_CHANGED(id, func)}
index 837972ef6a9bc274de921a3841917bd080246cc6..b58e501b495824925bfef19892c32439efd9e965 100644 (file)
@@ -111,7 +111,7 @@ enum wxAuiManagerOption
         understand layers is by running the wxAUI sample.
 
 
-    @beginEventTable{wxAuiManagerEvent}
+    @beginEventEmissionTable{wxAuiManagerEvent}
     @event{EVT_AUI_PANE_BUTTON(func)}
         Triggered when any button is pressed for any docked panes.
     @event{EVT_AUI_PANE_CLOSE(func)}
index 320093d419f10371f2e523d3117a62d3c09f7156..457995a7ee49dd9ba3525de183978529ecad773b 100644 (file)
@@ -54,7 +54,7 @@
     Note that the wxBU_EXACTFIT style supported by wxButton is not used by this
     class as bitmap buttons don't have any minimal standard size by default.
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_BUTTON(id, func)}
            Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.
     @endEventTable
index c073ead100378dd47b2da39b06c70bd224865aab..60bb9c842ac0d9f571f885b51b21df9318d46c30 100644 (file)
@@ -36,7 +36,7 @@
 
     @todo create wxCB_PROCESS_ENTER rather than reusing wxTE_PROCESS_ENTER!
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_COMBOBOX(id, func)}
            Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
            the list is selected.
index 127938c17fa44d9647c3b2264f7eb21fa9dd29c1..5bb2bff16e31d11aa527d3b233729a129bdf4f5d 100644 (file)
@@ -31,7 +31,7 @@
            Creates a flat button. Windows and GTK+ only.
     @endStyleTable
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_BUTTON(id, func)}
            Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.
     @endEventTable
index ccd01dba9ed613253c2a2d5f2a2f4c9f37401d74..dc0c5c9bf4be9a64681b27c24da0fd263ba592a6 100644 (file)
@@ -237,7 +237,7 @@ enum wxCalendarHitTestResult
            Show week numbers on the left side of the calendar. (not in generic)
     @endStyleTable
 
-    @beginEventTable{wxCalendarEvent}
+    @beginEventEmissionTable{wxCalendarEvent}
     @event{EVT_CALENDAR(id, func)}
            A day was double clicked in the calendar.
     @event{EVT_CALENDAR_SEL_CHANGED(id, func)}
index 73278025630446dd6224f88601c8558531230325..94516894d0f2c75239204c287f2784c6fcd1925d 100644 (file)
@@ -39,7 +39,7 @@ enum wxCheckBoxState
            Makes the text appear on the left of the checkbox.
     @endStyleTable
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_CHECKBOX(id, func)}
            Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox
            is clicked.
index f1cc9e9a9a5eb0c4dc3d11d0944c18af356229ff..982209412b23a867c891f14ded6d204bb596ed68 100644 (file)
     When using this class under Windows wxWidgets must be compiled with
     wxUSE_OWNER_DRAWN set to 1.
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_CHECKLISTBOX(id, func)}
-           Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in
-           the check list box is checked or unchecked. wxCommandEvent::GetInt()
-           will contain the index of the item that was checked or unchecked.
-           wxCommandEvent::IsChecked() is not valid! Use wxCheckListBox::IsChecked()
-           instead.
+        Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in
+        the check list box is checked or unchecked. wxCommandEvent::GetInt()
+        will contain the index of the item that was checked or unchecked.
+        wxCommandEvent::IsChecked() is not valid! Use wxCheckListBox::IsChecked()
+        instead.
     @endEventTable
 
     @library{wxcore}
index 19f71b00ef99b9e94bd32092269bc9c3c379c7ab..82cb664da29542c7180657de866c0223a72b0433 100644 (file)
@@ -18,7 +18,7 @@
            Sorts the entries alphabetically.
     @endStyleTable
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_CHOICE(id, func)}
            Process a wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the
            list is selected.
index 202747d1bcbdd0e44b30b156bf149464ffcb6a7a..bc3fec7ea1890bf0152e5e179b3430b0239f2660 100644 (file)
@@ -35,7 +35,7 @@
            Place labels below the page area.
     @endStyleTable
 
-    @beginEventTable{wxBookCtrlEvent}
+    @beginEventEmissionTable{wxBookCtrlEvent}
     @event{EVT_CHOICEBOOK_PAGE_CHANGED(id, func)}
         The page selection was changed.
         Processes a @c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED event.
index 93391720f736dd15cc5c3477a7b5168ff3e5866b..551711ff518f6999ab3baa7fae4bd64959952fd7 100644 (file)
@@ -29,7 +29,7 @@
            (instead of no label at all).
     @endStyleTable
 
-    @beginEventTable{wxColourPickerEvent}
+    @beginEventEmissionTable{wxColourPickerEvent}
     @event{EVT_COLOURPICKER_CHANGED(id, func)}
            The user changed the colour selected in the control either using the
            button or using text control (see @c wxCLRP_USE_TEXTCTRL; note that
index 5718757d1f627d36d74ee3e43678442eeea6068d..2d0573f5aee248c6258f6eb0fc1f5306e74909e1 100644 (file)
@@ -91,9 +91,11 @@ public:
         flag to disable this automatic parent resizing then.
     @endStyleTable
 
-    @beginEventTable{wxCollapsiblePaneEvent}
+    @beginEventEmissionTable{wxCollapsiblePaneEvent,wxNavigationKeyEvent}
     @event{EVT_COLLAPSIBLEPANE_CHANGED(id, func)}
-           The user expanded or collapsed the collapsible pane.
+        The user expanded or collapsed the collapsible pane.
+    @event{EVT_NAVIGATION_KEY(func)}
+        Process a navigation key event.
     @endEventTable
 
     @library{wxcore}
index 604340e956e10136525e32d700877e5a0245ad11..4e49a4386e0a3b0f3ec868abdb44093e08107ece 100644 (file)
@@ -292,7 +292,7 @@ struct wxComboCtrlFeatures
            Drop button will behave more like a standard push button.
     @endStyleTable
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_TEXT(id, func)}
            Process a wxEVT_COMMAND_TEXT_UPDATED event, when the text changes.
     @event{EVT_TEXT_ENTER(id, func)}
index 931d495294014546c5889a71fc8c76edf551384f..2054fbd949aec4771fb0407626410aa3d9df529d 100644 (file)
@@ -37,7 +37,7 @@
            only.
     @endStyleTable
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_COMBOBOX(id, func)}
            Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
            the list is selected. Note that calling GetValue() returns the new
index cba493cbb97d60d04fd8a83c147d32564a67ea84..2d56ad3c609a1955ecaea54241ff81cffdc826c5 100644 (file)
@@ -53,6 +53,16 @@ enum wxEllipsizeMode
     A control is generally a small window which processes user input and/or
     displays one or more item of data.
 
+    @beginEventEmissionTable{wxClipboardTextEvent}
+    @event{EVT_TEXT_COPY(id, func)}
+           Some or all of the controls content was copied to the clipboard.
+    @event{EVT_TEXT_CUT(id, func)}
+           Some or all of the controls content was cut (i.e. copied and
+           deleted).
+    @event{EVT_TEXT_PASTE(id, func)}
+           Clipboard content was pasted into the control.
+    @endEventTable
+
     @library{wxcore}
     @category{ctrl}
 
index ce3da34d0b2c7b560a901765acefc64fe6082f2d..3168a38dcabfe7ca2737fff9a7d2ad4d52edffd1 100644 (file)
@@ -525,7 +525,7 @@ public:
             This can be inefficient when displaying large number of items.
     @endStyleTable
 
-    @beginEventTable{wxDataViewEvent}
+    @beginEventEmissionTable{wxDataViewEvent}
     @event{EVT_DATAVIEW_SELECTION_CHANGED(id, func)}
            Process a wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED event.
     @event{EVT_DATAVIEW_ITEM_ACTIVATED(id, func)}
index 90d457a2208723002faa6a14bcb02e125a5f132f..086bb2edb1a807a6d786ab4534c0fdc27826e50e 100644 (file)
@@ -40,7 +40,7 @@
            default date representation in the system.
     @endStyleTable
 
-    @beginEventTable{wxDateEvent}
+    @beginEventEmissionTable{wxDateEvent}
     @event{EVT_DATE_CHANGED(id, func)}
            This event fires when the user changes the current selection in the
            control.
index e057bc30ed6a2cc65f40bdc2d1085f17012efca2..07f15907c43f33e1188175dbbe5501db0bf33a6f 100644 (file)
@@ -126,13 +126,15 @@ enum wxDialogLayoutAdaptationMode
     styles to have an effect.
 
 
-    @beginEventTable{wxCloseEvent}
+    @beginEventEmissionTable{wxCloseEvent}
     @event{EVT_CLOSE(func)}
         The dialog is being closed by the user or programmatically (see wxWindow::Close).
         The user may generate this event clicking the close button
         (typically the 'X' on the top-right of the title bar) if it's present
         (see the @c wxCLOSE_BOX style) or by clicking a button with the
         @c wxID_CANCEL or @c wxID_OK ids.
+    @event{EVT_INIT_DIALOG(func)}
+        Process a @c wxEVT_INIT_DIALOG event. See wxInitDialogEvent.
     @endEventTable
 
     @library{wxcore}
index bbc06f5c88ec78d6c08de5d268a186b0a29260e0..1db8388a544a998276744ff67bbfd939ff6c6375 100644 (file)
     most one instance of this class in the program accessed via Create() and
     you can't create the objects of this class directly.
 
-    @beginEventTable{wxDialUpEvent}
+    @beginEventEmissionTable{wxDialUpEvent}
     @event{EVT_DIALUP_CONNECTED(func)}
-           A connection with the network was established.
+        A connection with the network was established.
     @event{EVT_DIALUP_DISCONNECTED(func)}
-           The connection with the network was lost.
+        The connection with the network was lost.
     @endEventTable
 
     @library{wxcore}
index eaf87f11354f21744fc57e3ad566e710aa34bbbc..e453085f9421745453c0926403149a6ccbd29857 100644 (file)
@@ -869,11 +869,11 @@ public:
 
     @beginEventTable{wxKeyEvent}
     @event{EVT_KEY_DOWN(func)}
-           Process a wxEVT_KEY_DOWN event (any key has been pressed).
+        Process a @c wxEVT_KEY_DOWN event (any key has been pressed).
     @event{EVT_KEY_UP(func)}
-           Process a wxEVT_KEY_UP event (any key has been released).
+        Process a @c wxEVT_KEY_UP event (any key has been released).
     @event{EVT_CHAR(func)}
-           Process a wxEVT_CHAR event.
+        Process a @c wxEVT_CHAR event.
     @endEventTable
 
     @see wxKeyboardState
@@ -956,15 +956,15 @@ public:
     events received by windows.
 
     @beginEventTable{wxJoystickEvent}
-    @style{EVT_JOY_BUTTON_DOWN(func)}
-        Process a wxEVT_JOY_BUTTON_DOWN event.
-    @style{EVT_JOY_BUTTON_UP(func)}
-        Process a wxEVT_JOY_BUTTON_UP event.
-    @style{EVT_JOY_MOVE(func)}
-        Process a wxEVT_JOY_MOVE event.
-    @style{EVT_JOY_ZMOVE(func)}
-        Process a wxEVT_JOY_ZMOVE event.
-    @style{EVT_JOYSTICK_EVENTS(func)}
+    @event{EVT_JOY_BUTTON_DOWN(func)}
+        Process a @c wxEVT_JOY_BUTTON_DOWN event.
+    @event{EVT_JOY_BUTTON_UP(func)}
+        Process a @c wxEVT_JOY_BUTTON_UP event.
+    @event{EVT_JOY_MOVE(func)}
+        Process a @c wxEVT_JOY_MOVE event.
+    @event{EVT_JOY_ZMOVE(func)}
+        Process a @c wxEVT_JOY_ZMOVE event.
+    @event{EVT_JOYSTICK_EVENTS(func)}
         Processes all joystick events.
     @endEventTable
 
@@ -1066,10 +1066,10 @@ public:
 
     A scroll event holds information about events sent from scrolling windows.
 
+    Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events
+    from the receiving window.
 
     @beginEventTable{wxScrollWinEvent}
-    You can use the EVT_SCROLLWIN* macros for intercepting scroll window events
-    from the receiving window.
     @event{EVT_SCROLLWIN(func)}
         Process all scroll events.
     @event{EVT_SCROLLWIN_TOP(func)}
@@ -1140,7 +1140,7 @@ public:
 
     @beginEventTable{wxSysColourChangedEvent}
     @event{EVT_SYS_COLOUR_CHANGED(func)}
-        Process a wxEVT_SYS_COLOUR_CHANGED event.
+        Process a @c wxEVT_SYS_COLOUR_CHANGED event.
     @endEventTable
 
     @library{wxcore}
@@ -1170,7 +1170,7 @@ public:
 
     @beginEventTable{wxWindowCreateEvent}
     @event{EVT_WINDOW_CREATE(func)}
-        Process a wxEVT_CREATE event.
+        Process a @c wxEVT_CREATE event.
     @endEventTable
 
     @library{wxcore}
@@ -1254,7 +1254,7 @@ public:
 
     @beginEventTable{wxPaintEvent}
     @event{EVT_PAINT(func)}
-        Process a wxEVT_PAINT event.
+        Process a @c wxEVT_PAINT event.
     @endEventTable
 
     @library{wxcore}
@@ -1282,7 +1282,7 @@ public:
 
     @beginEventTable{wxMaximizeEvent}
     @event{EVT_MAXIMIZE(func)}
-        Process a wxEVT_MAXIMIZE event.
+        Process a @c wxEVT_MAXIMIZE event.
     @endEventTable
 
     @library{wxcore}
@@ -1361,9 +1361,9 @@ enum wxUpdateUIMode
 
     @beginEventTable{wxUpdateUIEvent}
     @event{EVT_UPDATE_UI(id, func)}
-        Process a wxEVT_UPDATE_UI event for the command with the given id.
+        Process a @c wxEVT_UPDATE_UI event for the command with the given id.
     @event{EVT_UPDATE_UI_RANGE(id1, id2, func)}
-        Process a wxEVT_UPDATE_UI event for any command with id included in the given range.
+        Process a @c wxEVT_UPDATE_UI event for any command with id included in the given range.
     @endEventTable
 
     @library{wxcore}
@@ -1610,45 +1610,45 @@ public:
 
     @beginEventTable{wxMouseEvent}
     @event{EVT_LEFT_DOWN(func)}
-        Process a wxEVT_LEFT_DOWN event. The handler of this event should normally
+        Process a @c wxEVT_LEFT_DOWN event. The handler of this event should normally
         call event.Skip() to allow the default processing to take place as otherwise
         the window under mouse wouldn't get the focus.
     @event{EVT_LEFT_UP(func)}
-        Process a wxEVT_LEFT_UP event.
+        Process a @c wxEVT_LEFT_UP event.
     @event{EVT_LEFT_DCLICK(func)}
-        Process a wxEVT_LEFT_DCLICK event.
+        Process a @c wxEVT_LEFT_DCLICK event.
     @event{EVT_MIDDLE_DOWN(func)}
-        Process a wxEVT_MIDDLE_DOWN event.
+        Process a @c wxEVT_MIDDLE_DOWN event.
     @event{EVT_MIDDLE_UP(func)}
-        Process a wxEVT_MIDDLE_UP event.
+        Process a @c wxEVT_MIDDLE_UP event.
     @event{EVT_MIDDLE_DCLICK(func)}
-        Process a wxEVT_MIDDLE_DCLICK event.
+        Process a @c wxEVT_MIDDLE_DCLICK event.
     @event{EVT_RIGHT_DOWN(func)}
-        Process a wxEVT_RIGHT_DOWN event.
+        Process a @c wxEVT_RIGHT_DOWN event.
     @event{EVT_RIGHT_UP(func)}
-        Process a wxEVT_RIGHT_UP event.
+        Process a @c wxEVT_RIGHT_UP event.
     @event{EVT_RIGHT_DCLICK(func)}
-        Process a wxEVT_RIGHT_DCLICK event.
+        Process a @c wxEVT_RIGHT_DCLICK event.
     @event{EVT_MOUSE_AUX1_DOWN(func)}
-        Process a wxEVT_MOUSE_AUX1_DOWN event.
+        Process a @c wxEVT_MOUSE_AUX1_DOWN event.
     @event{EVT_MOUSE_AUX1_UP(func)}
-        Process a wxEVT_MOUSE_AUX1_UP event.
+        Process a @c wxEVT_MOUSE_AUX1_UP event.
     @event{EVT_MOUSE_AUX1_DCLICK(func)}
-        Process a wxEVT_MOUSE_AUX1_DCLICK event.
+        Process a @c wxEVT_MOUSE_AUX1_DCLICK event.
     @event{EVT_MOUSE_AUX2_DOWN(func)}
-        Process a wxEVT_MOUSE_AUX2_DOWN event.
+        Process a @c wxEVT_MOUSE_AUX2_DOWN event.
     @event{EVT_MOUSE_AUX2_UP(func)}
-        Process a wxEVT_MOUSE_AUX2_UP event.
+        Process a @c wxEVT_MOUSE_AUX2_UP event.
     @event{EVT_MOUSE_AUX2_DCLICK(func)}
-        Process a wxEVT_MOUSE_AUX2_DCLICK event.
+        Process a @c wxEVT_MOUSE_AUX2_DCLICK event.
     @event{EVT_MOTION(func)}
-        Process a wxEVT_MOTION event.
+        Process a @c wxEVT_MOTION event.
     @event{EVT_ENTER_WINDOW(func)}
-        Process a wxEVT_ENTER_WINDOW event.
+        Process a @c wxEVT_ENTER_WINDOW event.
     @event{EVT_LEAVE_WINDOW(func)}
-        Process a wxEVT_LEAVE_WINDOW event.
+        Process a @c wxEVT_LEAVE_WINDOW event.
     @event{EVT_MOUSEWHEEL(func)}
-        Process a wxEVT_MOUSEWHEEL event.
+        Process a @c wxEVT_MOUSEWHEEL event.
     @event{EVT_MOUSE_EVENTS(func)}
         Process all mouse events.
     @endEventTable
@@ -1986,7 +1986,7 @@ public:
 
     @beginEventTable{wxDropFilesEvent}
     @event{EVT_DROP_FILES(func)}
-        Process a wxEVT_DROP_FILES event.
+        Process a @c wxEVT_DROP_FILES event.
     @endEventTable
 
     @onlyfor{wxmsw}
@@ -2221,9 +2221,10 @@ public:
 
     @beginEventTable{wxActivateEvent}
     @event{EVT_ACTIVATE(func)}
-        Process a wxEVT_ACTIVATE event.
+        Process a @c wxEVT_ACTIVATE event.
     @event{EVT_ACTIVATE_APP(func)}
-        Process a wxEVT_ACTIVATE_APP event.
+        Process a @c wxEVT_ACTIVATE_APP event.
+        This event is received by the wxApp-derived instance only.
     @event{EVT_HIBERNATE(func)}
         Process a hibernate event, supplying the member function. This event applies
         to wxApp only, and only on Windows SmartPhone and PocketPC.
@@ -2232,7 +2233,6 @@ public:
         a wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP event.
     @endEventTable
 
-
     @library{wxcore}
     @category{events}
 
@@ -2259,7 +2259,7 @@ public:
     @class wxContextMenuEvent
 
     This class is used for context menu events, sent to give
-    the application a chance to show a context (popup) menu.
+    the application a chance to show a context (popup) menu for a wxWindow.
 
     Note that if wxContextMenuEvent::GetPosition returns wxDefaultPosition, this
     means that the event originated from a keyboard context button event, and you
@@ -2333,7 +2333,7 @@ public:
 
     @beginEventTable{wxEraseEvent}
     @event{EVT_ERASE_BACKGROUND(func)}
-        Process a wxEVT_ERASE_BACKGROUND event.
+        Process a @c wxEVT_ERASE_BACKGROUND event.
     @endEventTable
 
     @library{wxcore}
@@ -2369,9 +2369,9 @@ public:
 
     @beginEventTable{wxFocusEvent}
     @event{EVT_SET_FOCUS(func)}
-        Process a wxEVT_SET_FOCUS event.
+        Process a @c wxEVT_SET_FOCUS event.
     @event{EVT_KILL_FOCUS(func)}
-        Process a wxEVT_KILL_FOCUS event.
+        Process a @c wxEVT_KILL_FOCUS event.
     @endEventTable
 
     @library{wxcore}
@@ -2411,7 +2411,7 @@ public:
 
     @beginEventTable{wxChildFocusEvent}
     @event{EVT_CHILD_FOCUS(func)}
-        Process a wxEVT_CHILD_FOCUS event.
+        Process a @c wxEVT_CHILD_FOCUS event.
     @endEventTable
 
     @library{wxcore}
@@ -2458,7 +2458,7 @@ public:
 
     @beginEventTable{wxMouseCaptureLostEvent}
     @event{EVT_MOUSE_CAPTURE_LOST(func)}
-        Process a wxEVT_MOUSE_CAPTURE_LOST event.
+        Process a @c wxEVT_MOUSE_CAPTURE_LOST event.
     @endEventTable
 
     @onlyfor{wxmsw}
@@ -2467,7 +2467,7 @@ public:
     @category{events}
 
     @see wxMouseCaptureChangedEvent, @ref overview_events,
-    wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
+         wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
 */
 class wxMouseCaptureLostEvent : public wxEvent
 {
@@ -2587,9 +2587,9 @@ public:
 
     @beginEventTable{wxHelpEvent}
     @event{EVT_HELP(id, func)}
-        Process a wxEVT_HELP event.
+        Process a @c wxEVT_HELP event.
     @event{EVT_HELP_RANGE(id1, id2, func)}
-        Process a wxEVT_HELP event for a range of ids.
+        Process a @c wxEVT_HELP event for a range of ids.
     @endEventTable
 
     @library{wxcore}
@@ -2794,7 +2794,7 @@ enum wxIdleMode
 
     @beginEventTable{wxIdleEvent}
     @event{EVT_IDLE(func)}
-        Process a wxEVT_IDLE event.
+        Process a @c wxEVT_IDLE event.
     @endEventTable
 
     @library{wxbase}
@@ -2880,7 +2880,7 @@ public:
 
     @beginEventTable{wxInitDialogEvent}
     @event{EVT_INIT_DIALOG(func)}
-        Process a wxEVT_INIT_DIALOG event.
+        Process a @c wxEVT_INIT_DIALOG event.
     @endEventTable
 
     @library{wxcore}
@@ -2938,18 +2938,6 @@ public:
 };
 
 
-/**
-    The possible flag values for a wxNavigationKeyEvent.
-*/
-enum wxNavigationKeyEventFlags
-{
-    wxNKEF_IS_BACKWARD = 0x0000,
-    wxNKEF_IS_FORWARD = 0x0001,
-    wxNKEF_WINCHANGE = 0x0002,
-    wxNKEF_FROMTAB = 0x0004
-};
-
-
 /**
     @class wxNavigationKeyEvent
 
@@ -2974,6 +2962,17 @@ enum wxNavigationKeyEventFlags
 class wxNavigationKeyEvent : public wxEvent
 {
 public:
+    /**
+        Flags which can be used with wxNavigationKeyEvent.
+    */
+    enum wxNavigationKeyEventFlags
+    {
+        IsBackward = 0x0000,
+        IsForward = 0x0001,
+        WinChange = 0x0002,
+        FromTab = 0x0004
+    };
+
     wxNavigationKeyEvent();
     wxNavigationKeyEvent(const wxNavigationKeyEvent& event);
 
@@ -3033,7 +3032,7 @@ public:
     @class wxMouseCaptureChangedEvent
 
     An mouse capture changed event is sent to a window that loses its
-    mouse capture. This is called even if wxWindow::ReleaseCapture
+    mouse capture. This is called even if wxWindow::ReleaseMouse
     was called by the application code. Handling this event allows
     an application to cater for unexpected capture releases which
     might otherwise confuse mouse handling code.
@@ -3042,14 +3041,14 @@ public:
 
     @beginEventTable{wxMouseCaptureChangedEvent}
     @event{EVT_MOUSE_CAPTURE_CHANGED(func)}
-        Process a wxEVT_MOUSE_CAPTURE_CHANGED event.
+        Process a @c wxEVT_MOUSE_CAPTURE_CHANGED event.
     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @see wxMouseCaptureLostEvent, @ref overview_events,
-    wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
+         wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
 */
 class wxMouseCaptureChangedEvent : public wxEvent
 {
@@ -3253,7 +3252,7 @@ public:
 
     @beginEventTable{wxShowEvent}
     @event{EVT_SHOW(func)}
-        Process a wxEVT_SHOW event.
+        Process a @c wxEVT_SHOW event.
     @endEventTable
 
     @library{wxcore}
@@ -3301,7 +3300,7 @@ public:
 
     @beginEventTable{wxIconizeEvent}
     @event{EVT_ICONIZE(func)}
-        Process a wxEVT_ICONIZE event.
+        Process a @c wxEVT_ICONIZE event.
     @endEventTable
 
     @library{wxcore}
@@ -3335,16 +3334,16 @@ public:
 /**
     @class wxMoveEvent
 
-    A move event holds information about move change events.
+    A move event holds information about wxTopLevelWindow move change events.
 
     @beginEventTable{wxMoveEvent}
     @event{EVT_MOVE(func)}
-        Process a wxEVT_MOVE event, which is generated when a window is moved.
+        Process a @c wxEVT_MOVE event, which is generated when a window is moved.
     @event{EVT_MOVE_START(func)}
-        Process a wxEVT_MOVE_START event, which is generated when the user starts
+        Process a @c wxEVT_MOVE_START event, which is generated when the user starts
         to move or size a window. wxMSW only.
     @event{EVT_MOVE_END(func)}
-        Process a 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.
     @endEventTable
 
@@ -3371,7 +3370,7 @@ public:
 /**
     @class wxSizeEvent
 
-    A size event holds information about size change events.
+    A size event holds information about size change events of wxWindow.
 
     The EVT_SIZE handler function will be called when the window has been resized.
 
@@ -3387,7 +3386,7 @@ public:
 
     @beginEventTable{wxSizeEvent}
     @event{EVT_SIZE(func)}
-        Process a wxEVT_SIZE event.
+        Process a @c wxEVT_SIZE event.
     @endEventTable
 
     @library{wxcore}
@@ -3414,8 +3413,8 @@ public:
 /**
     @class wxSetCursorEvent
 
-    A wxSetCursorEvent is generated when the mouse cursor is about to be set as a
-    result of mouse motion.
+    A wxSetCursorEvent is generated from wxWindow when the mouse cursor is about
+    to be set as a result of mouse motion.
 
     This event gives the application the chance to perform specific mouse cursor
     processing based on the current position of the mouse within the window.
@@ -3423,7 +3422,7 @@ public:
 
     @beginEventTable{wxSetCursorEvent}
     @event{EVT_SET_CURSOR(func)}
-        Process a wxEVT_SET_CURSOR event.
+        Process a @c wxEVT_SET_CURSOR event.
     @endEventTable
 
     @library{wxcore}
index 997e5330ba9c7402d01027bb71ddee3b82c228c7..e8a42a4123724e1b1b8c7a31054ee2df8d72ac10 100644 (file)
@@ -45,7 +45,7 @@ enum wxFindReplaceDialogStyles
 /**
     @class wxFindDialogEvent
 
-    wxFindReplaceDialog events
+    wxFindReplaceDialog events.
 
     @beginEventTable{wxFindDialogEvent}
     @event{EVT_FIND(id, func)}
index 8da2119035853adbcf6e1192d3caddc0a989d067..e7ff427953101b0d4780663a3dcc369a7504f0e8 100644 (file)
@@ -30,7 +30,7 @@
            Hides the "Show Hidden Files" checkbox (Generic only)
     @endStyleTable
 
-    @beginEventTable{wxFileCtrlEvent}
+    @beginEventEmissionTable{wxFileCtrlEvent}
     @event{EVT_FILECTRL_FILEACTIVATED(id, func)}
         The user activated a file(by double-clicking or pressing Enter)
     @event{EVT_FILECTRL_SELECTIONCHANGED(id, func)}
index aed89f0067efe661bffe06f194c80d51d604fd14..2e83658293f3652e4e411799099a9f0dfefde794 100644 (file)
@@ -40,7 +40,7 @@
     @endStyleTable
 
 
-    @beginEventTable{wxFileDirPickerEvent}
+    @beginEventEmissionTable{wxFileDirPickerEvent}
     @event{EVT_FILEPICKER_CHANGED(id, func)}
         The user changed the file selected in the control either using the
         button or using text control (see wxFLP_USE_TEXTCTRL; note that in
@@ -163,7 +163,7 @@ public:
            Change current working directory on each user directory selection change.
     @endStyleTable
 
-    @beginEventTable{wxFileDirPickerEvent}
+    @beginEventEmissionTable{wxFileDirPickerEvent}
     @event{EVT_DIRPICKER_CHANGED(id, func)}
         The user changed the directory selected in the control either using the
         button or using text control (see wxDIRP_USE_TEXTCTRL; note that in this
index 33497c5bf153efde04778e15c7369bcf1759d8fd..48126f98565888ba1ad833631ce4a282f9db8071 100644 (file)
@@ -33,7 +33,7 @@
            Uses the currently selected font to draw the label of the button.
     @endStyleTable
 
-    @beginEventTable{wxFontPickerEvent}
+    @beginEventEmissionTable{wxFontPickerEvent}
     @event{EVT_FONTPICKER_CHANGED(id, func)}
         The user changed the font selected in the control either using the button
         or using text control (see wxFNTP_USE_TEXTCTRL; note that in this case the
index 58348fca312a1d64d31df5208824909ebc9b9ce1..826cf2fa670c08ea4592a24ff19865519d464c45 100644 (file)
            look. This is an extra style.
     @endExtraStyleTable
 
-    @beginEventTable{wxCloseEvent}
+    @beginEventEmissionTable
     @event{EVT_CLOSE(func)}
         The frame is being closed by the user or programmatically (see wxWindow::Close).
         The user may generate this event clicking the close button
         (typically the 'X' on the top-right of the title bar) if it's present
-        (see the @c wxCLOSE_BOX style).
+        (see the @c wxCLOSE_BOX style). See wxCloseEvent.
+    @event{EVT_ICONIZE(func)}
+        Process a @c wxEVT_ICONIZE event. See wxIconizeEvent.
+    @event{EVT_MENU_OPEN(func)}
+        A menu is about to be opened. See wxMenuEvent.
+    @event{EVT_MENU_CLOSE(func)}
+        A menu has been just closed. See wxMenuEvent.
+    @event{EVT_MENU_HIGHLIGHT(id, func)}
+        The menu item with the specified id has been highlighted: used to show
+        help prompts in the status bar by wxFrame. See wxMenuEvent.
+    @event{EVT_MENU_HIGHLIGHT_ALL(func)}
+        A menu item has been highlighted, i.e. the currently selected menu item has changed.
+        See wxMenuEvent.
     @endEventTable
 
-
     @library{wxcore}
     @category{managedwnd}
 
index b12548fe679d49c6e35ef8073df253a6aa22f4ea..862d26c5b6545331de52605e7d2916004461dc02 100644 (file)
@@ -66,7 +66,7 @@
         @c wxHD_ALLOW_REORDER.
     @endStyleTable
 
-    @beginEventTable{wxHeaderCtrlEvent}
+    @beginEventEmissionTable{wxHeaderCtrlEvent}
     @event{EVT_HEADER_CLICK(id, func)}
         A column heading was clicked.
     @event{EVT_HEADER_RIGHT_CLICK(id, func)}
index eee31d79bf4c5d54cbf32b1230757f60f2c91a19..dd08acaa0e1f791f84be04f468efd05a2e865d44 100644 (file)
@@ -35,7 +35,7 @@
     @endStyleTable
 
 
-    @beginEventTable{wxHtmlCellEvent, wxHtmlLinkEvent}
+    @beginEventEmissionTable{wxHtmlCellEvent, wxHtmlLinkEvent}
     @event{EVT_HTML_CELL_CLICKED(id, func)}
         A wxHtmlCell was clicked.
     @event{EVT_HTML_CELL_HOVER(id, func)}
index 2813c2ba76714a9e231c8ab34020d08d4c78a1c5..abbca90fc9ff9e48f99040c631c176828fc49633 100644 (file)
@@ -14,7 +14,7 @@
     derive your own class from it (see htlbox sample for the example) but you will
     only need to override a single wxHtmlListBox::OnGetItem function.
 
-    @beginEventTable{wxHtmlCellEvent,wxHtmlLinkEvent}
+    @beginEventEmissionTable{wxHtmlCellEvent,wxHtmlLinkEvent}
     @event{EVT_HTML_CELL_CLICKED(id, func)}
         A wxHtmlCell was clicked.
     @event{EVT_HTML_CELL_HOVER(id, func)}
@@ -180,25 +180,19 @@ protected:
 
     A wxSimpleHtmlListBox emits the same events used by wxListBox and by wxHtmlListBox.
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable
     @event{EVT_LISTBOX(id, func)}
         Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the list
-        is selected.
+        is selected. See wxCommandEvent.
     @event{EVT_LISTBOX_DCLICK(id, func)}
         Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the listbox is
-        double-clicked.
-    @endEventTable
-
-    @beginEventTable{wxHtmlCellEvent}
+        double-clicked. See wxCommandEvent.
     @event{EVT_HTML_CELL_CLICKED(id, func)}
-        A wxHtmlCell was clicked.
+        A wxHtmlCell was clicked. See wxHtmlCellEvent.
     @event{EVT_HTML_CELL_HOVER(id, func)}
-        The mouse passed over a wxHtmlCell.
-    @endEventTable
-
-    @beginEventTable{wxHtmlLinkEvent}
+        The mouse passed over a wxHtmlCell. See wxHtmlCellEvent.
     @event{EVT_HTML_LINK_CLICKED(id, func)}
-        A wxHtmlCell which contains an hyperlink was clicked.
+        A wxHtmlCell which contains an hyperlink was clicked. See wxHtmlLinkEvent
     @endEventTable
 
     @library{wxhtml}
index 4fdf631ae345753e4e830f7efbd1abc97dbff4c3..d2e4725735ebac97ccebf58d18388cf57084dea0 100644 (file)
@@ -71,7 +71,7 @@ public:
            wxBORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE.
     @endStyleTable
 
-    @beginEventTable{wxHyperlinkEvent}
+    @beginEventEmissionTable{wxHyperlinkEvent}
     @event{EVT_HYPERLINK(id, func)}
         The hyperlink was (left) clicked. If this event is not handled in user's
         code (or it's skipped; see wxEvent::Skip), then a call to wxLaunchDefaultBrowser
index 9c30c52e2fc4b7d7c06cb744448df38eb78e9331..74eab3752f26042d94a14d18cbf814db6b5a6efd 100644 (file)
@@ -90,7 +90,7 @@ enum wxLayoutAlignment
           It is an alternative way of specifying layouts for which the normal
           constraint system is unsuitable.
 
-    @beginEventTable{wxQueryLayoutInfoEvent,wxCalculateLayoutEvent}
+    @beginEventEmissionTable{wxQueryLayoutInfoEvent,wxCalculateLayoutEvent}
     @event{EVT_QUERY_LAYOUT_INFO(func)}
         Process a wxEVT_QUERY_LAYOUT_INFO event, to get size, orientation and
         alignment from a window. See wxQueryLayoutInfoEvent.
index 8ba18d5906ca602c178de292adfc2989dee6a81a..5683d89c4b0d5d82e257c376f2f857689d8b8fe3 100644 (file)
@@ -34,7 +34,7 @@
            Place labels below the page area.
     @endStyleTable
 
-    @beginEventTable{wxBookCtrlEvent}
+    @beginEventEmissionTable{wxBookCtrlEvent}
     @event{EVT_LISTBOOK_PAGE_CHANGED(id, func)}
         The page selection was changed.
         Processes a @c wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED event.
index 363f62471137c0a05e502802589f0ba469cae143..0877c5b74690eb12ecfe98f4823af0d07e6e92c6 100644 (file)
 
     @beginStyleTable
     @style{wxLB_SINGLE}
-           Single-selection list.
+        Single-selection list.
     @style{wxLB_MULTIPLE}
-           Multiple-selection list: the user can toggle multiple items on and off.
-           This is the same as wxLB_EXTENDED in wxGTK2 port.
+        Multiple-selection list: the user can toggle multiple items on and off.
+        This is the same as wxLB_EXTENDED in wxGTK2 port.
     @style{wxLB_EXTENDED}
-           Extended-selection list: the user can extend the selection by using
-           @c SHIFT or @c CTRL keys together with the cursor movement keys or
-           the mouse.
+        Extended-selection list: the user can extend the selection by using
+        @c SHIFT or @c CTRL keys together with the cursor movement keys or
+        the mouse.
     @style{wxLB_HSCROLL}
-           Create horizontal scrollbar if contents are too wide (Windows only).
+        Create horizontal scrollbar if contents are too wide (Windows only).
     @style{wxLB_ALWAYS_SB}
-           Always show a vertical scrollbar.
+        Always show a vertical scrollbar.
     @style{wxLB_NEEDED_SB}
-           Only create a vertical scrollbar if needed.
+        Only create a vertical scrollbar if needed.
     @style{wxLB_SORT}
-           The listbox contents are sorted in alphabetical order.
+        The listbox contents are sorted in alphabetical order.
     @endStyleTable
 
     Note that @c wxLB_SINGLE, @c wxLB_MULTIPLE and @c wxLB_EXTENDED styles are
     mutually exclusive and you can specify at most one of them (single selection
     is the default). See also @ref overview_windowstyles.
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_LISTBOX(id, func)}
-           Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the
-           list is selected or the selection changes.
+        Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the
+        list is selected or the selection changes.
     @event{EVT_LISTBOX_DCLICK(id, func)}
-           Process a wxEVT_COMMAND_LISTBOXDOUBLECLICKED event, when the listbox
-           is double-clicked.
+        Process a wxEVT_COMMAND_LISTBOXDOUBLECLICKED event, when the listbox
+        is double-clicked.
     @endEventTable
 
     @library{wxcore}
index 1a73747bc644b70e49cf5fa3c51dc69dc4ee5a47..7547e8b3e2e20e849f914f849b7ddf80c9cdc9a5 100644 (file)
@@ -83,7 +83,7 @@
     @endStyleTable
 
 
-    @beginEventTable{wxListEvent}
+    @beginEventEmissionTable{wxListEvent}
     @event{EVT_LIST_BEGIN_DRAG(id, func)}
            Begin dragging with the left mouse button.
     @event{EVT_LIST_BEGIN_RDRAG(id, func)}
index 8b3c3fb26b0ef76e9319d554cc9bbb1b546b06fe..8d5553c92eede86f58aec11ded7c624e1a15e2d8 100644 (file)
@@ -17,7 +17,7 @@
     Also please note that the methods related to fonts and bitmaps are currently
     only implemented for Windows, Mac and GTK+.
 
-    @beginEventTable{wxCommandEvent,wxMenuEvent}
+    @beginEventEmissionTable{wxCommandEvent,wxMenuEvent}
     @event{EVT_MENU(id, func)}
         Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
         This type of event is sent as wxCommandEvent.
index a04135c4ace70833df99f22c7604fb1dc183a2d2..863c01f991bd46facc6f60973991ea2f1790f8b5 100644 (file)
@@ -42,7 +42,7 @@
     The styles wxNB_LEFT, RIGHT and BOTTOM are not supported under
     Microsoft Windows XP when using visual themes.
 
-    @beginEventTable{wxBookCtrlEvent}
+    @beginEventEmissionTable{wxBookCtrlEvent}
     @event{EVT_NOTEBOOK_PAGE_CHANGED(id, func)}
         The page selection was changed.
         Processes a @c wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED event.
index f1958bbbcfa1afdc413a54d1ed9093df8a928cf9..92c516b9e2645d4127390b937e191c986594a547 100644 (file)
@@ -45,7 +45,7 @@ enum wxOwnerDrawnComboBoxPaintingFlags
 
     @see wxComboCtrl window styles and @ref overview_windowstyles.
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_COMBOBOX(id, func)}
            Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
            the list is selected. Note that calling GetValue() returns the new
index f836f6c6a1f35557f7c1fa843504ee3c72c88d30..4bf26f3f07a46db9189d9713721b6385309d6d70 100644 (file)
 
     @remarks By default, a panel has the same colouring as a dialog.
 
+    @beginEventEmissionTable{wxNavigationKeyEvent}
+    @event{EVT_NAVIGATION_KEY(func)}
+        Process a navigation key event.
+    @endEventTable
+
     @library{wxbase}
     @category{miscwnd}
 
index 83601ff757cc8e4a8a4c0ff82fbccc2eded5f676..3d86e0488da02e5d67d4bf9453d3394272d81527 100644 (file)
@@ -11,7 +11,7 @@
 
     The power events are generated when the system power state changes, e.g. the
     system is suspended, hibernated, plugged into or unplugged from the wall socket
-    and so on.
+    and so on. wxPowerEvents are emitted by wxWindows.
 
     Notice that currently only suspend and resume events are generated and only
     under MS Windows platform. To avoid the need to change the code using this
     supporting the power events.
 
     @beginEventTable{wxPowerEvent}
-    @event{EVT_POWER_SUSPENDING(func)}:
+    @event{EVT_POWER_SUSPENDING(func)}
            System is about to be suspended, this event can be vetoed to prevent
            suspend from taking place.
-    @event{EVT_POWER_SUSPENDED(func)}:
+    @event{EVT_POWER_SUSPENDED(func)}
            System is about to suspend: normally the application should quickly
            (i.e. without user intervention) close all the open files and network
            connections here, possibly remembering them to reopen them later when
            the system is resumed.
-    @event{EVT_POWER_SUSPEND_CANCEL(func)}:
+    @event{EVT_POWER_SUSPEND_CANCEL(func)}
            System suspension was cancelled because some application vetoed it.
-    @event{EVT_POWER_RESUME(func)}:
+    @event{EVT_POWER_RESUME(func)}
            System resumed from suspend: normally the application should restore
            the state in which it had been before the suspension.
     @endEventTable
index 996f0911c4a4439586cc602d75e2c396ea6ef1a4..c748d6440e9b4caf7c896dab870d633e053d2c44 100644 (file)
@@ -258,13 +258,14 @@ public:
 /**
     @class wxProcessEvent
 
-    A process event is sent when a process is terminated.
+    A process event is sent to the wxEvtHandler specified to wxProcess
+    when a process is terminated.
 
     @beginEventTable{wxProcessEvent}
     @event{EVT_END_PROCESS(id, func)}
-           Process a @c wxEVT_END_PROCESS event. @a id is the identifier of the process
-           object (the id passed to the wxProcess constructor) or a window to receive
-           the event.
+        Process a @c wxEVT_END_PROCESS event. @a id is the identifier of the process
+        object (the id passed to the wxProcess constructor) or a window to receive
+        the event.
     @endEventTable
 
     @library{wxbase}
index 6d5f72c8c9199c59fb402c37b236e4a53844d0b8..6e84d6e2afcdf156f5ae478b4f92467533452c35 100644 (file)
@@ -318,7 +318,7 @@ typedef int (*wxPGSortCallback)(wxPropertyGrid* propGrid,
     To process input from a property grid control, use these event handler macros
     to direct input to member functions that take a wxPropertyGridEvent argument.
 
-    @beginEventTable{wxPropertyGridEvent}
+    @beginEventEmissionTable{wxPropertyGridEvent}
     @event{EVT_PG_SELECTED (id, func)}
         Respond to wxEVT_PG_SELECTED event, generated when property value
         has been changed by user.
index 159d5791b331d8901c2d50b32ca908f034884420..b318203277424385dd4ed38afcc370c04c6223a4 100644 (file)
@@ -24,7 +24,7 @@
            supported only on PalmOS)
     @endStyleTable
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_RADIOBOX(id, func)}
            Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED event, when a radiobutton
            is clicked.
index 8deb1ec5b2ff88cadf8e49457f51b087c52fbdd9..eb5694a93313d59ffde09baa033678b21ea6c9ed 100644 (file)
@@ -30,7 +30,7 @@
            only on PalmOS).
     @endStyleTable
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_RADIOBUTTON(id, func)}
            Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the
            radiobutton is clicked.
index 78cc5e2022f4bfa2bff2a2b50b7c6fba2a2d3380..6ff15bed70adb664c88383875d67e08118517bce 100644 (file)
@@ -50,7 +50,7 @@ enum wxSashDragStatus
            Draws a thin black border.
     @endStyleTable
 
-    @beginEventTable{wxSashEvent}
+    @beginEventEmissionTable{wxSashEvent}
     @event{EVT_SASH_DRAGGED(id, func)}
            Process a wxEVT_SASH_DRAGGED event, when the user has finished
            dragging a sash.
index 45bc3e38242e4eddf3585f958b93b04a316b27c3..025767d981cbdd3421935beb6d946959f1aea83e 100644 (file)
@@ -39,7 +39,7 @@
            Specifies a vertical scrollbar.
     @endStyleTable
 
-    @beginEventTable{wxScrollEvent}
+    @beginEventEmissionTable{wxScrollEvent}
     You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting
     scroll events from controls, or EVT_SCROLL... macros without window IDs for
     intercepting scroll events from the receiving window -- except for this,
index 504b4d549c3fccce87b5dd9c19c3c33c64d578a7..37290f3d38123f36ab705d7a593097511e529a17 100644 (file)
@@ -40,7 +40,7 @@
            compatible with wxSL_SELRANGE.
     @endStyleTable
 
-    @beginEventTable{wxScrollEvent}
+    @beginEventEmissionTable{wxScrollEvent}
     You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting
     scroll events from controls, or EVT_SCROLL... macros without window IDs for
     intercepting scroll events from the receiving window -- except for this,
index 67e2e117258dfd3ce52186fc1062d45858dbb33d..0791ff4bb8c2363f63186a476d42908853f5577e 100644 (file)
@@ -435,10 +435,12 @@ public:
     @class wxSocketEvent
 
     This event class contains information about socket events.
+    This kind of events are sent to the event handler specified with
+    wxSocketBase::SetEventHandler.
 
     @beginEventTable{wxSocketEvent}
     @event{EVT_SOCKET(id, func)}
-           Process a socket event, supplying the member function.
+        Process a socket event, supplying the member function.
     @endEventTable
 
     @library{wxnet}
@@ -622,7 +624,7 @@ enum
     wxFTP or wxHTTP in another thread) you must initialize the sockets from the
     main thread by calling Initialize() before creating the other ones.
 
-    @beginEventTable{wxSocketEvent}
+    @beginEventEmissionTable{wxSocketEvent}
     @event{EVT_SOCKET(id, func)}
         Process a @c wxEVT_SOCKET event.
         See @ref wxSocketEventFlags and @ref wxSocketFlags for more info.
index e596243c80c7a7d2e11852c73088560c77f86aaf..2c343598840c8b204cd875626e1890df33b8561a 100644 (file)
@@ -77,7 +77,7 @@ public:
            The value wraps at the minimum and maximum.
     @endStyleTable
 
-    @beginEventTable{wxSpinEvent}
+    @beginEventEmissionTable{wxSpinEvent}
     @event{EVT_SPIN(id, func)}
         Generated whenever an arrow is pressed.
     @event{EVT_SPIN_UP(id, func)}
index 7274bf1aec2e08ed4427b9c644d39b0053e6d363..80701178c3903ac9ecad72f2ff59c4b2cfa0bb4d 100644 (file)
@@ -24,7 +24,7 @@
     @endStyleTable
 
 
-    @beginEventTable{wxSpinEvent}
+    @beginEventEmissionTable{wxSpinEvent}
     @event{EVT_SPINCTRL(id, func)}
         Generated whenever the numeric value of the spinctrl is updated
     @endEventTable
index 345fa0fdbe7a356567a152eca1343be6038bf6c5..7269d4a9b084e209f66654fed0cb14575affd0dc 100644 (file)
@@ -37,7 +37,7 @@
     @endStyleTable
 
 
-    @beginEventTable{wxSplitterEvent}
+    @beginEventEmissionTable{wxSplitterEvent}
     @event{EVT_SPLITTER_SASH_POS_CHANGING(id, func)}
         The sash position is in the process of being changed.
         May be used to modify the position of the tracking bar to properly
index eec053b845153e3915a7408491649a43915b83e6..29b9294c41cca48444cfaf606c4064ce9b581d8b 100644 (file)
@@ -39,7 +39,7 @@
            capitalized.
     @endStyleTable
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     To retrieve actual search queries, use EVT_TEXT and EVT_TEXT_ENTER events,
     just as you would with wxTextCtrl.
     @event{EVT_SEARCHCTRL_SEARCH_BTN(id, func)}
index e5e895d41067e789ec9f794f3bfa37dc804bb651..6338d312bc8d56ccb028678ce81e3829db4662d5 100644 (file)
@@ -263,7 +263,7 @@ public:
     wxStyledTextCtrl is a 1 to 1 mapping of "raw" scintilla interface, whose
     documentation can be found in the Scintilla website (http://www.scintilla.org/).
 
-    @beginEventTable{wxStyledTextEvent}
+    @beginEventEmissionTable{wxStyledTextEvent}
     @event{EVT_STC_CHANGE(id, fn)}
         TOWRITE
     @event{EVT_STC_STYLENEEDED(id, fn)}
index c159284623f10b5ef09453e83b2b73faf713e4b4..d82fddc70e99fa856f2891ce7edb5842d6a7ff4a 100644 (file)
@@ -48,7 +48,7 @@ public:
     The user should be required to explicitly enable the taskbar icon on Unix,
     it shouldn't be on by default.
 
-    @beginEventTable{wxTaskBarIconEvent}
+    @beginEventEmissionTable{wxTaskBarIconEvent}
     Note that not all ports are required to send these events and so it's better
     to override wxTaskBarIcon::CreatePopupMenu() if all that the application does
     is that it shows a popup menu in reaction to mouse click.
index e1f76c434a3b259112c959ead08b04393cad3c19..7a200fd109c55dc99a95d4f7e14a6632f4ec1ae4 100644 (file)
@@ -1042,7 +1042,7 @@ public:
     wxID_REDO. The associated UI update events are also processed
     automatically, when the control has the focus.
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_TEXT(id, func)}
         Respond to a wxEVT_COMMAND_TEXT_UPDATED event, generated when the text
         changes. Notice that this event will be sent when the text controls
index a64e52e402ca6679cd00e51f6a0691b5da7ee090..1c07261ab5390ce94b3d0dce2f439ba53683d891 100644 (file)
@@ -17,9 +17,9 @@
 
     You can see wxToggleButton in action in @ref page_samples_controls.
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_TOGGLEBUTTON(id, func)}
-           Handles a toggle button click event.
+        Handles a toggle button click event.
     @endEventTable
 
     @library{wxcore}
@@ -111,9 +111,9 @@ public:
 
     This control emits an update UI event.
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_TOGGLEBUTTON(id, func)}
-           Handles a toggle button click event.
+        Handles a toggle button click event.
     @endEventTable
 
     @library{wxcore}
index 3960006bee49afe8e88b278071a9567248162c67..4b7d1fbb177b86185861679e77ed78986fe0c100 100644 (file)
@@ -131,7 +131,8 @@ public:
 /**
     @class wxTimerEvent
 
-    wxTimerEvent object is passed to the event handler of timer events.
+    wxTimerEvent object is passed to the event handler of timer events
+    (see wxTimer::SetOwner).
 
     For example:
 
index 958ce46caf7db4239e827e4844d0870e1613eeea..f45393f0f0ac5204563b9cef1c70f739ff797bbb 100644 (file)
@@ -85,7 +85,7 @@
     ignores @c wxTB_NOICONS style. Also, toggling the @c wxTB_TEXT works only
     if the style was initially on.
 
-    @beginEventTable{wxCommandEvent}
+    @beginEventEmissionTable{wxCommandEvent}
     @event{EVT_TOOL(id, func)}
         Process a @c wxEVT_COMMAND_TOOL_CLICKED event (a synonym for @c
         wxEVT_COMMAND_MENU_SELECTED). Pass the id of the tool.
index b78c28c4a83bcd1204a07dc5eb0dc056dedfda72..ea4e48be83f9edfc5e9cb441a23df1ecff6b5228 100644 (file)
@@ -30,7 +30,7 @@
     The common wxBookCtrl styles described in the @ref overview_bookctrl are
     also supported.
 
-    @beginEventTable{wxBookCtrlEvent}
+    @beginEventEmissionTable{wxBookCtrlEvent}
     @event{EVT_TOOLBOOK_PAGE_CHANGED(id, func)}
         The page selection was changed.
         Processes a @c wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED event.
index 822e2edc7f3c06778e5a7674a07b303579b77a4e..acb79b1c724a69840a5cac5d38ef183f9a49f593 100644 (file)
@@ -45,6 +45,22 @@ enum
     Note that the instances of wxTopLevelWindow are managed by wxWidgets in the
     internal top level window list.
 
+    @beginEventEmissionTable
+    @event{EVT_ACTIVATE(id, func)}
+        Process a @c wxEVT_MAXIMIZE event. See wxMaximizeEvent.
+    @event{EVT_MOVE(func)}
+        Process a @c wxEVT_MOVE event, which is generated when a window is moved.
+        See wxMoveEvent.
+    @event{EVT_MOVE_START(func)}
+        Process a @c wxEVT_MOVE_START event, which is generated when the user starts
+        to move or size a window. wxMSW only.
+        See wxMoveEvent.
+    @event{EVT_MOVE_END(func)}
+        Process a @c wxEVT_MOVE_END event, which is generated when the user stops
+        moving or sizing a window. wxMSW only.
+        See wxMoveEvent.
+    @endEventTable
+
     @library{wxcore}
     @category{managedwnd}
 
index f51c5213cab7ce7cba49a3439acc55bb19d2db95..41b74df8112c934dd9725c4df232c73575d126a8 100644 (file)
@@ -21,7 +21,7 @@
     AddPage() and AddSubPage() to sequentially populate your tree by adding at
     every step a page or a subpage to the end of the tree.
 
-    @beginEventTable{wxBookCtrlEvent}
+    @beginEventEmissionTable{wxBookCtrlEvent}
     @event{EVT_TREEBOOK_PAGE_CHANGED(id, func)}
         The page selection was changed.
         Processes a @c wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED event.
index 5d5df02adffd55ff1b345819ba06c03997d66f3d..9e439555988ec3bcaa44b7e95a656a2d9eb665ae 100644 (file)
@@ -60,7 +60,7 @@
         for a particular toolkit.
     @endStyleTable
 
-    @beginEventTable{wxTreeEvent}
+    @beginEventEmissionTable{wxTreeEvent}
     @event{EVT_TREE_BEGIN_DRAG(id, func)}
           Begin dragging with the left mouse button.
           If you want to enable left-dragging you need to intercept this event
index 3580eb0fc2408adc1e952253561668c2f6fc0466..6eb30c66bb72a1fe20f01aababa7efaf0f40e367 100644 (file)
@@ -182,11 +182,64 @@ enum wxWindowVariant
            mode set by wxUpdateUIEvent::SetMode is @c wxUPDATE_UI_PROCESS_SPECIFIED.
     @endExtraStyleTable
 
+    @beginEventEmissionTable
+    @event{EVT_ACTIVATE(id, func)}
+        Process a @c wxEVT_ACTIVATE event. See wxActivateEvent.
+    @event{EVT_CHILD_FOCUS(func)}
+        Process a @c wxEVT_CHILD_FOCUS event. See wxChildFocusEvent.
+    @event{EVT_CONTEXT_MENU(func)}
+        A right click (or other context menu command depending on platform) has been detected.
+        See wxContextMenuEvent.
+    @event{EVT_HELP(id, func)}
+        Process a @c wxEVT_HELP event. See wxHelpEvent.
+    @event{EVT_HELP_RANGE(id1, id2, func)}
+        Process a @c wxEVT_HELP event for a range of ids. See wxHelpEvent.
+    @event{EVT_DROP_FILES(func)}
+        Process a @c wxEVT_DROP_FILES event. See wxDropFilesEvent.
+    @event{EVT_ERASE_BACKGROUND(func)}
+        Process a @c wxEVT_ERASE_BACKGROUND event. See wxEraseEvent.
+    @event{EVT_SET_FOCUS(func)}
+        Process a @c wxEVT_SET_FOCUS event. See wxFocusEvent.
+    @event{EVT_KILL_FOCUS(func)}
+        Process a @c wxEVT_KILL_FOCUS event. See wxFocusEvent.
+    @event{EVT_IDLE(func)}
+        Process a @c wxEVT_IDLE event. See wxIdleEvent.
+    @event{EVT_JOY_*(func)}
+        Processes joystick events. See wxJoystickEvent.
+    @event{EVT_KEY_DOWN(func)}
+        Process a @c wxEVT_KEY_DOWN event (any key has been pressed).
+        See wxKeyEvent.
+    @event{EVT_KEY_UP(func)}
+        Process a @c wxEVT_KEY_UP event (any key has been released).
+    @event{EVT_CHAR(func)}
+        Process a @c wxEVT_CHAR event.
+        See wxKeyEvent.
+    @event{EVT_MOUSE_CAPTURE_LOST(func)}
+        Process a @c wxEVT_MOUSE_CAPTURE_LOST event. See wxMouseCaptureLostEvent.
+    @event{EVT_MOUSE_CAPTURE_CHANGED(func)}
+        Process a @c wxEVT_MOUSE_CAPTURE_CHANGED event. See wxMouseCaptureChangedEvent.
+    @event{EVT_MOUSE_*(func)}
+        See wxMouseEvent.
+    @event{EVT_PAINT(func)}
+        Process a @c wxEVT_PAINT event. See wxPaintEvent.
+    @event{EVT_POWER_*(func)}
+        The system power state changed. See wxPowerEvent.
+    @event{EVT_SCROLLWIN_*(func)}
+        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)}
+        Process a @c wxEVT_SYS_COLOUR_CHANGED event. See wxSysColourChangedEvent.
+    @endEventTable
+
     @library{wxcore}
     @category{miscwnd}
 
-    @see @ref overview_events "Event handling overview",
-         @ref overview_windowsizing "Window sizing overview"
+    @see @ref overview_events, @ref overview_windowsizing
 */
 class wxWindow : public wxEvtHandler
 {
index 50c20e823f36917c537b0a226bda563dbfde8c57..3204fba1987158e79638819a4dde17d8dbfe8107 100644 (file)
@@ -223,7 +223,7 @@ public:
     wxDialog::EnableLayoutAdaptation() or per dialog with wxDialog::SetLayoutAdaptationMode().
     For more about layout adaptation, see @ref overview_dialog_autoscrolling.
 
-    @beginEventTable{wxWizardEvent}
+    @beginEventEmissionTable{wxWizardEvent}
     For some events, Veto() can be called to prevent the event from happening.
     @event{EVT_WIZARD_PAGE_CHANGED(id, func)}
         The page has just been changed (this event cannot be vetoed).