// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
+/**
+ The predefined constants for the number of times we propagate event
+ upwards window child-parent chain.
+*/
+enum wxEventPropagation
+{
+ /// don't propagate it at all
+ wxEVENT_PROPAGATE_NONE = 0,
+
+ /// propagate it until it is processed
+ wxEVENT_PROPAGATE_MAX = INT_MAX
+};
+
+/**
+ The different categories for a wxEvent; see wxEvent::GetEventCategory.
+
+ @note They are used as OR-combinable flags by wxEventLoopBase::YieldFor.
+*/
+enum wxEventCategory
+{
+ /**
+ This is the category for those events which are generated to update
+ the appearance of the GUI but which (usually) do not comport data
+ processing, i.e. which do not provide input or output data
+ (e.g. size events, scroll events, etc).
+ They are events NOT directly generated by the user's input devices.
+ */
+ wxEVT_CATEGORY_UI = 1,
+
+ /**
+ This category groups those events which are generated directly from the
+ user through input devices like mouse and keyboard and usually result in
+ data to be processed from the application
+ (e.g. mouse clicks, key presses, etc).
+ */
+ wxEVT_CATEGORY_USER_INPUT = 2,
+
+ /// This category is for wxSocketEvent
+ wxEVT_CATEGORY_SOCKET = 4,
+
+ /// This category is for wxTimerEvent
+ wxEVT_CATEGORY_TIMER = 8,
+
+ /**
+ 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,
+
+ /**
+ This mask is used in wxEventLoopBase::YieldFor to specify that all event
+ categories should be processed.
+ */
+ wxEVT_CATEGORY_ALL =
+ wxEVT_CATEGORY_UI|wxEVT_CATEGORY_USER_INPUT|wxEVT_CATEGORY_SOCKET| \
+ wxEVT_CATEGORY_TIMER|wxEVT_CATEGORY_THREAD
+};
/**
@class wxEvent
wxEvent used to be a multipurpose event object, and is an abstract base class
for other event classes (see below).
- For more information about events, see the @ref overview_eventhandling overview.
+ For more information about events, see the @ref overview_events overview.
@beginWxPerlOnly
In wxPerl custom event classes should be derived from
Returns a copy of the event.
Any event that is posted to the wxWidgets event system for later action
- (via wxEvtHandler::AddPendingEvent or wxPostEvent()) must implement
- this method.
+ (via wxEvtHandler::AddPendingEvent, wxEvtHandler::QueueEvent or wxPostEvent())
+ must implement this method.
All wxWidgets events fully implement this method, but any derived events
implemented by the user should also implement this method just in case they
*/
wxEventType GetEventType() const;
+ /**
+ 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.
+ */
+ virtual wxEventCategory GetEventCategory() const;
+
/**
Returns the identifier associated with this event, such as a button command id.
*/
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling, wxEvtHandler
+ @see @ref overview_events_processing, wxEvtHandler
*/
class wxEventBlocker : public wxEvtHandler
{
wxWindow is (and therefore all window classes are) derived from this class.
When events are received, wxEvtHandler invokes the method listed in the
- event table using itself as the object. When using multiple inheritance
+ event table using itself as the object. When using multiple inheritance
<b>it is imperative that the wxEvtHandler(-derived) class is the first
class inherited</b> such that the @c this pointer for the overall object
will be identical to the @c this pointer of the wxEvtHandler portion.
@library{wxbase}
@category{events}
- @see @ref overview_eventhandling
+ @see @ref overview_events_processing, wxEventBlocker, wxEventLoopBase
*/
-class wxEvtHandler : public wxObject
+class wxEvtHandler : public wxObject, public wxTrackable
{
public:
/**
/**
Destructor.
- If the handler is part of a chain, the destructor will unlink itself and
- restore the previous and next handlers so that they point to each other.
+ If the handler is part of a chain, the destructor will unlink itself
+ (see Unlink()).
*/
virtual ~wxEvtHandler();
+
+ /**
+ @name Event queuing and processing
+ */
+ //@{
+
/**
Queue event for a later processing.
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)
{
}
@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.
virtual void AddPendingEvent(const wxEvent& event);
/**
- Connects the given function dynamically with the event handler, id and event type.
- This is an alternative to the use of static event tables.
+ Processes an event, searching event tables and calling zero or more suitable
+ event handler function(s).
+
+ Normally, your application would not call this function: it is called in the
+ wxWidgets implementation to dispatch incoming user interface events to the
+ framework (and application).
+
+ However, you might need to call it if implementing new functionality
+ (such as a new control) where you define new event types, as opposed to
+ allowing the user to override virtual functions.
+
+ 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.
+ -# If the object is disabled (via a call to wxEvtHandler::SetEvtHandlerEnabled)
+ the function skips to step (7).
+ -# TryBefore() is called (this is where wxValidator are taken into
+ account for wxWindow objects). If this returns @true, the function exits.
+ -# Dynamic event table of the handlers binded 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 binded 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
+ (referring to the image, if @c A->ProcessEvent is called and it doesn't handle
+ the event, @c B->ProcessEvent will be called and so on...).
+ 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.
+ -# 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 ProcessEventHere() 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.
+
+ @see SearchEventTable()
+ */
+ virtual bool ProcessEvent(wxEvent& event);
+
+ /**
+ Try to process the event in this event handler.
+
+ This method is called from ProcessEvent(), please see the detailed
+ description of the event processing logic there.
+
+ It is @em not virtual and so may not be overridden but it does call
+ virtual TryBefore() which may be overridden.
+
+ @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 ProcessEventHere(wxEvent& event);
+
+ /**
+ Processes an event by calling ProcessEvent() and handles any exceptions
+ that occur in the process.
+ If an exception is thrown in event handler, wxApp::OnExceptionInMainLoop is called.
- See the @ref page_samples_event sample for usage.
+ @param event
+ Event to process.
+
+ @return @true if the event was processed, @false if no handler was found
+ or an exception was thrown.
+
+ @see wxWindow::HandleWindowEvent
+ */
+ 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.
+
+ @param table
+ Event table to be searched.
+ @param event
+ Event to be matched against an event table entry.
+
+ @return @true if a suitable event handler function was found and
+ executed, and the function did not call wxEvent::Skip.
+
+ @remarks This function looks through the object's event table and tries
+ to find an entry that will match the event.
+ An entry will match if:
+ @li The event type matches, and
+ @li the identifier or identifier range matches, or the event table
+ entry's identifier is zero.
+
+ 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,
+ wxEvent& event);
+
+ //@}
+
+
+ /**
+ @name Connecting and disconnecting
+ */
+ //@{
+
+ /**
+ 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
+ is impossible to do directly with the event tables -- the events can be
+ only handled in another object if they are propagated upwards to it).
+ Do make sure to specify the correct @a eventSink when connecting to an
+ event of a different object.
+
+ See @ref overview_events_bind for more detailed explanation
+ of this function and the @ref page_samples_event sample for usage
+ examples.
This specific overload allows you to connect an event handler to a @e range
of @e source IDs.
@param userData
Data to be associated with the event table entry.
@param eventSink
- Object whose member function should be called.
- If this is @NULL, @c *this will be used.
+ 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.
+
+ @see Bind<>()
*/
void Connect(int id, int lastId, wxEventType eventType,
wxObjectEventFunction function,
wxObjectEventFunction function = NULL,
wxObject* userData = NULL,
wxEvtHandler* eventSink = NULL);
+ //@}
- /**
- Returns user-supplied client data.
-
- @remarks Normally, any extra data the programmer wishes to associate with
- the object should be made available by deriving a new class with
- new data members.
-
- @see SetClientData()
- */
- void* GetClientData() const;
/**
- Returns a pointer to the user-supplied client data object.
-
- @see SetClientObject(), wxClientData
+ @name Binding and Unbinding
*/
- wxClientData* GetClientObject() const;
+ //@{
/**
- Returns @true if the event handler is enabled, @false otherwise.
+ Binds the given function, functor or method dynamically with the event.
- @see SetEvtHandlerEnabled()
- */
- bool GetEvtHandlerEnabled() const;
+ 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.
- /**
- Returns the pointer to the next handler in the chain.
+ See @ref overview_events_bind for more detailed explanation
+ of this function and the @ref page_samples_event sample for usage
+ examples.
- @see SetNextHandler(), GetPreviousHandler(), SetPreviousHandler(),
- wxWindow::PushEventHandler, wxWindow::PopEventHandler
- */
- wxEvtHandler* GetNextHandler() const;
-
- /**
- Returns the pointer to the previous handler in the chain.
+ @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 SetPreviousHandler(), GetNextHandler(), SetNextHandler(),
- wxWindow::PushEventHandler, wxWindow::PopEventHandler
+ @since 2.9.0
*/
- wxEvtHandler* GetPreviousHandler() const;
+ template <typename EventTag, typename Functor>
+ void Bind(const EventTag& eventType,
+ Functor functor,
+ int id = wxID_ANY,
+ int lastId = wxID_ANY,
+ wxObject *userData = NULL);
/**
- Processes an event, searching event tables and calling zero or more suitable
- event handler function(s).
+ See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for
+ more info.
- Normally, your application would not call this function: it is called in the
- wxWidgets implementation to dispatch incoming user interface events to the
- framework (and application).
+ This overload will bind the given method as the event handler.
- However, you might need to call it if implementing new functionality
- (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.
+ @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.
- The normal order of event table searching is as follows:
- -# 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 search is applied down the entire chain of event handlers (usually the
- chain has a length of one). If this succeeds, 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.
+ @since 2.9.0
+ */
+ template <typename EventTag, typename Class, typename EventArg, typename EventHandler>
+ 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.
- @param event
- Event to process.
+ This method can only unbind functions, functors or methods which have
+ been added using the Bind<>() method. There is no way to unbind
+ functions binded using the (static) event tables.
- @return @true if a suitable event handler function was found and
- executed, and the function did not call wxEvent::Skip.
+ @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 SearchEventTable()
+ @since 2.9.0
*/
- virtual bool ProcessEvent(wxEvent& event);
+ template <typename EventTag, typename Functor>
+ bool Unbind(const EventTag& eventType,
+ Functor functor,
+ int id = wxID_ANY,
+ int lastId = wxID_ANY,
+ wxObject *userData = NULL);
/**
- Processes an event by calling ProcessEvent() and handles any exceptions
- that occur in the process.
- If an exception is thrown in event handler, wxApp::OnExceptionInMainLoop is called.
+ See the Unbind<>(const EventTag&, Functor, int, int, wxObject*)
+ overload for more info.
- @param event
- Event to process.
+ This overload unbinds the given method from the event..
- @return @true if the event was processed, @false if no handler was found
- or an exception was thrown.
+ @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 wxWindow::HandleWindowEvent
+ @since 2.9.0
*/
- bool SafelyProcessEvent(wxEvent& event);
-
+ template <typename EventTag, typename Class, typename EventArg, typename EventHandler>
+ bool Unbind(const EventTag &eventType,
+ void (Class::*method)(EventArg&),
+ EventHandler *handler,
+ int id = wxID_ANY,
+ int lastId = wxID_ANY,
+ wxObject *userData = NULL );
+ //@}
/**
- Searches the event table, executing an event handler function if an appropriate
- one is found.
+ @name User-supplied data
+ */
+ //@{
- @param table
- Event table to be searched.
- @param event
- Event to be matched against an event table entry.
+ /**
+ Returns user-supplied client data.
- @return @true if a suitable event handler function was found and
- executed, and the function did not call wxEvent::Skip.
+ @remarks Normally, any extra data the programmer wishes to associate with
+ the object should be made available by deriving a new class with
+ new data members.
- @remarks This function looks through the object's event table and tries
- to find an entry that will match the event.
- An entry will match if:
- @li The event type matches, and
- @li the identifier or identifier range matches, or the event table
- entry's identifier is zero.
+ @see SetClientData()
+ */
+ void* GetClientData() const;
- If a suitable function is called but calls wxEvent::Skip, this
- function will fail, and searching will continue.
+ /**
+ Returns a pointer to the user-supplied client data object.
- @see ProcessEvent()
+ @see SetClientObject(), wxClientData
*/
- virtual bool SearchEventTable(wxEventTable& table,
- wxEvent& event);
+ wxClientData* GetClientObject() const;
/**
Sets user-supplied client data.
*/
void SetClientObject(wxClientData* data);
+ //@}
+
+
+ /**
+ @name Event handler chaining
+
+ wxEvtHandler can be arranged in a double-linked list of handlers
+ which is automatically iterated by ProcessEvent() if needed.
+ */
+ //@{
+
+ /**
+ Returns @true if the event handler is enabled, @false otherwise.
+
+ @see SetEvtHandlerEnabled()
+ */
+ bool GetEvtHandlerEnabled() const;
+
+ /**
+ Returns the pointer to the next handler in the chain.
+
+ @see SetNextHandler(), GetPreviousHandler(), SetPreviousHandler(),
+ wxWindow::PushEventHandler, wxWindow::PopEventHandler
+ */
+ wxEvtHandler* GetNextHandler() const;
+
+ /**
+ Returns the pointer to the previous handler in the chain.
+
+ @see SetPreviousHandler(), GetNextHandler(), SetNextHandler(),
+ wxWindow::PushEventHandler, wxWindow::PopEventHandler
+ */
+ wxEvtHandler* GetPreviousHandler() const;
+
/**
Enables or disables the event handler.
/**
Sets the pointer to the next handler.
+ @remarks
+ See ProcessEvent() for more info about how the chains of event handlers
+ are internally used.
+ Also remember that wxEvtHandler uses double-linked lists and thus if you
+ use this function, you should also call SetPreviousHandler() on the
+ argument passed to this function:
+ @code
+ handlerA->SetNextHandler(handlerB);
+ handlerB->SetPreviousHandler(handlerA);
+ @endcode
+
@param handler
- Event handler to be set as the next handler.
+ The event handler to be set as the next handler.
+ Cannot be @NULL.
- @see GetNextHandler(), SetPreviousHandler(), GetPreviousHandler(),
- wxWindow::PushEventHandler, wxWindow::PopEventHandler
+ @see @ref overview_events_processing
*/
- void SetNextHandler(wxEvtHandler* handler);
+ virtual void SetNextHandler(wxEvtHandler* handler);
/**
Sets the pointer to the previous handler.
+ All remarks about SetNextHandler() apply to this function as well.
@param handler
- Event handler to be set as the previous handler.
+ The event handler to be set as the previous handler.
+ Cannot be @NULL.
+
+ @see @ref overview_events_processing
+ */
+ virtual void SetPreviousHandler(wxEvtHandler* handler);
+
+ /**
+ Unlinks this event handler from the chain it's part of (if any);
+ then links the "previous" event handler to the "next" one
+ (so that the chain won't be interrupted).
+
+ E.g. if before calling Unlink() you have the following chain:
+ @image html evthandler_unlink_before.png
+ then after calling @c B->Unlink() you'll have:
+ @image html evthandler_unlink_after.png
+
+ @since 2.9.0
+ */
+ void Unlink();
+
+ /**
+ Returns @true if the next and the previous handler pointers of this
+ event handler instance are @NULL.
+
+ @since 2.9.0
+
+ @see SetPreviousHandler(), SetNextHandler()
*/
- void SetPreviousHandler(wxEvtHandler* handler);
+ 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(), ProcessEventHere()
+ */
+ virtual bool TryBefore(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(), ProcessEventHere()
+ */
+ 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
};
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 @ref page_keycodes.
+ 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.
@beginEventTable{wxKeyEvent}
@event{EVT_KEY_DOWN(func)}
- Process a wxEVT_KEY_DOWN event (any key has been pressed).
+ Process a @c wxEVT_KEY_DOWN event (any key has been pressed).
@event{EVT_KEY_UP(func)}
- Process a wxEVT_KEY_UP event (any key has been released).
+ Process a @c wxEVT_KEY_UP event (any key has been released).
@event{EVT_CHAR(func)}
- Process a wxEVT_CHAR event.
+ Process a @c wxEVT_CHAR event.
@endEventTable
@see wxKeyboardState
/**
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 @ref page_keycodes for a full list of the virtual key codes.
+ key. 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
*/
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.
events received by windows.
@beginEventTable{wxJoystickEvent}
- @style{EVT_JOY_BUTTON_DOWN(func)}
- Process a wxEVT_JOY_BUTTON_DOWN event.
- @style{EVT_JOY_BUTTON_UP(func)}
- Process a wxEVT_JOY_BUTTON_UP event.
- @style{EVT_JOY_MOVE(func)}
- Process a wxEVT_JOY_MOVE event.
- @style{EVT_JOY_ZMOVE(func)}
- Process a wxEVT_JOY_ZMOVE event.
- @style{EVT_JOYSTICK_EVENTS(func)}
+ @event{EVT_JOY_BUTTON_DOWN(func)}
+ Process a @c wxEVT_JOY_BUTTON_DOWN event.
+ @event{EVT_JOY_BUTTON_UP(func)}
+ Process a @c wxEVT_JOY_BUTTON_UP event.
+ @event{EVT_JOY_MOVE(func)}
+ Process a @c wxEVT_JOY_MOVE event.
+ @event{EVT_JOY_ZMOVE(func)}
+ Process a @c wxEVT_JOY_ZMOVE event.
+ @event{EVT_JOYSTICK_EVENTS(func)}
Processes all joystick events.
@endEventTable
A scroll event holds information about events sent from scrolling windows.
+ Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events
+ from the receiving window.
@beginEventTable{wxScrollWinEvent}
- You can use the EVT_SCROLLWIN* macros for intercepting scroll window events
- from the receiving window.
@event{EVT_SCROLLWIN(func)}
Process all scroll events.
@event{EVT_SCROLLWIN_TOP(func)}
@library{wxcore}
@category{events}
- @see wxScrollEvent, @ref overview_eventhandling
+ @see wxScrollEvent, @ref overview_events
*/
class wxScrollWinEvent : public wxEvent
{
@beginEventTable{wxSysColourChangedEvent}
@event{EVT_SYS_COLOUR_CHANGED(func)}
- Process a wxEVT_SYS_COLOUR_CHANGED event.
+ Process a @c wxEVT_SYS_COLOUR_CHANGED event.
@endEventTable
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling
+ @see @ref overview_events
*/
class wxSysColourChangedEvent : public wxEvent
{
@beginEventTable{wxWindowCreateEvent}
@event{EVT_WINDOW_CREATE(func)}
- Process a wxEVT_CREATE event.
+ Process a @c wxEVT_CREATE event.
@endEventTable
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling, wxWindowDestroyEvent
+ @see @ref overview_events, wxWindowDestroyEvent
*/
class wxWindowCreateEvent : public wxCommandEvent
{
Constructor.
*/
wxWindowCreateEvent(wxWindow* win = NULL);
+
+ /// Retutn the window being created.
+ wxWindow *GetWindow() const;
};
@beginEventTable{wxPaintEvent}
@event{EVT_PAINT(func)}
- Process a wxEVT_PAINT event.
+ Process a @c wxEVT_PAINT event.
@endEventTable
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling
+ @see @ref overview_events
*/
class wxPaintEvent : public wxEvent
{
@beginEventTable{wxMaximizeEvent}
@event{EVT_MAXIMIZE(func)}
- Process a wxEVT_MAXIMIZE event.
+ Process a @c wxEVT_MAXIMIZE event.
@endEventTable
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling, wxTopLevelWindow::Maximize,
+ @see @ref overview_events, wxTopLevelWindow::Maximize,
wxTopLevelWindow::IsMaximized
*/
class wxMaximizeEvent : public wxEvent
@beginEventTable{wxUpdateUIEvent}
@event{EVT_UPDATE_UI(id, func)}
- Process a wxEVT_UPDATE_UI event for the command with the given id.
+ Process a @c wxEVT_UPDATE_UI event for the command with the given id.
@event{EVT_UPDATE_UI_RANGE(id1, id2, func)}
- Process a wxEVT_UPDATE_UI event for any command with id included in the given range.
+ Process a @c wxEVT_UPDATE_UI event for any command with id included in the given range.
@endEventTable
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling
+ @see @ref overview_events
*/
class wxUpdateUIEvent : public wxCommandEvent
{
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}
@event{EVT_LEFT_DOWN(func)}
- Process a wxEVT_LEFT_DOWN event. The handler of this event should normally
+ Process a @c wxEVT_LEFT_DOWN event. The handler of this event should normally
call event.Skip() to allow the default processing to take place as otherwise
the window under mouse wouldn't get the focus.
@event{EVT_LEFT_UP(func)}
- Process a wxEVT_LEFT_UP event.
+ Process a @c wxEVT_LEFT_UP event.
@event{EVT_LEFT_DCLICK(func)}
- Process a wxEVT_LEFT_DCLICK event.
+ Process a @c wxEVT_LEFT_DCLICK event.
@event{EVT_MIDDLE_DOWN(func)}
- Process a wxEVT_MIDDLE_DOWN event.
+ Process a @c wxEVT_MIDDLE_DOWN event.
@event{EVT_MIDDLE_UP(func)}
- Process a wxEVT_MIDDLE_UP event.
+ Process a @c wxEVT_MIDDLE_UP event.
@event{EVT_MIDDLE_DCLICK(func)}
- Process a wxEVT_MIDDLE_DCLICK event.
+ Process a @c wxEVT_MIDDLE_DCLICK event.
@event{EVT_RIGHT_DOWN(func)}
- Process a wxEVT_RIGHT_DOWN event.
+ Process a @c wxEVT_RIGHT_DOWN event.
@event{EVT_RIGHT_UP(func)}
- Process a wxEVT_RIGHT_UP event.
+ Process a @c wxEVT_RIGHT_UP event.
@event{EVT_RIGHT_DCLICK(func)}
- Process a wxEVT_RIGHT_DCLICK event.
+ Process a @c wxEVT_RIGHT_DCLICK event.
@event{EVT_MOUSE_AUX1_DOWN(func)}
- Process a wxEVT_MOUSE_AUX1_DOWN event.
+ Process a @c wxEVT_MOUSE_AUX1_DOWN event.
@event{EVT_MOUSE_AUX1_UP(func)}
- Process a wxEVT_MOUSE_AUX1_UP event.
+ Process a @c wxEVT_MOUSE_AUX1_UP event.
@event{EVT_MOUSE_AUX1_DCLICK(func)}
- Process a wxEVT_MOUSE_AUX1_DCLICK event.
+ Process a @c wxEVT_MOUSE_AUX1_DCLICK event.
@event{EVT_MOUSE_AUX2_DOWN(func)}
- Process a wxEVT_MOUSE_AUX2_DOWN event.
+ Process a @c wxEVT_MOUSE_AUX2_DOWN event.
@event{EVT_MOUSE_AUX2_UP(func)}
- Process a wxEVT_MOUSE_AUX2_UP event.
+ Process a @c wxEVT_MOUSE_AUX2_UP event.
@event{EVT_MOUSE_AUX2_DCLICK(func)}
- Process a wxEVT_MOUSE_AUX2_DCLICK event.
+ Process a @c wxEVT_MOUSE_AUX2_DCLICK event.
@event{EVT_MOTION(func)}
- Process a wxEVT_MOTION event.
+ Process a @c wxEVT_MOTION event.
@event{EVT_ENTER_WINDOW(func)}
- Process a wxEVT_ENTER_WINDOW event.
+ Process a @c wxEVT_ENTER_WINDOW event.
@event{EVT_LEAVE_WINDOW(func)}
- Process a wxEVT_LEAVE_WINDOW event.
+ Process a @c wxEVT_LEAVE_WINDOW event.
@event{EVT_MOUSEWHEEL(func)}
- Process a wxEVT_MOUSEWHEEL event.
+ Process a @c wxEVT_MOUSEWHEEL event.
@event{EVT_MOUSE_EVENTS(func)}
Process all mouse events.
@endEventTable
*/
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.
*/
*/
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).
*/
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.
*/
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()).
*/
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.
*/
*/
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.
*/
*/
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.
*/
@beginEventTable{wxDropFilesEvent}
@event{EVT_DROP_FILES(func)}
- Process a wxEVT_DROP_FILES event.
+ Process a @c wxEVT_DROP_FILES event.
@endEventTable
@onlyfor{wxmsw}
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling
+ @see @ref overview_events
*/
class wxDropFilesEvent : public wxEvent
{
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}
Process a @c wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.
@event{EVT_LISTBOX_DCLICK(id, func)}
Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.
+ @event{EVT_CHECKLISTBOX(id, func)}
+ Process a @c wxEVT_COMMAND_CHECKLISTBOX_TOGGLED command, which is generated by a wxCheckListBox control.
@event{EVT_MENU(id, func)}
Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
@event{EVT_MENU_RANGE(id1, id2, func)}
@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)}
@beginEventTable{wxActivateEvent}
@event{EVT_ACTIVATE(func)}
- Process a wxEVT_ACTIVATE event.
+ Process a @c wxEVT_ACTIVATE event.
@event{EVT_ACTIVATE_APP(func)}
- Process a wxEVT_ACTIVATE_APP event.
+ Process a @c wxEVT_ACTIVATE_APP event.
+ This event is received by the wxApp-derived instance only.
@event{EVT_HIBERNATE(func)}
Process a hibernate event, supplying the member function. This event applies
to wxApp only, and only on Windows SmartPhone and PocketPC.
a wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP event.
@endEventTable
-
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling, wxApp::IsActive
+ @see @ref overview_events, wxApp::IsActive
*/
class wxActivateEvent : public wxEvent
{
@class wxContextMenuEvent
This class is used for context menu events, sent to give
- the application a chance to show a context (popup) menu.
+ the application a chance to show a context (popup) menu for a wxWindow.
Note that if wxContextMenuEvent::GetPosition returns wxDefaultPosition, this
means that the event originated from a keyboard context button event, and you
@library{wxcore}
@category{events}
- @see wxCommandEvent, @ref overview_eventhandling
+ @see wxCommandEvent, @ref overview_events
*/
class wxContextMenuEvent : public wxCommandEvent
{
@beginEventTable{wxEraseEvent}
@event{EVT_ERASE_BACKGROUND(func)}
- Process a wxEVT_ERASE_BACKGROUND event.
+ Process a @c wxEVT_ERASE_BACKGROUND event.
@endEventTable
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling
+ @see @ref overview_events
*/
class wxEraseEvent : public wxEvent
{
@beginEventTable{wxFocusEvent}
@event{EVT_SET_FOCUS(func)}
- Process a wxEVT_SET_FOCUS event.
+ Process a @c wxEVT_SET_FOCUS event.
@event{EVT_KILL_FOCUS(func)}
- Process a wxEVT_KILL_FOCUS event.
+ Process a @c wxEVT_KILL_FOCUS event.
@endEventTable
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling
+ @see @ref overview_events
*/
class wxFocusEvent : public wxEvent
{
@beginEventTable{wxChildFocusEvent}
@event{EVT_CHILD_FOCUS(func)}
- Process a wxEVT_CHILD_FOCUS event.
+ Process a @c wxEVT_CHILD_FOCUS event.
@endEventTable
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling
+ @see @ref overview_events
*/
class wxChildFocusEvent : public wxCommandEvent
{
@beginEventTable{wxMouseCaptureLostEvent}
@event{EVT_MOUSE_CAPTURE_LOST(func)}
- Process a wxEVT_MOUSE_CAPTURE_LOST event.
+ Process a @c wxEVT_MOUSE_CAPTURE_LOST event.
@endEventTable
@onlyfor{wxmsw}
@library{wxcore}
@category{events}
- @see wxMouseCaptureChangedEvent, @ref overview_eventhandling,
- wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
+ @see wxMouseCaptureChangedEvent, @ref overview_events,
+ wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
*/
class wxMouseCaptureLostEvent : public wxEvent
{
};
+/**
+ @class wxThreadEvent
+
+ 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,threading}
-enum wxHelpEventOrigin
+ @see @ref overview_thread, wxEventLoopBase::YieldFor
+*/
+class wxThreadEvent : public wxCommandEvent
{
- wxHE_ORIGIN_UNKNOWN = -1,
- wxHE_ORIGIN_KEYBOARD,
+public:
+ /**
+ Constructor.
+ */
+ wxThreadEvent(wxEventType eventType = wxEVT_COMMAND_THREAD, int id = wxID_ANY);
+
+ /**
+ Clones this event making sure that all internal members which use
+ COW (only @c m_commandString for now; see @ref overview_refcount)
+ are unshared (see wxObject::UnShare).
+ */
+ virtual wxEvent *Clone() const;
+
+ /**
+ Returns @c wxEVT_CATEGORY_THREAD.
- /** event generated by wxContextHelp or from the [?] button on
- the title bar (Windows). */
- wxHE_ORIGIN_HELPBUTTON
+ This is important to avoid unwanted processing of thread events
+ when calling wxEventLoopBase::YieldFor().
+ */
+ virtual wxEventCategory GetEventCategory() const;
};
+
/**
@class wxHelpEvent
@beginEventTable{wxHelpEvent}
@event{EVT_HELP(id, func)}
- Process a wxEVT_HELP event.
+ Process a @c wxEVT_HELP event.
@event{EVT_HELP_RANGE(id1, id2, func)}
- Process a wxEVT_HELP event for a range of ids.
+ Process a @c wxEVT_HELP event for a range of ids.
@endEventTable
@library{wxcore}
@category{events}
- @see wxContextHelp, wxDialog, @ref overview_eventhandling
+ @see wxContextHelp, wxDialog, @ref overview_events
*/
class wxHelpEvent : public wxCommandEvent
{
@library{wxcore}
@category{events}
- @see wxScrollBar, wxSlider, wxSpinButton, wxScrollWinEvent, @ref overview_eventhandling
+ @see wxScrollBar, wxSlider, wxSpinButton, wxScrollWinEvent, @ref overview_events
*/
class wxScrollEvent : public wxCommandEvent
{
@beginEventTable{wxIdleEvent}
@event{EVT_IDLE(func)}
- Process a wxEVT_IDLE event.
+ Process a @c wxEVT_IDLE event.
@endEventTable
@library{wxbase}
@category{events}
- @see @ref overview_eventhandling, wxUpdateUIEvent, wxWindow::OnInternalIdle
+ @see @ref overview_events, wxUpdateUIEvent, wxWindow::OnInternalIdle
*/
class wxIdleEvent : public wxEvent
{
@beginEventTable{wxInitDialogEvent}
@event{EVT_INIT_DIALOG(func)}
- Process a wxEVT_INIT_DIALOG event.
+ Process a @c wxEVT_INIT_DIALOG event.
@endEventTable
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling
+ @see @ref overview_events
*/
class wxInitDialogEvent : public wxEvent
{
/**
@class wxWindowDestroyEvent
- This event is sent from the wxWindow destructor wxWindow::~wxWindow() when a
- window is destroyed.
+ This event is sent as early as possible during the window destruction
+ process.
+
+ For the top level windows, as early as possible means that this is done by
+ wxFrame or wxDialog destructor, i.e. after the destructor of the derived
+ class was executed and so any methods specific to the derived class can't
+ be called any more from this event handler. If you need to do this, you
+ must call wxWindow::SendDestroyEvent() from your derived class destructor.
- When a class derived from wxWindow is destroyed its destructor will have
- already run by the time this event is sent. Therefore this event will not
- usually be received at all.
+ For the child windows, this event is generated just before deleting the
+ window from wxWindow::Destroy() (which is also called when the parent
+ window is deleted) or from the window destructor if operator @c delete was
+ used directly (which is not recommended for this very reason).
- To receive this event wxEvtHandler::Connect() must be used (using an event
- table macro will not work). Since it is received after the destructor has run,
- an object should not handle its own wxWindowDestroyEvent, but it can be used
- to get notification of the destruction of another window.
+ It is usually pointless to handle this event in the window itself but it ca
+ be very useful to receive notifications about the window destruction in the
+ parent window or in any other object interested in this window.
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling, wxWindowCreateEvent
+ @see @ref overview_events, wxWindowCreateEvent
*/
class wxWindowDestroyEvent : public wxCommandEvent
{
Constructor.
*/
wxWindowDestroyEvent(wxWindow* win = NULL);
-};
-
-/**
- The possible flag values for a wxNavigationKeyEvent.
-*/
-enum wxNavigationKeyEventFlags
-{
- wxNKEF_IS_BACKWARD = 0x0000,
- wxNKEF_IS_FORWARD = 0x0001,
- wxNKEF_WINCHANGE = 0x0002,
- wxNKEF_FROMTAB = 0x0004
+ /// Retutn the window being destroyed.
+ wxWindow *GetWindow() const;
};
class wxNavigationKeyEvent : public wxEvent
{
public:
+ /**
+ Flags which can be used with wxNavigationKeyEvent.
+ */
+ enum wxNavigationKeyEventFlags
+ {
+ IsBackward = 0x0000,
+ IsForward = 0x0001,
+ WinChange = 0x0002,
+ FromTab = 0x0004
+ };
+
wxNavigationKeyEvent();
wxNavigationKeyEvent(const wxNavigationKeyEvent& event);
@class wxMouseCaptureChangedEvent
An mouse capture changed event is sent to a window that loses its
- mouse capture. This is called even if wxWindow::ReleaseCapture
+ mouse capture. This is called even if wxWindow::ReleaseMouse
was called by the application code. Handling this event allows
an application to cater for unexpected capture releases which
might otherwise confuse mouse handling code.
@beginEventTable{wxMouseCaptureChangedEvent}
@event{EVT_MOUSE_CAPTURE_CHANGED(func)}
- Process a wxEVT_MOUSE_CAPTURE_CHANGED event.
+ Process a @c wxEVT_MOUSE_CAPTURE_CHANGED event.
@endEventTable
@library{wxcore}
@category{events}
- @see wxMouseCaptureLostEvent, @ref overview_eventhandling,
- wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
+ @see wxMouseCaptureLostEvent, @ref overview_events,
+ wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
*/
class wxMouseCaptureChangedEvent : public wxEvent
{
@library{wxcore}
@category{events}
- @see wxCommandEvent, @ref overview_eventhandling
+ @see wxCommandEvent, @ref overview_events
*/
class wxMenuEvent : public wxEvent
{
@beginEventTable{wxShowEvent}
@event{EVT_SHOW(func)}
- Process a wxEVT_SHOW event.
+ Process a @c wxEVT_SHOW event.
@endEventTable
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling, wxWindow::Show,
+ @see @ref overview_events, wxWindow::Show,
wxWindow::IsShown
*/
@beginEventTable{wxIconizeEvent}
@event{EVT_ICONIZE(func)}
- Process a wxEVT_ICONIZE event.
+ Process a @c wxEVT_ICONIZE event.
@endEventTable
@library{wxcore}
@category{events}
- @see @ref overview_eventhandling, wxTopLevelWindow::Iconize,
+ @see @ref overview_events, wxTopLevelWindow::Iconize,
wxTopLevelWindow::IsIconized
*/
class wxIconizeEvent : public wxEvent
/**
@class wxMoveEvent
- A move event holds information about move change events.
+ A move event holds information about wxTopLevelWindow move change events.
@beginEventTable{wxMoveEvent}
@event{EVT_MOVE(func)}
- Process a wxEVT_MOVE event, which is generated when a window is moved.
+ Process a @c wxEVT_MOVE event, which is generated when a window is moved.
@event{EVT_MOVE_START(func)}
- Process a wxEVT_MOVE_START event, which is generated when the user starts
+ Process a @c wxEVT_MOVE_START event, which is generated when the user starts
to move or size a window. wxMSW only.
@event{EVT_MOVE_END(func)}
- Process a wxEVT_MOVE_END event, which is generated when the user stops
+ Process a @c wxEVT_MOVE_END event, which is generated when the user stops
moving or sizing a window. wxMSW only.
@endEventTable
@library{wxcore}
@category{events}
- @see wxPoint, @ref overview_eventhandling
+ @see wxPoint, @ref overview_events
*/
class wxMoveEvent : public wxEvent
{
/**
@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.
@beginEventTable{wxSizeEvent}
@event{EVT_SIZE(func)}
- Process a wxEVT_SIZE event.
+ Process a @c wxEVT_SIZE event.
@endEventTable
@library{wxcore}
@category{events}
- @see wxSize, @ref overview_eventhandling
+ @see wxSize, @ref overview_events
*/
class wxSizeEvent : public wxEvent
{
/**
@class wxSetCursorEvent
- A wxSetCursorEvent is generated when the mouse cursor is about to be set as a
- result of mouse motion.
+ A wxSetCursorEvent is generated from wxWindow when the mouse cursor is about
+ to be set as a result of mouse motion.
This event gives the application the chance to perform specific mouse cursor
processing based on the current position of the mouse within the window.
@beginEventTable{wxSetCursorEvent}
@event{EVT_SET_CURSOR(func)}
- Process a wxEVT_SET_CURSOR event.
+ Process a @c wxEVT_SET_CURSOR event.
@endEventTable
@library{wxcore}
// Global functions/macros
// ============================================================================
-/** @ingroup group_funcmacro_events */
+/** @addtogroup group_funcmacro_events */
//@{
/**
- Each wxEvent-derived class has an @e event-type associated.
+ A value uniquely identifying the type of the event.
+
+ The values of this type should only be created using wxNewEventType().
+
See the macro DEFINE_EVENT_TYPE() for more info.
- @see @ref overview_eventhandling_custom
+ @see @ref overview_events_introduction
*/
typedef int wxEventType;
+/**
+ A special event type usually used to indicate that some wxEvent has yet
+ no type assigned.
+*/
+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.
+
+ Usually this function is only used by wxDEFINE_EVENT() and not called
+ directly.
*/
wxEventType wxNewEventType();
+/**
+ Define a new event type associated with the specified event class.
+
+ This macro defines a new unique event type @a name associated with the
+ event class @a cls.
+
+ For example:
+ @code
+ wxDEFINE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
+
+ class MyCustomEvent : public wxEvent { ... };
+ wxDEFINE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
+ @endcode
+
+ @see wxDECLARE_EVENT(), @ref overview_events_custom
+ */
+#define wxDEFINE_EVENT(name, cls) \
+ const wxEventTypeTag< cls > name(wxNewEventType())
+
+/**
+ Declares a custom event type.
+
+ This macro declares a variable called @a name which must be defined
+ elsewhere using wxDEFINE_EVENT().
+
+ 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)
+
+/**
+ Variant of wxDECLARE_EVENT() used for event types defined inside a shared
+ library.
+
+ This is mostly used by wxWidgets internally, e.g.
+ @code
+ wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent)
+ @endcode
+ */
+#define wxDECLARE_EXPORTED_EVENT( expdecl, name, cls ) \
+ extern const expdecl wxEventTypeTag< cls > name;
+
+/**
+ Helper macro for definition of custom event table macros.
+
+ This macro must only be used if wxEVENTS_COMPATIBILITY_2_8 is 1, otherwise
+ it is better and more clear to just use the address of the function
+ directly as this is all this macro does in this case. However it needs to
+ explicitly cast @a func to @a functype, which is the type of wxEvtHandler
+ member function taking the custom event argument when
+ wxEVENTS_COMPATIBILITY_2_8 is 0.
+
+ See wx__DECLARE_EVT0 for an example of use.
+
+ @see @ref overview_events_custom_ownclass
+ */
+#define wxEVENT_HANDLER_CAST(functype, func) (&func)
+
+/**
+ This macro is used to define event table macros for handling custom
+ events.
+
+ Example of use:
+ @code
+ class MyEvent : public wxEvent { ... };
+
+ // note that this is not necessary unless using old compilers: for the
+ // reasonably new ones just use &func instead of MyEventHandler(func)
+ typedef void (wxEvtHandler::*MyEventFunction)(MyEvent&);
+ #define MyEventHandler(func) wxEVENT_HANDLER_CAST(MyEventFunction, func)
+
+ wxDEFINE_EVENT(MY_EVENT_TYPE, MyEvent);
+
+ #define EVT_MY(id, func) \
+ wx__DECLARE_EVT1(MY_EVENT_TYPE, id, MyEventHandler(func))
+
+ ...
+
+ BEGIN_EVENT_TABLE(MyFrame, wxFrame)
+ EVT_MY(wxID_ANY, MyFrame::OnMyEvent)
+ END_EVENT_TABLE()
+ @endcode
+
+ @param evt
+ The event type to handle.
+ @param id
+ The identifier of events to handle.
+ @param fn
+ The event handler method.
+ */
+#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.
and the END_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro
to capture events.
- @see @ref overview_eventhandling_eventtables
+ @see @ref overview_events_eventtables
*/
#define DECLARE_EVENT_TABLE()
Use END_EVENT_TABLE() to terminate the event-declaration block.
- @see @ref overview_eventhandling_eventtables
+ @see @ref overview_events_eventtables
*/
#define BEGIN_EVENT_TABLE(theClass, baseClass)
Use BEGIN_EVENT_TABLE() to start the event-declaration block.
- @see @ref overview_eventhandling_eventtables
+ @see @ref overview_events_eventtables
*/
#define END_EVENT_TABLE()
projects / wxWidgets.git / blobdiff