// wxEvent-derived classes
// Author: wxWidgets team
// RCS-ID: $Id$
-// Licence: wxWindows license
+// Licence: wxWindows licence
/////////////////////////////////////////////////////////////////////////////
+#if wxUSE_BASE
+
/**
The predefined constants for the number of times we propagate event
upwards window child-parent chain.
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,
The identifier of the object (window, timer, ...) which generated
this event.
@param eventType
- The unique type of event, e.g. wxEVT_PAINT, wxEVT_SIZE or
- wxEVT_COMMAND_BUTTON_CLICKED.
+ The unique type of event, e.g. @c wxEVT_PAINT, @c wxEVT_SIZE or
+ @c wxEVT_BUTTON.
*/
wxEvent(int id = 0, wxEventType eventType = wxEVT_NULL);
wxObject* GetEventObject() const;
/**
- Returns the identifier of the given event type, such as @c wxEVT_COMMAND_BUTTON_CLICKED.
+ Returns the identifier of the given event type, such as @c wxEVT_BUTTON.
*/
wxEventType GetEventType() const;
*/
int GetId() const;
+ /**
+ Return the user data associated with a dynamically connected event handler.
+
+ wxEvtHandler::Connect() and wxEvtHandler::Bind() allow associating
+ optional @c userData pointer with the handler and this method returns
+ the value of this pointer.
+
+ The returned pointer is owned by wxWidgets and must not be deleted.
+
+ @since 2.9.5
+ */
+ wxObject *GetEventUserData() const;
+
/**
Returns @true if the event handler should be skipped, @false otherwise.
*/
void SetTimestamp(long timeStamp = 0);
/**
- Test if this event should be propagated or not, i.e. if the propagation level
+ Test if this event should be propagated or not, i.e.\ if the propagation level
is currently greater than 0.
*/
bool ShouldPropagate() const;
int m_propagationLevel;
};
+#endif // wxUSE_BASE
+
+#if wxUSE_GUI
+
/**
@class wxEventBlocker
+/**
+ Helper class to temporarily change an event to not propagate.
+*/
+class wxPropagationDisabler
+{
+public:
+ wxPropagationDisabler(wxEvent& event);
+ ~wxPropagationDisabler();
+};
+
+
+/**
+ Helper class to temporarily lower propagation level.
+*/
+class wxPropagateOnce
+{
+public:
+ wxPropagateOnce(wxEvent& event);
+ ~wxPropagateOnce();
+};
+
+#endif // wxUSE_GUI
+
+#if wxUSE_BASE
+
/**
@class wxEvtHandler
@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:
/**
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);
+ /**
+ Asynchronously call the given method.
+
+ Calling this function on an object schedules an asynchronous call to
+ the method specified as CallAfter() argument at a (slightly) later
+ time. This is useful when processing some events as certain actions
+ typically can't be performed inside their handlers, e.g. you shouldn't
+ show a modal dialog from a mouse click event handler as this would
+ break the mouse capture state -- but you can call a method showing
+ this message dialog after the current event handler completes.
+
+ The method being called must be the method of the object on which
+ CallAfter() itself is called.
+
+ Notice that it is safe to use CallAfter() from other, non-GUI,
+ threads, but that the method will be always called in the main, GUI,
+ thread context.
+
+ Example of use:
+ @code
+ class MyFrame : public wxFrame {
+ void OnClick(wxMouseEvent& event) {
+ CallAfter(&MyFrame::ShowPosition, event.GetPosition());
+ }
+
+ void ShowPosition(const wxPoint& pos) {
+ if ( wxMessageBox(
+ wxString::Format("Perform click at (%d, %d)?",
+ pos.x, pos.y), "", wxYES_NO) == wxYES )
+ {
+ ... do take this click into account ...
+ }
+ }
+ };
+ @endcode
+
+ @param method The method to call.
+ @param x1 The (optional) first parameter to pass to the method.
+ @param x2 The (optional) second parameter to pass to the method.
+
+ Note that currently only up to 2 arguments can be passed.
+
+ @note This method is not available with Visual C++ before version 8
+ (Visual Studio 2005) as earlier versions of the compiler don't
+ have the required support for C++ templates to implement it.
+
+ @since 2.9.5
+ */
+ template<typename T, typename T1, ...>
+ void CallAfter(void (T::*method)(T1, ...), T1 x1, ...);
+
/**
Processes an event, searching event tables and calling zero or more suitable
event handler function(s).
(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 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
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
+ TryBefore() and TryAfter(). 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.
*/
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.
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,
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
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.
be explicitly converted to the correct type which can be done using a macro
called @c wxFooEventHandler for the handler for any @c wxFooEvent.
@param userData
- Data to be associated with the event table entry.
+ Optional data to be associated with the event table entry.
+ wxWidgets will take ownership of this pointer, i.e. it will be
+ destroyed when the event handler is disconnected or at the program
+ termination. This pointer can be retrieved using
+ wxEvent::GetEventUserData() later.
@param eventSink
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,
Example:
@code
frame->Connect( wxID_EXIT,
- wxEVT_COMMAND_MENU_SELECTED,
+ wxEVT_MENU,
wxCommandEventHandler(MyFrame::OnQuit) );
@endcode
+
+ @beginWxPerlOnly
+ Not supported by wxPerl.
+ @endWxPerlOnly
*/
void Connect(int id, wxEventType eventType,
wxObjectEventFunction function,
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,
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,
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,
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,
//@}
+ /**
+ @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,
+ whereas 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
+ Optional data to be associated with the event table entry.
+ wxWidgets will take ownership of this pointer, i.e. it will be
+ destroyed when the event handler is disconnected or at the program
+ termination. This pointer can be retrieved using
+ wxEvent::GetEventUserData() later.
+
+ @see @ref overview_cpp_rtti_disabled
+
+ @since 2.9.0
+ */
+ template <typename EventTag, typename Functor>
+ 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
+ Optional data to be associated with the event table entry.
+ wxWidgets will take ownership of this pointer, i.e. it will be
+ destroyed when the event handler is disconnected or at the program
+ termination. This pointer can be retrieved using
+ wxEvent::GetEventUserData() later.
+
+ @see @ref overview_cpp_rtti_disabled
+
+ @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.
+
+ 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 <typename EventTag, typename Functor>
+ 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 <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 );
+ //@}
/**
@name User-supplied data
*/
bool IsUnlinked() const;
//@}
+
+ /**
+ @name Global event filters.
+
+ Methods for working with the global list of event filters.
+
+ Event filters can be defined to pre-process all the events that happen
+ in an application, see wxEventFilter documentation for more information.
+ */
+ //@{
+
+ /**
+ Add an event filter whose FilterEvent() method will be called for each
+ and every event processed by wxWidgets.
+
+ The filters are called in LIFO order and wxApp is registered as an
+ event filter by default. The pointer must remain valid until it's
+ removed with RemoveFilter() and is not deleted by wxEvtHandler.
+
+ @since 2.9.3
+ */
+ static void AddFilter(wxEventFilter* filter);
+
+ /**
+ Remove a filter previously installed with AddFilter().
+
+ It's an error to remove a filter that hadn't been previously added or
+ was already removed.
+
+ @since 2.9.3
+ */
+ static void RemoveFilter(wxEventFilter* filter);
+
+ //@}
+
+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);
+
+ /**
+ 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);
+};
+
+#endif // wxUSE_BASE
+
+#if wxUSE_GUI
+
+/**
+ 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.
+ Since version 2.9.2, the enum values @c WXK_CONTROL_A - @c WXK_CONTROL_Z
+ can be used instead of the non-descriptive constant values 1-26.
+
+ 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}
@event{EVT_KEY_DOWN(func)}
- Process a @c wxEVT_KEY_DOWN event (any key has been pressed).
+ Process a @c wxEVT_KEY_DOWN event (any key has been pressed). If this
+ event is handled and not skipped, @c wxEVT_CHAR will not be generated
+ at all for this key press (but @c wxEVT_KEY_UP will be).
@event{EVT_KEY_UP(func)}
Process a @c wxEVT_KEY_UP event (any key has been released).
@event{EVT_CHAR(func)}
Process a @c wxEVT_CHAR event.
+ @event{EVT_CHAR_HOOK(func)}
+ Process a @c wxEVT_CHAR_HOOK event. Unlike all the other key events,
+ this event is propagated upwards the window hierarchy which allows
+ intercepting it in the parent window of the focused window to which it
+ is sent initially (if there is no focused window, this event is sent to
+ the wxApp global object). It is also generated before any other key
+ events and so gives the parent window an opportunity to modify the
+ keyboard handling of its children, e.g. it is used internally by
+ wxWidgets in some ports to intercept pressing Esc key in any child of a
+ dialog to close the dialog itself when it's pressed. By default, if
+ this event is handled, i.e. the handler doesn't call wxEvent::Skip(),
+ neither @c wxEVT_KEY_DOWN nor @c wxEVT_CHAR events will be generated
+ (although @c wxEVT_KEY_UP still will be), i.e. it replaces the normal
+ key events. However by calling the special DoAllowNextEvent() method
+ you can handle @c wxEVT_CHAR_HOOK and still allow normal events
+ generation. This is something that is rarely useful but can be required
+ if you need to prevent a parent @c wxEVT_CHAR_HOOK handler from running
+ without suppressing the normal key events. Finally notice that this
+ event is not generated when the mouse is captured as it is considered
+ that the window which has the capture should receive all the keyboard
+ events too without allowing its parent wxTopLevelWindow to interfere
+ with their processing.
@endEventTable
@see wxKeyboardState
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 Latin-1 character (this
+ includes ASCII and the accented letters found in Western European
+ languages but not letters of other alphabets such as e.g. Cyrillic).
+ Otherwise it simply 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)
+ {
+ wxChar uc = event.GetUnicodeKey();
+ if ( uc != WXK_NONE )
+ {
+ // It's a "normal" character. Notice that this includes
+ // control characters in 1..31 range, e.g. WXK_RETURN or
+ // WXK_BACK, so check for them explicitly.
+ if ( uc >= 32 )
+ {
+ wxLogMessage("You pressed '%c'", uc);
+ }
+ else
+ {
+ // It's a control character
+ ...
+ }
+ }
+ else // No Unicode equivalent.
+ {
+ // It's a special key, deal with all the known ones:
+ switch ( event.GetKeyCode() )
+ {
+ 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.
+
+ Notice that under most platforms this position is simply the current
+ mouse pointer position and has no special relationship to the key event
+ itself.
+
+ @a x and @a y may be @NULL if the corresponding coordinate is not
+ needed.
*/
wxPoint GetPosition() const;
- void GetPosition(long* x, long* y) const;
+ void GetPosition(wxCoord* x, wxCoord* y) const;
//@}
/**
- 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.
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.
/**
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.
*/
/**
Returns the X position (in client coordinates) of the event.
+
+ @see GetPosition()
*/
wxCoord GetX() const;
/**
Returns the Y position (in client coordinates) of the event.
+
+ @see GetPosition()
*/
wxCoord GetY() const;
+
+ /**
+ Allow normal key events generation.
+
+ Can be called from @c wxEVT_CHAR_HOOK handler to indicate that the
+ generation of normal events should @em not be suppressed, as it happens
+ by default when this event is handled.
+
+ The intended use of this method is to allow some window object to
+ prevent @c wxEVT_CHAR_HOOK handler in its parent window from running by
+ defining its own handler for this event. Without calling this method,
+ this would result in not generating @c wxEVT_KEY_DOWN nor @c wxEVT_CHAR
+ events at all but by calling it you can ensure that these events would
+ still be generated, even if @c wxEVT_CHAR_HOOK event was handled.
+
+ @since 2.9.3
+ */
+ void DoAllowNextEvent();
+
+ /**
+ Returns @true if DoAllowNextEvent() had been called, @false by default.
+
+ This method is used by wxWidgets itself to determine whether the normal
+ key events should be generated after @c wxEVT_CHAR_HOOK processing.
+
+ @since 2.9.3
+ */
+ bool IsNextEventAllowed() const;
+};
+
+
+
+enum
+{
+ wxJOYSTICK1,
+ wxJOYSTICK2
};
+// Which button is down?
+enum
+{
+ wxJOY_BUTTON_ANY = -1,
+ wxJOY_BUTTON1 = 1,
+ wxJOY_BUTTON2 = 2,
+ wxJOY_BUTTON3 = 4,
+ wxJOY_BUTTON4 = 8
+};
/**
/**
Returns the x, y position of the joystick event.
+
+ These coordinates are valid for all the events except wxEVT_JOY_ZMOVE.
*/
wxPoint GetPosition() const;
/**
Returns the z position of the joystick event.
+
+ This method can only be used for wxEVT_JOY_ZMOVE events.
*/
int GetZPosition() const;
@event{EVT_SCROLLWIN(func)}
Process all scroll events.
@event{EVT_SCROLLWIN_TOP(func)}
- Process wxEVT_SCROLLWIN_TOP scroll-to-top events.
+ Process @c wxEVT_SCROLLWIN_TOP scroll-to-top events.
@event{EVT_SCROLLWIN_BOTTOM(func)}
- Process wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
+ Process @c wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
@event{EVT_SCROLLWIN_LINEUP(func)}
- Process wxEVT_SCROLLWIN_LINEUP line up events.
+ Process @c wxEVT_SCROLLWIN_LINEUP line up events.
@event{EVT_SCROLLWIN_LINEDOWN(func)}
- Process wxEVT_SCROLLWIN_LINEDOWN line down events.
+ Process @c wxEVT_SCROLLWIN_LINEDOWN line down events.
@event{EVT_SCROLLWIN_PAGEUP(func)}
- Process wxEVT_SCROLLWIN_PAGEUP page up events.
+ Process @c wxEVT_SCROLLWIN_PAGEUP page up events.
@event{EVT_SCROLLWIN_PAGEDOWN(func)}
- Process wxEVT_SCROLLWIN_PAGEDOWN page down events.
+ Process @c wxEVT_SCROLLWIN_PAGEDOWN page down events.
@event{EVT_SCROLLWIN_THUMBTRACK(func)}
- Process wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
+ Process @c wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
(frequent events sent as the user drags the thumbtrack).
@event{EVT_SCROLLWIN_THUMBRELEASE(func)}
- Process wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
+ Process @c wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
@endEventTable
the window itself for the current position in that case.
*/
int GetPosition() const;
+
+ void SetOrientation(int orient);
+ void SetPosition(int pos);
};
/**
- @class wxWindowCreateEvent
+ @class wxCommandEvent
+
+ 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}
+ @event{EVT_COMMAND(id, event, func)}
+ Process a command, supplying the window identifier, command event identifier,
+ and member function.
+ @event{EVT_COMMAND_RANGE(id1, id2, event, func)}
+ Process a command for a range of window identifiers, supplying the minimum and
+ maximum window identifiers, command event identifier, and member function.
+ @event{EVT_BUTTON(id, func)}
+ Process a @c wxEVT_BUTTON command, which is generated by a wxButton control.
+ @event{EVT_CHECKBOX(id, func)}
+ Process a @c wxEVT_CHECKBOX command, which is generated by a wxCheckBox control.
+ @event{EVT_CHOICE(id, func)}
+ Process a @c wxEVT_CHOICE command, which is generated by a wxChoice control.
+ @event{EVT_COMBOBOX(id, func)}
+ Process a @c wxEVT_COMBOBOX command, which is generated by a wxComboBox control.
+ @event{EVT_LISTBOX(id, func)}
+ Process a @c wxEVT_LISTBOX command, which is generated by a wxListBox control.
+ @event{EVT_LISTBOX_DCLICK(id, func)}
+ Process a @c wxEVT_LISTBOX_DCLICK command, which is generated by a wxListBox control.
+ @event{EVT_CHECKLISTBOX(id, func)}
+ Process a @c wxEVT_CHECKLISTBOX command, which is generated by a wxCheckListBox control.
+ @event{EVT_MENU(id, func)}
+ Process a @c wxEVT_MENU command, which is generated by a menu item.
+ @event{EVT_MENU_RANGE(id1, id2, func)}
+ Process a @c wxEVT_MENU command, which is generated by a range of menu items.
+ @event{EVT_CONTEXT_MENU(func)}
+ Process the event generated when the user has requested a popup menu to appear by
+ pressing a special keyboard key (under Windows) or by right clicking the mouse.
+ @event{EVT_RADIOBOX(id, func)}
+ Process a @c wxEVT_RADIOBOX command, which is generated by a wxRadioBox control.
+ @event{EVT_RADIOBUTTON(id, func)}
+ Process a @c wxEVT_RADIOBUTTON command, which is generated by a wxRadioButton control.
+ @event{EVT_SCROLLBAR(id, func)}
+ Process a @c wxEVT_SCROLLBAR command, which is generated by a wxScrollBar
+ control. This is provided for compatibility only; more specific scrollbar event macros
+ should be used instead (see wxScrollEvent).
+ @event{EVT_SLIDER(id, func)}
+ Process a @c wxEVT_SLIDER command, which is generated by a wxSlider control.
+ @event{EVT_TEXT(id, func)}
+ Process a @c wxEVT_TEXT command, which is generated by a wxTextCtrl control.
+ @event{EVT_TEXT_ENTER(id, func)}
+ Process a @c wxEVT_TEXT_ENTER command, which is generated by a wxTextCtrl control.
+ Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it
+ to generate such events.
+ @event{EVT_TEXT_MAXLEN(id, func)}
+ Process a @c wxEVT_TEXT_MAXLEN command, which is generated by a wxTextCtrl control
+ when the user tries to enter more characters into it than the limit previously set
+ with SetMaxLength().
+ @event{EVT_TOGGLEBUTTON(id, func)}
+ Process a @c wxEVT_TOGGLEBUTTON event.
+ @event{EVT_TOOL(id, func)}
+ Process a @c wxEVT_TOOL event (a synonym for @c wxEVT_MENU).
+ Pass the id of the tool.
+ @event{EVT_TOOL_RANGE(id1, id2, func)}
+ Process a @c wxEVT_TOOL event for a range of identifiers. Pass the ids of the tools.
+ @event{EVT_TOOL_RCLICKED(id, func)}
+ Process a @c wxEVT_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_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_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. (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)}
+ Process a @c wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (wxMSW only).
+ @event{EVT_COMMAND_RIGHT_CLICK(id, func)}
+ Process a @c wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (wxMSW only).
+ @event{EVT_COMMAND_SET_FOCUS(id, func)}
+ Process a @c wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (wxMSW only).
+ @event{EVT_COMMAND_KILL_FOCUS(id, func)}
+ Process a @c wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (wxMSW only).
+ @event{EVT_COMMAND_ENTER(id, func)}
+ Process a @c wxEVT_COMMAND_ENTER command, which is generated by a control.
+ @endEventTable
+
+ @library{wxcore}
+ @category{events}
+*/
+class wxCommandEvent : public wxEvent
+{
+public:
+ /**
+ Constructor.
+ */
+ wxCommandEvent(wxEventType commandEventType = wxEVT_NULL, int id = 0);
+
+ /**
+ Returns client data pointer for a listbox or choice selection event
+ (not valid for a deselection).
+ */
+ void* GetClientData() const;
+
+ /**
+ Returns client object pointer for a listbox or choice selection event
+ (not valid for a deselection).
+ */
+ wxClientData* GetClientObject() const;
+
+ /**
+ Returns extra information dependent on the event objects type.
+
+ If the event comes from a listbox selection, it is a boolean
+ determining whether the event was a selection (@true) or a
+ deselection (@false). A listbox deselection only occurs for
+ multiple-selection boxes, and in this case the index and string values
+ are indeterminate and the listbox must be examined by the application.
+ */
+ long GetExtraLong() const;
+
+ /**
+ Returns the integer identifier corresponding to a listbox, choice or
+ radiobox selection (only if the event was a selection, not a deselection),
+ or a boolean value representing the value of a checkbox.
+
+ For a menu item, this method returns -1 if the item is not checkable or
+ a boolean value (true or false) for checkable items indicating the new
+ state of the item.
+ */
+ int GetInt() const;
+
+ /**
+ Returns item index for a listbox or choice selection event (not valid for
+ a deselection).
+ */
+ int GetSelection() const;
+
+ /**
+ Returns item string for a listbox or choice selection event. If one
+ or several items have been deselected, returns the index of the first
+ deselected item. If some items have been selected and others deselected
+ at the same time, it will return the index of the first selected item.
+ */
+ wxString GetString() const;
+
+ /**
+ This method can be used with checkbox and menu events: for the checkboxes, the
+ method returns @true for a selection event and @false for a deselection one.
+ For the menu events, this method indicates if the menu item just has become
+ checked or unchecked (and thus only makes sense for checkable menu items).
+
+ Notice that this method cannot be used with wxCheckListBox currently.
+ */
+ bool IsChecked() const;
+
+ /**
+ For a listbox or similar event, returns @true if it is a selection, @false
+ if it is a deselection. If some items have been selected and others deselected
+ at the same time, it will return @true.
+ */
+ bool IsSelection() const;
+
+ /**
+ Sets the client data for this event.
+ */
+ void SetClientData(void* clientData);
+
+ /**
+ Sets the client object for this event. The client object is not owned by the
+ event object and the event object will not delete the client object in its destructor.
+
+ The client object must be owned and deleted by another object (e.g. a control)
+ that has longer life time than the event object.
+ */
+ void SetClientObject(wxClientData* clientObject);
+
+ /**
+ Sets the @b m_extraLong member.
+ */
+ void SetExtraLong(long extraLong);
+
+ /**
+ Sets the @b m_commandInt member.
+ */
+ void SetInt(int intCommand);
+
+ /**
+ Sets the @b m_commandString member.
+ */
+ void SetString(const wxString& string);
+};
+
+
+
+/**
+ @class wxWindowCreateEvent
This event is sent just after the actual window associated with a wxWindow
object has been created.
*/
wxWindowCreateEvent(wxWindow* win = NULL);
- /// Retutn the window being created.
+ /// Return the window being created.
wxWindow *GetWindow() const;
};
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)
{
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
}
@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)}
not sent when the window is restored to its original size after it had been
maximized, only a normal wxSizeEvent is generated in this case.
+ Currently this event is only generated in wxMSW, wxGTK, wxOSX/Cocoa and wxOS2
+ ports so portable programs should only rely on receiving @c wxEVT_SIZE and
+ not necessarily this event when the window is maximized.
+
@beginEventTable{wxMaximizeEvent}
@event{EVT_MAXIMIZE(func)}
Process a @c wxEVT_MAXIMIZE event.
wxTextCtrl but other windows can generate these events as well) when its
content gets copied or cut to, or pasted from the clipboard.
- There are three types of corresponding events wxEVT_COMMAND_TEXT_COPY,
- wxEVT_COMMAND_TEXT_CUT and wxEVT_COMMAND_TEXT_PASTE.
+ There are three types of corresponding events @c wxEVT_TEXT_COPY,
+ @c wxEVT_TEXT_CUT and @c wxEVT_TEXT_PASTE.
If any of these events is processed (without being skipped) by an event
handler, the corresponding operation doesn't take place which allows to
text was copied or cut.
@note
- These events are currently only generated by wxTextCtrl under GTK+.
- They are generated by all controls under Windows.
+ These events are currently only generated by wxTextCtrl in wxGTK and wxOSX
+ but are also generated by wxComboBox without wxCB_READONLY style in wxMSW.
@beginEventTable{wxClipboardTextEvent}
@event{EVT_TEXT_COPY(id, func)}
wxClipboardTextEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
};
+/**
+ Possible axis values for mouse wheel scroll events.
+
+ @since 2.9.4
+ */
+enum wxMouseWheelAxis
+{
+ wxMOUSE_WHEEL_VERTICAL, ///< Vertical scroll event.
+ wxMOUSE_WHEEL_HORIZONTAL ///< Horizontal scroll event.
+};
/**
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_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)}
/**
Constructor. Valid event types are:
- @li wxEVT_ENTER_WINDOW
- @li wxEVT_LEAVE_WINDOW
- @li wxEVT_LEFT_DOWN
- @li wxEVT_LEFT_UP
- @li wxEVT_LEFT_DCLICK
- @li wxEVT_MIDDLE_DOWN
- @li wxEVT_MIDDLE_UP
- @li wxEVT_MIDDLE_DCLICK
- @li wxEVT_RIGHT_DOWN
- @li wxEVT_RIGHT_UP
- @li wxEVT_RIGHT_DCLICK
- @li wxEVT_MOUSE_AUX1_DOWN
- @li wxEVT_MOUSE_AUX1_UP
- @li wxEVT_MOUSE_AUX1_DCLICK
- @li wxEVT_MOUSE_AUX2_DOWN
- @li wxEVT_MOUSE_AUX2_UP
- @li wxEVT_MOUSE_AUX2_DCLICK
- @li wxEVT_MOTION
- @li wxEVT_MOUSEWHEEL
+ @li @c wxEVT_ENTER_WINDOW
+ @li @c wxEVT_LEAVE_WINDOW
+ @li @c wxEVT_LEFT_DOWN
+ @li @c wxEVT_LEFT_UP
+ @li @c wxEVT_LEFT_DCLICK
+ @li @c wxEVT_MIDDLE_DOWN
+ @li @c wxEVT_MIDDLE_UP
+ @li @c wxEVT_MIDDLE_DCLICK
+ @li @c wxEVT_RIGHT_DOWN
+ @li @c wxEVT_RIGHT_UP
+ @li @c wxEVT_RIGHT_DCLICK
+ @li @c wxEVT_AUX1_DOWN
+ @li @c wxEVT_AUX1_UP
+ @li @c wxEVT_AUX1_DCLICK
+ @li @c wxEVT_AUX2_DOWN
+ @li @c wxEVT_AUX2_UP
+ @li @c wxEVT_AUX2_DCLICK
+ @li @c wxEVT_MOTION
+ @li @c wxEVT_MOUSEWHEEL
*/
wxMouseEvent(wxEventType mouseEventType = wxEVT_NULL);
*/
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:
+ Returns @true if the event was generated by the specified button.
- @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
-
- @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).
/**
Returns the configured number of lines (or whatever) to be scrolled per
- wheel action. Defaults to three.
+ wheel action.
+
+ Default value under most platforms is three.
+
+ @see GetColumnsPerAction()
*/
int GetLinesPerAction() const;
/**
- Returns the logical mouse position in pixels (i.e. translated according to the
- translation set for the DC, which usually indicates that the window has been
- scrolled).
+ Returns the configured number of columns (or whatever) to be scrolled per
+ wheel action.
+
+ Default value under most platforms is three.
+
+ @see GetLinesPerAction()
+
+ @since 2.9.5
*/
- wxPoint GetLogicalPosition(const wxDC& dc) const;
+ int GetColumnsPerAction() 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.
+ Returns the logical mouse position in pixels (i.e.\ translated according to the
+ translation set for the DC, which usually indicates that the window has been
+ scrolled).
*/
- wxPoint GetPosition() const;
- void GetPosition(wxCoord* x, wxCoord* y) const;
- void GetPosition(long* x, long* y) const;
- //@}
+ wxPoint GetLogicalPosition(const wxDC& dc) const;
/**
Get wheel delta, normally 120.
int GetWheelRotation() const;
/**
- Gets the axis the wheel operation concerns; @c 0 is the Y axis as on
- most mouse wheels, @c 1 is the X axis.
-
- Note that only some models of mouse have horizontal wheel axis.
- */
- 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 IsButton() const;
-
- /**
- Returns @true if the system has been setup to do page scrolling with
- the mouse wheel instead of line scrolling.
- */
- bool IsPageScroll() const;
-
- /**
- Returns @true if the mouse was leaving the window.
-
- @see Entering().
- */
- bool Leaving() const;
-
- /**
- Returns @true if the event was a left double click.
- */
- bool LeftDClick() const;
-
- /**
- Returns @true if the left mouse button changed to down.
- */
- 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 LeftUp() const;
-
- /**
- Returns @true if the Meta key was down at the time of the event.
- */
- bool MetaDown() const;
-
- /**
- Returns @true if the event was a middle double click.
- */
- bool MiddleDClick() const;
-
- /**
- Returns @true if the middle mouse button changed to down.
- */
- 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 MiddleUp() const;
-
- /**
- Returns @true if this was a motion event and no mouse buttons were pressed.
- If any mouse button is held pressed, then this method returns @false and
- Dragging() returns @true.
- */
- bool Moving() const;
-
- /**
- Returns @true if the event was a right double click.
- */
- bool RightDClick() const;
-
- /**
- Returns @true if the right mouse button changed to down.
- */
- 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.
- */
- bool RightUp() const;
-};
-
-
-
-/**
- @class wxDropFilesEvent
-
- This class is used for drop files events, that is, when files have been dropped
- onto the window. This functionality is currently only available under Windows.
-
- The window must have previously been enabled for dropping by calling
- wxWindow::DragAcceptFiles().
-
- Important note: this is a separate implementation to the more general drag and drop
- implementation documented in the @ref overview_dnd. It uses the older, Windows
- message-based approach of dropping files.
-
- @beginEventTable{wxDropFilesEvent}
- @event{EVT_DROP_FILES(func)}
- Process a @c wxEVT_DROP_FILES event.
- @endEventTable
-
- @onlyfor{wxmsw}
-
- @library{wxcore}
- @category{events}
-
- @see @ref overview_events
-*/
-class wxDropFilesEvent : public wxEvent
-{
-public:
- /**
- Constructor.
- */
- wxDropFilesEvent(wxEventType id = 0, int noFiles = 0,
- wxString* files = NULL);
-
- /**
- Returns an array of filenames.
- */
- wxString* GetFiles() const;
-
- /**
- Returns the number of files dropped.
- */
- int GetNumberOfFiles() const;
-
- /**
- Returns the position at which the files were dropped.
- Returns an array of filenames.
- */
- wxPoint GetPosition() const;
-};
-
-
-
-/**
- @class wxCommandEvent
-
- 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}
- @event{EVT_COMMAND(id, event, func)}
- Process a command, supplying the window identifier, command event identifier,
- and member function.
- @event{EVT_COMMAND_RANGE(id1, id2, event, func)}
- Process a command for a range of window identifiers, supplying the minimum and
- maximum window identifiers, command event identifier, and member function.
- @event{EVT_BUTTON(id, func)}
- Process a @c wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wxButton control.
- @event{EVT_CHECKBOX(id, func)}
- Process a @c wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wxCheckBox control.
- @event{EVT_CHOICE(id, func)}
- Process a @c wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wxChoice control.
- @event{EVT_COMBOBOX(id, func)}
- Process a @c wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wxComboBox control.
- @event{EVT_LISTBOX(id, func)}
- 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)}
- Process a @c wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.
- @event{EVT_CONTEXT_MENU(func)}
- Process the event generated when the user has requested a popup menu to appear by
- pressing a special keyboard key (under Windows) or by right clicking the mouse.
- @event{EVT_RADIOBOX(id, func)}
- Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wxRadioBox control.
- @event{EVT_RADIOBUTTON(id, func)}
- Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wxRadioButton control.
- @event{EVT_SCROLLBAR(id, func)}
- Process a @c wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a wxScrollBar
- control. This is provided for compatibility only; more specific scrollbar event macros
- should be used instead (see wxScrollEvent).
- @event{EVT_SLIDER(id, func)}
- Process a @c wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wxSlider control.
- @event{EVT_TEXT(id, func)}
- Process a @c wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wxTextCtrl control.
- @event{EVT_TEXT_ENTER(id, func)}
- Process a @c wxEVT_COMMAND_TEXT_ENTER command, which is generated by a wxTextCtrl control.
- Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it
- to generate such events.
- @event{EVT_TEXT_MAXLEN(id, func)}
- Process a @c wxEVT_COMMAND_TEXT_MAXLEN command, which is generated by a wxTextCtrl control
- when the user tries to enter more characters into it than the limit previously set
- with SetMaxLength().
- @event{EVT_TOGGLEBUTTON(id, func)}
- Process a @c wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event.
- @event{EVT_TOOL(id, func)}
- Process a @c wxEVT_COMMAND_TOOL_CLICKED event (a synonym for @c wxEVT_COMMAND_MENU_SELECTED).
- Pass the id of the tool.
- @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.
- @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.
- @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.
- @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)}
- Process a @c wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (wxMSW only).
- @event{EVT_COMMAND_RIGHT_CLICK(id, func)}
- Process a @c wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (wxMSW only).
- @event{EVT_COMMAND_SET_FOCUS(id, func)}
- Process a @c wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (wxMSW only).
- @event{EVT_COMMAND_KILL_FOCUS(id, func)}
- Process a @c wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (wxMSW only).
- @event{EVT_COMMAND_ENTER(id, func)}
- Process a @c wxEVT_COMMAND_ENTER command, which is generated by a control.
- @endEventTable
-
- @library{wxcore}
- @category{events}
-*/
-class wxCommandEvent : public wxEvent
-{
-public:
- /**
- Constructor.
+ Gets the axis the wheel operation concerns.
+
+ Usually the mouse wheel is used to scroll vertically so @c
+ wxMOUSE_WHEEL_VERTICAL is returned but some mice (and most trackpads)
+ also allow to use the wheel to scroll horizontally in which case
+ @c wxMOUSE_WHEEL_HORIZONTAL is returned.
+
+ Notice that before wxWidgets 2.9.4 this method returned @c int.
*/
- wxCommandEvent(wxEventType commandEventType = wxEVT_NULL, int id = 0);
+ wxMouseWheelAxis GetWheelAxis() const;
/**
- Returns client data pointer for a listbox or choice selection event
- (not valid for a deselection).
+ Returns @true if the event was a mouse button event (not necessarily a button
+ down event - that may be tested using ButtonDown()).
*/
- void* GetClientData() const;
+ bool IsButton() const;
/**
- Returns client object pointer for a listbox or choice selection event
- (not valid for a deselection).
+ Returns @true if the system has been setup to do page scrolling with
+ the mouse wheel instead of line scrolling.
*/
- wxClientData* GetClientObject() const;
+ bool IsPageScroll() const;
/**
- Returns extra information dependant on the event objects type.
+ Returns @true if the mouse was leaving the window.
- If the event comes from a listbox selection, it is a boolean
- determining whether the event was a selection (@true) or a
- deselection (@false). A listbox deselection only occurs for
- multiple-selection boxes, and in this case the index and string values
- are indeterminate and the listbox must be examined by the application.
+ @see Entering().
*/
- long GetExtraLong() const;
+ bool Leaving() const;
/**
- Returns the integer identifier corresponding to a listbox, choice or
- radiobox selection (only if the event was a selection, not a deselection),
- or a boolean value representing the value of a checkbox.
+ Returns @true if the event was a left double click.
*/
- int GetInt() const;
+ bool LeftDClick() const;
/**
- Returns item index for a listbox or choice selection event (not valid for
- a deselection).
+ Returns @true if the left mouse button changed to down.
*/
- int GetSelection() const;
+ bool LeftDown() const;
/**
- Returns item string for a listbox or choice selection event. If one
- or several items have been deselected, returns the index of the first
- deselected item. If some items have been selected and others deselected
- at the same time, it will return the index of the first selected item.
+ Returns @true if the left mouse button changed to up.
*/
- wxString GetString() const;
+ bool LeftUp() const;
/**
- This method can be used with checkbox and menu events: for the checkboxes, the
- method returns @true for a selection event and @false for a deselection one.
- For the menu events, this method indicates if the menu item just has become
- checked or unchecked (and thus only makes sense for checkable menu items).
+ Returns @true if the Meta key was down at the time of the event.
+ */
+ bool MetaDown() const;
- Notice that this method can not be used with wxCheckListBox currently.
+ /**
+ Returns @true if the event was a middle double click.
*/
- bool IsChecked() const;
+ bool MiddleDClick() const;
/**
- For a listbox or similar event, returns @true if it is a selection, @false
- if it is a deselection. If some items have been selected and others deselected
- at the same time, it will return @true.
+ Returns @true if the middle mouse button changed to down.
*/
- bool IsSelection() const;
+ bool MiddleDown() const;
/**
- Sets the client data for this event.
+ Returns @true if the middle mouse button changed to up.
*/
- void SetClientData(void* clientData);
+ bool MiddleUp() const;
/**
- Sets the client object for this event. The client object is not owned by the
- event object and the event object will not delete the client object in its destructor.
+ Returns @true if this was a motion event and no mouse buttons were pressed.
+ If any mouse button is held pressed, then this method returns @false and
+ Dragging() returns @true.
+ */
+ bool Moving() const;
- The client object must be owned and deleted by another object (e.g. a control)
- that has longer life time than the event object.
+ /**
+ Returns @true if the event was a right double click.
*/
- void SetClientObject(wxClientData* clientObject);
+ bool RightDClick() const;
/**
- Sets the @b m_extraLong member.
+ Returns @true if the right mouse button changed to down.
*/
- void SetExtraLong(long extraLong);
+ bool RightDown() const;
/**
- Sets the @b m_commandInt member.
+ Returns @true if the right mouse button changed to up.
*/
- void SetInt(int intCommand);
+ bool RightUp() const;
+};
+
+
+
+/**
+ @class wxDropFilesEvent
+
+ This class is used for drop files events, that is, when files have been dropped
+ onto the window. This functionality is currently only available under Windows.
+
+ The window must have previously been enabled for dropping by calling
+ wxWindow::DragAcceptFiles().
+
+ Important note: this is a separate implementation to the more general drag and drop
+ implementation documented in the @ref overview_dnd. It uses the older, Windows
+ message-based approach of dropping files.
+
+ @beginEventTable{wxDropFilesEvent}
+ @event{EVT_DROP_FILES(func)}
+ Process a @c wxEVT_DROP_FILES event.
+ @endEventTable
+ @onlyfor{wxmsw}
+
+ @library{wxcore}
+ @category{events}
+
+ @see @ref overview_events
+*/
+class wxDropFilesEvent : public wxEvent
+{
+public:
/**
- Sets the @b m_commandString member.
+ Constructor.
*/
- void SetString(const wxString& string);
+ wxDropFilesEvent(wxEventType id = 0, int noFiles = 0,
+ wxString* files = NULL);
+
+ /**
+ Returns an array of filenames.
+ */
+ wxString* GetFiles() const;
+
+ /**
+ Returns the number of files dropped.
+ */
+ int GetNumberOfFiles() const;
+
+ /**
+ Returns the position at which the files were dropped.
+ Returns an array of filenames.
+ */
+ wxPoint GetPosition() const;
};
to wxApp only, and only on Windows SmartPhone and PocketPC.
It is generated when the system is low on memory; the application should free
up as much memory as possible, and restore full working state when it receives
- a wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP event.
+ a @c wxEVT_ACTIVATE or @c wxEVT_ACTIVATE_APP event.
@endEventTable
@library{wxcore}
means that the event originated from a keyboard context button event, and you
should compute a suitable position yourself, for example by calling wxGetMousePosition().
- When a keyboard context menu button is pressed on Windows, a right-click event
- with default position is sent first, and if this event is not processed, the
- context menu event is sent. So if you process mouse events and you find your
- context menu event handler is not being called, you could call wxEvent::Skip()
- for mouse right-down events.
+ Notice that the exact sequence of mouse events is different across the
+ platforms. For example, under MSW the context menu event is generated after
+ @c EVT_RIGHT_UP event and only if it was not handled but under GTK the
+ context menu event is generated after @c EVT_RIGHT_DOWN event. This is
+ correct in the sense that it ensures that the context menu is shown
+ according to the current platform UI conventions and also means that you
+ must not handle (or call wxEvent::Skip() in your handler if you do have
+ one) neither right mouse down nor right mouse up event if you plan on
+ handling @c EVT_CONTEXT_MENU event.
@beginEventTable{wxContextMenuEvent}
@event{EVT_CONTEXT_MENU(func)}
/**
Constructor.
*/
- wxContextMenuEvent(wxEventType id = wxEVT_NULL, int id = 0,
+ wxContextMenuEvent(wxEventType type = wxEVT_NULL, int id = 0,
const wxPoint& pos = wxDefaultPosition);
/**
To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table
definition.
- You must call wxEraseEvent::GetDC and use the returned device context if it is
- non-@NULL. If it is @NULL, create your own temporary wxClientDC object.
-
- @remarks
- Use the device context returned by GetDC to draw on, don't create
- a wxPaintDC in the event handler.
+ You must use the device context returned by GetDC() to draw on, don't create
+ a wxPaintDC in the event handler.
@beginEventTable{wxEraseEvent}
@event{EVT_ERASE_BACKGROUND(func)}
/**
Returns the device context associated with the erase event to draw on.
+
+ The returned pointer is never @NULL.
*/
wxDC* GetDC() const;
};
window (whether using the mouse or keyboard) and when it is done from the
program itself using wxWindow::SetFocus.
+ The focus event handlers should almost invariably call wxEvent::Skip() on
+ their event argument to allow the default handling to take place. Failure
+ to do this may result in incorrect behaviour of the native controls. Also
+ note that wxEVT_KILL_FOCUS handler must not call wxWindow::SetFocus() as
+ this, again, is not supported by all native controls. If you need to do
+ this, consider using the @ref sec_delayed_action described in wxIdleEvent
+ documentation.
+
@beginEventTable{wxFocusEvent}
@event{EVT_SET_FOCUS(func)}
Process a @c wxEVT_SET_FOCUS event.
Warning: the window pointer may be @NULL!
*/
wxWindow *GetWindow() const;
+
+ void SetWindow(wxWindow *win);
};
child if it loses it now and regains later.
Notice that child window is the direct child of the window receiving event.
- Use wxWindow::FindFocus() to retreive the window which is actually getting focus.
+ Use wxWindow::FindFocus() to retrieve the window which is actually getting focus.
@beginEventTable{wxChildFocusEvent}
@event{EVT_CHILD_FOCUS(func)}
/**
@class wxMouseCaptureLostEvent
- An mouse capture lost event is sent to a window that obtained mouse capture,
- which was subsequently loss due to "external" event, for example when a dialog
- box is shown or if another application captures the mouse.
+ A mouse capture lost event is sent to a window that had obtained mouse capture,
+ which was subsequently lost due to an "external" event (for example, when a dialog
+ box is shown or if another application captures the mouse).
- If this happens, this event is sent to all windows that are on capture stack
+ If this happens, this event is sent to all windows that are on the capture stack
(i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is
not sent if the capture changes because of a call to CaptureMouse or
ReleaseMouse.
+class wxDisplayChangedEvent : public wxEvent
+{
+public:
+ wxDisplayChangedEvent();
+};
+
+
+class wxPaletteChangedEvent : public wxEvent
+{
+public:
+ wxPaletteChangedEvent(wxWindowID winid = 0);
+
+ void SetChangedWindow(wxWindow* win);
+ wxWindow* GetChangedWindow() const;
+};
+
+
+class wxQueryNewPaletteEvent : public wxEvent
+{
+public:
+ wxQueryNewPaletteEvent(wxWindowID winid = 0);
+
+ void SetPaletteRealized(bool realized);
+ bool GetPaletteRealized();
+};
+
+
+
+
/**
@class wxNotifyEvent
/**
@class wxThreadEvent
- This class adds some simple functionalities to wxCommandEvent coinceived
- for inter-threads communications.
+ This class adds some simple functionality to wxEvent to facilitate
+ inter-thread communication.
- This event is not natively emitted by any control/class: this is just
- an helper class for the user.
+ This event is not natively emitted by any control/class: it is just
+ a 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
+ allows thread events @b NOT to 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
+
+ @since 2.9.0
*/
-class wxThreadEvent : public wxCommandEvent
+class wxThreadEvent : public wxEvent
{
public:
/**
Constructor.
*/
- wxThreadEvent(wxEventType eventType = wxEVT_COMMAND_THREAD, int id = wxID_ANY);
+ wxThreadEvent(wxEventType eventType = wxEVT_THREAD, int id = wxID_ANY);
/**
Clones this event making sure that all internal members which use
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<typename T>
+ 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<typename T>
+ T GetPayload() const;
+
+ /**
+ Returns extra information integer value.
+ */
+ long GetExtraLong() const;
+
+ /**
+ Returns stored integer value.
+ */
+ int GetInt() const;
+
+ /**
+ Returns stored string value.
+ */
+ wxString GetString() const;
+
+
+ /**
+ Sets the extra information value.
+ */
+ void SetExtraLong(long extraLong);
+
+ /**
+ Sets the integer value.
+ */
+ void SetInt(int intCommand);
+
+ /**
+ Sets the string value.
+ */
+ void SetString(const wxString& string);
};
@event{EVT_SCROLL(func)}
Process all scroll events.
@event{EVT_SCROLL_TOP(func)}
- Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
+ Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
@event{EVT_SCROLL_BOTTOM(func)}
- Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
+ Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
@event{EVT_SCROLL_LINEUP(func)}
- Process wxEVT_SCROLL_LINEUP line up events.
+ Process @c wxEVT_SCROLL_LINEUP line up events.
@event{EVT_SCROLL_LINEDOWN(func)}
- Process wxEVT_SCROLL_LINEDOWN line down events.
+ Process @c wxEVT_SCROLL_LINEDOWN line down events.
@event{EVT_SCROLL_PAGEUP(func)}
- Process wxEVT_SCROLL_PAGEUP page up events.
+ Process @c wxEVT_SCROLL_PAGEUP page up events.
@event{EVT_SCROLL_PAGEDOWN(func)}
- Process wxEVT_SCROLL_PAGEDOWN page down events.
+ Process @c wxEVT_SCROLL_PAGEDOWN page down events.
@event{EVT_SCROLL_THUMBTRACK(func)}
- Process wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the
+ Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the
user drags the thumbtrack).
@event{EVT_SCROLL_THUMBRELEASE(func)}
- Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
+ Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
@event{EVT_SCROLL_CHANGED(func)}
- Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
+ Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
@event{EVT_COMMAND_SCROLL(id, func)}
Process all scroll events.
@event{EVT_COMMAND_SCROLL_TOP(id, func)}
- Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
+ Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
@event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
- Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
+ Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
@event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
- Process wxEVT_SCROLL_LINEUP line up events.
+ Process @c wxEVT_SCROLL_LINEUP line up events.
@event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
- Process wxEVT_SCROLL_LINEDOWN line down events.
+ Process @c wxEVT_SCROLL_LINEDOWN line down events.
@event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
- Process wxEVT_SCROLL_PAGEUP page up events.
+ Process @c wxEVT_SCROLL_PAGEUP page up events.
@event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
- Process wxEVT_SCROLL_PAGEDOWN page down events.
+ Process @c wxEVT_SCROLL_PAGEDOWN page down events.
@event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
- Process wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent
+ Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent
as the user drags the thumbtrack).
@event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
- Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
+ Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
@event{EVT_COMMAND_SCROLL_CHANGED(func)}
- Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
+ Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
@endEventTable
@library{wxcore}
Returns the position of the scrollbar.
*/
int GetPosition() const;
+
+
+ void SetOrientation(int orient);
+ void SetPosition(int pos);
};
+#endif // wxUSE_GUI
+
+#if wxUSE_BASE
+
/**
See wxIdleEvent::SetMode() for more info.
*/
(and especially the first one) increase the system load and so should be avoided
if possible.
- By default, idle events are sent to all windows (and also wxApp, as usual).
- If this is causing a significant overhead in your application, you can call
- wxIdleEvent::SetMode with the value wxIDLE_PROCESS_SPECIFIED, and set the
- wxWS_EX_PROCESS_IDLE extra window style for every window which should receive
- idle events.
+ By default, idle events are sent to all windows, including even the hidden
+ ones because they may be shown if some condition is met from their @c
+ wxEVT_IDLE (or related @c wxEVT_UPDATE_UI) handler. The children of hidden
+ windows do not receive idle events however as they can't change their state
+ in any way noticeable by the user. Finally, the global wxApp object also
+ receives these events, as usual, so it can be used for any global idle time
+ processing.
+
+ If sending idle events to all windows is causing a significant overhead in
+ your application, you can call wxIdleEvent::SetMode with the value
+ wxIDLE_PROCESS_SPECIFIED, and set the wxWS_EX_PROCESS_IDLE extra window
+ style for every window which should receive idle events, all the other ones
+ will not receive them in this case.
@beginEventTable{wxIdleEvent}
@event{EVT_IDLE(func)}
@library{wxbase}
@category{events}
+ @section sec_delayed_action Delayed Action Mechanism
+
+ wxIdleEvent can be used to perform some action "at slightly later time".
+ This can be necessary in several circumstances when, for whatever reason,
+ something can't be done in the current event handler. For example, if a
+ mouse event handler is called with the mouse button pressed, the mouse can
+ be currently captured and some operations with it -- notably capturing it
+ again -- might be impossible or lead to undesirable results. If you still
+ want to capture it, you can do it from @c wxEVT_IDLE handler when it is
+ called the next time instead of doing it immediately.
+
+ This can be achieved in two different ways: when using static event tables,
+ you will need a flag indicating to the (always connected) idle event
+ handler whether the desired action should be performed. The originally
+ called handler would then set it to indicate that it should indeed be done
+ and the idle handler itself would reset it to prevent it from doing the
+ same action again.
+
+ Using dynamically connected event handlers things are even simpler as the
+ original event handler can simply wxEvtHandler::Connect() or
+ wxEvtHandler::Bind() the idle event handler which would only be executed
+ then and could wxEvtHandler::Disconnect() or wxEvtHandler::Unbind() itself.
+
+
@see @ref overview_events, wxUpdateUIEvent, wxWindow::OnInternalIdle
*/
class wxIdleEvent : public wxEvent
*/
wxIdleEvent();
- /**
- Returns @true if it is appropriate to send idle events to this window.
-
- This function looks at the mode used (see wxIdleEvent::SetMode),
- and the wxWS_EX_PROCESS_IDLE style in @a window to determine whether idle
- events should be sent to this window now.
-
- By default this will always return @true because the update mode is initially
- wxIDLE_PROCESS_ALL. You can change the mode to only send idle events to
- windows with the wxWS_EX_PROCESS_IDLE extra window style set.
-
- @see SetMode()
- */
- static bool CanSend(wxWindow* window);
-
/**
Static function returning a value specifying how wxWidgets will send idle
events: to all windows, or only to those which specify that they
static void SetMode(wxIdleMode mode);
};
+#endif // wxUSE_BASE
+#if wxUSE_GUI
/**
@class wxInitDialogEvent
*/
wxWindowDestroyEvent(wxWindow* win = NULL);
- /// Retutn the window being destroyed.
+ /// Return the window being destroyed.
wxWindow *GetWindow() const;
};
This event is mainly used by wxWidgets implementations.
A wxNavigationKeyEvent handler is automatically provided by wxWidgets
- when you make a class into a control container with the macro
- WX_DECLARE_CONTROL_CONTAINER.
+ when you enable keyboard navigation inside a window by inheriting it from
+ wxNavigationEnabled<>.
@beginEventTable{wxNavigationKeyEvent}
@event{EVT_NAVIGATION_KEY(func)}
@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
/**
Constructor.
*/
- wxMenuEvent(wxEventType id = wxEVT_NULL, int id = 0, wxMenu* menu = NULL);
+ wxMenuEvent(wxEventType type = wxEVT_NULL, int id = 0, wxMenu* menu = NULL);
/**
- Returns the menu which is being opened or closed. This method should only be
- used with the @c OPEN and @c CLOSE events and even for them the
- returned pointer may be @NULL in some ports.
+ Returns the menu which is being opened or closed.
+
+ This method can only be used with the @c OPEN and @c CLOSE events.
+
+ The returned value is never @NULL in the ports implementing this
+ function, which currently includes all the major ones.
*/
wxMenu* GetMenu() const;
@class wxShowEvent
An event being sent when the window is shown or hidden.
-
- Currently only wxMSW, wxGTK and wxOS2 generate such events.
+ 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.
@onlyfor{wxmsw,wxgtk,wxos2}
A move event holds information about wxTopLevelWindow move change events.
+ These events are currently only generated by wxMSW port.
+
@beginEventTable{wxMoveEvent}
@event{EVT_MOVE(func)}
Process a @c wxEVT_MOVE event, which is generated when a window is moved.
@event{EVT_MOVE_START(func)}
Process a @c wxEVT_MOVE_START event, which is generated when the user starts
to move or size a window. wxMSW only.
+ @event{EVT_MOVING(func)}
+ Process a @c wxEVT_MOVING event, which is generated while the user is
+ moving the window. wxMSW only.
@event{EVT_MOVE_END(func)}
Process a @c wxEVT_MOVE_END event, which is generated when the user stops
moving or sizing a window. wxMSW only.
Returns the position of the window generating the move change event.
*/
wxPoint GetPosition() const;
+
+ wxRect GetRect() const;
+ void SetRect(const wxRect& rect);
+ void SetPosition(const wxPoint& pos);
};
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
size of the window, you may need to clear the DC explicitly and repaint the whole window.
In which case, you may need to call wxWindow::Refresh to invalidate the entire window.
+ @b Important : Sizers ( see @ref overview_sizer ) rely on size events to function
+ correctly. Therefore, in a sizer-based layout, do not forget to call Skip on all
+ size events you catch (and don't catch size events at all when you don't need to).
+
@beginEventTable{wxSizeEvent}
@event{EVT_SIZE(func)}
Process a @c wxEVT_SIZE event.
/**
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;
+ void SetSize(wxSize size);
+
+ wxRect GetRect() const;
+ void SetRect(wxRect rect);
};
@library{wxcore}
@category{events}
- @see ::wxSetCursor, wxWindow::wxSetCursor
+ @see ::wxSetCursor, wxWindow::SetCursor
*/
class wxSetCursorEvent : public wxEvent
{
void SetCursor(const wxCursor& cursor);
};
-
+#endif // wxUSE_GUI
// ============================================================================
// Global functions/macros
/** @addtogroup group_funcmacro_events */
//@{
+#if wxUSE_BASE
+
/**
A value uniquely identifying the type of the event.
See the macro DEFINE_EVENT_TYPE() for more info.
- @see @ref overview_events_introduction
+ @see @ref overview_events
*/
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();
+wxEventType wxEVT_ANY;
/**
Generates a new unique event type.
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)
This is mostly used by wxWidgets internally, e.g.
@code
- wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent)
+ wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_BUTTON, wxCommandEvent)
@endcode
*/
#define wxDECLARE_EXPORTED_EVENT( expdecl, name, cls ) \
*/
#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:
...
- 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
*/
void wxQueueEvent(wxEvtHandler* dest, wxEvent *event);
+#endif // wxUSE_BASE
+
+#if wxUSE_GUI
+
+wxEventType wxEVT_BUTTON;
+wxEventType wxEVT_CHECKBOX;
+wxEventType wxEVT_CHOICE;
+wxEventType wxEVT_LISTBOX;
+wxEventType wxEVT_LISTBOX_DCLICK;
+wxEventType wxEVT_CHECKLISTBOX;
+wxEventType wxEVT_MENU;
+wxEventType wxEVT_SLIDER;
+wxEventType wxEVT_RADIOBOX;
+wxEventType wxEVT_RADIOBUTTON;
+wxEventType wxEVT_SCROLLBAR;
+wxEventType wxEVT_VLBOX;
+wxEventType wxEVT_COMBOBOX;
+wxEventType wxEVT_TOOL_RCLICKED;
+wxEventType wxEVT_TOOL_DROPDOWN;
+wxEventType wxEVT_TOOL_ENTER;
+wxEventType wxEVT_COMBOBOX_DROPDOWN;
+wxEventType wxEVT_COMBOBOX_CLOSEUP;
+wxEventType wxEVT_THREAD;
+wxEventType wxEVT_LEFT_DOWN;
+wxEventType wxEVT_LEFT_UP;
+wxEventType wxEVT_MIDDLE_DOWN;
+wxEventType wxEVT_MIDDLE_UP;
+wxEventType wxEVT_RIGHT_DOWN;
+wxEventType wxEVT_RIGHT_UP;
+wxEventType wxEVT_MOTION;
+wxEventType wxEVT_ENTER_WINDOW;
+wxEventType wxEVT_LEAVE_WINDOW;
+wxEventType wxEVT_LEFT_DCLICK;
+wxEventType wxEVT_MIDDLE_DCLICK;
+wxEventType wxEVT_RIGHT_DCLICK;
+wxEventType wxEVT_SET_FOCUS;
+wxEventType wxEVT_KILL_FOCUS;
+wxEventType wxEVT_CHILD_FOCUS;
+wxEventType wxEVT_MOUSEWHEEL;
+wxEventType wxEVT_AUX1_DOWN;
+wxEventType wxEVT_AUX1_UP;
+wxEventType wxEVT_AUX1_DCLICK;
+wxEventType wxEVT_AUX2_DOWN;
+wxEventType wxEVT_AUX2_UP;
+wxEventType wxEVT_AUX2_DCLICK;
+wxEventType wxEVT_CHAR;
+wxEventType wxEVT_CHAR_HOOK;
+wxEventType wxEVT_NAVIGATION_KEY;
+wxEventType wxEVT_KEY_DOWN;
+wxEventType wxEVT_KEY_UP;
+wxEventType wxEVT_HOTKEY;
+wxEventType wxEVT_SET_CURSOR;
+wxEventType wxEVT_SCROLL_TOP;
+wxEventType wxEVT_SCROLL_BOTTOM;
+wxEventType wxEVT_SCROLL_LINEUP;
+wxEventType wxEVT_SCROLL_LINEDOWN;
+wxEventType wxEVT_SCROLL_PAGEUP;
+wxEventType wxEVT_SCROLL_PAGEDOWN;
+wxEventType wxEVT_SCROLL_THUMBTRACK;
+wxEventType wxEVT_SCROLL_THUMBRELEASE;
+wxEventType wxEVT_SCROLL_CHANGED;
+wxEventType wxEVT_SPIN_UP;
+wxEventType wxEVT_SPIN_DOWN;
+wxEventType wxEVT_SPIN;
+wxEventType wxEVT_SCROLLWIN_TOP;
+wxEventType wxEVT_SCROLLWIN_BOTTOM;
+wxEventType wxEVT_SCROLLWIN_LINEUP;
+wxEventType wxEVT_SCROLLWIN_LINEDOWN;
+wxEventType wxEVT_SCROLLWIN_PAGEUP;
+wxEventType wxEVT_SCROLLWIN_PAGEDOWN;
+wxEventType wxEVT_SCROLLWIN_THUMBTRACK;
+wxEventType wxEVT_SCROLLWIN_THUMBRELEASE;
+wxEventType wxEVT_SIZE;
+wxEventType wxEVT_MOVE;
+wxEventType wxEVT_CLOSE_WINDOW;
+wxEventType wxEVT_END_SESSION;
+wxEventType wxEVT_QUERY_END_SESSION;
+wxEventType wxEVT_ACTIVATE_APP;
+wxEventType wxEVT_ACTIVATE;
+wxEventType wxEVT_CREATE;
+wxEventType wxEVT_DESTROY;
+wxEventType wxEVT_SHOW;
+wxEventType wxEVT_ICONIZE;
+wxEventType wxEVT_MAXIMIZE;
+wxEventType wxEVT_MOUSE_CAPTURE_CHANGED;
+wxEventType wxEVT_MOUSE_CAPTURE_LOST;
+wxEventType wxEVT_PAINT;
+wxEventType wxEVT_ERASE_BACKGROUND;
+wxEventType wxEVT_NC_PAINT;
+wxEventType wxEVT_MENU_OPEN;
+wxEventType wxEVT_MENU_CLOSE;
+wxEventType wxEVT_MENU_HIGHLIGHT;
+wxEventType wxEVT_CONTEXT_MENU;
+wxEventType wxEVT_SYS_COLOUR_CHANGED;
+wxEventType wxEVT_DISPLAY_CHANGED;
+wxEventType wxEVT_QUERY_NEW_PALETTE;
+wxEventType wxEVT_PALETTE_CHANGED;
+wxEventType wxEVT_JOY_BUTTON_DOWN;
+wxEventType wxEVT_JOY_BUTTON_UP;
+wxEventType wxEVT_JOY_MOVE;
+wxEventType wxEVT_JOY_ZMOVE;
+wxEventType wxEVT_DROP_FILES;
+wxEventType wxEVT_INIT_DIALOG;
+wxEventType wxEVT_IDLE;
+wxEventType wxEVT_UPDATE_UI;
+wxEventType wxEVT_SIZING;
+wxEventType wxEVT_MOVING;
+wxEventType wxEVT_MOVE_START;
+wxEventType wxEVT_MOVE_END;
+wxEventType wxEVT_HIBERNATE;
+wxEventType wxEVT_TEXT_COPY;
+wxEventType wxEVT_TEXT_CUT;
+wxEventType wxEVT_TEXT_PASTE;
+wxEventType wxEVT_COMMAND_LEFT_CLICK;
+wxEventType wxEVT_COMMAND_LEFT_DCLICK;
+wxEventType wxEVT_COMMAND_RIGHT_CLICK;
+wxEventType wxEVT_COMMAND_RIGHT_DCLICK;
+wxEventType wxEVT_COMMAND_SET_FOCUS;
+wxEventType wxEVT_COMMAND_KILL_FOCUS;
+wxEventType wxEVT_COMMAND_ENTER;
+wxEventType wxEVT_HELP;
+wxEventType wxEVT_DETAILED_HELP;
+wxEventType wxEVT_TOOL;
+wxEventType wxEVT_WINDOW_MODAL_DIALOG_CLOSED;
+
+#endif // wxUSE_GUI
+
//@}
projects / wxWidgets.git / blobdiff