X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/3051a44a73502c2b03d1618d0a8e94274ee67e16..0c46625036e3dfb9613aae310f72a00590530689:/interface/wx/event.h?ds=inline diff --git a/interface/wx/event.h b/interface/wx/event.h index e453085f94..64adc9862e 100644 --- a/interface/wx/event.h +++ b/interface/wx/event.h @@ -4,7 +4,7 @@ // wxEvent-derived classes // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @@ -54,6 +54,7 @@ enum wxEventCategory This category is for any event used to send notifications from the secondary threads to the main one or in general for notifications among different threads (which may or may not be user-generated). + See e.g. wxThreadEvent. */ wxEVT_CATEGORY_THREAD = 16, @@ -147,6 +148,7 @@ public: /** Returns a generic category for this event. + wxEvent implementation returns @c wxEVT_CATEGORY_UI by default. This function is used to selectively process events in wxEventLoopBase::YieldFor. */ @@ -331,9 +333,9 @@ public: @library{wxbase} @category{events} - @see @ref overview_events_processing + @see @ref overview_events_processing, wxEventBlocker, wxEventLoopBase */ -class wxEvtHandler : public wxObject +class wxEvtHandler : public wxObject, public wxTrackable { public: /** @@ -378,7 +380,7 @@ public: fields of this object are used by it, notably any wxString members of the event object must not be shallow copies of another wxString object as this would result in them still using the same string buffer behind - the scenes. For example + the scenes. For example: @code void FunctionInAWorkerThread(const wxString& str) { @@ -391,6 +393,20 @@ public: } @endcode + Note that you can use wxThreadEvent instead of wxCommandEvent + to avoid this problem: + @code + void FunctionInAWorkerThread(const wxString& str) + { + wxThreadEvent evt; + evt->SetString(str); + + // wxThreadEvent::Clone() makes sure that the internal wxString + // member is not shared by other wxString instances: + wxTheApp->QueueEvent( evt.Clone() ); + } + @endcode + Finally notice that this method automatically wakes up the event loop if it is currently idle by calling ::wxWakeUpIdle() so there is no need to do it manually when using it. @@ -437,22 +453,29 @@ public: (such as a new control) where you define new event types, as opposed to allowing the user to override virtual functions. - An instance where you might actually override the ProcessEvent() function is where - you want to direct event processing to event handlers not normally noticed by - wxWidgets. For example, in the document/view architecture, documents and views - are potential event handlers. When an event reaches a frame, ProcessEvent() will - need to be called on the associated document and view in case event handler functions - are associated with these objects. The property classes library (wxProperty) also - overrides ProcessEvent() for similar reasons. + Notice that you don't usually need to override ProcessEvent() to + customize the event handling, overriding the specially provided + TryBefore() and TryAfter() functions is usually enough. For example, + wxMDIParentFrame may override TryBefore() to ensure that the menu + events are processed in the active child frame before being processed + in the parent frame itself. The normal order of event table searching is as follows: + -# wxApp::FilterEvent() is called. If it returns anything but @c -1 + (default) the processing stops here. + -# TryBefore() is called (this is where wxValidator are taken into + account for wxWindow objects). If this returns @true, the function exits. -# If the object is disabled (via a call to wxEvtHandler::SetEvtHandlerEnabled) - the function skips to step (6). - -# If the object is a wxWindow, ProcessEvent() is recursively called on the - window's wxValidator. If this returns @true, the function exits. - -# 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 - function was found, in which case the function exits. + the function skips to step (7). + -# Dynamic event table of the handlers bound using Bind<>() is + searched. If a handler is found, it is executed and the function + returns @true unless the handler used wxEvent::Skip() to indicate + that it didn't handle the event in which case the search continues. + -# Static events table of the handlers bound using event table + macros is searched for this event handler. If this fails, the base + class event table table is tried, and so on until no more tables + exist or an appropriate function was found. If a handler is found, + the same logic as in the previous step applies. -# The search is applied down the entire chain of event handlers (usually the chain has a length of one). This chain can be formed using wxEvtHandler::SetNextHandler(): @image html overview_events_chain.png @@ -461,21 +484,50 @@ public: Note that in the case of wxWindow you can build a stack of event handlers (see wxWindow::PushEventHandler() for more info). If any of the handlers of the chain return @true, the function exits. - -# If the object is a wxWindow and the event is a wxCommandEvent, ProcessEvent() - is recursively applied to the parent window's event handler. - If this returns @true, the function exits. - -# Finally, ProcessEvent() is called on the wxApp object. + -# TryAfter() is called: for the wxWindow object this may propagate the + event to the window parent (recursively). If the event is still not + processed, ProcessEvent() on wxTheApp object is called as the last + step. + + Notice that steps (2)-(6) are performed in ProcessEventLocally() + which is called by this function. @param event Event to process. - - @return @true if a suitable event handler function was found and - executed, and the function did not call wxEvent::Skip. + @return + @true if a suitable event handler function was found and executed, + and the function did not call wxEvent::Skip. @see SearchEventTable() */ virtual bool ProcessEvent(wxEvent& event); + /** + Try to process the event in this handler and all those chained to it. + + As explained in ProcessEvent() documentation, the event handlers may be + chained in a doubly-linked list. This function tries to process the + event in this handler (including performing any pre-processing done in + TryBefore(), e.g. applying validators) and all those following it in + the chain until the event is processed or the chain is exhausted. + + This function is called from ProcessEvent() and, in turn, calls + TryThis() for each handler in turn. It is not virtual and so cannot be + overridden but can, and should, be called to forward an event to + another handler instead of ProcessEvent() which would result in a + duplicate call to TryAfter(), e.g. resulting in all unprocessed events + being sent to the application object multiple times. + + @since 2.9.1 + + @param event + Event to process. + @return + @true if this handler of one of those chained to it processed the + event. + */ + bool ProcessEventLocally(wxEvent& event); + /** Processes an event by calling ProcessEvent() and handles any exceptions that occur in the process. @@ -491,6 +543,31 @@ public: */ bool SafelyProcessEvent(wxEvent& event); + /** + Processes the pending events previously queued using QueueEvent() or + AddPendingEvent(); you must call this function only if you are sure + there are pending events for this handler, otherwise a @c wxCHECK + will fail. + + The real processing still happens in ProcessEvent() which is called by this + function. + + Note that this function needs a valid application object (see + wxAppConsole::GetInstance()) because wxApp holds the list of the event + handlers with pending events and this function manipulates that list. + */ + void ProcessPendingEvents(); + + /** + Deletes all events queued on this event handler using QueueEvent() or + AddPendingEvent(). + + Use with care because the events which are deleted are (obviously) not + processed and this may have unwanted consequences (e.g. user actions events + will be lost). + */ + void DeletePendingEvents(); + /** Searches the event table, executing an event handler function if an appropriate one is found. @@ -513,6 +590,9 @@ public: If a suitable function is called but calls wxEvent::Skip, this function will fail, and searching will continue. + @todo this function in the header is listed as an "implementation only" function; + are we sure we want to document it? + @see ProcessEvent() */ virtual bool SearchEventTable(wxEventTable& table, @@ -530,6 +610,11 @@ public: Connects the given function dynamically with the event handler, id and event type. + Notice that Bind() provides a more flexible and safer way to do the + same thing as Connect(), please use it in any new code -- while + Connect() is not formally deprecated due to its existing widespread + usage, it has no advantages compared to Bind(). + This is an alternative to the use of static event tables. It is more flexible as it allows to connect events generated by some object to an event handler defined in a different object of a different class (which @@ -538,7 +623,7 @@ public: Do make sure to specify the correct @a eventSink when connecting to an event of a different object. - See @ref overview_events_connect for more detailed explanation + See @ref overview_events_bind for more detailed explanation of this function and the @ref page_samples_event sample for usage examples. @@ -568,6 +653,14 @@ public: Object whose member function should be called. It must be specified when connecting an event generated by one object to a member function of a different object. If it is omitted, @c this is used. + + @beginWxPerlOnly + In wxPerl this function takes 4 arguments: @a id, @a lastid, + @a type, @a method; if @a method is undef, the handler is + disconnected.} + @endWxPerlOnly + + @see Bind<>() */ void Connect(int id, int lastId, wxEventType eventType, wxObjectEventFunction function, @@ -586,6 +679,10 @@ public: wxEVT_COMMAND_MENU_SELECTED, wxCommandEventHandler(MyFrame::OnQuit) ); @endcode + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ void Connect(int id, wxEventType eventType, wxObjectEventFunction function, @@ -598,6 +695,10 @@ public: This overload will connect the given event handler so that regardless of the ID of the event source, the handler will be called. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ void Connect(wxEventType eventType, wxObjectEventFunction function, @@ -621,6 +722,10 @@ public: Data associated with the event table entry. @param eventSink Object whose member function should be called. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ bool Disconnect(wxEventType eventType, wxObjectEventFunction function, @@ -632,6 +737,10 @@ public: overload for more info. This overload takes the additional @a id parameter. + + @beginWxPerlOnly + Not supported by wxPerl. + @endWxPerlOnly */ bool Disconnect(int id = wxID_ANY, wxEventType eventType = wxEVT_NULL, @@ -644,6 +753,11 @@ public: overload for more info. This overload takes an additional range of source IDs. + + @beginWxPerlOnly + In wxPerl this function takes 3 arguments: @a id, + @a lastid, @a type. + @endWxPerlOnly */ bool Disconnect(int id, int lastId, wxEventType eventType, @@ -653,6 +767,151 @@ public: //@} + /** + @name Binding and Unbinding + */ + //@{ + + /** + Binds the given function, functor or method dynamically with the event. + + This offers basically the same functionality as Connect(), but it is + more flexible as it also allows you to use ordinary functions and + arbitrary functors as event handlers. It is also less restrictive then + Connect() because you can use an arbitrary method as an event handler, + where as Connect() requires a wxEvtHandler derived handler. + + See @ref overview_events_bind for more detailed explanation + of this function and the @ref page_samples_event sample for usage + examples. + + @param eventType + The event type to be associated with this event handler. + @param functor + The event handler functor. This can be an ordinary function but also + an arbitrary functor like boost::function<>. + @param id + The first ID of the identifier range to be associated with the event + handler. + @param lastId + The last ID of the identifier range to be associated with the event + handler. + @param userData + Data to be associated with the event table entry. + + @see @ref overview_cpp_rtti_disabled + + @since 2.9.0 + */ + template + void Bind(const EventTag& eventType, + Functor functor, + int id = wxID_ANY, + int lastId = wxID_ANY, + wxObject *userData = NULL); + + /** + See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for + more info. + + This overload will bind the given method as the event handler. + + @param eventType + The event type to be associated with this event handler. + @param method + The event handler method. This can be an arbitrary method (doesn't need + to be from a wxEvtHandler derived class). + @param handler + Object whose method should be called. It must always be specified + so it can be checked at compile time whether the given method is an + actual member of the given handler. + @param id + The first ID of the identifier range to be associated with the event + handler. + @param lastId + The last ID of the identifier range to be associated with the event + handler. + @param userData + Data to be associated with the event table entry. + + @see @ref overview_cpp_rtti_disabled + + @since 2.9.0 + */ + template + void Bind(const EventTag &eventType, + void (Class::*method)(EventArg &), + EventHandler *handler, + int id = wxID_ANY, + int lastId = wxID_ANY, + wxObject *userData = NULL); + /** + Unbinds the given function, functor or method dynamically from the + event handler, using the specified parameters as search criteria and + returning @true if a matching function has been found and removed. + + This method can only unbind functions, functors or methods which have + been added using the Bind<>() method. There is no way to unbind + functions bound using the (static) event tables. + + @param eventType + The event type associated with this event handler. + @param functor + The event handler functor. This can be an ordinary function but also + an arbitrary functor like boost::function<>. + @param id + The first ID of the identifier range associated with the event + handler. + @param lastId + The last ID of the identifier range associated with the event + handler. + @param userData + Data associated with the event table entry. + + @see @ref overview_cpp_rtti_disabled + + @since 2.9.0 + */ + template + bool Unbind(const EventTag& eventType, + Functor functor, + int id = wxID_ANY, + int lastId = wxID_ANY, + wxObject *userData = NULL); + + /** + See the Unbind<>(const EventTag&, Functor, int, int, wxObject*) + overload for more info. + + This overload unbinds the given method from the event.. + + @param eventType + The event type associated with this event handler. + @param method + The event handler method associated with this event. + @param handler + Object whose method was called. + @param id + The first ID of the identifier range associated with the event + handler. + @param lastId + The last ID of the identifier range associated with the event + handler. + @param userData + Data associated with the event table entry. + + @see @ref overview_cpp_rtti_disabled + + @since 2.9.0 + */ + template + bool Unbind(const EventTag &eventType, + void (Class::*method)(EventArg&), + EventHandler *handler, + int id = wxID_ANY, + int lastId = wxID_ANY, + wxObject *userData = NULL ); + //@} /** @name User-supplied data */ @@ -805,66 +1064,236 @@ public: bool IsUnlinked() const; //@} + +protected: + /** + Method called by ProcessEvent() before examining this object event + tables. + + This method can be overridden to hook into the event processing logic + as early as possible. You should usually call the base class version + when overriding this method, even if wxEvtHandler itself does nothing + here, some derived classes do use this method, e.g. wxWindow implements + support for wxValidator in it. + + Example: + @code + class MyClass : public BaseClass // inheriting from wxEvtHandler + { + ... + protected: + virtual bool TryBefore(wxEvent& event) + { + if ( MyPreProcess(event) ) + return true; + + return BaseClass::TryBefore(event); + } + }; + @endcode + + @see ProcessEvent() + */ + virtual bool TryBefore(wxEvent& event); + + /** + Try to process the event in this event handler. + + This method is called from ProcessEventLocally() and thus, indirectly, + from ProcessEvent(), please see the detailed description of the event + processing logic there. + + It is currently @em not virtual and so may not be overridden. + + @since 2.9.1 + + @param event + Event to process. + @return + @true if this object itself defines a handler for this event and + the handler didn't skip the event. + */ + bool TryThis(wxEvent& event); + + /** + Method called by ProcessEvent() as last resort. + + This method can be overridden to implement post-processing for the + events which were not processed anywhere else. + + The base class version handles forwarding the unprocessed events to + wxApp at wxEvtHandler level and propagating them upwards the window + child-parent chain at wxWindow level and so should usually be called + when overriding this method: + @code + class MyClass : public BaseClass // inheriting from wxEvtHandler + { + ... + protected: + virtual bool TryAfter(wxEvent& event) + { + if ( BaseClass::TryAfter(event) ) + return true; + + return MyPostProcess(event); + } + }; + @endcode + + @see ProcessEvent() + */ + virtual bool TryAfter(wxEvent& event); +}; + + +/** + Flags for categories of keys. + + These values are used by wxKeyEvent::IsKeyInCategory(). They may be + combined via the bitwise operators |, &, and ~. + + @since 2.9.1 +*/ +enum wxKeyCategoryFlags +{ + /// arrow keys, on and off numeric keypads + WXK_CATEGORY_ARROW, + + /// page up and page down keys, on and off numeric keypads + WXK_CATEGORY_PAGING, + + /// home and end keys, on and off numeric keypads + WXK_CATEGORY_JUMP, + + /// tab key, on and off numeric keypads + WXK_CATEGORY_TAB, + + /// backspace and delete keys, on and off numeric keypads + WXK_CATEGORY_CUT, + + /// union of WXK_CATEGORY_ARROW, WXK_CATEGORY_PAGING, and WXK_CATEGORY_JUMP categories + WXK_CATEGORY_NAVIGATION }; /** @class wxKeyEvent - This event class contains information about keypress (character) events. - - Notice that there are three different kinds of keyboard events in wxWidgets: - key down and up events and char events. The difference between the first two - is clear - the first corresponds to a key press and the second to a key - release - otherwise they are identical. Just note that if the key is - maintained in a pressed state you will typically get a lot of (automatically - generated) down events but only one up so it is wrong to assume that there is - one up event corresponding to each down one. - - Both key events provide untranslated key codes while the char event carries - the translated one. The untranslated code for alphanumeric keys is always - an upper case value. For the other keys it is one of @c WXK_XXX values - from the ::wxKeyCode enumeration. - The translated key is, in general, the character the user expects to appear - as the result of the key combination when typing the text into a text entry - zone, for example. - - A few examples to clarify this (all assume that CAPS LOCK is unpressed - and the standard US keyboard): when the @c 'A' key is pressed, the key down - event key code is equal to @c ASCII A == 65. But the char event key code - is @c ASCII a == 97. On the other hand, if you press both SHIFT and - @c 'A' keys simultaneously , the key code in key down event will still be - just @c 'A' while the char event key code parameter will now be @c 'A' - as well. - - Although in this simple case it is clear that the correct key code could be - found in the key down event handler by checking the value returned by - wxKeyEvent::ShiftDown(), in general you should use @c EVT_CHAR for this as - for non-alphanumeric keys the translation is keyboard-layout dependent and - can only be done properly by the system itself. - - Another kind of translation is done when the control key is pressed: for - example, for CTRL-A key press the key down event still carries the - same key code @c 'a' as usual but the char event will have key code of 1, - the ASCII value of this key combination. - - You may discover how the other keys on your system behave interactively by - running the @ref page_samples_text wxWidgets sample and pressing some keys - in any of the text controls shown in it. - - @b Tip: be sure to call @c event.Skip() for events that you don't process in - key event function, otherwise menu shortcuts may cease to work under Windows. + This event class contains information about key press and release events. + + The main information carried by this event is the key being pressed or + released. It can be accessed using either GetKeyCode() function or + GetUnicodeKey(). For the printable characters, the latter should be used as + it works for any keys, including non-Latin-1 characters that can be entered + when using national keyboard layouts. GetKeyCode() should be used to handle + special characters (such as cursor arrows keys or @c HOME or @c INS and so + on) which correspond to ::wxKeyCode enum elements above the @c WXK_START + constant. While GetKeyCode() also returns the character code for Latin-1 + keys for compatibility, it doesn't work for Unicode characters in general + and will return @c WXK_NONE for any non-Latin-1 ones. For this reason, it's + recommended to always use GetUnicodeKey() and only fall back to GetKeyCode() + if GetUnicodeKey() returned @c WXK_NONE meaning that the event corresponds + to a non-printable special keys. + + While both of these functions can be used with the events of @c + wxEVT_KEY_DOWN, @c wxEVT_KEY_UP and @c wxEVT_CHAR types, the values + returned by them are different for the first two events and the last one. + For the latter, the key returned corresponds to the character that would + appear in e.g. a text zone if the user pressed the key in it. As such, its + value depends on the current state of the Shift key and, for the letters, + on the state of Caps Lock modifier. For example, if @c A key is pressed + without Shift being held down, wxKeyEvent of type @c wxEVT_CHAR generated + for this key press will return (from either GetKeyCode() or GetUnicodeKey() + as their meanings coincide for ASCII characters) key code of 97 + corresponding the ASCII value of @c a. And if the same key is pressed but + with Shift being held (or Caps Lock being active), then the key could would + be 65, i.e. ASCII value of capital @c A. + + However for the key down and up events the returned key code will instead + be @c A independently of the state of the modifier keys i.e. it depends + only on physical key being pressed and is not translated to its logical + representation using the current keyboard state. Such untranslated key + codes are defined as follows: + - For the letters they correspond to the @e upper case value of the + letter. + - For the other alphanumeric keys (e.g. @c 7 or @c +), the untranslated + key code corresponds to the character produced by the key when it is + pressed without Shift. E.g. in standard US keyboard layout the + untranslated key code for the key @c =/+ in the upper right corner of + the keyboard is 61 which is the ASCII value of @c =. + - For the rest of the keys (i.e. special non-printable keys) it is the + same as the normal key code as no translation is used anyhow. + + Notice that the first rule applies to all Unicode letters, not just the + usual Latin-1 ones. However for non-Latin-1 letters only GetUnicodeKey() + can be used to retrieve the key code as GetKeyCode() just returns @c + WXK_NONE in this case. + + To summarize: you should handle @c wxEVT_CHAR if you need the translated + key and @c wxEVT_KEY_DOWN if you only need the value of the key itself, + independent of the current keyboard state. + + @note Not all key down events may be generated by the user. As an example, + @c wxEVT_KEY_DOWN with @c = key code can be generated using the + standard US keyboard layout but not using the German one because the @c + = key corresponds to Shift-0 key combination in this layout and the key + code for it is @c 0, not @c =. Because of this you should avoid + requiring your users to type key events that might be impossible to + enter on their keyboard. + + + Another difference between key and char events is that another kind of + translation is done for the latter ones when the Control key is pressed: + char events for ASCII letters in this case carry codes corresponding to the + ASCII value of Ctrl-Latter, i.e. 1 for Ctrl-A, 2 for Ctrl-B and so on until + 26 for Ctrl-Z. This is convenient for terminal-like applications and can be + completely ignored by all the other ones (if you need to handle Ctrl-A it + is probably a better idea to use the key event rather than the char one). + Notice that currently no translation is done for the presses of @c [, @c + \\, @c ], @c ^ and @c _ keys which might be mapped to ASCII values from 27 + to 31. + + Finally, modifier keys only generate key events but no char events at all. + The modifiers keys are @c WXK_SHIFT, @c WXK_CONTROL, @c WXK_ALT and various + @c WXK_WINDOWS_XXX from ::wxKeyCode enum. + + Modifier keys events are special in one additional aspect: usually the + keyboard state associated with a key press is well defined, e.g. + wxKeyboardState::ShiftDown() returns @c true only if the Shift key was held + pressed when the key that generated this event itself was pressed. There is + an ambiguity for the key press events for Shift key itself however. By + convention, it is considered to be already pressed when it is pressed and + already released when it is released. In other words, @c wxEVT_KEY_DOWN + event for the Shift key itself will have @c wxMOD_SHIFT in GetModifiers() + and ShiftDown() will return true while the @c wxEVT_KEY_UP event for Shift + itself will not have @c wxMOD_SHIFT in its modifiers and ShiftDown() will + return false. + + + @b Tip: You may discover the key codes and modifiers generated by all the + keys on your system interactively by running the @ref + page_samples_keyboard wxWidgets sample and pressing some keys in it. @note If a key down (@c EVT_KEY_DOWN) event is caught and the event handler does not call @c event.Skip() then the corresponding char event - (@c EVT_CHAR) will not happen. - This is by design and enables the programs that handle both types of - events to be a bit simpler. + (@c EVT_CHAR) will not happen. This is by design and enables the + programs that handle both types of events to avoid processing the + same key twice. As a consequence, if you do not want to suppress the + @c wxEVT_CHAR events for the keys you handle, always call @c + event.Skip() in your @c wxEVT_KEY_DOWN handler. Not doing may also + prevent accelerators defined using this key from working. + + @note If a key is maintained in a pressed state, you will typically get a + lot of (automatically generated) key down events but only one key up + one at the end when the key is released so it is wrong to assume that + there is one up event corresponding to each down one. @note For Windows programmers: The key and char events in wxWidgets are similar to but slightly different from Windows @c WM_KEYDOWN and @c WM_CHAR events. In particular, Alt-x combination will generate a - char event in wxWidgets (unless it is used as an accelerator). + char event in wxWidgets (unless it is used as an accelerator) and + almost all keys, including ones without ASCII equivalents, generate + char events too. @beginEventTable{wxKeyEvent} @@ -892,16 +1321,62 @@ public: wxKeyEvent(wxEventType keyEventType = wxEVT_NULL); /** - Returns the virtual key code. ASCII events return normal ASCII values, - while non-ASCII events return values such as @b WXK_LEFT for the left cursor - key. See ::wxKeyCode for a full list of the virtual key codes. + Returns the key code of the key that generated this event. + + ASCII symbols return normal ASCII values, while events from special + keys such as "left cursor arrow" (@c WXK_LEFT) return values outside of + the ASCII range. See ::wxKeyCode for a full list of the virtual key + codes. - Note that in Unicode build, the returned value is meaningful only if the - user entered a character that can be represented in current locale's default - charset. You can obtain the corresponding Unicode character using GetUnicodeKey(). + Note that this method returns a meaningful value only for special + non-alphanumeric keys or if the user entered a character that can be + represented in current locale's default charset. Otherwise, e.g. if the + user enters a Japanese character in a program not using Japanese + locale, this method returns @c WXK_NONE and GetUnicodeKey() should be + used to obtain the corresponding Unicode character. + + Using GetUnicodeKey() is in general the right thing to do if you are + interested in the characters typed by the user, GetKeyCode() should be + only used for special keys (for which GetUnicodeKey() returns @c + WXK_NONE). To handle both kinds of keys you might write: + @code + void MyHandler::OnChar(wxKeyEvent& event) + { + if ( event.GetUnicodeKey() != WXK_NONE ) + { + // It's a printable character + wxLogMessage("You pressed '%c'", event.GetUnicodeKey()); + } + else + { + // It's a special key, deal with all the known ones: + switch ( keycode ) + { + case WXK_LEFT: + case WXK_RIGHT: + ... move cursor ... + break; + + case WXK_F1: + ... give help ... + break; + } + } + } + @endcode */ int GetKeyCode() const; + /** + Returns true if the key is in the given key category. + + @param category + A bitwise combination of named ::wxKeyCategoryFlags constants. + + @since 2.9.1 + */ + bool IsKeyInCategory(int category) const; + //@{ /** Obtains the position (in client coordinates) at which the key was pressed. @@ -911,8 +1386,19 @@ public: //@} /** - Returns the raw key code for this event. This is a platform-dependent scan code - which should only be used in advanced applications. + Returns the raw key code for this event. + + The flags are platform-dependent and should only be used if the + functionality provided by other wxKeyEvent methods is insufficient. + + Under MSW, the raw key code is the value of @c wParam parameter of the + corresponding message. + + Under GTK, the raw key code is the @c keyval field of the corresponding + GDK event. + + Under OS X, the raw key code is the @c keyCode field of the + corresponding NSEvent. @note Currently the raw key codes are not supported by all ports, use @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available. @@ -920,8 +1406,18 @@ public: wxUint32 GetRawKeyCode() const; /** - Returns the low level key flags for this event. The flags are - platform-dependent and should only be used in advanced applications. + Returns the low level key flags for this event. + + The flags are platform-dependent and should only be used if the + functionality provided by other wxKeyEvent methods is insufficient. + + Under MSW, the raw flags are just the value of @c lParam parameter of + the corresponding message. + + Under GTK, the raw flags contain the @c hardware_keycode field of the + corresponding GDK event. + + Under OS X, the raw flags contain the modifiers state. @note Currently the raw key flags are not supported by all ports, use @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available. @@ -931,6 +1427,10 @@ public: /** Returns the Unicode character corresponding to this key event. + If the key pressed doesn't have any character value (e.g. a cursor key) + this method will return @c WXK_NONE. In this case you should use + GetKeyCode() to retrieve the value of the key. + This function is only available in Unicode build, i.e. when @c wxUSE_UNICODE is 1. */ @@ -1197,16 +1697,8 @@ public: A paint event is sent when a window's contents needs to be repainted. - Please notice that in general it is impossible to change the drawing of a - standard control (such as wxButton) and so you shouldn't attempt to handle - paint events for them as even if it might work on some platforms, this is - inherently not portable and won't work everywhere. - - @remarks - Note that in a paint event handler, the application must always create a - wxPaintDC object, even if you do not use it. Otherwise, under MS Windows, - refreshing for this and other windows will go wrong. - For example: + The handler of this event must create a wxPaintDC object and use it for + painting the window contents. For example: @code void MyWindow::OnPaint(wxPaintEvent& event) { @@ -1215,6 +1707,12 @@ public: DrawMyDocument(dc); } @endcode + + Notice that you must @e not create other kinds of wxDC (e.g. wxClientDC or + wxWindowDC) in EVT_PAINT handlers and also don't create wxPaintDC outside + of this event handlers. + + You can optimize painting by retrieving the rectangles that have been damaged and only repainting these. The rectangles are in terms of the client area, and are unscrolled, so you will need to do some calculations using the current @@ -1251,6 +1749,12 @@ public: } @endcode + @remarks + Please notice that in general it is impossible to change the drawing of a + standard control (such as wxButton) and so you shouldn't attempt to handle + paint events for them as even if it might work on some platforms, this is + inherently not portable and won't work everywhere. + @beginEventTable{wxPaintEvent} @event{EVT_PAINT(func)} @@ -1598,14 +2102,16 @@ public: left the window and the state variables for it may have changed during this time. @note Note the difference between methods like wxMouseEvent::LeftDown and - wxMouseEvent::LeftIsDown: the former returns @true when the event corresponds - to the left mouse button click while the latter returns @true if the left - mouse button is currently being pressed. For example, when the user is dragging - the mouse you can use wxMouseEvent::LeftIsDown to test whether the left mouse - button is (still) depressed. Also, by convention, if wxMouseEvent::LeftDown - returns @true, wxMouseEvent::LeftIsDown will also return @true in wxWidgets - whatever the underlying GUI behaviour is (which is platform-dependent). - The same applies, of course, to other mouse buttons as well. + the inherited wxMouseState::LeftIsDown: the former returns @true when + the event corresponds to the left mouse button click while the latter + returns @true if the left mouse button is currently being pressed. + For example, when the user is dragging the mouse you can use + wxMouseEvent::LeftIsDown to test whether the left mouse button is + (still) depressed. Also, by convention, if wxMouseEvent::LeftDown + returns @true, wxMouseEvent::LeftIsDown will also return @true in + wxWidgets whatever the underlying GUI behaviour is (which is + platform-dependent). The same applies, of course, to other mouse + buttons as well. @beginEventTable{wxMouseEvent} @@ -1630,17 +2136,17 @@ public: @event{EVT_RIGHT_DCLICK(func)} Process a @c wxEVT_RIGHT_DCLICK event. @event{EVT_MOUSE_AUX1_DOWN(func)} - Process a @c wxEVT_MOUSE_AUX1_DOWN event. + Process a @c wxEVT_AUX1_DOWN event. @event{EVT_MOUSE_AUX1_UP(func)} - Process a @c wxEVT_MOUSE_AUX1_UP event. + Process a @c wxEVT_AUX1_UP event. @event{EVT_MOUSE_AUX1_DCLICK(func)} - Process a @c wxEVT_MOUSE_AUX1_DCLICK event. + Process a @c wxEVT_AUX1_DCLICK event. @event{EVT_MOUSE_AUX2_DOWN(func)} - Process a @c wxEVT_MOUSE_AUX2_DOWN event. + Process a @c wxEVT_AUX2_DOWN event. @event{EVT_MOUSE_AUX2_UP(func)} - Process a @c wxEVT_MOUSE_AUX2_UP event. + Process a @c wxEVT_AUX2_UP event. @event{EVT_MOUSE_AUX2_DCLICK(func)} - Process a @c wxEVT_MOUSE_AUX2_DCLICK event. + Process a @c wxEVT_AUX2_DCLICK event. @event{EVT_MOTION(func)} Process a @c wxEVT_MOTION event. @event{EVT_ENTER_WINDOW(func)} @@ -1697,12 +2203,6 @@ public: */ bool Aux1Down() const; - /** - Returns @true if the first extra button mouse button is currently down, - independent of the current event type. - */ - bool Aux1IsDown() const; - /** Returns @true if the first extra button mouse button changed to up. */ @@ -1718,52 +2218,38 @@ public: */ bool Aux2Down() const; - /** - Returns @true if the second extra button mouse button is currently down, - independent of the current event type. - */ - bool Aux2IsDown() const; - /** Returns @true if the second extra button mouse button changed to up. */ bool Aux2Up() const; /** - Returns @true if the identified mouse button is changing state. - Valid values of @a button are: - - @li @c wxMOUSE_BTN_LEFT: check if left button was pressed - @li @c wxMOUSE_BTN_MIDDLE: check if middle button was pressed - @li @c wxMOUSE_BTN_RIGHT: check if right button was pressed - @li @c wxMOUSE_BTN_AUX1: check if the first extra button was pressed - @li @c wxMOUSE_BTN_AUX2: check if the second extra button was pressed - @li @c wxMOUSE_BTN_ANY: check if any button was pressed + Returns @true if the event was generated by the specified button. - @todo introduce wxMouseButton enum + @see wxMouseState::ButtoinIsDown() */ - bool Button(int button) const; + bool Button(wxMouseButton but) const; /** If the argument is omitted, this returns @true if the event was a mouse double click event. Otherwise the argument specifies which double click event was generated (see Button() for the possible values). */ - bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const; + bool ButtonDClick(wxMouseButton but = wxMOUSE_BTN_ANY) const; /** If the argument is omitted, this returns @true if the event was a mouse button down event. Otherwise the argument specifies which button-down event was generated (see Button() for the possible values). */ - bool ButtonDown(int = wxMOUSE_BTN_ANY) const; + bool ButtonDown(wxMouseButton but = wxMOUSE_BTN_ANY) const; /** If the argument is omitted, this returns @true if the event was a mouse button up event. Otherwise the argument specifies which button-up event was generated (see Button() for the possible values). */ - bool ButtonUp(int = wxMOUSE_BTN_ANY) const; + bool ButtonUp(wxMouseButton but = wxMOUSE_BTN_ANY) const; /** Returns @true if this was a dragging event (motion while a button is depressed). @@ -1813,20 +2299,6 @@ public: */ wxPoint GetLogicalPosition(const wxDC& dc) const; - //@{ - /** - Sets *x and *y to the position at which the event occurred. - Returns the physical mouse position in pixels. - - Note that if the mouse event has been artificially generated from a special - keyboard combination (e.g. under Windows when the "menu" key is pressed), the - returned position is ::wxDefaultPosition. - */ - wxPoint GetPosition() const; - void GetPosition(wxCoord* x, wxCoord* y) const; - void GetPosition(long* x, long* y) const; - //@} - /** Get wheel delta, normally 120. @@ -1855,16 +2327,6 @@ public: */ int GetWheelAxis() const; - /** - Returns X coordinate of the physical mouse event position. - */ - wxCoord GetX() const; - - /** - Returns Y coordinate of the physical mouse event position. - */ - wxCoord GetY() const; - /** Returns @true if the event was a mouse button event (not necessarily a button down event - that may be tested using ButtonDown()). @@ -1894,21 +2356,6 @@ public: */ bool LeftDown() const; - /** - Returns @true if the left mouse button is currently down, independent - of the current event type. - - Please notice that it is not the same as LeftDown() which returns @true if the - event was generated by the left mouse button being pressed. Rather, it simply - describes the state of the left mouse button at the time when the event was - generated (so while it will be @true for a left click event, it can also be @true - for a right click if it happened while the left mouse button was pressed). - - This event is usually used in the mouse event handlers which process "move - mouse" messages to determine whether the user is (still) dragging the mouse. - */ - bool LeftIsDown() const; - /** Returns @true if the left mouse button changed to up. */ @@ -1929,12 +2376,6 @@ public: */ bool MiddleDown() const; - /** - Returns @true if the middle mouse button is currently down, independent - of the current event type. - */ - bool MiddleIsDown() const; - /** Returns @true if the middle mouse button changed to up. */ @@ -1957,12 +2398,6 @@ public: */ bool RightDown() const; - /** - Returns @true if the right mouse button is currently down, independent - of the current event type. - */ - bool RightIsDown() const; - /** Returns @true if the right mouse button changed to up. */ @@ -2030,6 +2465,11 @@ public: This event class contains information about command events, which originate from a variety of simple controls. + Note that wxCommandEvents and wxCommandEvent-derived event classes by default + and unlike other wxEvent-derived classes propagate upward from the source + window (the window which emits the event) up to the first parent which processes + the event. Be sure to read @ref overview_events_propagation. + More complex controls, such as wxTreeCtrl, have separate command event classes. @beginEventTable{wxCommandEvent} @@ -2088,13 +2528,13 @@ public: @event{EVT_TOOL_RANGE(id1, id2, func)} Process a @c wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools. @event{EVT_TOOL_RCLICKED(id, func)} - Process a @c wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool. + Process a @c wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool. (Not available on wxOSX.) @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)} - Process a @c wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. + Process a @c wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. (Not available on wxOSX.) @event{EVT_TOOL_ENTER(id, func)} Process a @c wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself. The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor - has moved off a tool. + has moved off a tool. (Not available on wxOSX.) @event{EVT_COMMAND_LEFT_CLICK(id, func)} Process a @c wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only). @event{EVT_COMMAND_LEFT_DCLICK(id, func)} @@ -2534,8 +2974,14 @@ public: This class adds some simple functionalities to wxCommandEvent coinceived for inter-threads communications. + This event is not natively emitted by any control/class: this is just + an helper class for the user. + Its most important feature is the GetEventCategory() implementation which + allows thread events to @b NOT be processed by wxEventLoopBase::YieldFor calls + (unless the @c wxEVT_CATEGORY_THREAD is specified - which is never in wx code). + @library{wxcore} - @category{events} + @category{events,threading} @see @ref overview_thread, wxEventLoopBase::YieldFor */ @@ -2561,6 +3007,37 @@ public: when calling wxEventLoopBase::YieldFor(). */ virtual wxEventCategory GetEventCategory() const; + + /** + Sets custom data payload. + + The @a payload argument may be of any type that wxAny can handle + (i.e. pretty much anything). Note that T's copy constructor must be + thread-safe, i.e. create a copy that doesn't share anything with + the original (see Clone()). + + @note This method is not available with Visual C++ 6. + + @since 2.9.1 + + @see GetPayload(), wxAny + */ + template + void SetPayload(const T& payload); + + /** + Get custom data payload. + + Correct type is checked in debug builds. + + @note This method is not available with Visual C++ 6. + + @since 2.9.1 + + @see SetPayload(), wxAny + */ + template + T GetPayload() const; }; @@ -3125,13 +3602,13 @@ public: @beginEventTable{wxCloseEvent} @event{EVT_CLOSE(func)} - Process a close event, supplying the member function. + Process a @c wxEVT_CLOSE_WINDOW command event, supplying the member function. This event applies to wxFrame and wxDialog classes. @event{EVT_QUERY_END_SESSION(func)} - Process a query end session event, supplying the member function. + Process a @c wxEVT_QUERY_END_SESSION session event, supplying the member function. This event can be handled in wxApp-derived class only. @event{EVT_END_SESSION(func)} - Process an end session event, supplying the member function. + Process a @c wxEVT_END_SESSION session event, supplying the member function. This event can be handled in wxApp-derived class only. @endEventTable @@ -3245,6 +3722,11 @@ public: @class wxShowEvent An event being sent when the window is shown or hidden. + The event is triggered by calls to wxWindow::Show(), and any user + action showing a previously hidden window or vice versa (if allowed by + the current platform and/or window manager). + Notice that the event is not triggered when the application is iconized + (minimized) or restored under wxMSW. Currently only wxMSW, wxGTK and wxOS2 generate such events. @@ -3376,7 +3858,7 @@ public: You may wish to use this for frames to resize their child windows as appropriate. - Note that the size passed is of the whole window: call wxWindow::GetClientSize + Note that the size passed is of the whole window: call wxWindow::GetClientSize() for the area which may be used by the application. When a window is resized, usually only a small part of the window is damaged @@ -3404,6 +3886,11 @@ public: /** Returns the entire size of the window generating the size change event. + + This is the new total size of the window, i.e. the same size as would + be returned by wxWindow::GetSize() if it were called now. Use + wxWindow::GetClientSize() if you catch this event in a top level window + such as wxFrame to find the size available for the window contents. */ wxSize GetSize() const; }; @@ -3494,13 +3981,6 @@ typedef int wxEventType; */ wxEventType wxEVT_NULL; -/** - Initializes a new event type using wxNewEventType(). - - @deprecated Use wxDEFINE_EVENT() instead -*/ -#define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType(); - /** Generates a new unique event type. @@ -3537,6 +4017,14 @@ wxEventType wxNewEventType(); The class @a cls must be the wxEvent-derived class associated with the events of this type and its full declaration must be visible from the point of use of this macro. + + For example: + @code + wxDECLARE_EVENT(MY_COMMAND_EVENT, wxCommandEvent); + + class MyCustomEvent : public wxEvent { ... }; + wxDECLARE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent); + @endcode */ #define wxDECLARE_EVENT(name, cls) \ wxDECLARE_EXPORTED_EVENT(wxEMPTY_PARAMETER_VALUE, name, cls) @@ -3569,9 +4057,8 @@ wxEventType wxNewEventType(); */ #define wxEVENT_HANDLER_CAST(functype, func) (&func) -//@{ /** - These macros are used to define event table macros for handling custom + This macro is used to define event table macros for handling custom events. Example of use: @@ -3590,62 +4077,71 @@ wxEventType wxNewEventType(); ... - BEGIN_EVENT_TABLE(MyFrame, wxFrame) + wxBEGIN_EVENT_TABLE(MyFrame, wxFrame) EVT_MY(wxID_ANY, MyFrame::OnMyEvent) - END_EVENT_TABLE() + wxEND_EVENT_TABLE() @endcode @param evt The event type to handle. @param id The identifier of events to handle. - @param id1 - The first identifier of the range. - @param id2 - The second identifier of the range. @param fn The event handler method. */ -#define wx__DECLARE_EVT2(evt, id1, id2, fn) \ - DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL), #define wx__DECLARE_EVT1(evt, id, fn) \ wx__DECLARE_EVT2(evt, id, wxID_ANY, fn) + +/** + Generalized version of the wx__DECLARE_EVT1() macro taking a range of + IDs instead of a single one. + Argument @a id1 is the first identifier of the range, @a id2 is the + second identifier of the range. +*/ +#define wx__DECLARE_EVT2(evt, id1, id2, fn) \ + DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL), + +/** + Simplified version of the wx__DECLARE_EVT1() macro, to be used when the + event type must be handled regardless of the ID associated with the + specific event instances. +*/ #define wx__DECLARE_EVT0(evt, fn) \ wx__DECLARE_EVT1(evt, wxID_ANY, fn) -//@} - /** Use this macro inside a class declaration to declare a @e static event table for that class. - In the implementation file you'll need to use the BEGIN_EVENT_TABLE() - and the END_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro + In the implementation file you'll need to use the wxBEGIN_EVENT_TABLE() + and the wxEND_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro to capture events. + + Note that this macro requires a final semicolon. @see @ref overview_events_eventtables */ -#define DECLARE_EVENT_TABLE() +#define wxDECLARE_EVENT_TABLE() /** Use this macro in a source file to start listing @e static event handlers for a specific class. - Use END_EVENT_TABLE() to terminate the event-declaration block. + Use wxEND_EVENT_TABLE() to terminate the event-declaration block. @see @ref overview_events_eventtables */ -#define BEGIN_EVENT_TABLE(theClass, baseClass) +#define wxBEGIN_EVENT_TABLE(theClass, baseClass) /** Use this macro in a source file to end listing @e static event handlers for a specific class. - Use BEGIN_EVENT_TABLE() to start the event-declaration block. + Use wxBEGIN_EVENT_TABLE() to start the event-declaration block. @see @ref overview_events_eventtables */ -#define END_EVENT_TABLE() +#define wxEND_EVENT_TABLE() /** In a GUI application, this function posts @a event to the specified @e dest