]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/overviews/eventhandling.h
projects / wxWidgets.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
wxVector<T> is header-based, use @nolibrary
[wxWidgets.git] / docs / doxygen / overviews / eventhandling.h
diff --git a/docs/doxygen/overviews/eventhandling.h b/docs/doxygen/overviews/eventhandling.h
index 1594f828a50aab0efa498bede7623946658306ed..68c2aa5f4564a71d6cfa1a1a0e25b717c80b2e5f 100644 (file)
--- a/docs/doxygen/overviews/eventhandling.h
+++ b/docs/doxygen/overviews/eventhandling.h
@@ -6,9 +6,9 @@
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
 // Licence:     wxWindows license
 /////////////////////////////////////////////////////////////////////////////
 
-/*!
+/**
 
 
- @page overview_eventhandling Event handling overview
+ @page overview_eventhandling Event Handling
 
  Classes: wxEvtHandler, wxWindow, wxEvent
 
 
  Classes: wxEvtHandler, wxWindow, wxEvent
 
@@ -18,8 +18,7 @@
  @li @ref overview_eventhandling_pluggable
  @li @ref overview_eventhandling_winid
  @li @ref overview_eventhandling_custom
  @li @ref overview_eventhandling_pluggable
  @li @ref overview_eventhandling_winid
  @li @ref overview_eventhandling_custom
-
- <!-- @li @ref overview_eventhandling_macros -->
+ @li @ref overview_eventhandling_macros
 
 
  <hr>
 
 
  <hr>
@@ -64,9 +63,9 @@
  member function in a derived class will not have any effect. These member
  functions take an event argument, and the class of event differs according to
  the type of event and the class of the originating window. For size events,
  member function in a derived class will not have any effect. These member
  functions take an event argument, and the class of event differs according to
  the type of event and the class of the originating window. For size events,
- wxSizeEvent is used. For menu commands and most control commands 
+ wxSizeEvent is used. For menu commands and most control commands
  (such as button presses), wxCommandEvent is used. When controls get more
  (such as button presses), wxCommandEvent is used. When controls get more
- complicated, then specific event classes are used, such as wxTreeEvent for 
+ complicated, then specific event classes are used, such as wxTreeEvent for
  events from wxTreeCtrl windows.
 
  As well as the event table in the implementation file, there must also be a
  events from wxTreeCtrl windows.
 
  As well as the event table in the implementation file, there must also be a
@@ -153,9 +152,9 @@
  @li If the object is a wxWindow, @b ProcessEvent is recursively called on the window's
      wxValidator. If this returns @true, the function exits.
  @li @b SearchEventTable is called for this event handler. If this fails, the base
  @li If the object is a wxWindow, @b ProcessEvent is recursively called on the window's
      wxValidator. If this returns @true, the function exits.
  @li @b SearchEventTable is called for this event handler. If this fails, the base
-     class table is tried, and so on until no more tables exist or an appropriate 
+     class table is tried, and so on until no more tables exist or an appropriate
      function was found, in which case the function exits.
      function was found, in which case the function exits.
- @li The search is applied down the entire chain of event handlers (usually the chain has 
+ @li The search is applied down the entire chain of event handlers (usually the chain has
      a length of one). If this succeeds, the function exits.
  @li If the object is a wxWindow and the event is set to set to propagate (in the library only
      wxCommandEvent based events are set to propagate), @b ProcessEvent is recursively applied
      a length of one). If this succeeds, the function exits.
  @li If the object is a wxWindow and the event is set to set to propagate (in the library only
      wxCommandEvent based events are set to propagate), @b ProcessEvent is recursively applied
@@ -233,13 +232,13 @@
 
  While generically wxEvents can be generated both by user
  actions (e.g. resize of a wxWindow) and by calls to functions
 
  While generically wxEvents can be generated both by user
  actions (e.g. resize of a wxWindow) and by calls to functions
- (e.g. wxWindow::SetSize), wxWidgets controls normally send wxCommandEvent-derived 
+ (e.g. wxWindow::SetSize), wxWidgets controls normally send wxCommandEvent-derived
  events only for the user-generated events. The only @b exceptions to this rule are:
 
  @li wxNotebook::AddPage: No event-free alternatives
  @li wxNotebook::AdvanceSelection: No event-free alternatives
  @li wxNotebook::DeletePage: No event-free alternatives
  events only for the user-generated events. The only @b exceptions to this rule are:
 
  @li wxNotebook::AddPage: No event-free alternatives
  @li wxNotebook::AdvanceSelection: No event-free alternatives
  @li wxNotebook::DeletePage: No event-free alternatives
- @li wxNotebook::SetSelection: Use wxNotebook::ChangeSelection instead, as 
+ @li wxNotebook::SetSelection: Use wxNotebook::ChangeSelection instead, as
      wxNotebook::SetSelection is deprecated
  @li wxTreeCtrl::Delete: No event-free alternatives
  @li wxTreeCtrl::DeleteAllItems: No event-free alternatives
      wxNotebook::SetSelection is deprecated
  @li wxTreeCtrl::Delete: No event-free alternatives
  @li wxTreeCtrl::DeleteAllItems: No event-free alternatives
@@ -256,7 +255,7 @@
 
  In fact, you don't have to derive a new class from a window class
  if you don't want to. You can derive a new class from wxEvtHandler instead,
 
  In fact, you don't have to derive a new class from a window class
  if you don't want to. You can derive a new class from wxEvtHandler instead,
- defining the appropriate event table, and then call wxWindow::SetEventHandler 
+ defining the appropriate event table, and then call wxWindow::SetEventHandler
  (or, preferably, wxWindow::PushEventHandler) to make this
  event handler the object that responds to events. This way, you can avoid
  a lot of class derivation, and use instances of the same event handler class (but different
  (or, preferably, wxWindow::PushEventHandler) to make this
  event handler the object that responds to events. This way, you can avoid
  a lot of class derivation, and use instances of the same event handler class (but different
@@ -304,336 +303,12 @@
  will never conflict with the user-specified identifiers which must be always
  positive.
 
  will never conflict with the user-specified identifiers which must be always
  positive.
 
- The following standard identifiers are supplied. You can use wxID_HIGHEST to
- determine the number above which it is safe to define your own identifiers. Or,
- you can use identifiers below wxID_LOWEST.
-
- @code
- #define wxID_ANY                -1
-
- #define wxID_LOWEST             4999
-
- #define wxID_OPEN               5000
- #define wxID_CLOSE              5001
- #define wxID_NEW                5002
- #define wxID_SAVE               5003
- #define wxID_SAVEAS             5004
- #define wxID_REVERT             5005
- #define wxID_EXIT               5006
- #define wxID_UNDO               5007
- #define wxID_REDO               5008
- #define wxID_HELP               5009
- #define wxID_PRINT              5010
- #define wxID_PRINT_SETUP        5011
- #define wxID_PREVIEW            5012
- #define wxID_ABOUT              5013
- #define wxID_HELP_CONTENTS      5014
- #define wxID_HELP_COMMANDS      5015
- #define wxID_HELP_PROCEDURES    5016
- #define wxID_HELP_CONTEXT       5017
-
- #define wxID_CUT                5030
- #define wxID_COPY               5031
- #define wxID_PASTE              5032
- #define wxID_CLEAR              5033
- #define wxID_FIND               5034
- #define wxID_DUPLICATE          5035
- #define wxID_SELECTALL          5036
- #define wxID_DELETE             5037
- #define wxID_REPLACE            5038
- #define wxID_REPLACE_ALL        5039
- #define wxID_PROPERTIES         5040
-
- #define wxID_VIEW_DETAILS       5041
- #define wxID_VIEW_LARGEICONS    5042
- #define wxID_VIEW_SMALLICONS    5043
- #define wxID_VIEW_LIST          5044
- #define wxID_VIEW_SORTDATE      5045
- #define wxID_VIEW_SORTNAME      5046
- #define wxID_VIEW_SORTSIZE      5047
- #define wxID_VIEW_SORTTYPE      5048
-
- #define wxID_FILE1              5050
- #define wxID_FILE2              5051
- #define wxID_FILE3              5052
- #define wxID_FILE4              5053
- #define wxID_FILE5              5054
- #define wxID_FILE6              5055
- #define wxID_FILE7              5056
- #define wxID_FILE8              5057
- #define wxID_FILE9              5058
-
- #define wxID_OK                 5100
- #define wxID_CANCEL             5101
- #define wxID_APPLY              5102
- #define wxID_YES                5103
- #define wxID_NO                 5104
- #define wxID_STATIC             5105
-
- #define wxID_HIGHEST            5999
- @endcode
-
-
-
- <!-- 
-
- NOTE: this list is incomplete and it's a trouble to maintain it!
-       we must find an automatic way to generate it
-
- 
- @section overview_eventhandling_macros Event macros summary
-
- @b Macros listed by event class
- The documentation for specific event macros is organised by event class. Please refer
- to these sections for details.
-
-
-
-
-
-
- #wxActivateEvent
-
-
-
-
- The EVT_ACTIVATE and EVT_ACTIVATE_APP macros intercept
- activation and deactivation events.
-
-
-
-
-
- #wxCommandEvent
-
-
-
-
- A range of commonly-used control events.
-
-
-
-
-
- #wxCloseEvent
-
-
-
-
- The EVT_CLOSE macro handles window closure
- called via wxWindow::Close.
-
-
-
-
-
- #wxDropFilesEvent
-
-
-
-
- The EVT_DROP_FILES macros handles
- file drop events.
-
-
-
-
-
- #wxEraseEvent
-
-
-
-
- The EVT_ERASE_BACKGROUND macro is used to handle window erase requests.
-
-
-
-
-
- #wxFocusEvent
-
-
-
-
- The EVT_SET_FOCUS and EVT_KILL_FOCUS macros are used to handle keyboard focus events.
-
-
-
-
-
- #wxKeyEvent
-
-
-
-
- EVT_CHAR, EVT_KEY_DOWN and
- EVT_KEY_UP macros handle keyboard input for any window.
-
-
-
-
-
- #wxIdleEvent
-
-
-
-
- The EVT_IDLE macro handle application idle events
- (to process background tasks, for example).
-
-
-
-
-
- #wxInitDialogEvent
-
-
-
-
- The EVT_INIT_DIALOG macro is used
- to handle dialog initialisation.
-
-
-
-
-
- #wxListEvent
-
-
-
-
- These macros handle #wxListCtrl events.
-
-
-
-
-
- #wxMenuEvent
-
-
-
-
- These macros handle special menu events (not menu commands).
-
-
-
-
-
- #wxMouseEvent
-
-
-
-
- Mouse event macros can handle either individual
- mouse events or all mouse events.
-
-
-
-
-
- #wxMoveEvent
-
-
-
-
- The EVT_MOVE macro is used to handle a window move.
-
-
-
-
-
- #wxPaintEvent
-
-
-
-
- The EVT_PAINT macro is used to handle window paint requests.
-
-
-
-
-
- #wxScrollEvent
-
-
-
-
- These macros are used to handle scroll events from
- #wxScrollBar, #wxSlider,and #wxSpinButton.
-
-
-
-
-
- #wxSetCursorEvent
-
-
-
-
- The EVT_SET_CURSOR macro is used for special cursor processing.
-
-
-
-
-
- #wxSizeEvent
-
-
-
-
- The EVT_SIZE macro is used to handle a window resize.
-
-
-
-
-
- #wxSplitterEvent
-
-
-
-
- The EVT_SPLITTER_SASH_POS_CHANGED, EVT_SPLITTER_UNSPLIT
- and EVT_SPLITTER_DCLICK macros are used to handle the various splitter window events.
-
-
-
-
-
- #wxSysColourChangedEvent
-
-
-
-
- The EVT_SYS_COLOUR_CHANGED macro is used to handle
- events informing the application that the user has changed the system colours (Windows only).
-
-
-
-
-
- #wxTreeEvent
-
-
-
-
- These macros handle #wxTreeCtrl events.
-
-
-
-
-
- #wxUpdateUIEvent
-
-
-
-
- The EVT_UPDATE_UI macro is used to handle user interface
- update pseudo-events, which are generated to give the application the chance to update the visual state of menus,
- toolbars and controls.
-
-
- -->
-
+ See @ref page_stdevtid for the list of standard identifiers availabel.
+ You can use wxID_HIGHEST to determine the number above which it is safe to
+ define your own identifiers. Or, you can use identifiers below wxID_LOWEST.
+ Finally, you can allocate identifiers dynamically using wxNewId() function to.
+ If you use wxNewId() consistently in your application, you can be sure that
+ the your identifiers don't conflict accidentally.
 
 
  @section overview_eventhandling_custom Custom event summary
 
 
  @section overview_eventhandling_custom Custom event summary
@@ -708,7 +383,7 @@
      // Give it some contents
      event.SetText( wxT("Hallo") );
      // Send it
      // Give it some contents
      event.SetText( wxT("Hallo") );
      // Send it
-     GetEventHandler()-ProcessEvent( event );
+     GetEventHandler()->ProcessEvent( event );
  }
  @endcode
 
  }
  @endcode
 
@@ -723,7 +398,7 @@
  @row2col{EVT_CUSTOM_RANGE(event\, id1\, id2\, func),
           The same as EVT_CUSTOM, but responds to a range of window identifiers.}
  @row2col{EVT_COMMAND(id\, event\, func),
  @row2col{EVT_CUSTOM_RANGE(event\, id1\, id2\, func),
           The same as EVT_CUSTOM, but responds to a range of window identifiers.}
  @row2col{EVT_COMMAND(id\, event\, func),
-          The same as EVT_CUSTOM, but expects a member function with a 
+          The same as EVT_CUSTOM, but expects a member function with a
           wxCommandEvent argument.}
  @row2col{EVT_COMMAND_RANGE(id1\, id2\, event\, func),
           The same as EVT_CUSTOM_RANGE, but
           wxCommandEvent argument.}
  @row2col{EVT_COMMAND_RANGE(id1\, id2\, event\, func),
           The same as EVT_CUSTOM_RANGE, but
@@ -771,7 +446,7 @@
  #define EVT_PLOT(id, fn) \
      DECLARE_EVENT_TABLE_ENTRY( wxEVT_PLOT_ACTION, id, -1, \
      (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxNotifyEventFunction) \
  #define EVT_PLOT(id, fn) \
      DECLARE_EVENT_TABLE_ENTRY( wxEVT_PLOT_ACTION, id, -1, \
      (wxObjectEventFunction) (wxEventFunction) (wxCommandEventFunction) (wxNotifyEventFunction) \
-     wxStaticCastEvent( wxPlotEventFunction, & fn ), (wxObject *) NULL ),
+     wxStaticCastEvent( wxPlotEventFunction, &fn ), (wxObject *) NULL ),
 
 
  // code implementing the event type and the event class
 
 
  // code implementing the event type and the event class
@@ -787,7 +462,7 @@
    EVT_PLOT  (ID_MY_WINDOW, MyFrame::OnPlot)
  END_EVENT_TABLE()
 
    EVT_PLOT  (ID_MY_WINDOW, MyFrame::OnPlot)
  END_EVENT_TABLE()
 
- void MyFrame::OnPlot( wxPlotEvent  )
+ void MyFrame::OnPlot( wxPlotEvent &event )
  {
      wxPlotCurve *curve = event.GetCurve();
  }
  {
      wxPlotCurve *curve = event.GetCurve();
  }
@@ -804,5 +479,13 @@
  }
  @endcode
 
  }
  @endcode
 
+
+
+
+ @section overview_eventhandling_macros Event macros summary
+
+ For the full list of event classes, please see the
+ @ref page_class_cat_events page.
+
 */
 
 */
 
wxWidgets (Impactor)