From 3051a44a73502c2b03d1618d0a8e94274ee67e16 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Wed, 18 Feb 2009 17:58:51 +0000 Subject: [PATCH] make distinction between classes which send events (use @beginEventEmissionTable for them) from event classes (use @beginEventTable for them); add event tables for wxWindow, wxFrame, wxTopLevelWindow, wxApp git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@59000 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/doxygen/Doxyfile_inc | 19 ++-- interface/wx/app.h | 19 ++++ interface/wx/aui/auibook.h | 2 +- interface/wx/aui/framemanager.h | 2 +- interface/wx/bmpbuttn.h | 2 +- interface/wx/bmpcbox.h | 2 +- interface/wx/button.h | 2 +- interface/wx/calctrl.h | 2 +- interface/wx/checkbox.h | 2 +- interface/wx/checklst.h | 12 +-- interface/wx/choice.h | 2 +- interface/wx/choicebk.h | 2 +- interface/wx/clrpicker.h | 2 +- interface/wx/collpane.h | 6 +- interface/wx/combo.h | 2 +- interface/wx/combobox.h | 2 +- interface/wx/control.h | 10 ++ interface/wx/dataview.h | 2 +- interface/wx/datectrl.h | 2 +- interface/wx/dialog.h | 4 +- interface/wx/dialup.h | 6 +- interface/wx/event.h | 159 +++++++++++++++---------------- interface/wx/fdrepdlg.h | 2 +- interface/wx/filectrl.h | 2 +- interface/wx/filepicker.h | 4 +- interface/wx/fontpicker.h | 2 +- interface/wx/frame.h | 17 +++- interface/wx/headerctrl.h | 2 +- interface/wx/html/htmlwin.h | 2 +- interface/wx/htmllbox.h | 20 ++-- interface/wx/hyperlink.h | 2 +- interface/wx/laywin.h | 2 +- interface/wx/listbook.h | 2 +- interface/wx/listbox.h | 30 +++--- interface/wx/listctrl.h | 2 +- interface/wx/menuitem.h | 2 +- interface/wx/notebook.h | 2 +- interface/wx/odcombo.h | 2 +- interface/wx/panel.h | 5 + interface/wx/power.h | 10 +- interface/wx/process.h | 9 +- interface/wx/propgrid/propgrid.h | 2 +- interface/wx/radiobox.h | 2 +- interface/wx/radiobut.h | 2 +- interface/wx/sashwin.h | 2 +- interface/wx/scrolbar.h | 2 +- interface/wx/slider.h | 2 +- interface/wx/socket.h | 6 +- interface/wx/spinbutt.h | 2 +- interface/wx/spinctrl.h | 2 +- interface/wx/splitter.h | 2 +- interface/wx/srchctrl.h | 2 +- interface/wx/stc/stc.h | 2 +- interface/wx/taskbar.h | 2 +- interface/wx/textctrl.h | 2 +- interface/wx/tglbtn.h | 8 +- interface/wx/timer.h | 3 +- interface/wx/toolbar.h | 2 +- interface/wx/toolbook.h | 2 +- interface/wx/toplevel.h | 16 ++++ interface/wx/treebook.h | 2 +- interface/wx/treectrl.h | 2 +- interface/wx/window.h | 57 ++++++++++- interface/wx/wizard.h | 2 +- 64 files changed, 315 insertions(+), 193 deletions(-) diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc index 8afbd597c6..2a695611ef 100644 --- a/docs/doxygen/Doxyfile_inc +++ b/docs/doxygen/Doxyfile_inc @@ -52,9 +52,16 @@ SYMBOL_CACHE_SIZE = 0 # Aliases - for use when documenting C++ classes #--------------------------------------------------------------------------- -# event aliases -ALIASES = beginEventTable{1}="\n

Events

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(\1& event)

Event macros:
" -ALIASES += beginEventTable{2}="\n

Events

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(\1& event) or void handlerFuncName(\2& event)

Event macros:
" +# aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc): +ALIASES = beginEventEmissionTable="\n

Events emitted by this class

Event macros for events emitted by this class:

" +ALIASES += beginEventEmissionTable{1}="\n

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(\1& event)

Event macros for events emitted by this class:
" +ALIASES += beginEventEmissionTable{2}="\n

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(\1& event) or void handlerFuncName(\2& event)

Event macros for events emitted by this class:
" + +# aliases to be used in wxEvent-derived classes: +ALIASES += beginEventTable{1}="\n

Events using this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(\1& event)

Event macros:
" +ALIASES += beginEventTable{2}="\n

Events using this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(\1& event) or void handlerFuncName(\2& event)

Event macros:
" + +# common event aliases: ALIASES += event{1}="
\li \1:
" ALIASES += event{2}="
\li \1, \2:
" ALIASES += event{3}="
\li \1, \2, \3:
" @@ -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 diff --git a/interface/wx/app.h b/interface/wx/app.h index a67a414d69..3e6fa3a054 100644 --- a/interface/wx/app.h +++ b/interface/wx/app.h @@ -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} diff --git a/interface/wx/aui/auibook.h b/interface/wx/aui/auibook.h index 0d0eb54140..23812d65da 100644 --- a/interface/wx/aui/auibook.h +++ b/interface/wx/aui/auibook.h @@ -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)} diff --git a/interface/wx/aui/framemanager.h b/interface/wx/aui/framemanager.h index 837972ef6a..b58e501b49 100644 --- a/interface/wx/aui/framemanager.h +++ b/interface/wx/aui/framemanager.h @@ -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)} diff --git a/interface/wx/bmpbuttn.h b/interface/wx/bmpbuttn.h index 320093d419..457995a7ee 100644 --- a/interface/wx/bmpbuttn.h +++ b/interface/wx/bmpbuttn.h @@ -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 diff --git a/interface/wx/bmpcbox.h b/interface/wx/bmpcbox.h index c073ead100..60bb9c842a 100644 --- a/interface/wx/bmpcbox.h +++ b/interface/wx/bmpcbox.h @@ -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. diff --git a/interface/wx/button.h b/interface/wx/button.h index 127938c17f..5bb2bff16e 100644 --- a/interface/wx/button.h +++ b/interface/wx/button.h @@ -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 diff --git a/interface/wx/calctrl.h b/interface/wx/calctrl.h index ccd01dba9e..dc0c5c9bf4 100644 --- a/interface/wx/calctrl.h +++ b/interface/wx/calctrl.h @@ -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)} diff --git a/interface/wx/checkbox.h b/interface/wx/checkbox.h index 7327802563..94516894d0 100644 --- a/interface/wx/checkbox.h +++ b/interface/wx/checkbox.h @@ -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. diff --git a/interface/wx/checklst.h b/interface/wx/checklst.h index f1cc9e9a9a..982209412b 100644 --- a/interface/wx/checklst.h +++ b/interface/wx/checklst.h @@ -15,13 +15,13 @@ 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} diff --git a/interface/wx/choice.h b/interface/wx/choice.h index 19f71b00ef..82cb664da2 100644 --- a/interface/wx/choice.h +++ b/interface/wx/choice.h @@ -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. diff --git a/interface/wx/choicebk.h b/interface/wx/choicebk.h index 202747d1bc..bc3fec7ea1 100644 --- a/interface/wx/choicebk.h +++ b/interface/wx/choicebk.h @@ -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. diff --git a/interface/wx/clrpicker.h b/interface/wx/clrpicker.h index 93391720f7..551711ff51 100644 --- a/interface/wx/clrpicker.h +++ b/interface/wx/clrpicker.h @@ -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 diff --git a/interface/wx/collpane.h b/interface/wx/collpane.h index 5718757d1f..2d0573f5ae 100644 --- a/interface/wx/collpane.h +++ b/interface/wx/collpane.h @@ -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} diff --git a/interface/wx/combo.h b/interface/wx/combo.h index 604340e956..4e49a4386e 100644 --- a/interface/wx/combo.h +++ b/interface/wx/combo.h @@ -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)} diff --git a/interface/wx/combobox.h b/interface/wx/combobox.h index 931d495294..2054fbd949 100644 --- a/interface/wx/combobox.h +++ b/interface/wx/combobox.h @@ -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 diff --git a/interface/wx/control.h b/interface/wx/control.h index cba493cbb9..2d56ad3c60 100644 --- a/interface/wx/control.h +++ b/interface/wx/control.h @@ -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} diff --git a/interface/wx/dataview.h b/interface/wx/dataview.h index ce3da34d0b..3168a38dca 100644 --- a/interface/wx/dataview.h +++ b/interface/wx/dataview.h @@ -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)} diff --git a/interface/wx/datectrl.h b/interface/wx/datectrl.h index 90d457a220..086bb2edb1 100644 --- a/interface/wx/datectrl.h +++ b/interface/wx/datectrl.h @@ -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. diff --git a/interface/wx/dialog.h b/interface/wx/dialog.h index e057bc30ed..07f15907c4 100644 --- a/interface/wx/dialog.h +++ b/interface/wx/dialog.h @@ -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} diff --git a/interface/wx/dialup.h b/interface/wx/dialup.h index bbc06f5c88..1db8388a54 100644 --- a/interface/wx/dialup.h +++ b/interface/wx/dialup.h @@ -25,11 +25,11 @@ 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} diff --git a/interface/wx/event.h b/interface/wx/event.h index eaf87f1135..e453085f94 100644 --- a/interface/wx/event.h +++ b/interface/wx/event.h @@ -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} diff --git a/interface/wx/fdrepdlg.h b/interface/wx/fdrepdlg.h index 997e5330ba..e8a42a4123 100644 --- a/interface/wx/fdrepdlg.h +++ b/interface/wx/fdrepdlg.h @@ -45,7 +45,7 @@ enum wxFindReplaceDialogStyles /** @class wxFindDialogEvent - wxFindReplaceDialog events + wxFindReplaceDialog events. @beginEventTable{wxFindDialogEvent} @event{EVT_FIND(id, func)} diff --git a/interface/wx/filectrl.h b/interface/wx/filectrl.h index 8da2119035..e7ff427953 100644 --- a/interface/wx/filectrl.h +++ b/interface/wx/filectrl.h @@ -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)} diff --git a/interface/wx/filepicker.h b/interface/wx/filepicker.h index aed89f0067..2e83658293 100644 --- a/interface/wx/filepicker.h +++ b/interface/wx/filepicker.h @@ -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 diff --git a/interface/wx/fontpicker.h b/interface/wx/fontpicker.h index 33497c5bf1..48126f9856 100644 --- a/interface/wx/fontpicker.h +++ b/interface/wx/fontpicker.h @@ -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 diff --git a/interface/wx/frame.h b/interface/wx/frame.h index 58348fca31..826cf2fa67 100644 --- a/interface/wx/frame.h +++ b/interface/wx/frame.h @@ -106,15 +106,26 @@ 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} diff --git a/interface/wx/headerctrl.h b/interface/wx/headerctrl.h index b12548fe67..862d26c5b6 100644 --- a/interface/wx/headerctrl.h +++ b/interface/wx/headerctrl.h @@ -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)} diff --git a/interface/wx/html/htmlwin.h b/interface/wx/html/htmlwin.h index eee31d79bf..dd08acaa0e 100644 --- a/interface/wx/html/htmlwin.h +++ b/interface/wx/html/htmlwin.h @@ -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)} diff --git a/interface/wx/htmllbox.h b/interface/wx/htmllbox.h index 2813c2ba76..abbca90fc9 100644 --- a/interface/wx/htmllbox.h +++ b/interface/wx/htmllbox.h @@ -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} diff --git a/interface/wx/hyperlink.h b/interface/wx/hyperlink.h index 4fdf631ae3..d2e4725735 100644 --- a/interface/wx/hyperlink.h +++ b/interface/wx/hyperlink.h @@ -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 diff --git a/interface/wx/laywin.h b/interface/wx/laywin.h index 9c30c52e2f..74eab3752f 100644 --- a/interface/wx/laywin.h +++ b/interface/wx/laywin.h @@ -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. diff --git a/interface/wx/listbook.h b/interface/wx/listbook.h index 8ba18d5906..5683d89c4b 100644 --- a/interface/wx/listbook.h +++ b/interface/wx/listbook.h @@ -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. diff --git a/interface/wx/listbox.h b/interface/wx/listbox.h index 363f624711..0877c5b746 100644 --- a/interface/wx/listbox.h +++ b/interface/wx/listbox.h @@ -25,35 +25,35 @@ @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} diff --git a/interface/wx/listctrl.h b/interface/wx/listctrl.h index 1a73747bc6..7547e8b3e2 100644 --- a/interface/wx/listctrl.h +++ b/interface/wx/listctrl.h @@ -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)} diff --git a/interface/wx/menuitem.h b/interface/wx/menuitem.h index 8b3c3fb26b..8d5553c92e 100644 --- a/interface/wx/menuitem.h +++ b/interface/wx/menuitem.h @@ -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. diff --git a/interface/wx/notebook.h b/interface/wx/notebook.h index a04135c4ac..863c01f991 100644 --- a/interface/wx/notebook.h +++ b/interface/wx/notebook.h @@ -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. diff --git a/interface/wx/odcombo.h b/interface/wx/odcombo.h index f1958bbbcf..92c516b9e2 100644 --- a/interface/wx/odcombo.h +++ b/interface/wx/odcombo.h @@ -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 diff --git a/interface/wx/panel.h b/interface/wx/panel.h index f836f6c6a1..4bf26f3f07 100644 --- a/interface/wx/panel.h +++ b/interface/wx/panel.h @@ -26,6 +26,11 @@ @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} diff --git a/interface/wx/power.h b/interface/wx/power.h index 83601ff757..3d86e0488d 100644 --- a/interface/wx/power.h +++ b/interface/wx/power.h @@ -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 @@ -21,17 +21,17 @@ 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 diff --git a/interface/wx/process.h b/interface/wx/process.h index 996f0911c4..c748d6440e 100644 --- a/interface/wx/process.h +++ b/interface/wx/process.h @@ -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} diff --git a/interface/wx/propgrid/propgrid.h b/interface/wx/propgrid/propgrid.h index 6d5f72c8c9..6e84d6e2af 100644 --- a/interface/wx/propgrid/propgrid.h +++ b/interface/wx/propgrid/propgrid.h @@ -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. diff --git a/interface/wx/radiobox.h b/interface/wx/radiobox.h index 159d5791b3..b318203277 100644 --- a/interface/wx/radiobox.h +++ b/interface/wx/radiobox.h @@ -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. diff --git a/interface/wx/radiobut.h b/interface/wx/radiobut.h index 8deb1ec5b2..eb5694a933 100644 --- a/interface/wx/radiobut.h +++ b/interface/wx/radiobut.h @@ -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. diff --git a/interface/wx/sashwin.h b/interface/wx/sashwin.h index 78cc5e2022..6ff15bed70 100644 --- a/interface/wx/sashwin.h +++ b/interface/wx/sashwin.h @@ -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. diff --git a/interface/wx/scrolbar.h b/interface/wx/scrolbar.h index 45bc3e3824..025767d981 100644 --- a/interface/wx/scrolbar.h +++ b/interface/wx/scrolbar.h @@ -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, diff --git a/interface/wx/slider.h b/interface/wx/slider.h index 504b4d549c..37290f3d38 100644 --- a/interface/wx/slider.h +++ b/interface/wx/slider.h @@ -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, diff --git a/interface/wx/socket.h b/interface/wx/socket.h index 67e2e11725..0791ff4bb8 100644 --- a/interface/wx/socket.h +++ b/interface/wx/socket.h @@ -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. diff --git a/interface/wx/spinbutt.h b/interface/wx/spinbutt.h index e596243c80..2c34359884 100644 --- a/interface/wx/spinbutt.h +++ b/interface/wx/spinbutt.h @@ -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)} diff --git a/interface/wx/spinctrl.h b/interface/wx/spinctrl.h index 7274bf1aec..80701178c3 100644 --- a/interface/wx/spinctrl.h +++ b/interface/wx/spinctrl.h @@ -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 diff --git a/interface/wx/splitter.h b/interface/wx/splitter.h index 345fa0fdbe..7269d4a9b0 100644 --- a/interface/wx/splitter.h +++ b/interface/wx/splitter.h @@ -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 diff --git a/interface/wx/srchctrl.h b/interface/wx/srchctrl.h index eec053b845..29b9294c41 100644 --- a/interface/wx/srchctrl.h +++ b/interface/wx/srchctrl.h @@ -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)} diff --git a/interface/wx/stc/stc.h b/interface/wx/stc/stc.h index e5e895d410..6338d312bc 100644 --- a/interface/wx/stc/stc.h +++ b/interface/wx/stc/stc.h @@ -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)} diff --git a/interface/wx/taskbar.h b/interface/wx/taskbar.h index c159284623..d82fddc70e 100644 --- a/interface/wx/taskbar.h +++ b/interface/wx/taskbar.h @@ -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. diff --git a/interface/wx/textctrl.h b/interface/wx/textctrl.h index e1f76c434a..7a200fd109 100644 --- a/interface/wx/textctrl.h +++ b/interface/wx/textctrl.h @@ -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 diff --git a/interface/wx/tglbtn.h b/interface/wx/tglbtn.h index a64e52e402..1c07261ab5 100644 --- a/interface/wx/tglbtn.h +++ b/interface/wx/tglbtn.h @@ -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} diff --git a/interface/wx/timer.h b/interface/wx/timer.h index 3960006bee..4b7d1fbb17 100644 --- a/interface/wx/timer.h +++ b/interface/wx/timer.h @@ -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: diff --git a/interface/wx/toolbar.h b/interface/wx/toolbar.h index 958ce46caf..f45393f0f0 100644 --- a/interface/wx/toolbar.h +++ b/interface/wx/toolbar.h @@ -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. diff --git a/interface/wx/toolbook.h b/interface/wx/toolbook.h index b78c28c4a8..ea4e48be83 100644 --- a/interface/wx/toolbook.h +++ b/interface/wx/toolbook.h @@ -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. diff --git a/interface/wx/toplevel.h b/interface/wx/toplevel.h index 822e2edc7f..acb79b1c72 100644 --- a/interface/wx/toplevel.h +++ b/interface/wx/toplevel.h @@ -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} diff --git a/interface/wx/treebook.h b/interface/wx/treebook.h index f51c5213ca..41b74df811 100644 --- a/interface/wx/treebook.h +++ b/interface/wx/treebook.h @@ -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. diff --git a/interface/wx/treectrl.h b/interface/wx/treectrl.h index 5d5df02adf..9e43955598 100644 --- a/interface/wx/treectrl.h +++ b/interface/wx/treectrl.h @@ -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 diff --git a/interface/wx/window.h b/interface/wx/window.h index 3580eb0fc2..6eb30c66bb 100644 --- a/interface/wx/window.h +++ b/interface/wx/window.h @@ -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 { diff --git a/interface/wx/wizard.h b/interface/wx/wizard.h index 50c20e823f..3204fba198 100644 --- a/interface/wx/wizard.h +++ b/interface/wx/wizard.h @@ -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). -- 2.47.2