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
This commit is contained in:
Francesco Montorsi
2009-02-18 17:58:51 +00:00
parent f8f7cff436
commit 3051a44a73
64 changed files with 315 additions and 193 deletions

View File

@@ -52,9 +52,16 @@ SYMBOL_CACHE_SIZE = 0
# Aliases - for use when documenting C++ classes # Aliases - for use when documenting C++ classes
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# event aliases # aliases to be used by classes which emit wxEvents (e.g. wxWindow, wxTextCtrl, etc):
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 = beginEventEmissionTable="\n<h2>Events emitted by this class</h2><p>Event macros for events emitted by this class:</p><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 += 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{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{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'>" ALIASES += event{3}="</div>\li <span class='event'>\1, \2, \3</span>:<div class='eventDesc'>"

View File

@@ -493,6 +493,25 @@ public:
In general, application-wide settings for GUI-only apps are accessible In general, application-wide settings for GUI-only apps are accessible
from wxApp (or from wxSystemSettings or wxSystemOptions classes). 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} @library{wxbase}
@category{appmanagement} @category{appmanagement}

View File

@@ -55,7 +55,7 @@
@endStyleTable @endStyleTable
@beginEventTable{wxAuiNotebookEvent} @beginEventEmissionTable{wxAuiNotebookEvent}
@event{EVT_AUINOTEBOOK_PAGE_CLOSE(id, func)} @event{EVT_AUINOTEBOOK_PAGE_CLOSE(id, func)}
Provide description. Provide description.
@event{EVT_AUINOTEBOOK_PAGE_CHANGED(id, func)} @event{EVT_AUINOTEBOOK_PAGE_CHANGED(id, func)}

View File

@@ -111,7 +111,7 @@ enum wxAuiManagerOption
understand layers is by running the wxAUI sample. understand layers is by running the wxAUI sample.
@beginEventTable{wxAuiManagerEvent} @beginEventEmissionTable{wxAuiManagerEvent}
@event{EVT_AUI_PANE_BUTTON(func)} @event{EVT_AUI_PANE_BUTTON(func)}
Triggered when any button is pressed for any docked panes. Triggered when any button is pressed for any docked panes.
@event{EVT_AUI_PANE_CLOSE(func)} @event{EVT_AUI_PANE_CLOSE(func)}

View File

@@ -54,7 +54,7 @@
Note that the wxBU_EXACTFIT style supported by wxButton is not used by this 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. class as bitmap buttons don't have any minimal standard size by default.
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_BUTTON(id, func)} @event{EVT_BUTTON(id, func)}
Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked. Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.
@endEventTable @endEventTable

View File

@@ -36,7 +36,7 @@
@todo create wxCB_PROCESS_ENTER rather than reusing wxTE_PROCESS_ENTER! @todo create wxCB_PROCESS_ENTER rather than reusing wxTE_PROCESS_ENTER!
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_COMBOBOX(id, func)} @event{EVT_COMBOBOX(id, func)}
Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
the list is selected. the list is selected.

View File

@@ -31,7 +31,7 @@
Creates a flat button. Windows and GTK+ only. Creates a flat button. Windows and GTK+ only.
@endStyleTable @endStyleTable
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_BUTTON(id, func)} @event{EVT_BUTTON(id, func)}
Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked. Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.
@endEventTable @endEventTable

View File

@@ -237,7 +237,7 @@ enum wxCalendarHitTestResult
Show week numbers on the left side of the calendar. (not in generic) Show week numbers on the left side of the calendar. (not in generic)
@endStyleTable @endStyleTable
@beginEventTable{wxCalendarEvent} @beginEventEmissionTable{wxCalendarEvent}
@event{EVT_CALENDAR(id, func)} @event{EVT_CALENDAR(id, func)}
A day was double clicked in the calendar. A day was double clicked in the calendar.
@event{EVT_CALENDAR_SEL_CHANGED(id, func)} @event{EVT_CALENDAR_SEL_CHANGED(id, func)}

View File

@@ -39,7 +39,7 @@ enum wxCheckBoxState
Makes the text appear on the left of the checkbox. Makes the text appear on the left of the checkbox.
@endStyleTable @endStyleTable
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_CHECKBOX(id, func)} @event{EVT_CHECKBOX(id, func)}
Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox
is clicked. is clicked.

View File

@@ -15,7 +15,7 @@
When using this class under Windows wxWidgets must be compiled with When using this class under Windows wxWidgets must be compiled with
wxUSE_OWNER_DRAWN set to 1. wxUSE_OWNER_DRAWN set to 1.
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_CHECKLISTBOX(id, func)} @event{EVT_CHECKLISTBOX(id, func)}
Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in Process a wxEVT_COMMAND_CHECKLISTBOX_TOGGLED event, when an item in
the check list box is checked or unchecked. wxCommandEvent::GetInt() the check list box is checked or unchecked. wxCommandEvent::GetInt()

View File

@@ -18,7 +18,7 @@
Sorts the entries alphabetically. Sorts the entries alphabetically.
@endStyleTable @endStyleTable
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_CHOICE(id, func)} @event{EVT_CHOICE(id, func)}
Process a wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the Process a wxEVT_COMMAND_CHOICE_SELECTED event, when an item on the
list is selected. list is selected.

View File

@@ -35,7 +35,7 @@
Place labels below the page area. Place labels below the page area.
@endStyleTable @endStyleTable
@beginEventTable{wxBookCtrlEvent} @beginEventEmissionTable{wxBookCtrlEvent}
@event{EVT_CHOICEBOOK_PAGE_CHANGED(id, func)} @event{EVT_CHOICEBOOK_PAGE_CHANGED(id, func)}
The page selection was changed. The page selection was changed.
Processes a @c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED event. Processes a @c wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED event.

View File

@@ -29,7 +29,7 @@
(instead of no label at all). (instead of no label at all).
@endStyleTable @endStyleTable
@beginEventTable{wxColourPickerEvent} @beginEventEmissionTable{wxColourPickerEvent}
@event{EVT_COLOURPICKER_CHANGED(id, func)} @event{EVT_COLOURPICKER_CHANGED(id, func)}
The user changed the colour selected in the control either using the The user changed the colour selected in the control either using the
button or using text control (see @c wxCLRP_USE_TEXTCTRL; note that button or using text control (see @c wxCLRP_USE_TEXTCTRL; note that

View File

@@ -91,9 +91,11 @@ public:
flag to disable this automatic parent resizing then. flag to disable this automatic parent resizing then.
@endStyleTable @endStyleTable
@beginEventTable{wxCollapsiblePaneEvent} @beginEventEmissionTable{wxCollapsiblePaneEvent,wxNavigationKeyEvent}
@event{EVT_COLLAPSIBLEPANE_CHANGED(id, func)} @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 @endEventTable
@library{wxcore} @library{wxcore}

View File

@@ -292,7 +292,7 @@ struct wxComboCtrlFeatures
Drop button will behave more like a standard push button. Drop button will behave more like a standard push button.
@endStyleTable @endStyleTable
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_TEXT(id, func)} @event{EVT_TEXT(id, func)}
Process a wxEVT_COMMAND_TEXT_UPDATED event, when the text changes. Process a wxEVT_COMMAND_TEXT_UPDATED event, when the text changes.
@event{EVT_TEXT_ENTER(id, func)} @event{EVT_TEXT_ENTER(id, func)}

View File

@@ -37,7 +37,7 @@
only. only.
@endStyleTable @endStyleTable
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_COMBOBOX(id, func)} @event{EVT_COMBOBOX(id, func)}
Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
the list is selected. Note that calling GetValue() returns the new the list is selected. Note that calling GetValue() returns the new

View File

@@ -53,6 +53,16 @@ enum wxEllipsizeMode
A control is generally a small window which processes user input and/or A control is generally a small window which processes user input and/or
displays one or more item of data. 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} @library{wxcore}
@category{ctrl} @category{ctrl}

View File

@@ -525,7 +525,7 @@ public:
This can be inefficient when displaying large number of items. This can be inefficient when displaying large number of items.
@endStyleTable @endStyleTable
@beginEventTable{wxDataViewEvent} @beginEventEmissionTable{wxDataViewEvent}
@event{EVT_DATAVIEW_SELECTION_CHANGED(id, func)} @event{EVT_DATAVIEW_SELECTION_CHANGED(id, func)}
Process a wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED event. Process a wxEVT_COMMAND_DATAVIEW_SELECTION_CHANGED event.
@event{EVT_DATAVIEW_ITEM_ACTIVATED(id, func)} @event{EVT_DATAVIEW_ITEM_ACTIVATED(id, func)}

View File

@@ -40,7 +40,7 @@
default date representation in the system. default date representation in the system.
@endStyleTable @endStyleTable
@beginEventTable{wxDateEvent} @beginEventEmissionTable{wxDateEvent}
@event{EVT_DATE_CHANGED(id, func)} @event{EVT_DATE_CHANGED(id, func)}
This event fires when the user changes the current selection in the This event fires when the user changes the current selection in the
control. control.

View File

@@ -126,13 +126,15 @@ enum wxDialogLayoutAdaptationMode
styles to have an effect. styles to have an effect.
@beginEventTable{wxCloseEvent} @beginEventEmissionTable{wxCloseEvent}
@event{EVT_CLOSE(func)} @event{EVT_CLOSE(func)}
The dialog is being closed by the user or programmatically (see wxWindow::Close). The dialog is being closed by the user or programmatically (see wxWindow::Close).
The user may generate this event clicking the close button 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 (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 (see the @c wxCLOSE_BOX style) or by clicking a button with the
@c wxID_CANCEL or @c wxID_OK ids. @c wxID_CANCEL or @c wxID_OK ids.
@event{EVT_INIT_DIALOG(func)}
Process a @c wxEVT_INIT_DIALOG event. See wxInitDialogEvent.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}

View File

@@ -25,7 +25,7 @@
most one instance of this class in the program accessed via Create() and most one instance of this class in the program accessed via Create() and
you can't create the objects of this class directly. you can't create the objects of this class directly.
@beginEventTable{wxDialUpEvent} @beginEventEmissionTable{wxDialUpEvent}
@event{EVT_DIALUP_CONNECTED(func)} @event{EVT_DIALUP_CONNECTED(func)}
A connection with the network was established. A connection with the network was established.
@event{EVT_DIALUP_DISCONNECTED(func)} @event{EVT_DIALUP_DISCONNECTED(func)}

View File

@@ -869,11 +869,11 @@ public:
@beginEventTable{wxKeyEvent} @beginEventTable{wxKeyEvent}
@event{EVT_KEY_DOWN(func)} @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)} @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)} @event{EVT_CHAR(func)}
Process a wxEVT_CHAR event. Process a @c wxEVT_CHAR event.
@endEventTable @endEventTable
@see wxKeyboardState @see wxKeyboardState
@@ -956,15 +956,15 @@ public:
events received by windows. events received by windows.
@beginEventTable{wxJoystickEvent} @beginEventTable{wxJoystickEvent}
@style{EVT_JOY_BUTTON_DOWN(func)} @event{EVT_JOY_BUTTON_DOWN(func)}
Process a wxEVT_JOY_BUTTON_DOWN event. Process a @c wxEVT_JOY_BUTTON_DOWN event.
@style{EVT_JOY_BUTTON_UP(func)} @event{EVT_JOY_BUTTON_UP(func)}
Process a wxEVT_JOY_BUTTON_UP event. Process a @c wxEVT_JOY_BUTTON_UP event.
@style{EVT_JOY_MOVE(func)} @event{EVT_JOY_MOVE(func)}
Process a wxEVT_JOY_MOVE event. Process a @c wxEVT_JOY_MOVE event.
@style{EVT_JOY_ZMOVE(func)} @event{EVT_JOY_ZMOVE(func)}
Process a wxEVT_JOY_ZMOVE event. Process a @c wxEVT_JOY_ZMOVE event.
@style{EVT_JOYSTICK_EVENTS(func)} @event{EVT_JOYSTICK_EVENTS(func)}
Processes all joystick events. Processes all joystick events.
@endEventTable @endEventTable
@@ -1066,10 +1066,10 @@ public:
A scroll event holds information about events sent from scrolling windows. 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} @beginEventTable{wxScrollWinEvent}
You can use the EVT_SCROLLWIN* macros for intercepting scroll window events
from the receiving window.
@event{EVT_SCROLLWIN(func)} @event{EVT_SCROLLWIN(func)}
Process all scroll events. Process all scroll events.
@event{EVT_SCROLLWIN_TOP(func)} @event{EVT_SCROLLWIN_TOP(func)}
@@ -1140,7 +1140,7 @@ public:
@beginEventTable{wxSysColourChangedEvent} @beginEventTable{wxSysColourChangedEvent}
@event{EVT_SYS_COLOUR_CHANGED(func)} @event{EVT_SYS_COLOUR_CHANGED(func)}
Process a wxEVT_SYS_COLOUR_CHANGED event. Process a @c wxEVT_SYS_COLOUR_CHANGED event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}
@@ -1170,7 +1170,7 @@ public:
@beginEventTable{wxWindowCreateEvent} @beginEventTable{wxWindowCreateEvent}
@event{EVT_WINDOW_CREATE(func)} @event{EVT_WINDOW_CREATE(func)}
Process a wxEVT_CREATE event. Process a @c wxEVT_CREATE event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}
@@ -1254,7 +1254,7 @@ public:
@beginEventTable{wxPaintEvent} @beginEventTable{wxPaintEvent}
@event{EVT_PAINT(func)} @event{EVT_PAINT(func)}
Process a wxEVT_PAINT event. Process a @c wxEVT_PAINT event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}
@@ -1282,7 +1282,7 @@ public:
@beginEventTable{wxMaximizeEvent} @beginEventTable{wxMaximizeEvent}
@event{EVT_MAXIMIZE(func)} @event{EVT_MAXIMIZE(func)}
Process a wxEVT_MAXIMIZE event. Process a @c wxEVT_MAXIMIZE event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}
@@ -1361,9 +1361,9 @@ enum wxUpdateUIMode
@beginEventTable{wxUpdateUIEvent} @beginEventTable{wxUpdateUIEvent}
@event{EVT_UPDATE_UI(id, func)} @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)} @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 @endEventTable
@library{wxcore} @library{wxcore}
@@ -1610,45 +1610,45 @@ public:
@beginEventTable{wxMouseEvent} @beginEventTable{wxMouseEvent}
@event{EVT_LEFT_DOWN(func)} @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 call event.Skip() to allow the default processing to take place as otherwise
the window under mouse wouldn't get the focus. the window under mouse wouldn't get the focus.
@event{EVT_LEFT_UP(func)} @event{EVT_LEFT_UP(func)}
Process a wxEVT_LEFT_UP event. Process a @c wxEVT_LEFT_UP event.
@event{EVT_LEFT_DCLICK(func)} @event{EVT_LEFT_DCLICK(func)}
Process a wxEVT_LEFT_DCLICK event. Process a @c wxEVT_LEFT_DCLICK event.
@event{EVT_MIDDLE_DOWN(func)} @event{EVT_MIDDLE_DOWN(func)}
Process a wxEVT_MIDDLE_DOWN event. Process a @c wxEVT_MIDDLE_DOWN event.
@event{EVT_MIDDLE_UP(func)} @event{EVT_MIDDLE_UP(func)}
Process a wxEVT_MIDDLE_UP event. Process a @c wxEVT_MIDDLE_UP event.
@event{EVT_MIDDLE_DCLICK(func)} @event{EVT_MIDDLE_DCLICK(func)}
Process a wxEVT_MIDDLE_DCLICK event. Process a @c wxEVT_MIDDLE_DCLICK event.
@event{EVT_RIGHT_DOWN(func)} @event{EVT_RIGHT_DOWN(func)}
Process a wxEVT_RIGHT_DOWN event. Process a @c wxEVT_RIGHT_DOWN event.
@event{EVT_RIGHT_UP(func)} @event{EVT_RIGHT_UP(func)}
Process a wxEVT_RIGHT_UP event. Process a @c wxEVT_RIGHT_UP event.
@event{EVT_RIGHT_DCLICK(func)} @event{EVT_RIGHT_DCLICK(func)}
Process a wxEVT_RIGHT_DCLICK event. Process a @c wxEVT_RIGHT_DCLICK event.
@event{EVT_MOUSE_AUX1_DOWN(func)} @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)} @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)} @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)} @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)} @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)} @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)} @event{EVT_MOTION(func)}
Process a wxEVT_MOTION event. Process a @c wxEVT_MOTION event.
@event{EVT_ENTER_WINDOW(func)} @event{EVT_ENTER_WINDOW(func)}
Process a wxEVT_ENTER_WINDOW event. Process a @c wxEVT_ENTER_WINDOW event.
@event{EVT_LEAVE_WINDOW(func)} @event{EVT_LEAVE_WINDOW(func)}
Process a wxEVT_LEAVE_WINDOW event. Process a @c wxEVT_LEAVE_WINDOW event.
@event{EVT_MOUSEWHEEL(func)} @event{EVT_MOUSEWHEEL(func)}
Process a wxEVT_MOUSEWHEEL event. Process a @c wxEVT_MOUSEWHEEL event.
@event{EVT_MOUSE_EVENTS(func)} @event{EVT_MOUSE_EVENTS(func)}
Process all mouse events. Process all mouse events.
@endEventTable @endEventTable
@@ -1986,7 +1986,7 @@ public:
@beginEventTable{wxDropFilesEvent} @beginEventTable{wxDropFilesEvent}
@event{EVT_DROP_FILES(func)} @event{EVT_DROP_FILES(func)}
Process a wxEVT_DROP_FILES event. Process a @c wxEVT_DROP_FILES event.
@endEventTable @endEventTable
@onlyfor{wxmsw} @onlyfor{wxmsw}
@@ -2221,9 +2221,10 @@ public:
@beginEventTable{wxActivateEvent} @beginEventTable{wxActivateEvent}
@event{EVT_ACTIVATE(func)} @event{EVT_ACTIVATE(func)}
Process a wxEVT_ACTIVATE event. Process a @c wxEVT_ACTIVATE event.
@event{EVT_ACTIVATE_APP(func)} @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)} @event{EVT_HIBERNATE(func)}
Process a hibernate event, supplying the member function. This event applies Process a hibernate event, supplying the member function. This event applies
to wxApp only, and only on Windows SmartPhone and PocketPC. to wxApp only, and only on Windows SmartPhone and PocketPC.
@@ -2232,7 +2233,6 @@ public:
a wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP event. a wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}
@category{events} @category{events}
@@ -2259,7 +2259,7 @@ public:
@class wxContextMenuEvent @class wxContextMenuEvent
This class is used for context menu events, sent to give 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 Note that if wxContextMenuEvent::GetPosition returns wxDefaultPosition, this
means that the event originated from a keyboard context button event, and you means that the event originated from a keyboard context button event, and you
@@ -2333,7 +2333,7 @@ public:
@beginEventTable{wxEraseEvent} @beginEventTable{wxEraseEvent}
@event{EVT_ERASE_BACKGROUND(func)} @event{EVT_ERASE_BACKGROUND(func)}
Process a wxEVT_ERASE_BACKGROUND event. Process a @c wxEVT_ERASE_BACKGROUND event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}
@@ -2369,9 +2369,9 @@ public:
@beginEventTable{wxFocusEvent} @beginEventTable{wxFocusEvent}
@event{EVT_SET_FOCUS(func)} @event{EVT_SET_FOCUS(func)}
Process a wxEVT_SET_FOCUS event. Process a @c wxEVT_SET_FOCUS event.
@event{EVT_KILL_FOCUS(func)} @event{EVT_KILL_FOCUS(func)}
Process a wxEVT_KILL_FOCUS event. Process a @c wxEVT_KILL_FOCUS event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}
@@ -2411,7 +2411,7 @@ public:
@beginEventTable{wxChildFocusEvent} @beginEventTable{wxChildFocusEvent}
@event{EVT_CHILD_FOCUS(func)} @event{EVT_CHILD_FOCUS(func)}
Process a wxEVT_CHILD_FOCUS event. Process a @c wxEVT_CHILD_FOCUS event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}
@@ -2458,7 +2458,7 @@ public:
@beginEventTable{wxMouseCaptureLostEvent} @beginEventTable{wxMouseCaptureLostEvent}
@event{EVT_MOUSE_CAPTURE_LOST(func)} @event{EVT_MOUSE_CAPTURE_LOST(func)}
Process a wxEVT_MOUSE_CAPTURE_LOST event. Process a @c wxEVT_MOUSE_CAPTURE_LOST event.
@endEventTable @endEventTable
@onlyfor{wxmsw} @onlyfor{wxmsw}
@@ -2587,9 +2587,9 @@ public:
@beginEventTable{wxHelpEvent} @beginEventTable{wxHelpEvent}
@event{EVT_HELP(id, func)} @event{EVT_HELP(id, func)}
Process a wxEVT_HELP event. Process a @c wxEVT_HELP event.
@event{EVT_HELP_RANGE(id1, id2, func)} @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 @endEventTable
@library{wxcore} @library{wxcore}
@@ -2794,7 +2794,7 @@ enum wxIdleMode
@beginEventTable{wxIdleEvent} @beginEventTable{wxIdleEvent}
@event{EVT_IDLE(func)} @event{EVT_IDLE(func)}
Process a wxEVT_IDLE event. Process a @c wxEVT_IDLE event.
@endEventTable @endEventTable
@library{wxbase} @library{wxbase}
@@ -2880,7 +2880,7 @@ public:
@beginEventTable{wxInitDialogEvent} @beginEventTable{wxInitDialogEvent}
@event{EVT_INIT_DIALOG(func)} @event{EVT_INIT_DIALOG(func)}
Process a wxEVT_INIT_DIALOG event. Process a @c wxEVT_INIT_DIALOG event.
@endEventTable @endEventTable
@library{wxcore} @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 @class wxNavigationKeyEvent
@@ -2974,6 +2962,17 @@ enum wxNavigationKeyEventFlags
class wxNavigationKeyEvent : public wxEvent class wxNavigationKeyEvent : public wxEvent
{ {
public: public:
/**
Flags which can be used with wxNavigationKeyEvent.
*/
enum wxNavigationKeyEventFlags
{
IsBackward = 0x0000,
IsForward = 0x0001,
WinChange = 0x0002,
FromTab = 0x0004
};
wxNavigationKeyEvent(); wxNavigationKeyEvent();
wxNavigationKeyEvent(const wxNavigationKeyEvent& event); wxNavigationKeyEvent(const wxNavigationKeyEvent& event);
@@ -3033,7 +3032,7 @@ public:
@class wxMouseCaptureChangedEvent @class wxMouseCaptureChangedEvent
An mouse capture changed event is sent to a window that loses its 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 was called by the application code. Handling this event allows
an application to cater for unexpected capture releases which an application to cater for unexpected capture releases which
might otherwise confuse mouse handling code. might otherwise confuse mouse handling code.
@@ -3042,7 +3041,7 @@ public:
@beginEventTable{wxMouseCaptureChangedEvent} @beginEventTable{wxMouseCaptureChangedEvent}
@event{EVT_MOUSE_CAPTURE_CHANGED(func)} @event{EVT_MOUSE_CAPTURE_CHANGED(func)}
Process a wxEVT_MOUSE_CAPTURE_CHANGED event. Process a @c wxEVT_MOUSE_CAPTURE_CHANGED event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}
@@ -3253,7 +3252,7 @@ public:
@beginEventTable{wxShowEvent} @beginEventTable{wxShowEvent}
@event{EVT_SHOW(func)} @event{EVT_SHOW(func)}
Process a wxEVT_SHOW event. Process a @c wxEVT_SHOW event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}
@@ -3301,7 +3300,7 @@ public:
@beginEventTable{wxIconizeEvent} @beginEventTable{wxIconizeEvent}
@event{EVT_ICONIZE(func)} @event{EVT_ICONIZE(func)}
Process a wxEVT_ICONIZE event. Process a @c wxEVT_ICONIZE event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}
@@ -3335,16 +3334,16 @@ public:
/** /**
@class wxMoveEvent @class wxMoveEvent
A move event holds information about move change events. A move event holds information about wxTopLevelWindow move change events.
@beginEventTable{wxMoveEvent} @beginEventTable{wxMoveEvent}
@event{EVT_MOVE(func)} @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)} @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. to move or size a window. wxMSW only.
@event{EVT_MOVE_END(func)} @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. moving or sizing a window. wxMSW only.
@endEventTable @endEventTable
@@ -3371,7 +3370,7 @@ public:
/** /**
@class wxSizeEvent @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. The EVT_SIZE handler function will be called when the window has been resized.
@@ -3387,7 +3386,7 @@ public:
@beginEventTable{wxSizeEvent} @beginEventTable{wxSizeEvent}
@event{EVT_SIZE(func)} @event{EVT_SIZE(func)}
Process a wxEVT_SIZE event. Process a @c wxEVT_SIZE event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}
@@ -3414,8 +3413,8 @@ public:
/** /**
@class wxSetCursorEvent @class wxSetCursorEvent
A wxSetCursorEvent is generated when the mouse cursor is about to be set as a A wxSetCursorEvent is generated from wxWindow when the mouse cursor is about
result of mouse motion. to be set as a result of mouse motion.
This event gives the application the chance to perform specific mouse cursor This event gives the application the chance to perform specific mouse cursor
processing based on the current position of the mouse within the window. processing based on the current position of the mouse within the window.
@@ -3423,7 +3422,7 @@ public:
@beginEventTable{wxSetCursorEvent} @beginEventTable{wxSetCursorEvent}
@event{EVT_SET_CURSOR(func)} @event{EVT_SET_CURSOR(func)}
Process a wxEVT_SET_CURSOR event. Process a @c wxEVT_SET_CURSOR event.
@endEventTable @endEventTable
@library{wxcore} @library{wxcore}

View File

@@ -45,7 +45,7 @@ enum wxFindReplaceDialogStyles
/** /**
@class wxFindDialogEvent @class wxFindDialogEvent
wxFindReplaceDialog events wxFindReplaceDialog events.
@beginEventTable{wxFindDialogEvent} @beginEventTable{wxFindDialogEvent}
@event{EVT_FIND(id, func)} @event{EVT_FIND(id, func)}

View File

@@ -30,7 +30,7 @@
Hides the "Show Hidden Files" checkbox (Generic only) Hides the "Show Hidden Files" checkbox (Generic only)
@endStyleTable @endStyleTable
@beginEventTable{wxFileCtrlEvent} @beginEventEmissionTable{wxFileCtrlEvent}
@event{EVT_FILECTRL_FILEACTIVATED(id, func)} @event{EVT_FILECTRL_FILEACTIVATED(id, func)}
The user activated a file(by double-clicking or pressing Enter) The user activated a file(by double-clicking or pressing Enter)
@event{EVT_FILECTRL_SELECTIONCHANGED(id, func)} @event{EVT_FILECTRL_SELECTIONCHANGED(id, func)}

View File

@@ -40,7 +40,7 @@
@endStyleTable @endStyleTable
@beginEventTable{wxFileDirPickerEvent} @beginEventEmissionTable{wxFileDirPickerEvent}
@event{EVT_FILEPICKER_CHANGED(id, func)} @event{EVT_FILEPICKER_CHANGED(id, func)}
The user changed the file selected in the control either using the The user changed the file selected in the control either using the
button or using text control (see wxFLP_USE_TEXTCTRL; note that in 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. Change current working directory on each user directory selection change.
@endStyleTable @endStyleTable
@beginEventTable{wxFileDirPickerEvent} @beginEventEmissionTable{wxFileDirPickerEvent}
@event{EVT_DIRPICKER_CHANGED(id, func)} @event{EVT_DIRPICKER_CHANGED(id, func)}
The user changed the directory selected in the control either using the 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 button or using text control (see wxDIRP_USE_TEXTCTRL; note that in this

View File

@@ -33,7 +33,7 @@
Uses the currently selected font to draw the label of the button. Uses the currently selected font to draw the label of the button.
@endStyleTable @endStyleTable
@beginEventTable{wxFontPickerEvent} @beginEventEmissionTable{wxFontPickerEvent}
@event{EVT_FONTPICKER_CHANGED(id, func)} @event{EVT_FONTPICKER_CHANGED(id, func)}
The user changed the font selected in the control either using the button 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 or using text control (see wxFNTP_USE_TEXTCTRL; note that in this case the

View File

@@ -106,15 +106,26 @@
look. This is an extra style. look. This is an extra style.
@endExtraStyleTable @endExtraStyleTable
@beginEventTable{wxCloseEvent} @beginEventEmissionTable
@event{EVT_CLOSE(func)} @event{EVT_CLOSE(func)}
The frame is being closed by the user or programmatically (see wxWindow::Close). The frame is being closed by the user or programmatically (see wxWindow::Close).
The user may generate this event clicking the close button 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 (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 @endEventTable
@library{wxcore} @library{wxcore}
@category{managedwnd} @category{managedwnd}

View File

@@ -66,7 +66,7 @@
@c wxHD_ALLOW_REORDER. @c wxHD_ALLOW_REORDER.
@endStyleTable @endStyleTable
@beginEventTable{wxHeaderCtrlEvent} @beginEventEmissionTable{wxHeaderCtrlEvent}
@event{EVT_HEADER_CLICK(id, func)} @event{EVT_HEADER_CLICK(id, func)}
A column heading was clicked. A column heading was clicked.
@event{EVT_HEADER_RIGHT_CLICK(id, func)} @event{EVT_HEADER_RIGHT_CLICK(id, func)}

View File

@@ -35,7 +35,7 @@
@endStyleTable @endStyleTable
@beginEventTable{wxHtmlCellEvent, wxHtmlLinkEvent} @beginEventEmissionTable{wxHtmlCellEvent, wxHtmlLinkEvent}
@event{EVT_HTML_CELL_CLICKED(id, func)} @event{EVT_HTML_CELL_CLICKED(id, func)}
A wxHtmlCell was clicked. A wxHtmlCell was clicked.
@event{EVT_HTML_CELL_HOVER(id, func)} @event{EVT_HTML_CELL_HOVER(id, func)}

View File

@@ -14,7 +14,7 @@
derive your own class from it (see htlbox sample for the example) but you will derive your own class from it (see htlbox sample for the example) but you will
only need to override a single wxHtmlListBox::OnGetItem function. only need to override a single wxHtmlListBox::OnGetItem function.
@beginEventTable{wxHtmlCellEvent,wxHtmlLinkEvent} @beginEventEmissionTable{wxHtmlCellEvent,wxHtmlLinkEvent}
@event{EVT_HTML_CELL_CLICKED(id, func)} @event{EVT_HTML_CELL_CLICKED(id, func)}
A wxHtmlCell was clicked. A wxHtmlCell was clicked.
@event{EVT_HTML_CELL_HOVER(id, func)} @event{EVT_HTML_CELL_HOVER(id, func)}
@@ -180,25 +180,19 @@ protected:
A wxSimpleHtmlListBox emits the same events used by wxListBox and by wxHtmlListBox. A wxSimpleHtmlListBox emits the same events used by wxListBox and by wxHtmlListBox.
@beginEventTable{wxCommandEvent} @beginEventEmissionTable
@event{EVT_LISTBOX(id, func)} @event{EVT_LISTBOX(id, func)}
Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the list 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)} @event{EVT_LISTBOX_DCLICK(id, func)}
Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the listbox is Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED event, when the listbox is
double-clicked. double-clicked. See wxCommandEvent.
@endEventTable
@beginEventTable{wxHtmlCellEvent}
@event{EVT_HTML_CELL_CLICKED(id, func)} @event{EVT_HTML_CELL_CLICKED(id, func)}
A wxHtmlCell was clicked. A wxHtmlCell was clicked. See wxHtmlCellEvent.
@event{EVT_HTML_CELL_HOVER(id, func)} @event{EVT_HTML_CELL_HOVER(id, func)}
The mouse passed over a wxHtmlCell. The mouse passed over a wxHtmlCell. See wxHtmlCellEvent.
@endEventTable
@beginEventTable{wxHtmlLinkEvent}
@event{EVT_HTML_LINK_CLICKED(id, func)} @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 @endEventTable
@library{wxhtml} @library{wxhtml}

View File

@@ -71,7 +71,7 @@ public:
wxBORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE. wxBORDER_NONE|wxHL_CONTEXTMENU|wxHL_ALIGN_CENTRE.
@endStyleTable @endStyleTable
@beginEventTable{wxHyperlinkEvent} @beginEventEmissionTable{wxHyperlinkEvent}
@event{EVT_HYPERLINK(id, func)} @event{EVT_HYPERLINK(id, func)}
The hyperlink was (left) clicked. If this event is not handled in user's 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 code (or it's skipped; see wxEvent::Skip), then a call to wxLaunchDefaultBrowser

View File

@@ -90,7 +90,7 @@ enum wxLayoutAlignment
It is an alternative way of specifying layouts for which the normal It is an alternative way of specifying layouts for which the normal
constraint system is unsuitable. constraint system is unsuitable.
@beginEventTable{wxQueryLayoutInfoEvent,wxCalculateLayoutEvent} @beginEventEmissionTable{wxQueryLayoutInfoEvent,wxCalculateLayoutEvent}
@event{EVT_QUERY_LAYOUT_INFO(func)} @event{EVT_QUERY_LAYOUT_INFO(func)}
Process a wxEVT_QUERY_LAYOUT_INFO event, to get size, orientation and Process a wxEVT_QUERY_LAYOUT_INFO event, to get size, orientation and
alignment from a window. See wxQueryLayoutInfoEvent. alignment from a window. See wxQueryLayoutInfoEvent.

View File

@@ -34,7 +34,7 @@
Place labels below the page area. Place labels below the page area.
@endStyleTable @endStyleTable
@beginEventTable{wxBookCtrlEvent} @beginEventEmissionTable{wxBookCtrlEvent}
@event{EVT_LISTBOOK_PAGE_CHANGED(id, func)} @event{EVT_LISTBOOK_PAGE_CHANGED(id, func)}
The page selection was changed. The page selection was changed.
Processes a @c wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED event. Processes a @c wxEVT_COMMAND_LISTBOOK_PAGE_CHANGED event.

View File

@@ -47,7 +47,7 @@
mutually exclusive and you can specify at most one of them (single selection mutually exclusive and you can specify at most one of them (single selection
is the default). See also @ref overview_windowstyles. is the default). See also @ref overview_windowstyles.
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_LISTBOX(id, func)} @event{EVT_LISTBOX(id, func)}
Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the Process a wxEVT_COMMAND_LISTBOX_SELECTED event, when an item on the
list is selected or the selection changes. list is selected or the selection changes.

View File

@@ -83,7 +83,7 @@
@endStyleTable @endStyleTable
@beginEventTable{wxListEvent} @beginEventEmissionTable{wxListEvent}
@event{EVT_LIST_BEGIN_DRAG(id, func)} @event{EVT_LIST_BEGIN_DRAG(id, func)}
Begin dragging with the left mouse button. Begin dragging with the left mouse button.
@event{EVT_LIST_BEGIN_RDRAG(id, func)} @event{EVT_LIST_BEGIN_RDRAG(id, func)}

View File

@@ -17,7 +17,7 @@
Also please note that the methods related to fonts and bitmaps are currently Also please note that the methods related to fonts and bitmaps are currently
only implemented for Windows, Mac and GTK+. only implemented for Windows, Mac and GTK+.
@beginEventTable{wxCommandEvent,wxMenuEvent} @beginEventEmissionTable{wxCommandEvent,wxMenuEvent}
@event{EVT_MENU(id, func)} @event{EVT_MENU(id, func)}
Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item. Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
This type of event is sent as wxCommandEvent. This type of event is sent as wxCommandEvent.

View File

@@ -42,7 +42,7 @@
The styles wxNB_LEFT, RIGHT and BOTTOM are not supported under The styles wxNB_LEFT, RIGHT and BOTTOM are not supported under
Microsoft Windows XP when using visual themes. Microsoft Windows XP when using visual themes.
@beginEventTable{wxBookCtrlEvent} @beginEventEmissionTable{wxBookCtrlEvent}
@event{EVT_NOTEBOOK_PAGE_CHANGED(id, func)} @event{EVT_NOTEBOOK_PAGE_CHANGED(id, func)}
The page selection was changed. The page selection was changed.
Processes a @c wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED event. Processes a @c wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED event.

View File

@@ -45,7 +45,7 @@ enum wxOwnerDrawnComboBoxPaintingFlags
@see wxComboCtrl window styles and @ref overview_windowstyles. @see wxComboCtrl window styles and @ref overview_windowstyles.
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_COMBOBOX(id, func)} @event{EVT_COMBOBOX(id, func)}
Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on Process a wxEVT_COMMAND_COMBOBOX_SELECTED event, when an item on
the list is selected. Note that calling GetValue() returns the new the list is selected. Note that calling GetValue() returns the new

View File

@@ -26,6 +26,11 @@
@remarks By default, a panel has the same colouring as a dialog. @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} @library{wxbase}
@category{miscwnd} @category{miscwnd}

View File

@@ -11,7 +11,7 @@
The power events are generated when the system power state changes, e.g. the 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 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 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 under MS Windows platform. To avoid the need to change the code using this
@@ -21,17 +21,17 @@
supporting the power events. supporting the power events.
@beginEventTable{wxPowerEvent} @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 System is about to be suspended, this event can be vetoed to prevent
suspend from taking place. suspend from taking place.
@event{EVT_POWER_SUSPENDED(func)}: @event{EVT_POWER_SUSPENDED(func)}
System is about to suspend: normally the application should quickly System is about to suspend: normally the application should quickly
(i.e. without user intervention) close all the open files and network (i.e. without user intervention) close all the open files and network
connections here, possibly remembering them to reopen them later when connections here, possibly remembering them to reopen them later when
the system is resumed. 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. 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 System resumed from suspend: normally the application should restore
the state in which it had been before the suspension. the state in which it had been before the suspension.
@endEventTable @endEventTable

View File

@@ -258,7 +258,8 @@ public:
/** /**
@class wxProcessEvent @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} @beginEventTable{wxProcessEvent}
@event{EVT_END_PROCESS(id, func)} @event{EVT_END_PROCESS(id, func)}

View File

@@ -318,7 +318,7 @@ typedef int (*wxPGSortCallback)(wxPropertyGrid* propGrid,
To process input from a property grid control, use these event handler macros To process input from a property grid control, use these event handler macros
to direct input to member functions that take a wxPropertyGridEvent argument. to direct input to member functions that take a wxPropertyGridEvent argument.
@beginEventTable{wxPropertyGridEvent} @beginEventEmissionTable{wxPropertyGridEvent}
@event{EVT_PG_SELECTED (id, func)} @event{EVT_PG_SELECTED (id, func)}
Respond to wxEVT_PG_SELECTED event, generated when property value Respond to wxEVT_PG_SELECTED event, generated when property value
has been changed by user. has been changed by user.

View File

@@ -24,7 +24,7 @@
supported only on PalmOS) supported only on PalmOS)
@endStyleTable @endStyleTable
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_RADIOBOX(id, func)} @event{EVT_RADIOBOX(id, func)}
Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED event, when a radiobutton Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED event, when a radiobutton
is clicked. is clicked.

View File

@@ -30,7 +30,7 @@
only on PalmOS). only on PalmOS).
@endStyleTable @endStyleTable
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_RADIOBUTTON(id, func)} @event{EVT_RADIOBUTTON(id, func)}
Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED event, when the
radiobutton is clicked. radiobutton is clicked.

View File

@@ -50,7 +50,7 @@ enum wxSashDragStatus
Draws a thin black border. Draws a thin black border.
@endStyleTable @endStyleTable
@beginEventTable{wxSashEvent} @beginEventEmissionTable{wxSashEvent}
@event{EVT_SASH_DRAGGED(id, func)} @event{EVT_SASH_DRAGGED(id, func)}
Process a wxEVT_SASH_DRAGGED event, when the user has finished Process a wxEVT_SASH_DRAGGED event, when the user has finished
dragging a sash. dragging a sash.

View File

@@ -39,7 +39,7 @@
Specifies a vertical scrollbar. Specifies a vertical scrollbar.
@endStyleTable @endStyleTable
@beginEventTable{wxScrollEvent} @beginEventEmissionTable{wxScrollEvent}
You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting 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 scroll events from controls, or EVT_SCROLL... macros without window IDs for
intercepting scroll events from the receiving window -- except for this, intercepting scroll events from the receiving window -- except for this,

View File

@@ -40,7 +40,7 @@
compatible with wxSL_SELRANGE. compatible with wxSL_SELRANGE.
@endStyleTable @endStyleTable
@beginEventTable{wxScrollEvent} @beginEventEmissionTable{wxScrollEvent}
You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting 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 scroll events from controls, or EVT_SCROLL... macros without window IDs for
intercepting scroll events from the receiving window -- except for this, intercepting scroll events from the receiving window -- except for this,

View File

@@ -435,6 +435,8 @@ public:
@class wxSocketEvent @class wxSocketEvent
This event class contains information about socket events. This event class contains information about socket events.
This kind of events are sent to the event handler specified with
wxSocketBase::SetEventHandler.
@beginEventTable{wxSocketEvent} @beginEventTable{wxSocketEvent}
@event{EVT_SOCKET(id, func)} @event{EVT_SOCKET(id, func)}
@@ -622,7 +624,7 @@ enum
wxFTP or wxHTTP in another thread) you must initialize the sockets from the wxFTP or wxHTTP in another thread) you must initialize the sockets from the
main thread by calling Initialize() before creating the other ones. main thread by calling Initialize() before creating the other ones.
@beginEventTable{wxSocketEvent} @beginEventEmissionTable{wxSocketEvent}
@event{EVT_SOCKET(id, func)} @event{EVT_SOCKET(id, func)}
Process a @c wxEVT_SOCKET event. Process a @c wxEVT_SOCKET event.
See @ref wxSocketEventFlags and @ref wxSocketFlags for more info. See @ref wxSocketEventFlags and @ref wxSocketFlags for more info.

View File

@@ -77,7 +77,7 @@ public:
The value wraps at the minimum and maximum. The value wraps at the minimum and maximum.
@endStyleTable @endStyleTable
@beginEventTable{wxSpinEvent} @beginEventEmissionTable{wxSpinEvent}
@event{EVT_SPIN(id, func)} @event{EVT_SPIN(id, func)}
Generated whenever an arrow is pressed. Generated whenever an arrow is pressed.
@event{EVT_SPIN_UP(id, func)} @event{EVT_SPIN_UP(id, func)}

View File

@@ -24,7 +24,7 @@
@endStyleTable @endStyleTable
@beginEventTable{wxSpinEvent} @beginEventEmissionTable{wxSpinEvent}
@event{EVT_SPINCTRL(id, func)} @event{EVT_SPINCTRL(id, func)}
Generated whenever the numeric value of the spinctrl is updated Generated whenever the numeric value of the spinctrl is updated
@endEventTable @endEventTable

View File

@@ -37,7 +37,7 @@
@endStyleTable @endStyleTable
@beginEventTable{wxSplitterEvent} @beginEventEmissionTable{wxSplitterEvent}
@event{EVT_SPLITTER_SASH_POS_CHANGING(id, func)} @event{EVT_SPLITTER_SASH_POS_CHANGING(id, func)}
The sash position is in the process of being changed. The sash position is in the process of being changed.
May be used to modify the position of the tracking bar to properly May be used to modify the position of the tracking bar to properly

View File

@@ -39,7 +39,7 @@
capitalized. capitalized.
@endStyleTable @endStyleTable
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
To retrieve actual search queries, use EVT_TEXT and EVT_TEXT_ENTER events, To retrieve actual search queries, use EVT_TEXT and EVT_TEXT_ENTER events,
just as you would with wxTextCtrl. just as you would with wxTextCtrl.
@event{EVT_SEARCHCTRL_SEARCH_BTN(id, func)} @event{EVT_SEARCHCTRL_SEARCH_BTN(id, func)}

View File

@@ -263,7 +263,7 @@ public:
wxStyledTextCtrl is a 1 to 1 mapping of "raw" scintilla interface, whose wxStyledTextCtrl is a 1 to 1 mapping of "raw" scintilla interface, whose
documentation can be found in the Scintilla website (http://www.scintilla.org/). documentation can be found in the Scintilla website (http://www.scintilla.org/).
@beginEventTable{wxStyledTextEvent} @beginEventEmissionTable{wxStyledTextEvent}
@event{EVT_STC_CHANGE(id, fn)} @event{EVT_STC_CHANGE(id, fn)}
TOWRITE TOWRITE
@event{EVT_STC_STYLENEEDED(id, fn)} @event{EVT_STC_STYLENEEDED(id, fn)}

View File

@@ -48,7 +48,7 @@ public:
The user should be required to explicitly enable the taskbar icon on Unix, The user should be required to explicitly enable the taskbar icon on Unix,
it shouldn't be on by default. 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 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 to override wxTaskBarIcon::CreatePopupMenu() if all that the application does
is that it shows a popup menu in reaction to mouse click. is that it shows a popup menu in reaction to mouse click.

View File

@@ -1042,7 +1042,7 @@ public:
wxID_REDO. The associated UI update events are also processed wxID_REDO. The associated UI update events are also processed
automatically, when the control has the focus. automatically, when the control has the focus.
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_TEXT(id, func)} @event{EVT_TEXT(id, func)}
Respond to a wxEVT_COMMAND_TEXT_UPDATED event, generated when the text Respond to a wxEVT_COMMAND_TEXT_UPDATED event, generated when the text
changes. Notice that this event will be sent when the text controls changes. Notice that this event will be sent when the text controls

View File

@@ -17,7 +17,7 @@
You can see wxToggleButton in action in @ref page_samples_controls. You can see wxToggleButton in action in @ref page_samples_controls.
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_TOGGLEBUTTON(id, func)} @event{EVT_TOGGLEBUTTON(id, func)}
Handles a toggle button click event. Handles a toggle button click event.
@endEventTable @endEventTable
@@ -111,7 +111,7 @@ public:
This control emits an update UI event. This control emits an update UI event.
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_TOGGLEBUTTON(id, func)} @event{EVT_TOGGLEBUTTON(id, func)}
Handles a toggle button click event. Handles a toggle button click event.
@endEventTable @endEventTable

View File

@@ -131,7 +131,8 @@ public:
/** /**
@class wxTimerEvent @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: For example:

View File

@@ -85,7 +85,7 @@
ignores @c wxTB_NOICONS style. Also, toggling the @c wxTB_TEXT works only ignores @c wxTB_NOICONS style. Also, toggling the @c wxTB_TEXT works only
if the style was initially on. if the style was initially on.
@beginEventTable{wxCommandEvent} @beginEventEmissionTable{wxCommandEvent}
@event{EVT_TOOL(id, func)} @event{EVT_TOOL(id, func)}
Process a @c wxEVT_COMMAND_TOOL_CLICKED event (a synonym for @c Process a @c wxEVT_COMMAND_TOOL_CLICKED event (a synonym for @c
wxEVT_COMMAND_MENU_SELECTED). Pass the id of the tool. wxEVT_COMMAND_MENU_SELECTED). Pass the id of the tool.

View File

@@ -30,7 +30,7 @@
The common wxBookCtrl styles described in the @ref overview_bookctrl are The common wxBookCtrl styles described in the @ref overview_bookctrl are
also supported. also supported.
@beginEventTable{wxBookCtrlEvent} @beginEventEmissionTable{wxBookCtrlEvent}
@event{EVT_TOOLBOOK_PAGE_CHANGED(id, func)} @event{EVT_TOOLBOOK_PAGE_CHANGED(id, func)}
The page selection was changed. The page selection was changed.
Processes a @c wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED event. Processes a @c wxEVT_COMMAND_TOOLBOOK_PAGE_CHANGED event.

View File

@@ -45,6 +45,22 @@ enum
Note that the instances of wxTopLevelWindow are managed by wxWidgets in the Note that the instances of wxTopLevelWindow are managed by wxWidgets in the
internal top level window list. 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} @library{wxcore}
@category{managedwnd} @category{managedwnd}

View File

@@ -21,7 +21,7 @@
AddPage() and AddSubPage() to sequentially populate your tree by adding at AddPage() and AddSubPage() to sequentially populate your tree by adding at
every step a page or a subpage to the end of the tree. every step a page or a subpage to the end of the tree.
@beginEventTable{wxBookCtrlEvent} @beginEventEmissionTable{wxBookCtrlEvent}
@event{EVT_TREEBOOK_PAGE_CHANGED(id, func)} @event{EVT_TREEBOOK_PAGE_CHANGED(id, func)}
The page selection was changed. The page selection was changed.
Processes a @c wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED event. Processes a @c wxEVT_COMMAND_TREEBOOK_PAGE_CHANGED event.

View File

@@ -60,7 +60,7 @@
for a particular toolkit. for a particular toolkit.
@endStyleTable @endStyleTable
@beginEventTable{wxTreeEvent} @beginEventEmissionTable{wxTreeEvent}
@event{EVT_TREE_BEGIN_DRAG(id, func)} @event{EVT_TREE_BEGIN_DRAG(id, func)}
Begin dragging with the left mouse button. Begin dragging with the left mouse button.
If you want to enable left-dragging you need to intercept this event If you want to enable left-dragging you need to intercept this event

View File

@@ -182,11 +182,64 @@ enum wxWindowVariant
mode set by wxUpdateUIEvent::SetMode is @c wxUPDATE_UI_PROCESS_SPECIFIED. mode set by wxUpdateUIEvent::SetMode is @c wxUPDATE_UI_PROCESS_SPECIFIED.
@endExtraStyleTable @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} @library{wxcore}
@category{miscwnd} @category{miscwnd}
@see @ref overview_events "Event handling overview", @see @ref overview_events, @ref overview_windowsizing
@ref overview_windowsizing "Window sizing overview"
*/ */
class wxWindow : public wxEvtHandler class wxWindow : public wxEvtHandler
{ {

View File

@@ -223,7 +223,7 @@ public:
wxDialog::EnableLayoutAdaptation() or per dialog with wxDialog::SetLayoutAdaptationMode(). wxDialog::EnableLayoutAdaptation() or per dialog with wxDialog::SetLayoutAdaptationMode().
For more about layout adaptation, see @ref overview_dialog_autoscrolling. 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. For some events, Veto() can be called to prevent the event from happening.
@event{EVT_WIZARD_PAGE_CHANGED(id, func)} @event{EVT_WIZARD_PAGE_CHANGED(id, func)}
The page has just been changed (this event cannot be vetoed). The page has just been changed (this event cannot be vetoed).