X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2862acdeb75e148c6215e5e7793a8fdbb22c4b61..74c481d11721fb42343c6b79996478a2ebacde3a:/docs/latex/wx/tevent.tex?ds=sidebyside diff --git a/docs/latex/wx/tevent.tex b/docs/latex/wx/tevent.tex index b3cf6814fd..183076087c 100644 --- a/docs/latex/wx/tevent.tex +++ b/docs/latex/wx/tevent.tex @@ -4,13 +4,13 @@ Classes: \helpref{wxEvtHandler}{wxevthandler}, \helpref{wxWindow}{wxwindow}, \he \subsection{Introduction} -Before version 2.0 of wxWindows, events were handled by the application +Before version 2.0 of wxWidgets, events were handled by the application either by supplying callback functions, or by overriding virtual member functions such as {\bf OnSize}. -From wxWindows 2.0, {\it event tables} are used instead, with a few exceptions. +From wxWidgets 2.0, {\it event tables} are used instead, with a few exceptions. -An event table is placed in an implementation file to tell wxWindows how to map +An event table is placed in an implementation file to tell wxWidgets how to map events to member functions. These member functions are not virtual functions, but they are all similar in form: they take a single wxEvent-derived argument, and have a void return type. @@ -84,11 +84,11 @@ connect the events to the handlers dynamically, during run-time. See the \subsection{How events are processed}\label{eventprocessing} -When an event is received from the windowing system, wxWindows calls +When an event is received from the windowing system, wxWidgets calls \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent} on the first event handler object belonging to the window generating the event. -It may be noted that wxWindows' event processing system implements something +It may be noted that wxWidgets' event processing system implements something very close to virtual methods in normal C++, i.e. it is possible to alter the behaviour of a class by overriding its event handling functions. In many cases this works even for changing the behaviour of native controls. @@ -113,7 +113,7 @@ void MyTextCtrl::OnChar(wxKeyEvent& event) if ( isalpha( event.KeyCode() ) ) { // key code is within legal range. we call event.Skip() so the - // event can be processed either in the base wxWindows class + // event can be processed either in the base wxWidgets class // or the native control. event.Skip(); @@ -142,21 +142,23 @@ class table is tried, and so on until no more tables exist or an appropriate fun in which case the function exits. \item 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. -\item If the object is a wxWindow and the event is a wxCommandEvent, {\bf ProcessEvent} is -recursively applied to the parent window's event handler. If this returns true, the function exits. +\item 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), {\bf ProcessEvent} is recursively applied +to the parent window's event handler. If this returns true, the function exits. \item Finally, {\bf ProcessEvent} is called on the wxApp object. \end{enumerate} {\bf Pay close attention to Step 5.} People often overlook or get -confused by this powerful feature of the wxWindows event processing -system. To put it a different way, events derived either directly or -indirectly from wxCommandEvent will travel up the containment -hierarchy from child to parent until an event handler is found that -doesn't call event.Skip(). Events not derived from wxCommandEvent are -sent only to the window they occurred in and then stop. +confused by this powerful feature of the wxWidgets event processing +system. To put it a different way, events set to propagate +(\helpref{See: wxEvent::ShouldPropagate}{wxeventshouldpropagate}) +(most likely derived either directly or indirectly from wxCommandEvent) +will travel up the containment hierarchy from child to parent until the +maximal propagation level is reached or an event handler is found that +doesn't call \helpref{event.Skip()}{wxeventskip}. Finally, there is another additional complication (which, in fact, simplifies -life of wxWindows programmers significantly): when propagating the command +life of wxWidgets programmers significantly): when propagating the command events upwards to the parent window, the event propagation stops when it reaches the parent dialog, if any. This means that you don't risk to get unexpected events from the dialog controls (which might be left unprocessed by @@ -166,7 +168,7 @@ for this choice is that there are only a few frames in a typical application and their parent-child relation are well understood by the programmer while it may be very difficult, if not impossible, to track down all the dialogs which may be popped up in a complex program (remember that some are created -automatically by wxWindows). If you need to specify a different behaviour for +automatically by wxWidgets). If you need to specify a different behaviour for some reason, you can use \helpref{SetExtraStyle(wxWS\_EX\_BLOCK\_EVENTS)}{wxwindowsetextrastyle} explicitly to prevent the events from being propagated beyond the given window @@ -182,12 +184,13 @@ event. Note that your application may wish to override ProcessEvent to redirect processing of events. This is done in the document/view framework, for example, to allow event handlers to be defined in the document or view. To test for command events (which will probably -be the only events you wish to redirect), you may use wxEvent::IsCommandEvent for -efficiency, instead of using the slower run-time type system. +be the only events you wish to redirect), you may use +\helpref{wxEvent::IsCommandEvent}{wxeventiscommandevent} for efficiency, +instead of using the slower run-time type system. As mentioned above, only command events are recursively applied to the parents event -handler. As this quite often causes confusion for users, here is a list of system -events which will NOT get sent to the parent's event handler: +handler in the libary itself. As this quite often causes confusion for users, +here is a list of system events which will NOT get sent to the parent's event handler: \begin{twocollist}\itemsep=0pt \twocolitem{\helpref{wxEvent}{wxevent}}{The event base class} @@ -272,7 +275,7 @@ may use the {\tt wxID\_OK} identifier, for example, on any number of dialogs so long as you don't have several within the same dialog. If you pass {\tt wxID\_ANY} to a window constructor, an identifier will be -generated for you automatically by wxWindows. This is useful when you don't +generated for you automatically by wxWidgets. This is useful when you don't care about the exact identifier either because you're not going to process the events from the control being created at all or because you process the events from all controls in one place (in which case you should specify {\tt wxID\_ANY} @@ -316,6 +319,19 @@ you can use identifiers below wxID\_LOWEST. #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