1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxEvtHandler, wxEventBlocker and many
4 // wxEvent-derived classes
5 // Author: wxWidgets team
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
11 The predefined constants for the number of times we propagate event
12 upwards window child-parent chain.
14 enum wxEventPropagation
16 /// don't propagate it at all
17 wxEVENT_PROPAGATE_NONE
= 0,
19 /// propagate it until it is processed
20 wxEVENT_PROPAGATE_MAX
= INT_MAX
24 The different categories for a wxEvent; see wxEvent::GetEventCategory.
26 @note They are used as OR-combinable flags by wxEventLoopBase::YieldFor.
31 This is the category for those events which are generated to update
32 the appearance of the GUI but which (usually) do not comport data
33 processing, i.e. which do not provide input or output data
34 (e.g. size events, scroll events, etc).
35 They are events NOT directly generated by the user's input devices.
37 wxEVT_CATEGORY_UI
= 1,
40 This category groups those events which are generated directly from the
41 user through input devices like mouse and keyboard and usually result in
42 data to be processed from the application
43 (e.g. mouse clicks, key presses, etc).
45 wxEVT_CATEGORY_USER_INPUT
= 2,
47 /// This category is for wxSocketEvent
48 wxEVT_CATEGORY_SOCKET
= 4,
50 /// This category is for wxTimerEvent
51 wxEVT_CATEGORY_TIMER
= 8,
54 This category is for any event used to send notifications from the
55 secondary threads to the main one or in general for notifications among
56 different threads (which may or may not be user-generated).
57 See e.g. wxThreadEvent.
59 wxEVT_CATEGORY_THREAD
= 16,
62 This mask is used in wxEventLoopBase::YieldFor to specify that all event
63 categories should be processed.
66 wxEVT_CATEGORY_UI
|wxEVT_CATEGORY_USER_INPUT
|wxEVT_CATEGORY_SOCKET
| \
67 wxEVT_CATEGORY_TIMER
|wxEVT_CATEGORY_THREAD
73 An event is a structure holding information about an event passed to a
74 callback or member function.
76 wxEvent used to be a multipurpose event object, and is an abstract base class
77 for other event classes (see below).
79 For more information about events, see the @ref overview_events overview.
82 In wxPerl custom event classes should be derived from
83 @c Wx::PlEvent and @c Wx::PlCommandEvent.
89 @see wxCommandEvent, wxMouseEvent
91 class wxEvent
: public wxObject
97 Notice that events are usually created by wxWidgets itself and creating
98 e.g. a wxPaintEvent in your code and sending it to e.g. a wxTextCtrl
99 will not usually affect it at all as native controls have no specific
100 knowledge about wxWidgets events. However you may construct objects of
101 specific types and pass them to wxEvtHandler::ProcessEvent() if you
102 want to create your own custom control and want to process its events
103 in the same manner as the standard ones.
105 Also please notice that the order of parameters in this constructor is
106 different from almost all the derived classes which specify the event
107 type as the first argument.
110 The identifier of the object (window, timer, ...) which generated
113 The unique type of event, e.g. @c wxEVT_PAINT, @c wxEVT_SIZE or
114 @c wxEVT_COMMAND_BUTTON_CLICKED.
116 wxEvent(int id
= 0, wxEventType eventType
= wxEVT_NULL
);
119 Returns a copy of the event.
121 Any event that is posted to the wxWidgets event system for later action
122 (via wxEvtHandler::AddPendingEvent, wxEvtHandler::QueueEvent or wxPostEvent())
123 must implement this method.
125 All wxWidgets events fully implement this method, but any derived events
126 implemented by the user should also implement this method just in case they
127 (or some event derived from them) are ever posted.
129 All wxWidgets events implement a copy constructor, so the easiest way of
130 implementing the Clone function is to implement a copy constructor for
131 a new event (call it MyEvent) and then define the Clone function like this:
134 wxEvent *Clone() const { return new MyEvent(*this); }
137 virtual wxEvent
* Clone() const = 0;
140 Returns the object (usually a window) associated with the event, if any.
142 wxObject
* GetEventObject() const;
145 Returns the identifier of the given event type, such as @c wxEVT_COMMAND_BUTTON_CLICKED.
147 wxEventType
GetEventType() const;
150 Returns a generic category for this event.
151 wxEvent implementation returns @c wxEVT_CATEGORY_UI by default.
153 This function is used to selectively process events in wxEventLoopBase::YieldFor.
155 virtual wxEventCategory
GetEventCategory() const;
158 Returns the identifier associated with this event, such as a button command id.
163 Returns @true if the event handler should be skipped, @false otherwise.
165 bool GetSkipped() const;
168 Gets the timestamp for the event. The timestamp is the time in milliseconds
169 since some fixed moment (not necessarily the standard Unix Epoch, so only
170 differences between the timestamps and not their absolute values usually make sense).
173 wxWidgets returns a non-NULL timestamp only for mouse and key events
174 (see wxMouseEvent and wxKeyEvent).
176 long GetTimestamp() const;
179 Returns @true if the event is or is derived from wxCommandEvent else it returns @false.
181 @note exists only for optimization purposes.
183 bool IsCommandEvent() const;
186 Sets the propagation level to the given value (for example returned from an
187 earlier call to wxEvent::StopPropagation).
189 void ResumePropagation(int propagationLevel
);
192 Sets the originating object.
194 void SetEventObject(wxObject
* object
);
199 void SetEventType(wxEventType type
);
202 Sets the identifier associated with this event, such as a button command id.
207 Sets the timestamp for the event.
209 void SetTimestamp(long timeStamp
= 0);
212 Test if this event should be propagated or not, i.e. if the propagation level
213 is currently greater than 0.
215 bool ShouldPropagate() const;
218 This method can be used inside an event handler to control whether further
219 event handlers bound to this event will be called after the current one returns.
221 Without Skip() (or equivalently if Skip(@false) is used), the event will not
222 be processed any more. If Skip(@true) is called, the event processing system
223 continues searching for a further handler function for this event, even though
224 it has been processed already in the current handler.
226 In general, it is recommended to skip all non-command events to allow the
227 default handling to take place. The command events are, however, normally not
228 skipped as usually a single command such as a button click or menu item
229 selection must only be processed by one handler.
231 void Skip(bool skip
= true);
234 Stop the event from propagating to its parent window.
236 Returns the old propagation level value which may be later passed to
237 ResumePropagation() to allow propagating the event again.
239 int StopPropagation();
243 Indicates how many levels the event can propagate.
245 This member is protected and should typically only be set in the constructors
246 of the derived classes. It may be temporarily changed by StopPropagation()
247 and ResumePropagation() and tested with ShouldPropagate().
249 The initial value is set to either @c wxEVENT_PROPAGATE_NONE (by default)
250 meaning that the event shouldn't be propagated at all or to
251 @c wxEVENT_PROPAGATE_MAX (for command events) meaning that it should be
252 propagated as much as necessary.
254 Any positive number means that the event should be propagated but no more than
255 the given number of times. E.g. the propagation level may be set to 1 to
256 propagate the event to its parent only, but not to its grandparent.
258 int m_propagationLevel
;
262 @class wxEventBlocker
264 This class is a special event handler which allows to discard
265 any event (or a set of event types) directed to a specific window.
270 void MyWindow::DoSomething()
273 // block all events directed to this window while
274 // we do the 1000 FunctionWhichSendsEvents() calls
275 wxEventBlocker blocker(this);
277 for ( int i = 0; i 1000; i++ )
278 FunctionWhichSendsEvents(i);
280 } // ~wxEventBlocker called, old event handler is restored
282 // the event generated by this call will be processed:
283 FunctionWhichSendsEvents(0)
290 @see @ref overview_events_processing, wxEvtHandler
292 class wxEventBlocker
: public wxEvtHandler
296 Constructs the blocker for the given window and for the given event type.
298 If @a type is @c wxEVT_ANY, then all events for that window are blocked.
299 You can call Block() after creation to add other event types to the list
302 Note that the @a win window @b must remain alive until the
303 wxEventBlocker object destruction.
305 wxEventBlocker(wxWindow
* win
, wxEventType type
= -1);
308 Destructor. The blocker will remove itself from the chain of event handlers for
309 the window provided in the constructor, thus restoring normal processing of events.
311 virtual ~wxEventBlocker();
314 Adds to the list of event types which should be blocked the given @a eventType.
316 void Block(wxEventType eventType
);
322 Helper class to temporarily change an event to not propagate.
324 class wxPropagationDisabler
327 wxPropagationDisabler(wxEvent
& event
);
328 ~wxPropagationDisabler();
333 Helper class to temporarily lower propagation level.
335 class wxPropagateOnce
338 wxPropagateOnce(wxEvent
& event
);
347 A class that can handle events from the windowing system.
348 wxWindow is (and therefore all window classes are) derived from this class.
350 When events are received, wxEvtHandler invokes the method listed in the
351 event table using itself as the object. When using multiple inheritance
352 <b>it is imperative that the wxEvtHandler(-derived) class is the first
353 class inherited</b> such that the @c this pointer for the overall object
354 will be identical to the @c this pointer of the wxEvtHandler portion.
359 @see @ref overview_events_processing, wxEventBlocker, wxEventLoopBase
361 class wxEvtHandler
: public wxObject
, public wxTrackable
372 If the handler is part of a chain, the destructor will unlink itself
375 virtual ~wxEvtHandler();
379 @name Event queuing and processing
384 Queue event for a later processing.
386 This method is similar to ProcessEvent() but while the latter is
387 synchronous, i.e. the event is processed immediately, before the
388 function returns, this one is asynchronous and returns immediately
389 while the event will be processed at some later time (usually during
390 the next event loop iteration).
392 Another important difference is that this method takes ownership of the
393 @a event parameter, i.e. it will delete it itself. This implies that
394 the event should be allocated on the heap and that the pointer can't be
395 used any more after the function returns (as it can be deleted at any
398 QueueEvent() can be used for inter-thread communication from the worker
399 threads to the main thread, it is safe in the sense that it uses
400 locking internally and avoids the problem mentioned in AddPendingEvent()
401 documentation by ensuring that the @a event object is not used by the
402 calling thread any more. Care should still be taken to avoid that some
403 fields of this object are used by it, notably any wxString members of
404 the event object must not be shallow copies of another wxString object
405 as this would result in them still using the same string buffer behind
406 the scenes. For example:
408 void FunctionInAWorkerThread(const wxString& str)
410 wxCommandEvent* evt = new wxCommandEvent;
412 // NOT evt->SetString(str) as this would be a shallow copy
413 evt->SetString(str.c_str()); // make a deep copy
415 wxTheApp->QueueEvent( evt );
419 Note that you can use wxThreadEvent instead of wxCommandEvent
420 to avoid this problem:
422 void FunctionInAWorkerThread(const wxString& str)
427 // wxThreadEvent::Clone() makes sure that the internal wxString
428 // member is not shared by other wxString instances:
429 wxTheApp->QueueEvent( evt.Clone() );
433 Finally notice that this method automatically wakes up the event loop
434 if it is currently idle by calling ::wxWakeUpIdle() so there is no need
435 to do it manually when using it.
440 A heap-allocated event to be queued, QueueEvent() takes ownership
441 of it. This parameter shouldn't be @c NULL.
443 virtual void QueueEvent(wxEvent
*event
);
446 Post an event to be processed later.
448 This function is similar to QueueEvent() but can't be used to post
449 events from worker threads for the event objects with wxString fields
450 (i.e. in practice most of them) because of an unsafe use of the same
451 wxString object which happens because the wxString field in the
452 original @a event object and its copy made internally by this function
453 share the same string buffer internally. Use QueueEvent() to avoid
456 A copy of @a event is made by the function, so the original can be deleted
457 as soon as function returns (it is common that the original is created
458 on the stack). This requires that the wxEvent::Clone() method be
459 implemented by event so that it can be duplicated and stored until it
463 Event to add to the pending events queue.
465 virtual void AddPendingEvent(const wxEvent
& event
);
468 Processes an event, searching event tables and calling zero or more suitable
469 event handler function(s).
471 Normally, your application would not call this function: it is called in the
472 wxWidgets implementation to dispatch incoming user interface events to the
473 framework (and application).
475 However, you might need to call it if implementing new functionality
476 (such as a new control) where you define new event types, as opposed to
477 allowing the user to override virtual functions.
479 Notice that you don't usually need to override ProcessEvent() to
480 customize the event handling, overriding the specially provided
481 TryBefore() and TryAfter() functions is usually enough. For example,
482 wxMDIParentFrame may override TryBefore() to ensure that the menu
483 events are processed in the active child frame before being processed
484 in the parent frame itself.
486 The normal order of event table searching is as follows:
487 -# wxApp::FilterEvent() is called. If it returns anything but @c -1
488 (default) the processing stops here.
489 -# TryBefore() is called (this is where wxValidator are taken into
490 account for wxWindow objects). If this returns @true, the function exits.
491 -# If the object is disabled (via a call to wxEvtHandler::SetEvtHandlerEnabled)
492 the function skips to step (7).
493 -# Dynamic event table of the handlers bound using Bind<>() is
494 searched. If a handler is found, it is executed and the function
495 returns @true unless the handler used wxEvent::Skip() to indicate
496 that it didn't handle the event in which case the search continues.
497 -# Static events table of the handlers bound using event table
498 macros is searched for this event handler. If this fails, the base
499 class event table is tried, and so on until no more tables
500 exist or an appropriate function was found. If a handler is found,
501 the same logic as in the previous step applies.
502 -# The search is applied down the entire chain of event handlers (usually the
503 chain has a length of one). This chain can be formed using wxEvtHandler::SetNextHandler():
504 @image html overview_events_chain.png
505 (referring to the image, if @c A->ProcessEvent is called and it doesn't handle
506 the event, @c B->ProcessEvent will be called and so on...).
507 Note that in the case of wxWindow you can build a stack of event handlers
508 (see wxWindow::PushEventHandler() for more info).
509 If any of the handlers of the chain return @true, the function exits.
510 -# TryAfter() is called: for the wxWindow object this may propagate the
511 event to the window parent (recursively). If the event is still not
512 processed, ProcessEvent() on wxTheApp object is called as the last
515 Notice that steps (2)-(6) are performed in ProcessEventLocally()
516 which is called by this function.
521 @true if a suitable event handler function was found and executed,
522 and the function did not call wxEvent::Skip.
524 @see SearchEventTable()
526 virtual bool ProcessEvent(wxEvent
& event
);
529 Try to process the event in this handler and all those chained to it.
531 As explained in ProcessEvent() documentation, the event handlers may be
532 chained in a doubly-linked list. This function tries to process the
533 event in this handler (including performing any pre-processing done in
534 TryBefore(), e.g. applying validators) and all those following it in
535 the chain until the event is processed or the chain is exhausted.
537 This function is called from ProcessEvent() and, in turn, calls
538 TryThis() for each handler in turn. It is not virtual and so cannot be
539 overridden but can, and should, be called to forward an event to
540 another handler instead of ProcessEvent() which would result in a
541 duplicate call to TryAfter(), e.g. resulting in all unprocessed events
542 being sent to the application object multiple times.
549 @true if this handler of one of those chained to it processed the
552 bool ProcessEventLocally(wxEvent
& event
);
555 Processes an event by calling ProcessEvent() and handles any exceptions
556 that occur in the process.
557 If an exception is thrown in event handler, wxApp::OnExceptionInMainLoop is called.
562 @return @true if the event was processed, @false if no handler was found
563 or an exception was thrown.
565 @see wxWindow::HandleWindowEvent
567 bool SafelyProcessEvent(wxEvent
& event
);
570 Processes the pending events previously queued using QueueEvent() or
571 AddPendingEvent(); you must call this function only if you are sure
572 there are pending events for this handler, otherwise a @c wxCHECK
575 The real processing still happens in ProcessEvent() which is called by this
578 Note that this function needs a valid application object (see
579 wxAppConsole::GetInstance()) because wxApp holds the list of the event
580 handlers with pending events and this function manipulates that list.
582 void ProcessPendingEvents();
585 Deletes all events queued on this event handler using QueueEvent() or
588 Use with care because the events which are deleted are (obviously) not
589 processed and this may have unwanted consequences (e.g. user actions events
592 void DeletePendingEvents();
595 Searches the event table, executing an event handler function if an appropriate
599 Event table to be searched.
601 Event to be matched against an event table entry.
603 @return @true if a suitable event handler function was found and
604 executed, and the function did not call wxEvent::Skip.
606 @remarks This function looks through the object's event table and tries
607 to find an entry that will match the event.
608 An entry will match if:
609 @li The event type matches, and
610 @li the identifier or identifier range matches, or the event table
611 entry's identifier is zero.
613 If a suitable function is called but calls wxEvent::Skip, this
614 function will fail, and searching will continue.
616 @todo this function in the header is listed as an "implementation only" function;
617 are we sure we want to document it?
621 virtual bool SearchEventTable(wxEventTable
& table
,
628 @name Connecting and disconnecting
633 Connects the given function dynamically with the event handler, id and
636 Notice that Bind() provides a more flexible and safer way to do the
637 same thing as Connect(), please use it in any new code -- while
638 Connect() is not formally deprecated due to its existing widespread
639 usage, it has no advantages compared to Bind().
641 This is an alternative to the use of static event tables. It is more
642 flexible as it allows to connect events generated by some object to an
643 event handler defined in a different object of a different class (which
644 is impossible to do directly with the event tables -- the events can be
645 only handled in another object if they are propagated upwards to it).
646 Do make sure to specify the correct @a eventSink when connecting to an
647 event of a different object.
649 See @ref overview_events_bind for more detailed explanation
650 of this function and the @ref page_samples_event sample for usage
653 This specific overload allows you to connect an event handler to a @e range
655 Do not confuse @e source IDs with event @e types: source IDs identify the
656 event generator objects (typically wxMenuItem or wxWindow objects) while the
657 event @e type identify which type of events should be handled by the
658 given @e function (an event generator object may generate many different
662 The first ID of the identifier range to be associated with the event
665 The last ID of the identifier range to be associated with the event
668 The event type to be associated with this event handler.
670 The event handler function. Note that this function should
671 be explicitly converted to the correct type which can be done using a macro
672 called @c wxFooEventHandler for the handler for any @c wxFooEvent.
674 Data to be associated with the event table entry.
676 Object whose member function should be called. It must be specified
677 when connecting an event generated by one object to a member
678 function of a different object. If it is omitted, @c this is used.
681 In wxPerl this function takes 4 arguments: @a id, @a lastid,
682 @a type, @a method; if @a method is undef, the handler is
688 void Connect(int id
, int lastId
, wxEventType eventType
,
689 wxObjectEventFunction function
,
690 wxObject
* userData
= NULL
,
691 wxEvtHandler
* eventSink
= NULL
);
694 See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
695 overload for more info.
697 This overload can be used to attach an event handler to a single source ID:
701 frame->Connect( wxID_EXIT,
702 wxEVT_COMMAND_MENU_SELECTED,
703 wxCommandEventHandler(MyFrame::OnQuit) );
707 Not supported by wxPerl.
710 void Connect(int id
, wxEventType eventType
,
711 wxObjectEventFunction function
,
712 wxObject
* userData
= NULL
,
713 wxEvtHandler
* eventSink
= NULL
);
716 See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
717 overload for more info.
719 This overload will connect the given event handler so that regardless of the
720 ID of the event source, the handler will be called.
723 Not supported by wxPerl.
726 void Connect(wxEventType eventType
,
727 wxObjectEventFunction function
,
728 wxObject
* userData
= NULL
,
729 wxEvtHandler
* eventSink
= NULL
);
732 Disconnects the given function dynamically from the event handler, using the
733 specified parameters as search criteria and returning @true if a matching
734 function has been found and removed.
736 This method can only disconnect functions which have been added using the
737 Connect() method. There is no way to disconnect functions connected using
738 the (static) event tables.
741 The event type associated with this event handler.
743 The event handler function.
745 Data associated with the event table entry.
747 Object whose member function should be called.
750 Not supported by wxPerl.
753 bool Disconnect(wxEventType eventType
,
754 wxObjectEventFunction function
,
755 wxObject
* userData
= NULL
,
756 wxEvtHandler
* eventSink
= NULL
);
759 See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
760 overload for more info.
762 This overload takes the additional @a id parameter.
765 Not supported by wxPerl.
768 bool Disconnect(int id
= wxID_ANY
,
769 wxEventType eventType
= wxEVT_NULL
,
770 wxObjectEventFunction function
= NULL
,
771 wxObject
* userData
= NULL
,
772 wxEvtHandler
* eventSink
= NULL
);
775 See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
776 overload for more info.
778 This overload takes an additional range of source IDs.
781 In wxPerl this function takes 3 arguments: @a id,
785 bool Disconnect(int id
, int lastId
,
786 wxEventType eventType
,
787 wxObjectEventFunction function
= NULL
,
788 wxObject
* userData
= NULL
,
789 wxEvtHandler
* eventSink
= NULL
);
794 @name Binding and Unbinding
799 Binds the given function, functor or method dynamically with the event.
801 This offers basically the same functionality as Connect(), but it is
802 more flexible as it also allows you to use ordinary functions and
803 arbitrary functors as event handlers. It is also less restrictive then
804 Connect() because you can use an arbitrary method as an event handler,
805 whereas Connect() requires a wxEvtHandler derived handler.
807 See @ref overview_events_bind for more detailed explanation
808 of this function and the @ref page_samples_event sample for usage
812 The event type to be associated with this event handler.
814 The event handler functor. This can be an ordinary function but also
815 an arbitrary functor like boost::function<>.
817 The first ID of the identifier range to be associated with the event
820 The last ID of the identifier range to be associated with the event
823 Data to be associated with the event table entry.
825 @see @ref overview_cpp_rtti_disabled
829 template <typename EventTag
, typename Functor
>
830 void Bind(const EventTag
& eventType
,
833 int lastId
= wxID_ANY
,
834 wxObject
*userData
= NULL
);
837 See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for
840 This overload will bind the given method as the event handler.
843 The event type to be associated with this event handler.
845 The event handler method. This can be an arbitrary method (doesn't need
846 to be from a wxEvtHandler derived class).
848 Object whose method should be called. It must always be specified
849 so it can be checked at compile time whether the given method is an
850 actual member of the given handler.
852 The first ID of the identifier range to be associated with the event
855 The last ID of the identifier range to be associated with the event
858 Data to be associated with the event table entry.
860 @see @ref overview_cpp_rtti_disabled
864 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
865 void Bind(const EventTag
&eventType
,
866 void (Class::*method
)(EventArg
&),
867 EventHandler
*handler
,
869 int lastId
= wxID_ANY
,
870 wxObject
*userData
= NULL
);
872 Unbinds the given function, functor or method dynamically from the
873 event handler, using the specified parameters as search criteria and
874 returning @true if a matching function has been found and removed.
876 This method can only unbind functions, functors or methods which have
877 been added using the Bind<>() method. There is no way to unbind
878 functions bound using the (static) event tables.
881 The event type associated with this event handler.
883 The event handler functor. This can be an ordinary function but also
884 an arbitrary functor like boost::function<>.
886 The first ID of the identifier range associated with the event
889 The last ID of the identifier range associated with the event
892 Data associated with the event table entry.
894 @see @ref overview_cpp_rtti_disabled
898 template <typename EventTag
, typename Functor
>
899 bool Unbind(const EventTag
& eventType
,
902 int lastId
= wxID_ANY
,
903 wxObject
*userData
= NULL
);
906 See the Unbind<>(const EventTag&, Functor, int, int, wxObject*)
907 overload for more info.
909 This overload unbinds the given method from the event..
912 The event type associated with this event handler.
914 The event handler method associated with this event.
916 Object whose method was called.
918 The first ID of the identifier range associated with the event
921 The last ID of the identifier range associated with the event
924 Data associated with the event table entry.
926 @see @ref overview_cpp_rtti_disabled
930 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
931 bool Unbind(const EventTag
&eventType
,
932 void (Class::*method
)(EventArg
&),
933 EventHandler
*handler
,
935 int lastId
= wxID_ANY
,
936 wxObject
*userData
= NULL
);
939 @name User-supplied data
944 Returns user-supplied client data.
946 @remarks Normally, any extra data the programmer wishes to associate with
947 the object should be made available by deriving a new class with
952 void* GetClientData() const;
955 Returns a pointer to the user-supplied client data object.
957 @see SetClientObject(), wxClientData
959 wxClientData
* GetClientObject() const;
962 Sets user-supplied client data.
965 Data to be associated with the event handler.
967 @remarks Normally, any extra data the programmer wishes to associate
968 with the object should be made available by deriving a new
969 class with new data members. You must not call this method
970 and SetClientObject on the same class - only one of them.
974 void SetClientData(void* data
);
977 Set the client data object. Any previous object will be deleted.
979 @see GetClientObject(), wxClientData
981 void SetClientObject(wxClientData
* data
);
987 @name Event handler chaining
989 wxEvtHandler can be arranged in a double-linked list of handlers
990 which is automatically iterated by ProcessEvent() if needed.
995 Returns @true if the event handler is enabled, @false otherwise.
997 @see SetEvtHandlerEnabled()
999 bool GetEvtHandlerEnabled() const;
1002 Returns the pointer to the next handler in the chain.
1004 @see SetNextHandler(), GetPreviousHandler(), SetPreviousHandler(),
1005 wxWindow::PushEventHandler, wxWindow::PopEventHandler
1007 wxEvtHandler
* GetNextHandler() const;
1010 Returns the pointer to the previous handler in the chain.
1012 @see SetPreviousHandler(), GetNextHandler(), SetNextHandler(),
1013 wxWindow::PushEventHandler, wxWindow::PopEventHandler
1015 wxEvtHandler
* GetPreviousHandler() const;
1018 Enables or disables the event handler.
1021 @true if the event handler is to be enabled, @false if it is to be disabled.
1023 @remarks You can use this function to avoid having to remove the event
1024 handler from the chain, for example when implementing a
1025 dialog editor and changing from edit to test mode.
1027 @see GetEvtHandlerEnabled()
1029 void SetEvtHandlerEnabled(bool enabled
);
1032 Sets the pointer to the next handler.
1035 See ProcessEvent() for more info about how the chains of event handlers
1036 are internally used.
1037 Also remember that wxEvtHandler uses double-linked lists and thus if you
1038 use this function, you should also call SetPreviousHandler() on the
1039 argument passed to this function:
1041 handlerA->SetNextHandler(handlerB);
1042 handlerB->SetPreviousHandler(handlerA);
1046 The event handler to be set as the next handler.
1049 @see @ref overview_events_processing
1051 virtual void SetNextHandler(wxEvtHandler
* handler
);
1054 Sets the pointer to the previous handler.
1055 All remarks about SetNextHandler() apply to this function as well.
1058 The event handler to be set as the previous handler.
1061 @see @ref overview_events_processing
1063 virtual void SetPreviousHandler(wxEvtHandler
* handler
);
1066 Unlinks this event handler from the chain it's part of (if any);
1067 then links the "previous" event handler to the "next" one
1068 (so that the chain won't be interrupted).
1070 E.g. if before calling Unlink() you have the following chain:
1071 @image html evthandler_unlink_before.png
1072 then after calling @c B->Unlink() you'll have:
1073 @image html evthandler_unlink_after.png
1080 Returns @true if the next and the previous handler pointers of this
1081 event handler instance are @NULL.
1085 @see SetPreviousHandler(), SetNextHandler()
1087 bool IsUnlinked() const;
1092 @name Global event filters.
1094 Methods for working with the global list of event filters.
1096 Event filters can be defined to pre-process all the events that happen
1097 in an application, see wxEventFilter documentation for more information.
1102 Add an event filter whose FilterEvent() method will be called for each
1103 and every event processed by wxWidgets.
1105 The filters are called in LIFO order and wxApp is registered as an
1106 event filter by default. The pointer must remain valid until it's
1107 removed with RemoveFilter() and is not deleted by wxEvtHandler.
1111 static void AddFilter(wxEventFilter
* filter
);
1114 Remove a filter previously installed with AddFilter().
1116 It's an error to remove a filter that hadn't been previously added or
1117 was already removed.
1121 static void RemoveFilter(wxEventFilter
* filter
);
1127 Method called by ProcessEvent() before examining this object event
1130 This method can be overridden to hook into the event processing logic
1131 as early as possible. You should usually call the base class version
1132 when overriding this method, even if wxEvtHandler itself does nothing
1133 here, some derived classes do use this method, e.g. wxWindow implements
1134 support for wxValidator in it.
1138 class MyClass : public BaseClass // inheriting from wxEvtHandler
1142 virtual bool TryBefore(wxEvent& event)
1144 if ( MyPreProcess(event) )
1147 return BaseClass::TryBefore(event);
1154 virtual bool TryBefore(wxEvent
& event
);
1157 Try to process the event in this event handler.
1159 This method is called from ProcessEventLocally() and thus, indirectly,
1160 from ProcessEvent(), please see the detailed description of the event
1161 processing logic there.
1163 It is currently @em not virtual and so may not be overridden.
1170 @true if this object itself defines a handler for this event and
1171 the handler didn't skip the event.
1173 bool TryThis(wxEvent
& event
);
1176 Method called by ProcessEvent() as last resort.
1178 This method can be overridden to implement post-processing for the
1179 events which were not processed anywhere else.
1181 The base class version handles forwarding the unprocessed events to
1182 wxApp at wxEvtHandler level and propagating them upwards the window
1183 child-parent chain at wxWindow level and so should usually be called
1184 when overriding this method:
1186 class MyClass : public BaseClass // inheriting from wxEvtHandler
1190 virtual bool TryAfter(wxEvent& event)
1192 if ( BaseClass::TryAfter(event) )
1195 return MyPostProcess(event);
1202 virtual bool TryAfter(wxEvent
& event
);
1207 Flags for categories of keys.
1209 These values are used by wxKeyEvent::IsKeyInCategory(). They may be
1210 combined via the bitwise operators |, &, and ~.
1214 enum wxKeyCategoryFlags
1216 /// arrow keys, on and off numeric keypads
1219 /// page up and page down keys, on and off numeric keypads
1220 WXK_CATEGORY_PAGING
,
1222 /// home and end keys, on and off numeric keypads
1225 /// tab key, on and off numeric keypads
1228 /// backspace and delete keys, on and off numeric keypads
1231 /// union of WXK_CATEGORY_ARROW, WXK_CATEGORY_PAGING, and WXK_CATEGORY_JUMP categories
1232 WXK_CATEGORY_NAVIGATION
1239 This event class contains information about key press and release events.
1241 The main information carried by this event is the key being pressed or
1242 released. It can be accessed using either GetKeyCode() function or
1243 GetUnicodeKey(). For the printable characters, the latter should be used as
1244 it works for any keys, including non-Latin-1 characters that can be entered
1245 when using national keyboard layouts. GetKeyCode() should be used to handle
1246 special characters (such as cursor arrows keys or @c HOME or @c INS and so
1247 on) which correspond to ::wxKeyCode enum elements above the @c WXK_START
1248 constant. While GetKeyCode() also returns the character code for Latin-1
1249 keys for compatibility, it doesn't work for Unicode characters in general
1250 and will return @c WXK_NONE for any non-Latin-1 ones. For this reason, it's
1251 recommended to always use GetUnicodeKey() and only fall back to GetKeyCode()
1252 if GetUnicodeKey() returned @c WXK_NONE meaning that the event corresponds
1253 to a non-printable special keys.
1255 While both of these functions can be used with the events of @c
1256 wxEVT_KEY_DOWN, @c wxEVT_KEY_UP and @c wxEVT_CHAR types, the values
1257 returned by them are different for the first two events and the last one.
1258 For the latter, the key returned corresponds to the character that would
1259 appear in e.g. a text zone if the user pressed the key in it. As such, its
1260 value depends on the current state of the Shift key and, for the letters,
1261 on the state of Caps Lock modifier. For example, if @c A key is pressed
1262 without Shift being held down, wxKeyEvent of type @c wxEVT_CHAR generated
1263 for this key press will return (from either GetKeyCode() or GetUnicodeKey()
1264 as their meanings coincide for ASCII characters) key code of 97
1265 corresponding the ASCII value of @c a. And if the same key is pressed but
1266 with Shift being held (or Caps Lock being active), then the key could would
1267 be 65, i.e. ASCII value of capital @c A.
1269 However for the key down and up events the returned key code will instead
1270 be @c A independently of the state of the modifier keys i.e. it depends
1271 only on physical key being pressed and is not translated to its logical
1272 representation using the current keyboard state. Such untranslated key
1273 codes are defined as follows:
1274 - For the letters they correspond to the @e upper case value of the
1276 - For the other alphanumeric keys (e.g. @c 7 or @c +), the untranslated
1277 key code corresponds to the character produced by the key when it is
1278 pressed without Shift. E.g. in standard US keyboard layout the
1279 untranslated key code for the key @c =/+ in the upper right corner of
1280 the keyboard is 61 which is the ASCII value of @c =.
1281 - For the rest of the keys (i.e. special non-printable keys) it is the
1282 same as the normal key code as no translation is used anyhow.
1284 Notice that the first rule applies to all Unicode letters, not just the
1285 usual Latin-1 ones. However for non-Latin-1 letters only GetUnicodeKey()
1286 can be used to retrieve the key code as GetKeyCode() just returns @c
1287 WXK_NONE in this case.
1289 To summarize: you should handle @c wxEVT_CHAR if you need the translated
1290 key and @c wxEVT_KEY_DOWN if you only need the value of the key itself,
1291 independent of the current keyboard state.
1293 @note Not all key down events may be generated by the user. As an example,
1294 @c wxEVT_KEY_DOWN with @c = key code can be generated using the
1295 standard US keyboard layout but not using the German one because the @c
1296 = key corresponds to Shift-0 key combination in this layout and the key
1297 code for it is @c 0, not @c =. Because of this you should avoid
1298 requiring your users to type key events that might be impossible to
1299 enter on their keyboard.
1302 Another difference between key and char events is that another kind of
1303 translation is done for the latter ones when the Control key is pressed:
1304 char events for ASCII letters in this case carry codes corresponding to the
1305 ASCII value of Ctrl-Latter, i.e. 1 for Ctrl-A, 2 for Ctrl-B and so on until
1306 26 for Ctrl-Z. This is convenient for terminal-like applications and can be
1307 completely ignored by all the other ones (if you need to handle Ctrl-A it
1308 is probably a better idea to use the key event rather than the char one).
1309 Notice that currently no translation is done for the presses of @c [, @c
1310 \\, @c ], @c ^ and @c _ keys which might be mapped to ASCII values from 27
1312 Since version 2.9.2, the enum values @c WXK_CONTROL_A - @c WXK_CONTROL_Z
1313 can be used instead of the non-descriptive constant values 1-26.
1315 Finally, modifier keys only generate key events but no char events at all.
1316 The modifiers keys are @c WXK_SHIFT, @c WXK_CONTROL, @c WXK_ALT and various
1317 @c WXK_WINDOWS_XXX from ::wxKeyCode enum.
1319 Modifier keys events are special in one additional aspect: usually the
1320 keyboard state associated with a key press is well defined, e.g.
1321 wxKeyboardState::ShiftDown() returns @c true only if the Shift key was held
1322 pressed when the key that generated this event itself was pressed. There is
1323 an ambiguity for the key press events for Shift key itself however. By
1324 convention, it is considered to be already pressed when it is pressed and
1325 already released when it is released. In other words, @c wxEVT_KEY_DOWN
1326 event for the Shift key itself will have @c wxMOD_SHIFT in GetModifiers()
1327 and ShiftDown() will return true while the @c wxEVT_KEY_UP event for Shift
1328 itself will not have @c wxMOD_SHIFT in its modifiers and ShiftDown() will
1332 @b Tip: You may discover the key codes and modifiers generated by all the
1333 keys on your system interactively by running the @ref
1334 page_samples_keyboard wxWidgets sample and pressing some keys in it.
1336 @note If a key down (@c EVT_KEY_DOWN) event is caught and the event handler
1337 does not call @c event.Skip() then the corresponding char event
1338 (@c EVT_CHAR) will not happen. This is by design and enables the
1339 programs that handle both types of events to avoid processing the
1340 same key twice. As a consequence, if you do not want to suppress the
1341 @c wxEVT_CHAR events for the keys you handle, always call @c
1342 event.Skip() in your @c wxEVT_KEY_DOWN handler. Not doing may also
1343 prevent accelerators defined using this key from working.
1345 @note If a key is maintained in a pressed state, you will typically get a
1346 lot of (automatically generated) key down events but only one key up
1347 one at the end when the key is released so it is wrong to assume that
1348 there is one up event corresponding to each down one.
1350 @note For Windows programmers: The key and char events in wxWidgets are
1351 similar to but slightly different from Windows @c WM_KEYDOWN and
1352 @c WM_CHAR events. In particular, Alt-x combination will generate a
1353 char event in wxWidgets (unless it is used as an accelerator) and
1354 almost all keys, including ones without ASCII equivalents, generate
1358 @beginEventTable{wxKeyEvent}
1359 @event{EVT_KEY_DOWN(func)}
1360 Process a @c wxEVT_KEY_DOWN event (any key has been pressed). If this
1361 event is handled and not skipped, @c wxEVT_CHAR will not be generated
1362 at all for this key press (but @c wxEVT_KEY_UP will be).
1363 @event{EVT_KEY_UP(func)}
1364 Process a @c wxEVT_KEY_UP event (any key has been released).
1365 @event{EVT_CHAR(func)}
1366 Process a @c wxEVT_CHAR event.
1367 @event{EVT_CHAR_HOOK(func)}
1368 Process a @c wxEVT_CHAR_HOOK event. Unlike all the other key events,
1369 this event is propagated upwards the window hierarchy which allows
1370 intercepting it in the parent window of the focused window to which it
1371 is sent initially (if there is no focused window, this event is sent to
1372 the wxApp global object). It is also generated before any other key
1373 events and so gives the parent window an opportunity to modify the
1374 keyboard handling of its children, e.g. it is used internally by
1375 wxWidgets in some ports to intercept pressing Esc key in any child of a
1376 dialog to close the dialog itself when it's pressed. By default, if
1377 this event is handled, i.e. the handler doesn't call wxEvent::Skip(),
1378 neither @c wxEVT_KEY_DOWN nor @c wxEVT_CHAR events will be generated
1379 (although @c wxEVT_KEY_UP still will be), i.e. it replaces the normal
1380 key events. However by calling the special DoAllowNextEvent() method
1381 you can handle @c wxEVT_CHAR_HOOK and still allow normal events
1382 generation. This is something that is rarely useful but can be required
1383 if you need to prevent a parent @c wxEVT_CHAR_HOOK handler from running
1384 without suppressing the normal key events. Finally notice that this
1385 event is not generated when the mouse is captured as it is considered
1386 that the window which has the capture should receive all the keyboard
1387 events too without allowing its parent wxTopLevelWindow to interfere
1388 with their processing.
1391 @see wxKeyboardState
1396 class wxKeyEvent
: public wxEvent
,
1397 public wxKeyboardState
1402 Currently, the only valid event types are @c wxEVT_CHAR and @c wxEVT_CHAR_HOOK.
1404 wxKeyEvent(wxEventType keyEventType
= wxEVT_NULL
);
1407 Returns the key code of the key that generated this event.
1409 ASCII symbols return normal ASCII values, while events from special
1410 keys such as "left cursor arrow" (@c WXK_LEFT) return values outside of
1411 the ASCII range. See ::wxKeyCode for a full list of the virtual key
1414 Note that this method returns a meaningful value only for special
1415 non-alphanumeric keys or if the user entered a character that can be
1416 represented in current locale's default charset. Otherwise, e.g. if the
1417 user enters a Japanese character in a program not using Japanese
1418 locale, this method returns @c WXK_NONE and GetUnicodeKey() should be
1419 used to obtain the corresponding Unicode character.
1421 Using GetUnicodeKey() is in general the right thing to do if you are
1422 interested in the characters typed by the user, GetKeyCode() should be
1423 only used for special keys (for which GetUnicodeKey() returns @c
1424 WXK_NONE). To handle both kinds of keys you might write:
1426 void MyHandler::OnChar(wxKeyEvent& event)
1428 if ( event.GetUnicodeKey() != WXK_NONE )
1430 // It's a printable character
1431 wxLogMessage("You pressed '%c'", event.GetUnicodeKey());
1435 // It's a special key, deal with all the known ones:
1451 int GetKeyCode() const;
1454 Returns true if the key is in the given key category.
1457 A bitwise combination of named ::wxKeyCategoryFlags constants.
1461 bool IsKeyInCategory(int category
) const;
1465 Obtains the position (in client coordinates) at which the key was pressed.
1467 wxPoint
GetPosition() const;
1468 void GetPosition(long* x
, long* y
) const;
1472 Returns the raw key code for this event.
1474 The flags are platform-dependent and should only be used if the
1475 functionality provided by other wxKeyEvent methods is insufficient.
1477 Under MSW, the raw key code is the value of @c wParam parameter of the
1478 corresponding message.
1480 Under GTK, the raw key code is the @c keyval field of the corresponding
1483 Under OS X, the raw key code is the @c keyCode field of the
1484 corresponding NSEvent.
1486 @note Currently the raw key codes are not supported by all ports, use
1487 @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
1489 wxUint32
GetRawKeyCode() const;
1492 Returns the low level key flags for this event.
1494 The flags are platform-dependent and should only be used if the
1495 functionality provided by other wxKeyEvent methods is insufficient.
1497 Under MSW, the raw flags are just the value of @c lParam parameter of
1498 the corresponding message.
1500 Under GTK, the raw flags contain the @c hardware_keycode field of the
1501 corresponding GDK event.
1503 Under OS X, the raw flags contain the modifiers state.
1505 @note Currently the raw key flags are not supported by all ports, use
1506 @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
1508 wxUint32
GetRawKeyFlags() const;
1511 Returns the Unicode character corresponding to this key event.
1513 If the key pressed doesn't have any character value (e.g. a cursor key)
1514 this method will return @c WXK_NONE. In this case you should use
1515 GetKeyCode() to retrieve the value of the key.
1517 This function is only available in Unicode build, i.e. when
1518 @c wxUSE_UNICODE is 1.
1520 wxChar
GetUnicodeKey() const;
1523 Returns the X position (in client coordinates) of the event.
1525 wxCoord
GetX() const;
1528 Returns the Y position (in client coordinates) of the event.
1530 wxCoord
GetY() const;
1533 Allow normal key events generation.
1535 Can be called from @c wxEVT_CHAR_HOOK handler to indicate that the
1536 generation of normal events should @em not be suppressed, as it happens
1537 by default when this event is handled.
1539 The intended use of this method is to allow some window object to
1540 prevent @c wxEVT_CHAR_HOOK handler in its parent window from running by
1541 defining its own handler for this event. Without calling this method,
1542 this would result in not generating @c wxEVT_KEY_DOWN nor @c wxEVT_CHAR
1543 events at all but by calling it you can ensure that these events would
1544 still be generated, even if @c wxEVT_CHAR_HOOK event was handled.
1548 void DoAllowNextEvent();
1551 Returns @true if DoAllowNextEvent() had been called, @false by default.
1553 This method is used by wxWidgets itself to determine whether the normal
1554 key events should be generated after @c wxEVT_CHAR_HOOK processing.
1558 bool IsNextEventAllowed() const;
1569 // Which button is down?
1572 wxJOY_BUTTON_ANY
= -1,
1581 @class wxJoystickEvent
1583 This event class contains information about joystick events, particularly
1584 events received by windows.
1586 @beginEventTable{wxJoystickEvent}
1587 @event{EVT_JOY_BUTTON_DOWN(func)}
1588 Process a @c wxEVT_JOY_BUTTON_DOWN event.
1589 @event{EVT_JOY_BUTTON_UP(func)}
1590 Process a @c wxEVT_JOY_BUTTON_UP event.
1591 @event{EVT_JOY_MOVE(func)}
1592 Process a @c wxEVT_JOY_MOVE event.
1593 @event{EVT_JOY_ZMOVE(func)}
1594 Process a @c wxEVT_JOY_ZMOVE event.
1595 @event{EVT_JOYSTICK_EVENTS(func)}
1596 Processes all joystick events.
1604 class wxJoystickEvent
: public wxEvent
1610 wxJoystickEvent(wxEventType eventType
= wxEVT_NULL
, int state
= 0,
1611 int joystick
= wxJOYSTICK1
,
1615 Returns @true if the event was a down event from the specified button
1619 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1620 indicate any button down event.
1622 bool ButtonDown(int button
= wxJOY_BUTTON_ANY
) const;
1625 Returns @true if the specified button (or any button) was in a down state.
1628 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1629 indicate any button down event.
1631 bool ButtonIsDown(int button
= wxJOY_BUTTON_ANY
) const;
1634 Returns @true if the event was an up event from the specified button
1638 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1639 indicate any button down event.
1641 bool ButtonUp(int button
= wxJOY_BUTTON_ANY
) const;
1644 Returns the identifier of the button changing state.
1646 This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
1648 int GetButtonChange() const;
1651 Returns the down state of the buttons.
1653 This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
1655 int GetButtonState() const;
1658 Returns the identifier of the joystick generating the event - one of
1659 wxJOYSTICK1 and wxJOYSTICK2.
1661 int GetJoystick() const;
1664 Returns the x, y position of the joystick event.
1666 These coordinates are valid for all the events except wxEVT_JOY_ZMOVE.
1668 wxPoint
GetPosition() const;
1671 Returns the z position of the joystick event.
1673 This method can only be used for wxEVT_JOY_ZMOVE events.
1675 int GetZPosition() const;
1678 Returns @true if this was a button up or down event
1679 (@e not 'is any button down?').
1681 bool IsButton() const;
1684 Returns @true if this was an x, y move event.
1686 bool IsMove() const;
1689 Returns @true if this was a z move event.
1691 bool IsZMove() const;
1697 @class wxScrollWinEvent
1699 A scroll event holds information about events sent from scrolling windows.
1701 Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events
1702 from the receiving window.
1704 @beginEventTable{wxScrollWinEvent}
1705 @event{EVT_SCROLLWIN(func)}
1706 Process all scroll events.
1707 @event{EVT_SCROLLWIN_TOP(func)}
1708 Process @c wxEVT_SCROLLWIN_TOP scroll-to-top events.
1709 @event{EVT_SCROLLWIN_BOTTOM(func)}
1710 Process @c wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
1711 @event{EVT_SCROLLWIN_LINEUP(func)}
1712 Process @c wxEVT_SCROLLWIN_LINEUP line up events.
1713 @event{EVT_SCROLLWIN_LINEDOWN(func)}
1714 Process @c wxEVT_SCROLLWIN_LINEDOWN line down events.
1715 @event{EVT_SCROLLWIN_PAGEUP(func)}
1716 Process @c wxEVT_SCROLLWIN_PAGEUP page up events.
1717 @event{EVT_SCROLLWIN_PAGEDOWN(func)}
1718 Process @c wxEVT_SCROLLWIN_PAGEDOWN page down events.
1719 @event{EVT_SCROLLWIN_THUMBTRACK(func)}
1720 Process @c wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
1721 (frequent events sent as the user drags the thumbtrack).
1722 @event{EVT_SCROLLWIN_THUMBRELEASE(func)}
1723 Process @c wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
1730 @see wxScrollEvent, @ref overview_events
1732 class wxScrollWinEvent
: public wxEvent
1738 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
, int pos
= 0,
1739 int orientation
= 0);
1742 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
1745 @todo wxHORIZONTAL and wxVERTICAL should go in their own enum
1747 int GetOrientation() const;
1750 Returns the position of the scrollbar for the thumb track and release events.
1752 Note that this field can't be used for the other events, you need to query
1753 the window itself for the current position in that case.
1755 int GetPosition() const;
1757 void SetOrientation(int orient
);
1758 void SetPosition(int pos
);
1764 @class wxSysColourChangedEvent
1766 This class is used for system colour change events, which are generated
1767 when the user changes the colour settings using the control panel.
1768 This is only appropriate under Windows.
1771 The default event handler for this event propagates the event to child windows,
1772 since Windows only sends the events to top-level windows.
1773 If intercepting this event for a top-level window, remember to call the base
1774 class handler, or to pass the event on to the window's children explicitly.
1776 @beginEventTable{wxSysColourChangedEvent}
1777 @event{EVT_SYS_COLOUR_CHANGED(func)}
1778 Process a @c wxEVT_SYS_COLOUR_CHANGED event.
1784 @see @ref overview_events
1786 class wxSysColourChangedEvent
: public wxEvent
1792 wxSysColourChangedEvent();
1798 @class wxWindowCreateEvent
1800 This event is sent just after the actual window associated with a wxWindow
1801 object has been created.
1803 Since it is derived from wxCommandEvent, the event propagates up
1804 the window hierarchy.
1806 @beginEventTable{wxWindowCreateEvent}
1807 @event{EVT_WINDOW_CREATE(func)}
1808 Process a @c wxEVT_CREATE event.
1814 @see @ref overview_events, wxWindowDestroyEvent
1816 class wxWindowCreateEvent
: public wxCommandEvent
1822 wxWindowCreateEvent(wxWindow
* win
= NULL
);
1824 /// Return the window being created.
1825 wxWindow
*GetWindow() const;
1833 A paint event is sent when a window's contents needs to be repainted.
1835 The handler of this event must create a wxPaintDC object and use it for
1836 painting the window contents. For example:
1838 void MyWindow::OnPaint(wxPaintEvent& event)
1846 Notice that you must @e not create other kinds of wxDC (e.g. wxClientDC or
1847 wxWindowDC) in EVT_PAINT handlers and also don't create wxPaintDC outside
1848 of this event handlers.
1851 You can optimize painting by retrieving the rectangles that have been damaged
1852 and only repainting these. The rectangles are in terms of the client area,
1853 and are unscrolled, so you will need to do some calculations using the current
1854 view position to obtain logical, scrolled units.
1855 Here is an example of using the wxRegionIterator class:
1857 // Called when window needs to be repainted.
1858 void MyWindow::OnPaint(wxPaintEvent& event)
1862 // Find Out where the window is scrolled to
1863 int vbX,vbY; // Top left corner of client
1864 GetViewStart(&vbX,&vbY);
1866 int vX,vY,vW,vH; // Dimensions of client area in pixels
1867 wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
1876 // Alternatively we can do this:
1877 // wxRect rect(upd.GetRect());
1879 // Repaint this rectangle
1888 Please notice that in general it is impossible to change the drawing of a
1889 standard control (such as wxButton) and so you shouldn't attempt to handle
1890 paint events for them as even if it might work on some platforms, this is
1891 inherently not portable and won't work everywhere.
1894 @beginEventTable{wxPaintEvent}
1895 @event{EVT_PAINT(func)}
1896 Process a @c wxEVT_PAINT event.
1902 @see @ref overview_events
1904 class wxPaintEvent
: public wxEvent
1910 wxPaintEvent(int id
= 0);
1916 @class wxMaximizeEvent
1918 An event being sent when a top level window is maximized. Notice that it is
1919 not sent when the window is restored to its original size after it had been
1920 maximized, only a normal wxSizeEvent is generated in this case.
1922 Currently this event is only generated in wxMSW, wxGTK, wxOSX/Cocoa and wxOS2
1923 ports so portable programs should only rely on receiving @c wxEVT_SIZE and
1924 not necessarily this event when the window is maximized.
1926 @beginEventTable{wxMaximizeEvent}
1927 @event{EVT_MAXIMIZE(func)}
1928 Process a @c wxEVT_MAXIMIZE event.
1934 @see @ref overview_events, wxTopLevelWindow::Maximize,
1935 wxTopLevelWindow::IsMaximized
1937 class wxMaximizeEvent
: public wxEvent
1941 Constructor. Only used by wxWidgets internally.
1943 wxMaximizeEvent(int id
= 0);
1947 The possibles modes to pass to wxUpdateUIEvent::SetMode().
1951 /** Send UI update events to all windows. */
1952 wxUPDATE_UI_PROCESS_ALL
,
1954 /** Send UI update events to windows that have
1955 the wxWS_EX_PROCESS_UI_UPDATES flag specified. */
1956 wxUPDATE_UI_PROCESS_SPECIFIED
1961 @class wxUpdateUIEvent
1963 This class is used for pseudo-events which are called by wxWidgets
1964 to give an application the chance to update various user interface elements.
1966 Without update UI events, an application has to work hard to check/uncheck,
1967 enable/disable, show/hide, and set the text for elements such as menu items
1968 and toolbar buttons. The code for doing this has to be mixed up with the code
1969 that is invoked when an action is invoked for a menu item or button.
1971 With update UI events, you define an event handler to look at the state of the
1972 application and change UI elements accordingly. wxWidgets will call your member
1973 functions in idle time, so you don't have to worry where to call this code.
1975 In addition to being a clearer and more declarative method, it also means you don't
1976 have to worry whether you're updating a toolbar or menubar identifier. The same
1977 handler can update a menu item and toolbar button, if the identifier is the same.
1978 Instead of directly manipulating the menu or button, you call functions in the event
1979 object, such as wxUpdateUIEvent::Check. wxWidgets will determine whether such a
1980 call has been made, and which UI element to update.
1982 These events will work for popup menus as well as menubars. Just before a menu is
1983 popped up, wxMenu::UpdateUI is called to process any UI events for the window that
1986 If you find that the overhead of UI update processing is affecting your application,
1987 you can do one or both of the following:
1988 @li Call wxUpdateUIEvent::SetMode with a value of wxUPDATE_UI_PROCESS_SPECIFIED,
1989 and set the extra style wxWS_EX_PROCESS_UI_UPDATES for every window that should
1990 receive update events. No other windows will receive update events.
1991 @li Call wxUpdateUIEvent::SetUpdateInterval with a millisecond value to set the delay
1992 between updates. You may need to call wxWindow::UpdateWindowUI at critical points,
1993 for example when a dialog is about to be shown, in case the user sees a slight
1994 delay before windows are updated.
1996 Note that although events are sent in idle time, defining a wxIdleEvent handler
1997 for a window does not affect this because the events are sent from wxWindow::OnInternalIdle
1998 which is always called in idle time.
2000 wxWidgets tries to optimize update events on some platforms.
2001 On Windows and GTK+, events for menubar items are only sent when the menu is about
2002 to be shown, and not in idle time.
2005 @beginEventTable{wxUpdateUIEvent}
2006 @event{EVT_UPDATE_UI(id, func)}
2007 Process a @c wxEVT_UPDATE_UI event for the command with the given id.
2008 @event{EVT_UPDATE_UI_RANGE(id1, id2, func)}
2009 Process a @c wxEVT_UPDATE_UI event for any command with id included in the given range.
2015 @see @ref overview_events
2017 class wxUpdateUIEvent
: public wxCommandEvent
2023 wxUpdateUIEvent(wxWindowID commandId
= 0);
2026 Returns @true if it is appropriate to update (send UI update events to)
2029 This function looks at the mode used (see wxUpdateUIEvent::SetMode),
2030 the wxWS_EX_PROCESS_UI_UPDATES flag in @a window, the time update events
2031 were last sent in idle time, and the update interval, to determine whether
2032 events should be sent to this window now. By default this will always
2033 return @true because the update mode is initially wxUPDATE_UI_PROCESS_ALL
2034 and the interval is set to 0; so update events will be sent as often as
2035 possible. You can reduce the frequency that events are sent by changing the
2036 mode and/or setting an update interval.
2038 @see ResetUpdateTime(), SetUpdateInterval(), SetMode()
2040 static bool CanUpdate(wxWindow
* window
);
2043 Check or uncheck the UI element.
2045 void Check(bool check
);
2048 Enable or disable the UI element.
2050 void Enable(bool enable
);
2053 Returns @true if the UI element should be checked.
2055 bool GetChecked() const;
2058 Returns @true if the UI element should be enabled.
2060 bool GetEnabled() const;
2063 Static function returning a value specifying how wxWidgets will send update
2064 events: to all windows, or only to those which specify that they will process
2069 static wxUpdateUIMode
GetMode();
2072 Returns @true if the application has called Check().
2073 For wxWidgets internal use only.
2075 bool GetSetChecked() const;
2078 Returns @true if the application has called Enable().
2079 For wxWidgets internal use only.
2081 bool GetSetEnabled() const;
2084 Returns @true if the application has called Show().
2085 For wxWidgets internal use only.
2087 bool GetSetShown() const;
2090 Returns @true if the application has called SetText().
2091 For wxWidgets internal use only.
2093 bool GetSetText() const;
2096 Returns @true if the UI element should be shown.
2098 bool GetShown() const;
2101 Returns the text that should be set for the UI element.
2103 wxString
GetText() const;
2106 Returns the current interval between updates in milliseconds.
2107 The value -1 disables updates, 0 updates as frequently as possible.
2109 @see SetUpdateInterval().
2111 static long GetUpdateInterval();
2114 Used internally to reset the last-updated time to the current time.
2116 It is assumed that update events are normally sent in idle time, so this
2117 is called at the end of idle processing.
2119 @see CanUpdate(), SetUpdateInterval(), SetMode()
2121 static void ResetUpdateTime();
2124 Specify how wxWidgets will send update events: to all windows, or only to
2125 those which specify that they will process the events.
2128 this parameter may be one of the ::wxUpdateUIMode enumeration values.
2129 The default mode is wxUPDATE_UI_PROCESS_ALL.
2131 static void SetMode(wxUpdateUIMode mode
);
2134 Sets the text for this UI element.
2136 void SetText(const wxString
& text
);
2139 Sets the interval between updates in milliseconds.
2141 Set to -1 to disable updates, or to 0 to update as frequently as possible.
2144 Use this to reduce the overhead of UI update events if your application
2145 has a lot of windows. If you set the value to -1 or greater than 0,
2146 you may also need to call wxWindow::UpdateWindowUI at appropriate points
2147 in your application, such as when a dialog is about to be shown.
2149 static void SetUpdateInterval(long updateInterval
);
2152 Show or hide the UI element.
2154 void Show(bool show
);
2160 @class wxClipboardTextEvent
2162 This class represents the events generated by a control (typically a
2163 wxTextCtrl but other windows can generate these events as well) when its
2164 content gets copied or cut to, or pasted from the clipboard.
2166 There are three types of corresponding events @c wxEVT_COMMAND_TEXT_COPY,
2167 @c wxEVT_COMMAND_TEXT_CUT and @c wxEVT_COMMAND_TEXT_PASTE.
2169 If any of these events is processed (without being skipped) by an event
2170 handler, the corresponding operation doesn't take place which allows to
2171 prevent the text from being copied from or pasted to a control. It is also
2172 possible to examine the clipboard contents in the PASTE event handler and
2173 transform it in some way before inserting in a control -- for example,
2174 changing its case or removing invalid characters.
2176 Finally notice that a CUT event is always preceded by the COPY event which
2177 makes it possible to only process the latter if it doesn't matter if the
2178 text was copied or cut.
2181 These events are currently only generated by wxTextCtrl under GTK+.
2182 They are generated by all controls under Windows.
2184 @beginEventTable{wxClipboardTextEvent}
2185 @event{EVT_TEXT_COPY(id, func)}
2186 Some or all of the controls content was copied to the clipboard.
2187 @event{EVT_TEXT_CUT(id, func)}
2188 Some or all of the controls content was cut (i.e. copied and
2190 @event{EVT_TEXT_PASTE(id, func)}
2191 Clipboard content was pasted into the control.
2200 class wxClipboardTextEvent
: public wxCommandEvent
2206 wxClipboardTextEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0);
2214 This event class contains information about the events generated by the mouse:
2215 they include mouse buttons press and release events and mouse move events.
2217 All mouse events involving the buttons use @c wxMOUSE_BTN_LEFT for the
2218 left mouse button, @c wxMOUSE_BTN_MIDDLE for the middle one and
2219 @c wxMOUSE_BTN_RIGHT for the right one. And if the system supports more
2220 buttons, the @c wxMOUSE_BTN_AUX1 and @c wxMOUSE_BTN_AUX2 events
2221 can also be generated. Note that not all mice have even a middle button so a
2222 portable application should avoid relying on the events from it (but the right
2223 button click can be emulated using the left mouse button with the control key
2224 under Mac platforms with a single button mouse).
2226 For the @c wxEVT_ENTER_WINDOW and @c wxEVT_LEAVE_WINDOW events
2227 purposes, the mouse is considered to be inside the window if it is in the
2228 window client area and not inside one of its children. In other words, the
2229 parent window receives @c wxEVT_LEAVE_WINDOW event not only when the
2230 mouse leaves the window entirely but also when it enters one of its children.
2232 The position associated with a mouse event is expressed in the window
2233 coordinates of the window which generated the event, you can use
2234 wxWindow::ClientToScreen() to convert it to screen coordinates and possibly
2235 call wxWindow::ScreenToClient() next to convert it to window coordinates of
2238 @note Note that under Windows CE mouse enter and leave events are not natively
2239 supported by the system but are generated by wxWidgets itself. This has several
2240 drawbacks: the LEAVE_WINDOW event might be received some time after the mouse
2241 left the window and the state variables for it may have changed during this time.
2243 @note Note the difference between methods like wxMouseEvent::LeftDown and
2244 the inherited wxMouseState::LeftIsDown: the former returns @true when
2245 the event corresponds to the left mouse button click while the latter
2246 returns @true if the left mouse button is currently being pressed.
2247 For example, when the user is dragging the mouse you can use
2248 wxMouseEvent::LeftIsDown to test whether the left mouse button is
2249 (still) depressed. Also, by convention, if wxMouseEvent::LeftDown
2250 returns @true, wxMouseEvent::LeftIsDown will also return @true in
2251 wxWidgets whatever the underlying GUI behaviour is (which is
2252 platform-dependent). The same applies, of course, to other mouse
2256 @beginEventTable{wxMouseEvent}
2257 @event{EVT_LEFT_DOWN(func)}
2258 Process a @c wxEVT_LEFT_DOWN event. The handler of this event should normally
2259 call event.Skip() to allow the default processing to take place as otherwise
2260 the window under mouse wouldn't get the focus.
2261 @event{EVT_LEFT_UP(func)}
2262 Process a @c wxEVT_LEFT_UP event.
2263 @event{EVT_LEFT_DCLICK(func)}
2264 Process a @c wxEVT_LEFT_DCLICK event.
2265 @event{EVT_MIDDLE_DOWN(func)}
2266 Process a @c wxEVT_MIDDLE_DOWN event.
2267 @event{EVT_MIDDLE_UP(func)}
2268 Process a @c wxEVT_MIDDLE_UP event.
2269 @event{EVT_MIDDLE_DCLICK(func)}
2270 Process a @c wxEVT_MIDDLE_DCLICK event.
2271 @event{EVT_RIGHT_DOWN(func)}
2272 Process a @c wxEVT_RIGHT_DOWN event.
2273 @event{EVT_RIGHT_UP(func)}
2274 Process a @c wxEVT_RIGHT_UP event.
2275 @event{EVT_RIGHT_DCLICK(func)}
2276 Process a @c wxEVT_RIGHT_DCLICK event.
2277 @event{EVT_MOUSE_AUX1_DOWN(func)}
2278 Process a @c wxEVT_AUX1_DOWN event.
2279 @event{EVT_MOUSE_AUX1_UP(func)}
2280 Process a @c wxEVT_AUX1_UP event.
2281 @event{EVT_MOUSE_AUX1_DCLICK(func)}
2282 Process a @c wxEVT_AUX1_DCLICK event.
2283 @event{EVT_MOUSE_AUX2_DOWN(func)}
2284 Process a @c wxEVT_AUX2_DOWN event.
2285 @event{EVT_MOUSE_AUX2_UP(func)}
2286 Process a @c wxEVT_AUX2_UP event.
2287 @event{EVT_MOUSE_AUX2_DCLICK(func)}
2288 Process a @c wxEVT_AUX2_DCLICK event.
2289 @event{EVT_MOTION(func)}
2290 Process a @c wxEVT_MOTION event.
2291 @event{EVT_ENTER_WINDOW(func)}
2292 Process a @c wxEVT_ENTER_WINDOW event.
2293 @event{EVT_LEAVE_WINDOW(func)}
2294 Process a @c wxEVT_LEAVE_WINDOW event.
2295 @event{EVT_MOUSEWHEEL(func)}
2296 Process a @c wxEVT_MOUSEWHEEL event.
2297 @event{EVT_MOUSE_EVENTS(func)}
2298 Process all mouse events.
2306 class wxMouseEvent
: public wxEvent
,
2311 Constructor. Valid event types are:
2313 @li @c wxEVT_ENTER_WINDOW
2314 @li @c wxEVT_LEAVE_WINDOW
2315 @li @c wxEVT_LEFT_DOWN
2316 @li @c wxEVT_LEFT_UP
2317 @li @c wxEVT_LEFT_DCLICK
2318 @li @c wxEVT_MIDDLE_DOWN
2319 @li @c wxEVT_MIDDLE_UP
2320 @li @c wxEVT_MIDDLE_DCLICK
2321 @li @c wxEVT_RIGHT_DOWN
2322 @li @c wxEVT_RIGHT_UP
2323 @li @c wxEVT_RIGHT_DCLICK
2324 @li @c wxEVT_AUX1_DOWN
2325 @li @c wxEVT_AUX1_UP
2326 @li @c wxEVT_AUX1_DCLICK
2327 @li @c wxEVT_AUX2_DOWN
2328 @li @c wxEVT_AUX2_UP
2329 @li @c wxEVT_AUX2_DCLICK
2331 @li @c wxEVT_MOUSEWHEEL
2333 wxMouseEvent(wxEventType mouseEventType
= wxEVT_NULL
);
2336 Returns @true if the event was a first extra button double click.
2338 bool Aux1DClick() const;
2341 Returns @true if the first extra button mouse button changed to down.
2343 bool Aux1Down() const;
2346 Returns @true if the first extra button mouse button changed to up.
2348 bool Aux1Up() const;
2351 Returns @true if the event was a second extra button double click.
2353 bool Aux2DClick() const;
2356 Returns @true if the second extra button mouse button changed to down.
2358 bool Aux2Down() const;
2361 Returns @true if the second extra button mouse button changed to up.
2363 bool Aux2Up() const;
2366 Returns @true if the event was generated by the specified button.
2368 @see wxMouseState::ButtoinIsDown()
2370 bool Button(wxMouseButton but
) const;
2373 If the argument is omitted, this returns @true if the event was a mouse
2374 double click event. Otherwise the argument specifies which double click event
2375 was generated (see Button() for the possible values).
2377 bool ButtonDClick(wxMouseButton but
= wxMOUSE_BTN_ANY
) const;
2380 If the argument is omitted, this returns @true if the event was a mouse
2381 button down event. Otherwise the argument specifies which button-down event
2382 was generated (see Button() for the possible values).
2384 bool ButtonDown(wxMouseButton but
= wxMOUSE_BTN_ANY
) const;
2387 If the argument is omitted, this returns @true if the event was a mouse
2388 button up event. Otherwise the argument specifies which button-up event
2389 was generated (see Button() for the possible values).
2391 bool ButtonUp(wxMouseButton but
= wxMOUSE_BTN_ANY
) const;
2394 Returns @true if this was a dragging event (motion while a button is depressed).
2398 bool Dragging() const;
2401 Returns @true if the mouse was entering the window.
2405 bool Entering() const;
2408 Returns the mouse button which generated this event or @c wxMOUSE_BTN_NONE
2409 if no button is involved (for mouse move, enter or leave event, for example).
2410 Otherwise @c wxMOUSE_BTN_LEFT is returned for the left button down, up and
2411 double click events, @c wxMOUSE_BTN_MIDDLE and @c wxMOUSE_BTN_RIGHT
2412 for the same events for the middle and the right buttons respectively.
2414 int GetButton() const;
2417 Returns the number of mouse clicks for this event: 1 for a simple click, 2
2418 for a double-click, 3 for a triple-click and so on.
2420 Currently this function is implemented only in wxMac and returns -1 for the
2421 other platforms (you can still distinguish simple clicks from double-clicks as
2422 they generate different kinds of events however).
2426 int GetClickCount() const;
2429 Returns the configured number of lines (or whatever) to be scrolled per
2430 wheel action. Defaults to three.
2432 int GetLinesPerAction() const;
2435 Returns the logical mouse position in pixels (i.e. translated according to the
2436 translation set for the DC, which usually indicates that the window has been
2439 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
2442 Get wheel delta, normally 120.
2444 This is the threshold for action to be taken, and one such action
2445 (for example, scrolling one increment) should occur for each delta.
2447 int GetWheelDelta() const;
2450 Get wheel rotation, positive or negative indicates direction of rotation.
2452 Current devices all send an event when rotation is at least +/-WheelDelta, but
2453 finer resolution devices can be created in the future.
2455 Because of this you shouldn't assume that one event is equal to 1 line, but you
2456 should be able to either do partial line scrolling or wait until several
2457 events accumulate before scrolling.
2459 int GetWheelRotation() const;
2462 Gets the axis the wheel operation concerns; @c 0 is the Y axis as on
2463 most mouse wheels, @c 1 is the X axis.
2465 Note that only some models of mouse have horizontal wheel axis.
2467 int GetWheelAxis() const;
2470 Returns @true if the event was a mouse button event (not necessarily a button
2471 down event - that may be tested using ButtonDown()).
2473 bool IsButton() const;
2476 Returns @true if the system has been setup to do page scrolling with
2477 the mouse wheel instead of line scrolling.
2479 bool IsPageScroll() const;
2482 Returns @true if the mouse was leaving the window.
2486 bool Leaving() const;
2489 Returns @true if the event was a left double click.
2491 bool LeftDClick() const;
2494 Returns @true if the left mouse button changed to down.
2496 bool LeftDown() const;
2499 Returns @true if the left mouse button changed to up.
2501 bool LeftUp() const;
2504 Returns @true if the Meta key was down at the time of the event.
2506 bool MetaDown() const;
2509 Returns @true if the event was a middle double click.
2511 bool MiddleDClick() const;
2514 Returns @true if the middle mouse button changed to down.
2516 bool MiddleDown() const;
2519 Returns @true if the middle mouse button changed to up.
2521 bool MiddleUp() const;
2524 Returns @true if this was a motion event and no mouse buttons were pressed.
2525 If any mouse button is held pressed, then this method returns @false and
2526 Dragging() returns @true.
2528 bool Moving() const;
2531 Returns @true if the event was a right double click.
2533 bool RightDClick() const;
2536 Returns @true if the right mouse button changed to down.
2538 bool RightDown() const;
2541 Returns @true if the right mouse button changed to up.
2543 bool RightUp() const;
2549 @class wxDropFilesEvent
2551 This class is used for drop files events, that is, when files have been dropped
2552 onto the window. This functionality is currently only available under Windows.
2554 The window must have previously been enabled for dropping by calling
2555 wxWindow::DragAcceptFiles().
2557 Important note: this is a separate implementation to the more general drag and drop
2558 implementation documented in the @ref overview_dnd. It uses the older, Windows
2559 message-based approach of dropping files.
2561 @beginEventTable{wxDropFilesEvent}
2562 @event{EVT_DROP_FILES(func)}
2563 Process a @c wxEVT_DROP_FILES event.
2571 @see @ref overview_events
2573 class wxDropFilesEvent
: public wxEvent
2579 wxDropFilesEvent(wxEventType id
= 0, int noFiles
= 0,
2580 wxString
* files
= NULL
);
2583 Returns an array of filenames.
2585 wxString
* GetFiles() const;
2588 Returns the number of files dropped.
2590 int GetNumberOfFiles() const;
2593 Returns the position at which the files were dropped.
2594 Returns an array of filenames.
2596 wxPoint
GetPosition() const;
2602 @class wxCommandEvent
2604 This event class contains information about command events, which originate
2605 from a variety of simple controls.
2607 Note that wxCommandEvents and wxCommandEvent-derived event classes by default
2608 and unlike other wxEvent-derived classes propagate upward from the source
2609 window (the window which emits the event) up to the first parent which processes
2610 the event. Be sure to read @ref overview_events_propagation.
2612 More complex controls, such as wxTreeCtrl, have separate command event classes.
2614 @beginEventTable{wxCommandEvent}
2615 @event{EVT_COMMAND(id, event, func)}
2616 Process a command, supplying the window identifier, command event identifier,
2617 and member function.
2618 @event{EVT_COMMAND_RANGE(id1, id2, event, func)}
2619 Process a command for a range of window identifiers, supplying the minimum and
2620 maximum window identifiers, command event identifier, and member function.
2621 @event{EVT_BUTTON(id, func)}
2622 Process a @c wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wxButton control.
2623 @event{EVT_CHECKBOX(id, func)}
2624 Process a @c wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wxCheckBox control.
2625 @event{EVT_CHOICE(id, func)}
2626 Process a @c wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wxChoice control.
2627 @event{EVT_COMBOBOX(id, func)}
2628 Process a @c wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wxComboBox control.
2629 @event{EVT_LISTBOX(id, func)}
2630 Process a @c wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.
2631 @event{EVT_LISTBOX_DCLICK(id, func)}
2632 Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.
2633 @event{EVT_CHECKLISTBOX(id, func)}
2634 Process a @c wxEVT_COMMAND_CHECKLISTBOX_TOGGLED command, which is generated by a wxCheckListBox control.
2635 @event{EVT_MENU(id, func)}
2636 Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
2637 @event{EVT_MENU_RANGE(id1, id2, func)}
2638 Process a @c wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.
2639 @event{EVT_CONTEXT_MENU(func)}
2640 Process the event generated when the user has requested a popup menu to appear by
2641 pressing a special keyboard key (under Windows) or by right clicking the mouse.
2642 @event{EVT_RADIOBOX(id, func)}
2643 Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wxRadioBox control.
2644 @event{EVT_RADIOBUTTON(id, func)}
2645 Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wxRadioButton control.
2646 @event{EVT_SCROLLBAR(id, func)}
2647 Process a @c wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a wxScrollBar
2648 control. This is provided for compatibility only; more specific scrollbar event macros
2649 should be used instead (see wxScrollEvent).
2650 @event{EVT_SLIDER(id, func)}
2651 Process a @c wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wxSlider control.
2652 @event{EVT_TEXT(id, func)}
2653 Process a @c wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wxTextCtrl control.
2654 @event{EVT_TEXT_ENTER(id, func)}
2655 Process a @c wxEVT_COMMAND_TEXT_ENTER command, which is generated by a wxTextCtrl control.
2656 Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it
2657 to generate such events.
2658 @event{EVT_TEXT_MAXLEN(id, func)}
2659 Process a @c wxEVT_COMMAND_TEXT_MAXLEN command, which is generated by a wxTextCtrl control
2660 when the user tries to enter more characters into it than the limit previously set
2661 with SetMaxLength().
2662 @event{EVT_TOGGLEBUTTON(id, func)}
2663 Process a @c wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event.
2664 @event{EVT_TOOL(id, func)}
2665 Process a @c wxEVT_COMMAND_TOOL_CLICKED event (a synonym for @c wxEVT_COMMAND_MENU_SELECTED).
2666 Pass the id of the tool.
2667 @event{EVT_TOOL_RANGE(id1, id2, func)}
2668 Process a @c wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools.
2669 @event{EVT_TOOL_RCLICKED(id, func)}
2670 Process a @c wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool. (Not available on wxOSX.)
2671 @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}
2672 Process a @c wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. (Not available on wxOSX.)
2673 @event{EVT_TOOL_ENTER(id, func)}
2674 Process a @c wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself.
2675 The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor
2676 has moved off a tool. (Not available on wxOSX.)
2677 @event{EVT_COMMAND_LEFT_CLICK(id, func)}
2678 Process a @c wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only).
2679 @event{EVT_COMMAND_LEFT_DCLICK(id, func)}
2680 Process a @c wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (wxMSW only).
2681 @event{EVT_COMMAND_RIGHT_CLICK(id, func)}
2682 Process a @c wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (wxMSW only).
2683 @event{EVT_COMMAND_SET_FOCUS(id, func)}
2684 Process a @c wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (wxMSW only).
2685 @event{EVT_COMMAND_KILL_FOCUS(id, func)}
2686 Process a @c wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (wxMSW only).
2687 @event{EVT_COMMAND_ENTER(id, func)}
2688 Process a @c wxEVT_COMMAND_ENTER command, which is generated by a control.
2694 class wxCommandEvent
: public wxEvent
2700 wxCommandEvent(wxEventType commandEventType
= wxEVT_NULL
, int id
= 0);
2703 Returns client data pointer for a listbox or choice selection event
2704 (not valid for a deselection).
2706 void* GetClientData() const;
2709 Returns client object pointer for a listbox or choice selection event
2710 (not valid for a deselection).
2712 wxClientData
* GetClientObject() const;
2715 Returns extra information dependant on the event objects type.
2717 If the event comes from a listbox selection, it is a boolean
2718 determining whether the event was a selection (@true) or a
2719 deselection (@false). A listbox deselection only occurs for
2720 multiple-selection boxes, and in this case the index and string values
2721 are indeterminate and the listbox must be examined by the application.
2723 long GetExtraLong() const;
2726 Returns the integer identifier corresponding to a listbox, choice or
2727 radiobox selection (only if the event was a selection, not a deselection),
2728 or a boolean value representing the value of a checkbox.
2730 For a menu item, this method returns -1 if the item is not checkable or
2731 a boolean value (true or false) for checkable items indicating the new
2737 Returns item index for a listbox or choice selection event (not valid for
2740 int GetSelection() const;
2743 Returns item string for a listbox or choice selection event. If one
2744 or several items have been deselected, returns the index of the first
2745 deselected item. If some items have been selected and others deselected
2746 at the same time, it will return the index of the first selected item.
2748 wxString
GetString() const;
2751 This method can be used with checkbox and menu events: for the checkboxes, the
2752 method returns @true for a selection event and @false for a deselection one.
2753 For the menu events, this method indicates if the menu item just has become
2754 checked or unchecked (and thus only makes sense for checkable menu items).
2756 Notice that this method cannot be used with wxCheckListBox currently.
2758 bool IsChecked() const;
2761 For a listbox or similar event, returns @true if it is a selection, @false
2762 if it is a deselection. If some items have been selected and others deselected
2763 at the same time, it will return @true.
2765 bool IsSelection() const;
2768 Sets the client data for this event.
2770 void SetClientData(void* clientData
);
2773 Sets the client object for this event. The client object is not owned by the
2774 event object and the event object will not delete the client object in its destructor.
2776 The client object must be owned and deleted by another object (e.g. a control)
2777 that has longer life time than the event object.
2779 void SetClientObject(wxClientData
* clientObject
);
2782 Sets the @b m_extraLong member.
2784 void SetExtraLong(long extraLong
);
2787 Sets the @b m_commandInt member.
2789 void SetInt(int intCommand
);
2792 Sets the @b m_commandString member.
2794 void SetString(const wxString
& string
);
2800 @class wxActivateEvent
2802 An activate event is sent when a window or application is being activated
2805 @beginEventTable{wxActivateEvent}
2806 @event{EVT_ACTIVATE(func)}
2807 Process a @c wxEVT_ACTIVATE event.
2808 @event{EVT_ACTIVATE_APP(func)}
2809 Process a @c wxEVT_ACTIVATE_APP event.
2810 This event is received by the wxApp-derived instance only.
2811 @event{EVT_HIBERNATE(func)}
2812 Process a hibernate event, supplying the member function. This event applies
2813 to wxApp only, and only on Windows SmartPhone and PocketPC.
2814 It is generated when the system is low on memory; the application should free
2815 up as much memory as possible, and restore full working state when it receives
2816 a @c wxEVT_ACTIVATE or @c wxEVT_ACTIVATE_APP event.
2822 @see @ref overview_events, wxApp::IsActive
2824 class wxActivateEvent
: public wxEvent
2830 wxActivateEvent(wxEventType eventType
= wxEVT_NULL
, bool active
= true,
2834 Returns @true if the application or window is being activated, @false otherwise.
2836 bool GetActive() const;
2842 @class wxContextMenuEvent
2844 This class is used for context menu events, sent to give
2845 the application a chance to show a context (popup) menu for a wxWindow.
2847 Note that if wxContextMenuEvent::GetPosition returns wxDefaultPosition, this
2848 means that the event originated from a keyboard context button event, and you
2849 should compute a suitable position yourself, for example by calling wxGetMousePosition().
2851 When a keyboard context menu button is pressed on Windows, a right-click event
2852 with default position is sent first, and if this event is not processed, the
2853 context menu event is sent. So if you process mouse events and you find your
2854 context menu event handler is not being called, you could call wxEvent::Skip()
2855 for mouse right-down events.
2857 @beginEventTable{wxContextMenuEvent}
2858 @event{EVT_CONTEXT_MENU(func)}
2859 A right click (or other context menu command depending on platform) has been detected.
2866 @see wxCommandEvent, @ref overview_events
2868 class wxContextMenuEvent
: public wxCommandEvent
2874 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
, int id
= 0,
2875 const wxPoint
& pos
= wxDefaultPosition
);
2878 Returns the position in screen coordinates at which the menu should be shown.
2879 Use wxWindow::ScreenToClient to convert to client coordinates.
2881 You can also omit a position from wxWindow::PopupMenu in order to use
2882 the current mouse pointer position.
2884 If the event originated from a keyboard event, the value returned from this
2885 function will be wxDefaultPosition.
2887 const wxPoint
& GetPosition() const;
2890 Sets the position at which the menu should be shown.
2892 void SetPosition(const wxPoint
& point
);
2900 An erase event is sent when a window's background needs to be repainted.
2902 On some platforms, such as GTK+, this event is simulated (simply generated just
2903 before the paint event) and may cause flicker. It is therefore recommended that
2904 you set the text background colour explicitly in order to prevent flicker.
2905 The default background colour under GTK+ is grey.
2907 To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table
2910 You must use the device context returned by GetDC() to draw on, don't create
2911 a wxPaintDC in the event handler.
2913 @beginEventTable{wxEraseEvent}
2914 @event{EVT_ERASE_BACKGROUND(func)}
2915 Process a @c wxEVT_ERASE_BACKGROUND event.
2921 @see @ref overview_events
2923 class wxEraseEvent
: public wxEvent
2929 wxEraseEvent(int id
= 0, wxDC
* dc
= NULL
);
2932 Returns the device context associated with the erase event to draw on.
2934 The returned pointer is never @NULL.
2936 wxDC
* GetDC() const;
2944 A focus event is sent when a window's focus changes. The window losing focus
2945 receives a "kill focus" event while the window gaining it gets a "set focus" one.
2947 Notice that the set focus event happens both when the user gives focus to the
2948 window (whether using the mouse or keyboard) and when it is done from the
2949 program itself using wxWindow::SetFocus.
2951 @beginEventTable{wxFocusEvent}
2952 @event{EVT_SET_FOCUS(func)}
2953 Process a @c wxEVT_SET_FOCUS event.
2954 @event{EVT_KILL_FOCUS(func)}
2955 Process a @c wxEVT_KILL_FOCUS event.
2961 @see @ref overview_events
2963 class wxFocusEvent
: public wxEvent
2969 wxFocusEvent(wxEventType eventType
= wxEVT_NULL
, int id
= 0);
2972 Returns the window associated with this event, that is the window which had the
2973 focus before for the @c wxEVT_SET_FOCUS event and the window which is
2974 going to receive focus for the @c wxEVT_KILL_FOCUS one.
2976 Warning: the window pointer may be @NULL!
2978 wxWindow
*GetWindow() const;
2980 void SetWindow(wxWindow
*win
);
2986 @class wxChildFocusEvent
2988 A child focus event is sent to a (parent-)window when one of its child windows
2989 gains focus, so that the window could restore the focus back to its corresponding
2990 child if it loses it now and regains later.
2992 Notice that child window is the direct child of the window receiving event.
2993 Use wxWindow::FindFocus() to retrieve the window which is actually getting focus.
2995 @beginEventTable{wxChildFocusEvent}
2996 @event{EVT_CHILD_FOCUS(func)}
2997 Process a @c wxEVT_CHILD_FOCUS event.
3003 @see @ref overview_events
3005 class wxChildFocusEvent
: public wxCommandEvent
3012 The direct child which is (or which contains the window which is) receiving
3015 wxChildFocusEvent(wxWindow
* win
= NULL
);
3018 Returns the direct child which receives the focus, or a (grand-)parent of the
3019 control receiving the focus.
3021 To get the actually focused control use wxWindow::FindFocus.
3023 wxWindow
*GetWindow() const;
3029 @class wxMouseCaptureLostEvent
3031 A mouse capture lost event is sent to a window that had obtained mouse capture,
3032 which was subsequently lost due to an "external" event (for example, when a dialog
3033 box is shown or if another application captures the mouse).
3035 If this happens, this event is sent to all windows that are on the capture stack
3036 (i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is
3037 not sent if the capture changes because of a call to CaptureMouse or
3040 This event is currently emitted under Windows only.
3042 @beginEventTable{wxMouseCaptureLostEvent}
3043 @event{EVT_MOUSE_CAPTURE_LOST(func)}
3044 Process a @c wxEVT_MOUSE_CAPTURE_LOST event.
3052 @see wxMouseCaptureChangedEvent, @ref overview_events,
3053 wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
3055 class wxMouseCaptureLostEvent
: public wxEvent
3061 wxMouseCaptureLostEvent(wxWindowID windowId
= 0);
3066 class wxDisplayChangedEvent
: public wxEvent
3069 wxDisplayChangedEvent();
3073 class wxPaletteChangedEvent
: public wxEvent
3076 wxPaletteChangedEvent(wxWindowID winid
= 0);
3078 void SetChangedWindow(wxWindow
* win
);
3079 wxWindow
* GetChangedWindow() const;
3083 class wxQueryNewPaletteEvent
: public wxEvent
3086 wxQueryNewPaletteEvent(wxWindowID winid
= 0);
3088 void SetPaletteRealized(bool realized
);
3089 bool GetPaletteRealized();
3096 @class wxNotifyEvent
3098 This class is not used by the event handlers by itself, but is a base class
3099 for other event classes (such as wxBookCtrlEvent).
3101 It (or an object of a derived class) is sent when the controls state is being
3102 changed and allows the program to wxNotifyEvent::Veto() this change if it wants
3103 to prevent it from happening.
3108 @see wxBookCtrlEvent
3110 class wxNotifyEvent
: public wxCommandEvent
3114 Constructor (used internally by wxWidgets only).
3116 wxNotifyEvent(wxEventType eventType
= wxEVT_NULL
, int id
= 0);
3119 This is the opposite of Veto(): it explicitly allows the event to be processed.
3120 For most events it is not necessary to call this method as the events are allowed
3121 anyhow but some are forbidden by default (this will be mentioned in the corresponding
3127 Returns @true if the change is allowed (Veto() hasn't been called) or @false
3128 otherwise (if it was).
3130 bool IsAllowed() const;
3133 Prevents the change announced by this event from happening.
3135 It is in general a good idea to notify the user about the reasons for vetoing
3136 the change because otherwise the applications behaviour (which just refuses to
3137 do what the user wants) might be quite surprising.
3144 @class wxThreadEvent
3146 This class adds some simple functionality to wxEvent to facilitate
3147 inter-thread communication.
3149 This event is not natively emitted by any control/class: it is just
3150 a helper class for the user.
3151 Its most important feature is the GetEventCategory() implementation which
3152 allows thread events @b NOT to be processed by wxEventLoopBase::YieldFor calls
3153 (unless the @c wxEVT_CATEGORY_THREAD is specified - which is never in wx code).
3156 @category{events,threading}
3158 @see @ref overview_thread, wxEventLoopBase::YieldFor
3162 class wxThreadEvent
: public wxEvent
3168 wxThreadEvent(wxEventType eventType
= wxEVT_THREAD
, int id
= wxID_ANY
);
3171 Clones this event making sure that all internal members which use
3172 COW (only @c m_commandString for now; see @ref overview_refcount)
3173 are unshared (see wxObject::UnShare).
3175 virtual wxEvent
*Clone() const;
3178 Returns @c wxEVT_CATEGORY_THREAD.
3180 This is important to avoid unwanted processing of thread events
3181 when calling wxEventLoopBase::YieldFor().
3183 virtual wxEventCategory
GetEventCategory() const;
3186 Sets custom data payload.
3188 The @a payload argument may be of any type that wxAny can handle
3189 (i.e. pretty much anything). Note that T's copy constructor must be
3190 thread-safe, i.e. create a copy that doesn't share anything with
3191 the original (see Clone()).
3193 @note This method is not available with Visual C++ 6.
3197 @see GetPayload(), wxAny
3199 template<typename T
>
3200 void SetPayload(const T
& payload
);
3203 Get custom data payload.
3205 Correct type is checked in debug builds.
3207 @note This method is not available with Visual C++ 6.
3211 @see SetPayload(), wxAny
3213 template<typename T
>
3214 T
GetPayload() const;
3217 Returns extra information integer value.
3219 long GetExtraLong() const;
3222 Returns stored integer value.
3227 Returns stored string value.
3229 wxString
GetString() const;
3233 Sets the extra information value.
3235 void SetExtraLong(long extraLong
);
3238 Sets the integer value.
3240 void SetInt(int intCommand
);
3243 Sets the string value.
3245 void SetString(const wxString
& string
);
3252 A help event is sent when the user has requested context-sensitive help.
3253 This can either be caused by the application requesting context-sensitive help mode
3254 via wxContextHelp, or (on MS Windows) by the system generating a WM_HELP message when
3255 the user pressed F1 or clicked on the query button in a dialog caption.
3257 A help event is sent to the window that the user clicked on, and is propagated
3258 up the window hierarchy until the event is processed or there are no more event
3261 The application should call wxEvent::GetId to check the identity of the
3262 clicked-on window, and then either show some suitable help or call wxEvent::Skip()
3263 if the identifier is unrecognised.
3265 Calling Skip is important because it allows wxWidgets to generate further
3266 events for ancestors of the clicked-on window. Otherwise it would be impossible to
3267 show help for container windows, since processing would stop after the first window
3270 @beginEventTable{wxHelpEvent}
3271 @event{EVT_HELP(id, func)}
3272 Process a @c wxEVT_HELP event.
3273 @event{EVT_HELP_RANGE(id1, id2, func)}
3274 Process a @c wxEVT_HELP event for a range of ids.
3280 @see wxContextHelp, wxDialog, @ref overview_events
3282 class wxHelpEvent
: public wxCommandEvent
3286 Indicates how a wxHelpEvent was generated.
3290 Origin_Unknown
, /**< unrecognized event source. */
3291 Origin_Keyboard
, /**< event generated from F1 key press. */
3293 /** event generated by wxContextHelp or from the [?] button on
3294 the title bar (Windows). */
3301 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
3302 wxWindowID winid
= 0,
3303 const wxPoint
& pt
= wxDefaultPosition
,
3304 wxHelpEvent::Origin origin
= Origin_Unknown
);
3307 Returns the origin of the help event which is one of the ::wxHelpEventOrigin
3310 The application may handle events generated using the keyboard or mouse
3311 differently, e.g. by using wxGetMousePosition() for the mouse events.
3315 wxHelpEvent::Origin
GetOrigin() const;
3318 Returns the left-click position of the mouse, in screen coordinates.
3319 This allows the application to position the help appropriately.
3321 const wxPoint
& GetPosition() const;
3324 Set the help event origin, only used internally by wxWidgets normally.
3328 void SetOrigin(wxHelpEvent::Origin origin
);
3331 Sets the left-click position of the mouse, in screen coordinates.
3333 void SetPosition(const wxPoint
& pt
);
3339 @class wxScrollEvent
3341 A scroll event holds information about events sent from stand-alone
3342 scrollbars (see wxScrollBar) and sliders (see wxSlider).
3344 Note that scrolled windows send the wxScrollWinEvent which does not derive from
3345 wxCommandEvent, but from wxEvent directly - don't confuse these two kinds of
3346 events and use the event table macros mentioned below only for the scrollbar-like
3349 @section scrollevent_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
3351 The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb
3352 using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed
3353 by an EVT_SCROLL_CHANGED event).
3355 The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb
3356 position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE
3357 event does not happen).
3359 In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving has finished
3360 independently of the way it had started. Please see the widgets sample ("Slider" page)
3361 to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
3364 Note that unless specifying a scroll control identifier, you will need to test for scrollbar
3365 orientation with wxScrollEvent::GetOrientation, since horizontal and vertical scroll events
3366 are processed using the same event handler.
3368 @beginEventTable{wxScrollEvent}
3369 You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting
3370 scroll events from controls, or EVT_SCROLL... macros without window IDs for
3371 intercepting scroll events from the receiving window -- except for this, the
3372 macros behave exactly the same.
3373 @event{EVT_SCROLL(func)}
3374 Process all scroll events.
3375 @event{EVT_SCROLL_TOP(func)}
3376 Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
3377 @event{EVT_SCROLL_BOTTOM(func)}
3378 Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
3379 @event{EVT_SCROLL_LINEUP(func)}
3380 Process @c wxEVT_SCROLL_LINEUP line up events.
3381 @event{EVT_SCROLL_LINEDOWN(func)}
3382 Process @c wxEVT_SCROLL_LINEDOWN line down events.
3383 @event{EVT_SCROLL_PAGEUP(func)}
3384 Process @c wxEVT_SCROLL_PAGEUP page up events.
3385 @event{EVT_SCROLL_PAGEDOWN(func)}
3386 Process @c wxEVT_SCROLL_PAGEDOWN page down events.
3387 @event{EVT_SCROLL_THUMBTRACK(func)}
3388 Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the
3389 user drags the thumbtrack).
3390 @event{EVT_SCROLL_THUMBRELEASE(func)}
3391 Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
3392 @event{EVT_SCROLL_CHANGED(func)}
3393 Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
3394 @event{EVT_COMMAND_SCROLL(id, func)}
3395 Process all scroll events.
3396 @event{EVT_COMMAND_SCROLL_TOP(id, func)}
3397 Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
3398 @event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
3399 Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
3400 @event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
3401 Process @c wxEVT_SCROLL_LINEUP line up events.
3402 @event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
3403 Process @c wxEVT_SCROLL_LINEDOWN line down events.
3404 @event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
3405 Process @c wxEVT_SCROLL_PAGEUP page up events.
3406 @event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
3407 Process @c wxEVT_SCROLL_PAGEDOWN page down events.
3408 @event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
3409 Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent
3410 as the user drags the thumbtrack).
3411 @event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
3412 Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
3413 @event{EVT_COMMAND_SCROLL_CHANGED(func)}
3414 Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
3420 @see wxScrollBar, wxSlider, wxSpinButton, wxScrollWinEvent, @ref overview_events
3422 class wxScrollEvent
: public wxCommandEvent
3428 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0, int pos
= 0,
3429 int orientation
= 0);
3432 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
3435 int GetOrientation() const;
3438 Returns the position of the scrollbar.
3440 int GetPosition() const;
3443 void SetOrientation(int orient
);
3444 void SetPosition(int pos
);
3448 See wxIdleEvent::SetMode() for more info.
3452 /** Send idle events to all windows */
3455 /** Send idle events to windows that have the wxWS_EX_PROCESS_IDLE flag specified */
3456 wxIDLE_PROCESS_SPECIFIED
3463 This class is used for idle events, which are generated when the system becomes
3464 idle. Note that, unless you do something specifically, the idle events are not
3465 sent if the system remains idle once it has become it, e.g. only a single idle
3466 event will be generated until something else resulting in more normal events
3467 happens and only then is the next idle event sent again.
3469 If you need to ensure a continuous stream of idle events, you can either use
3470 wxIdleEvent::RequestMore method in your handler or call wxWakeUpIdle() periodically
3471 (for example from a timer event handler), but note that both of these approaches
3472 (and especially the first one) increase the system load and so should be avoided
3475 By default, idle events are sent to all windows (and also wxApp, as usual).
3476 If this is causing a significant overhead in your application, you can call
3477 wxIdleEvent::SetMode with the value wxIDLE_PROCESS_SPECIFIED, and set the
3478 wxWS_EX_PROCESS_IDLE extra window style for every window which should receive
3481 @beginEventTable{wxIdleEvent}
3482 @event{EVT_IDLE(func)}
3483 Process a @c wxEVT_IDLE event.
3489 @see @ref overview_events, wxUpdateUIEvent, wxWindow::OnInternalIdle
3491 class wxIdleEvent
: public wxEvent
3500 Static function returning a value specifying how wxWidgets will send idle
3501 events: to all windows, or only to those which specify that they
3502 will process the events.
3506 static wxIdleMode
GetMode();
3509 Returns @true if the OnIdle function processing this event requested more
3514 bool MoreRequested() const;
3517 Tells wxWidgets that more processing is required.
3519 This function can be called by an OnIdle handler for a window or window event
3520 handler to indicate that wxApp::OnIdle should forward the OnIdle event once
3521 more to the application windows.
3523 If no window calls this function during OnIdle, then the application will
3524 remain in a passive event loop (not calling OnIdle) until a new event is
3525 posted to the application by the windowing system.
3527 @see MoreRequested()
3529 void RequestMore(bool needMore
= true);
3532 Static function for specifying how wxWidgets will send idle events: to
3533 all windows, or only to those which specify that they will process the events.
3536 Can be one of the ::wxIdleMode values.
3537 The default is wxIDLE_PROCESS_ALL.
3539 static void SetMode(wxIdleMode mode
);
3545 @class wxInitDialogEvent
3547 A wxInitDialogEvent is sent as a dialog or panel is being initialised.
3548 Handlers for this event can transfer data to the window.
3550 The default handler calls wxWindow::TransferDataToWindow.
3552 @beginEventTable{wxInitDialogEvent}
3553 @event{EVT_INIT_DIALOG(func)}
3554 Process a @c wxEVT_INIT_DIALOG event.
3560 @see @ref overview_events
3562 class wxInitDialogEvent
: public wxEvent
3568 wxInitDialogEvent(int id
= 0);
3574 @class wxWindowDestroyEvent
3576 This event is sent as early as possible during the window destruction
3579 For the top level windows, as early as possible means that this is done by
3580 wxFrame or wxDialog destructor, i.e. after the destructor of the derived
3581 class was executed and so any methods specific to the derived class can't
3582 be called any more from this event handler. If you need to do this, you
3583 must call wxWindow::SendDestroyEvent() from your derived class destructor.
3585 For the child windows, this event is generated just before deleting the
3586 window from wxWindow::Destroy() (which is also called when the parent
3587 window is deleted) or from the window destructor if operator @c delete was
3588 used directly (which is not recommended for this very reason).
3590 It is usually pointless to handle this event in the window itself but it ca
3591 be very useful to receive notifications about the window destruction in the
3592 parent window or in any other object interested in this window.
3597 @see @ref overview_events, wxWindowCreateEvent
3599 class wxWindowDestroyEvent
: public wxCommandEvent
3605 wxWindowDestroyEvent(wxWindow
* win
= NULL
);
3607 /// Return the window being destroyed.
3608 wxWindow
*GetWindow() const;
3613 @class wxNavigationKeyEvent
3615 This event class contains information about navigation events,
3616 generated by navigation keys such as tab and page down.
3618 This event is mainly used by wxWidgets implementations.
3619 A wxNavigationKeyEvent handler is automatically provided by wxWidgets
3620 when you enable keyboard navigation inside a window by inheriting it from
3621 wxNavigationEnabled<>.
3623 @beginEventTable{wxNavigationKeyEvent}
3624 @event{EVT_NAVIGATION_KEY(func)}
3625 Process a navigation key event.
3631 @see wxWindow::Navigate, wxWindow::NavigateIn
3633 class wxNavigationKeyEvent
: public wxEvent
3637 Flags which can be used with wxNavigationKeyEvent.
3639 enum wxNavigationKeyEventFlags
3641 IsBackward
= 0x0000,
3647 wxNavigationKeyEvent();
3648 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
);
3651 Returns the child that has the focus, or @NULL.
3653 wxWindow
* GetCurrentFocus() const;
3656 Returns @true if the navigation was in the forward direction.
3658 bool GetDirection() const;
3661 Returns @true if the navigation event was from a tab key.
3662 This is required for proper navigation over radio buttons.
3664 bool IsFromTab() const;
3667 Returns @true if the navigation event represents a window change
3668 (for example, from Ctrl-Page Down in a notebook).
3670 bool IsWindowChange() const;
3673 Sets the current focus window member.
3675 void SetCurrentFocus(wxWindow
* currentFocus
);
3678 Sets the direction to forward if @a direction is @true, or backward
3681 void SetDirection(bool direction
);
3684 Sets the flags for this event.
3685 The @a flags can be a combination of the ::wxNavigationKeyEventFlags values.
3687 void SetFlags(long flags
);
3690 Marks the navigation event as from a tab key.
3692 void SetFromTab(bool fromTab
);
3695 Marks the event as a window change event.
3697 void SetWindowChange(bool windowChange
);
3703 @class wxMouseCaptureChangedEvent
3705 An mouse capture changed event is sent to a window that loses its
3706 mouse capture. This is called even if wxWindow::ReleaseMouse
3707 was called by the application code. Handling this event allows
3708 an application to cater for unexpected capture releases which
3709 might otherwise confuse mouse handling code.
3713 @beginEventTable{wxMouseCaptureChangedEvent}
3714 @event{EVT_MOUSE_CAPTURE_CHANGED(func)}
3715 Process a @c wxEVT_MOUSE_CAPTURE_CHANGED event.
3721 @see wxMouseCaptureLostEvent, @ref overview_events,
3722 wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
3724 class wxMouseCaptureChangedEvent
: public wxEvent
3730 wxMouseCaptureChangedEvent(wxWindowID windowId
= 0,
3731 wxWindow
* gainedCapture
= NULL
);
3734 Returns the window that gained the capture, or @NULL if it was a
3735 non-wxWidgets window.
3737 wxWindow
* GetCapturedWindow() const;
3745 This event class contains information about window and session close events.
3747 The handler function for EVT_CLOSE is called when the user has tried to close a
3748 a frame or dialog box using the window manager (X) or system menu (Windows).
3749 It can also be invoked by the application itself programmatically, for example by
3750 calling the wxWindow::Close function.
3752 You should check whether the application is forcing the deletion of the window
3753 using wxCloseEvent::CanVeto. If this is @false, you @e must destroy the window
3754 using wxWindow::Destroy.
3756 If the return value is @true, it is up to you whether you respond by destroying
3759 If you don't destroy the window, you should call wxCloseEvent::Veto to
3760 let the calling code know that you did not destroy the window.
3761 This allows the wxWindow::Close function to return @true or @false depending
3762 on whether the close instruction was honoured or not.
3764 Example of a wxCloseEvent handler:
3767 void MyFrame::OnClose(wxCloseEvent& event)
3769 if ( event.CanVeto() && m_bFileNotSaved )
3771 if ( wxMessageBox("The file has not been saved... continue closing?",
3773 wxICON_QUESTION | wxYES_NO) != wxYES )
3780 Destroy(); // you may also do: event.Skip();
3781 // since the default event handler does call Destroy(), too
3785 The EVT_END_SESSION event is slightly different as it is sent by the system
3786 when the user session is ending (e.g. because of log out or shutdown) and
3787 so all windows are being forcefully closed. At least under MSW, after the
3788 handler for this event is executed the program is simply killed by the
3789 system. Because of this, the default handler for this event provided by
3790 wxWidgets calls all the usual cleanup code (including wxApp::OnExit()) so
3791 that it could still be executed and exit()s the process itself, without
3792 waiting for being killed. If this behaviour is for some reason undesirable,
3793 make sure that you define a handler for this event in your wxApp-derived
3794 class and do not call @c event.Skip() in it (but be aware that the system
3795 will still kill your application).
3797 @beginEventTable{wxCloseEvent}
3798 @event{EVT_CLOSE(func)}
3799 Process a @c wxEVT_CLOSE_WINDOW command event, supplying the member function.
3800 This event applies to wxFrame and wxDialog classes.
3801 @event{EVT_QUERY_END_SESSION(func)}
3802 Process a @c wxEVT_QUERY_END_SESSION session event, supplying the member function.
3803 This event can be handled in wxApp-derived class only.
3804 @event{EVT_END_SESSION(func)}
3805 Process a @c wxEVT_END_SESSION session event, supplying the member function.
3806 This event can be handled in wxApp-derived class only.
3812 @see wxWindow::Close, @ref overview_windowdeletion
3814 class wxCloseEvent
: public wxEvent
3820 wxCloseEvent(wxEventType commandEventType
= wxEVT_NULL
, int id
= 0);
3823 Returns @true if you can veto a system shutdown or a window close event.
3824 Vetoing a window close event is not possible if the calling code wishes to
3825 force the application to exit, and so this function must be called to check this.
3827 bool CanVeto() const;
3830 Returns @true if the user is just logging off or @false if the system is
3831 shutting down. This method can only be called for end session and query end
3832 session events, it doesn't make sense for close window event.
3834 bool GetLoggingOff() const;
3837 Sets the 'can veto' flag.
3839 void SetCanVeto(bool canVeto
);
3842 Sets the 'logging off' flag.
3844 void SetLoggingOff(bool loggingOff
);
3847 Call this from your event handler to veto a system shutdown or to signal
3848 to the calling application that a window close did not happen.
3850 You can only veto a shutdown if CanVeto() returns @true.
3852 void Veto(bool veto
= true);
3860 This class is used for a variety of menu-related events. Note that
3861 these do not include menu command events, which are
3862 handled using wxCommandEvent objects.
3864 The default handler for @c wxEVT_MENU_HIGHLIGHT displays help
3865 text in the first field of the status bar.
3867 @beginEventTable{wxMenuEvent}
3868 @event{EVT_MENU_OPEN(func)}
3869 A menu is about to be opened. On Windows, this is only sent once for each
3870 navigation of the menubar (up until all menus have closed).
3871 @event{EVT_MENU_CLOSE(func)}
3872 A menu has been just closed.
3873 @event{EVT_MENU_HIGHLIGHT(id, func)}
3874 The menu item with the specified id has been highlighted: used to show
3875 help prompts in the status bar by wxFrame
3876 @event{EVT_MENU_HIGHLIGHT_ALL(func)}
3877 A menu item has been highlighted, i.e. the currently selected menu item has changed.
3883 @see wxCommandEvent, @ref overview_events
3885 class wxMenuEvent
: public wxEvent
3891 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int id
= 0, wxMenu
* menu
= NULL
);
3894 Returns the menu which is being opened or closed.
3896 This method can only be used with the @c OPEN and @c CLOSE events.
3898 The returned value is never @NULL in the ports implementing this
3899 function, which currently includes all the major ones.
3901 wxMenu
* GetMenu() const;
3904 Returns the menu identifier associated with the event.
3905 This method should be only used with the @c HIGHLIGHT events.
3907 int GetMenuId() const;
3910 Returns @true if the menu which is being opened or closed is a popup menu,
3911 @false if it is a normal one.
3913 This method should only be used with the @c OPEN and @c CLOSE events.
3915 bool IsPopup() const;
3921 An event being sent when the window is shown or hidden.
3922 The event is triggered by calls to wxWindow::Show(), and any user
3923 action showing a previously hidden window or vice versa (if allowed by
3924 the current platform and/or window manager).
3925 Notice that the event is not triggered when the application is iconized
3926 (minimized) or restored under wxMSW.
3928 @onlyfor{wxmsw,wxgtk,wxos2}
3930 @beginEventTable{wxShowEvent}
3931 @event{EVT_SHOW(func)}
3932 Process a @c wxEVT_SHOW event.
3938 @see @ref overview_events, wxWindow::Show,
3942 class wxShowEvent
: public wxEvent
3948 wxShowEvent(int winid
= 0, bool show
= false);
3951 Set whether the windows was shown or hidden.
3953 void SetShow(bool show
);
3956 Return @true if the window has been shown, @false if it has been
3959 bool IsShown() const;
3962 @deprecated This function is deprecated in favour of IsShown().
3964 bool GetShow() const;
3970 @class wxIconizeEvent
3972 An event being sent when the frame is iconized (minimized) or restored.
3974 Currently only wxMSW and wxGTK generate such events.
3976 @onlyfor{wxmsw,wxgtk}
3978 @beginEventTable{wxIconizeEvent}
3979 @event{EVT_ICONIZE(func)}
3980 Process a @c wxEVT_ICONIZE event.
3986 @see @ref overview_events, wxTopLevelWindow::Iconize,
3987 wxTopLevelWindow::IsIconized
3989 class wxIconizeEvent
: public wxEvent
3995 wxIconizeEvent(int id
= 0, bool iconized
= true);
3998 Returns @true if the frame has been iconized, @false if it has been
4001 bool IsIconized() const;
4004 @deprecated This function is deprecated in favour of IsIconized().
4006 bool Iconized() const;
4014 A move event holds information about wxTopLevelWindow move change events.
4016 These events are currently only generated by wxMSW port.
4018 @beginEventTable{wxMoveEvent}
4019 @event{EVT_MOVE(func)}
4020 Process a @c wxEVT_MOVE event, which is generated when a window is moved.
4021 @event{EVT_MOVE_START(func)}
4022 Process a @c wxEVT_MOVE_START event, which is generated when the user starts
4023 to move or size a window. wxMSW only.
4024 @event{EVT_MOVING(func)}
4025 Process a @c wxEVT_MOVING event, which is generated while the user is
4026 moving the window. wxMSW only.
4027 @event{EVT_MOVE_END(func)}
4028 Process a @c wxEVT_MOVE_END event, which is generated when the user stops
4029 moving or sizing a window. wxMSW only.
4035 @see wxPoint, @ref overview_events
4037 class wxMoveEvent
: public wxEvent
4043 wxMoveEvent(const wxPoint
& pt
, int id
= 0);
4046 Returns the position of the window generating the move change event.
4048 wxPoint
GetPosition() const;
4050 wxRect
GetRect() const;
4051 void SetRect(const wxRect
& rect
);
4052 void SetPosition(const wxPoint
& pos
);
4059 A size event holds information about size change events of wxWindow.
4061 The EVT_SIZE handler function will be called when the window has been resized.
4063 You may wish to use this for frames to resize their child windows as appropriate.
4065 Note that the size passed is of the whole window: call wxWindow::GetClientSize()
4066 for the area which may be used by the application.
4068 When a window is resized, usually only a small part of the window is damaged
4069 and you may only need to repaint that area. However, if your drawing depends on the
4070 size of the window, you may need to clear the DC explicitly and repaint the whole window.
4071 In which case, you may need to call wxWindow::Refresh to invalidate the entire window.
4073 @b Important : Sizers ( see @ref overview_sizer ) rely on size events to function
4074 correctly. Therefore, in a sizer-based layout, do not forget to call Skip on all
4075 size events you catch (and don't catch size events at all when you don't need to).
4077 @beginEventTable{wxSizeEvent}
4078 @event{EVT_SIZE(func)}
4079 Process a @c wxEVT_SIZE event.
4085 @see wxSize, @ref overview_events
4087 class wxSizeEvent
: public wxEvent
4093 wxSizeEvent(const wxSize
& sz
, int id
= 0);
4096 Returns the entire size of the window generating the size change event.
4098 This is the new total size of the window, i.e. the same size as would
4099 be returned by wxWindow::GetSize() if it were called now. Use
4100 wxWindow::GetClientSize() if you catch this event in a top level window
4101 such as wxFrame to find the size available for the window contents.
4103 wxSize
GetSize() const;
4104 void SetSize(wxSize size
);
4106 wxRect
GetRect() const;
4107 void SetRect(wxRect rect
);
4113 @class wxSetCursorEvent
4115 A wxSetCursorEvent is generated from wxWindow when the mouse cursor is about
4116 to be set as a result of mouse motion.
4118 This event gives the application the chance to perform specific mouse cursor
4119 processing based on the current position of the mouse within the window.
4120 Use wxSetCursorEvent::SetCursor to specify the cursor you want to be displayed.
4122 @beginEventTable{wxSetCursorEvent}
4123 @event{EVT_SET_CURSOR(func)}
4124 Process a @c wxEVT_SET_CURSOR event.
4130 @see ::wxSetCursor, wxWindow::wxSetCursor
4132 class wxSetCursorEvent
: public wxEvent
4136 Constructor, used by the library itself internally to initialize the event
4139 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0);
4142 Returns a reference to the cursor specified by this event.
4144 const wxCursor
& GetCursor() const;
4147 Returns the X coordinate of the mouse in client coordinates.
4149 wxCoord
GetX() const;
4152 Returns the Y coordinate of the mouse in client coordinates.
4154 wxCoord
GetY() const;
4157 Returns @true if the cursor specified by this event is a valid cursor.
4159 @remarks You cannot specify wxNullCursor with this event, as it is not
4160 considered a valid cursor.
4162 bool HasCursor() const;
4165 Sets the cursor associated with this event.
4167 void SetCursor(const wxCursor
& cursor
);
4172 // ============================================================================
4173 // Global functions/macros
4174 // ============================================================================
4176 /** @addtogroup group_funcmacro_events */
4180 A value uniquely identifying the type of the event.
4182 The values of this type should only be created using wxNewEventType().
4184 See the macro DEFINE_EVENT_TYPE() for more info.
4186 @see @ref overview_events_introduction
4188 typedef int wxEventType
;
4191 A special event type usually used to indicate that some wxEvent has yet
4194 wxEventType wxEVT_NULL
;
4196 wxEventType wxEVT_ANY
;
4199 Generates a new unique event type.
4201 Usually this function is only used by wxDEFINE_EVENT() and not called
4204 wxEventType
wxNewEventType();
4207 Define a new event type associated with the specified event class.
4209 This macro defines a new unique event type @a name associated with the
4214 wxDEFINE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
4216 class MyCustomEvent : public wxEvent { ... };
4217 wxDEFINE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
4220 @see wxDECLARE_EVENT(), @ref overview_events_custom
4222 #define wxDEFINE_EVENT(name, cls) \
4223 const wxEventTypeTag< cls > name(wxNewEventType())
4226 Declares a custom event type.
4228 This macro declares a variable called @a name which must be defined
4229 elsewhere using wxDEFINE_EVENT().
4231 The class @a cls must be the wxEvent-derived class associated with the
4232 events of this type and its full declaration must be visible from the point
4233 of use of this macro.
4237 wxDECLARE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
4239 class MyCustomEvent : public wxEvent { ... };
4240 wxDECLARE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
4243 #define wxDECLARE_EVENT(name, cls) \
4244 wxDECLARE_EXPORTED_EVENT(wxEMPTY_PARAMETER_VALUE, name, cls)
4247 Variant of wxDECLARE_EVENT() used for event types defined inside a shared
4250 This is mostly used by wxWidgets internally, e.g.
4252 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent)
4255 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, cls ) \
4256 extern const expdecl wxEventTypeTag< cls > name;
4259 Helper macro for definition of custom event table macros.
4261 This macro must only be used if wxEVENTS_COMPATIBILITY_2_8 is 1, otherwise
4262 it is better and more clear to just use the address of the function
4263 directly as this is all this macro does in this case. However it needs to
4264 explicitly cast @a func to @a functype, which is the type of wxEvtHandler
4265 member function taking the custom event argument when
4266 wxEVENTS_COMPATIBILITY_2_8 is 0.
4268 See wx__DECLARE_EVT0 for an example of use.
4270 @see @ref overview_events_custom_ownclass
4272 #define wxEVENT_HANDLER_CAST(functype, func) (&func)
4275 This macro is used to define event table macros for handling custom
4280 class MyEvent : public wxEvent { ... };
4282 // note that this is not necessary unless using old compilers: for the
4283 // reasonably new ones just use &func instead of MyEventHandler(func)
4284 typedef void (wxEvtHandler::*MyEventFunction)(MyEvent&);
4285 #define MyEventHandler(func) wxEVENT_HANDLER_CAST(MyEventFunction, func)
4287 wxDEFINE_EVENT(MY_EVENT_TYPE, MyEvent);
4289 #define EVT_MY(id, func) \
4290 wx__DECLARE_EVT1(MY_EVENT_TYPE, id, MyEventHandler(func))
4294 wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)
4295 EVT_MY(wxID_ANY, MyFrame::OnMyEvent)
4300 The event type to handle.
4302 The identifier of events to handle.
4304 The event handler method.
4306 #define wx__DECLARE_EVT1(evt, id, fn) \
4307 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
4310 Generalized version of the wx__DECLARE_EVT1() macro taking a range of
4311 IDs instead of a single one.
4312 Argument @a id1 is the first identifier of the range, @a id2 is the
4313 second identifier of the range.
4315 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
4316 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
4319 Simplified version of the wx__DECLARE_EVT1() macro, to be used when the
4320 event type must be handled regardless of the ID associated with the
4321 specific event instances.
4323 #define wx__DECLARE_EVT0(evt, fn) \
4324 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
4327 Use this macro inside a class declaration to declare a @e static event table
4330 In the implementation file you'll need to use the wxBEGIN_EVENT_TABLE()
4331 and the wxEND_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro
4334 Note that this macro requires a final semicolon.
4336 @see @ref overview_events_eventtables
4338 #define wxDECLARE_EVENT_TABLE()
4341 Use this macro in a source file to start listing @e static event handlers
4342 for a specific class.
4344 Use wxEND_EVENT_TABLE() to terminate the event-declaration block.
4346 @see @ref overview_events_eventtables
4348 #define wxBEGIN_EVENT_TABLE(theClass, baseClass)
4351 Use this macro in a source file to end listing @e static event handlers
4352 for a specific class.
4354 Use wxBEGIN_EVENT_TABLE() to start the event-declaration block.
4356 @see @ref overview_events_eventtables
4358 #define wxEND_EVENT_TABLE()
4361 In a GUI application, this function posts @a event to the specified @e dest
4362 object using wxEvtHandler::AddPendingEvent().
4364 Otherwise, it dispatches @a event immediately using
4365 wxEvtHandler::ProcessEvent(). See the respective documentation for details
4366 (and caveats). Because of limitation of wxEvtHandler::AddPendingEvent()
4367 this function is not thread-safe for event objects having wxString fields,
4368 use wxQueueEvent() instead.
4372 void wxPostEvent(wxEvtHandler
* dest
, const wxEvent
& event
);
4375 Queue an event for processing on the given object.
4377 This is a wrapper around wxEvtHandler::QueueEvent(), see its documentation
4383 The object to queue the event on, can't be @c NULL.
4385 The heap-allocated and non-@c NULL event to queue, the function takes
4388 void wxQueueEvent(wxEvtHandler
* dest
, wxEvent
*event
);
4392 wxEventType wxEVT_COMMAND_BUTTON_CLICKED
;
4393 wxEventType wxEVT_COMMAND_CHECKBOX_CLICKED
;
4394 wxEventType wxEVT_COMMAND_CHOICE_SELECTED
;
4395 wxEventType wxEVT_COMMAND_LISTBOX_SELECTED
;
4396 wxEventType wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
;
4397 wxEventType wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
;
4398 wxEventType wxEVT_COMMAND_MENU_SELECTED
;
4399 wxEventType wxEVT_COMMAND_SLIDER_UPDATED
;
4400 wxEventType wxEVT_COMMAND_RADIOBOX_SELECTED
;
4401 wxEventType wxEVT_COMMAND_RADIOBUTTON_SELECTED
;
4402 wxEventType wxEVT_COMMAND_SCROLLBAR_UPDATED
;
4403 wxEventType wxEVT_COMMAND_VLBOX_SELECTED
;
4404 wxEventType wxEVT_COMMAND_COMBOBOX_SELECTED
;
4405 wxEventType wxEVT_COMMAND_TOOL_RCLICKED
;
4406 wxEventType wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
;
4407 wxEventType wxEVT_COMMAND_TOOL_ENTER
;
4408 wxEventType wxEVT_COMMAND_COMBOBOX_DROPDOWN
;
4409 wxEventType wxEVT_COMMAND_COMBOBOX_CLOSEUP
;
4410 wxEventType wxEVT_THREAD
;
4411 wxEventType wxEVT_LEFT_DOWN
;
4412 wxEventType wxEVT_LEFT_UP
;
4413 wxEventType wxEVT_MIDDLE_DOWN
;
4414 wxEventType wxEVT_MIDDLE_UP
;
4415 wxEventType wxEVT_RIGHT_DOWN
;
4416 wxEventType wxEVT_RIGHT_UP
;
4417 wxEventType wxEVT_MOTION
;
4418 wxEventType wxEVT_ENTER_WINDOW
;
4419 wxEventType wxEVT_LEAVE_WINDOW
;
4420 wxEventType wxEVT_LEFT_DCLICK
;
4421 wxEventType wxEVT_MIDDLE_DCLICK
;
4422 wxEventType wxEVT_RIGHT_DCLICK
;
4423 wxEventType wxEVT_SET_FOCUS
;
4424 wxEventType wxEVT_KILL_FOCUS
;
4425 wxEventType wxEVT_CHILD_FOCUS
;
4426 wxEventType wxEVT_MOUSEWHEEL
;
4427 wxEventType wxEVT_AUX1_DOWN
;
4428 wxEventType wxEVT_AUX1_UP
;
4429 wxEventType wxEVT_AUX1_DCLICK
;
4430 wxEventType wxEVT_AUX2_DOWN
;
4431 wxEventType wxEVT_AUX2_UP
;
4432 wxEventType wxEVT_AUX2_DCLICK
;
4433 wxEventType wxEVT_CHAR
;
4434 wxEventType wxEVT_CHAR_HOOK
;
4435 wxEventType wxEVT_NAVIGATION_KEY
;
4436 wxEventType wxEVT_KEY_DOWN
;
4437 wxEventType wxEVT_KEY_UP
;
4438 wxEventType wxEVT_HOTKEY
;
4439 wxEventType wxEVT_SET_CURSOR
;
4440 wxEventType wxEVT_SCROLL_TOP
;
4441 wxEventType wxEVT_SCROLL_BOTTOM
;
4442 wxEventType wxEVT_SCROLL_LINEUP
;
4443 wxEventType wxEVT_SCROLL_LINEDOWN
;
4444 wxEventType wxEVT_SCROLL_PAGEUP
;
4445 wxEventType wxEVT_SCROLL_PAGEDOWN
;
4446 wxEventType wxEVT_SCROLL_THUMBTRACK
;
4447 wxEventType wxEVT_SCROLL_THUMBRELEASE
;
4448 wxEventType wxEVT_SCROLL_CHANGED
;
4449 wxEventType wxEVT_SPIN_UP
;
4450 wxEventType wxEVT_SPIN_DOWN
;
4451 wxEventType wxEVT_SPIN
;
4452 wxEventType wxEVT_SCROLLWIN_TOP
;
4453 wxEventType wxEVT_SCROLLWIN_BOTTOM
;
4454 wxEventType wxEVT_SCROLLWIN_LINEUP
;
4455 wxEventType wxEVT_SCROLLWIN_LINEDOWN
;
4456 wxEventType wxEVT_SCROLLWIN_PAGEUP
;
4457 wxEventType wxEVT_SCROLLWIN_PAGEDOWN
;
4458 wxEventType wxEVT_SCROLLWIN_THUMBTRACK
;
4459 wxEventType wxEVT_SCROLLWIN_THUMBRELEASE
;
4460 wxEventType wxEVT_SIZE
;
4461 wxEventType wxEVT_MOVE
;
4462 wxEventType wxEVT_CLOSE_WINDOW
;
4463 wxEventType wxEVT_END_SESSION
;
4464 wxEventType wxEVT_QUERY_END_SESSION
;
4465 wxEventType wxEVT_ACTIVATE_APP
;
4466 wxEventType wxEVT_ACTIVATE
;
4467 wxEventType wxEVT_CREATE
;
4468 wxEventType wxEVT_DESTROY
;
4469 wxEventType wxEVT_SHOW
;
4470 wxEventType wxEVT_ICONIZE
;
4471 wxEventType wxEVT_MAXIMIZE
;
4472 wxEventType wxEVT_MOUSE_CAPTURE_CHANGED
;
4473 wxEventType wxEVT_MOUSE_CAPTURE_LOST
;
4474 wxEventType wxEVT_PAINT
;
4475 wxEventType wxEVT_ERASE_BACKGROUND
;
4476 wxEventType wxEVT_NC_PAINT
;
4477 wxEventType wxEVT_MENU_OPEN
;
4478 wxEventType wxEVT_MENU_CLOSE
;
4479 wxEventType wxEVT_MENU_HIGHLIGHT
;
4480 wxEventType wxEVT_CONTEXT_MENU
;
4481 wxEventType wxEVT_SYS_COLOUR_CHANGED
;
4482 wxEventType wxEVT_DISPLAY_CHANGED
;
4483 wxEventType wxEVT_QUERY_NEW_PALETTE
;
4484 wxEventType wxEVT_PALETTE_CHANGED
;
4485 wxEventType wxEVT_JOY_BUTTON_DOWN
;
4486 wxEventType wxEVT_JOY_BUTTON_UP
;
4487 wxEventType wxEVT_JOY_MOVE
;
4488 wxEventType wxEVT_JOY_ZMOVE
;
4489 wxEventType wxEVT_DROP_FILES
;
4490 wxEventType wxEVT_INIT_DIALOG
;
4491 wxEventType wxEVT_IDLE
;
4492 wxEventType wxEVT_UPDATE_UI
;
4493 wxEventType wxEVT_SIZING
;
4494 wxEventType wxEVT_MOVING
;
4495 wxEventType wxEVT_MOVE_START
;
4496 wxEventType wxEVT_MOVE_END
;
4497 wxEventType wxEVT_HIBERNATE
;
4498 wxEventType wxEVT_COMMAND_TEXT_COPY
;
4499 wxEventType wxEVT_COMMAND_TEXT_CUT
;
4500 wxEventType wxEVT_COMMAND_TEXT_PASTE
;
4501 wxEventType wxEVT_COMMAND_LEFT_CLICK
;
4502 wxEventType wxEVT_COMMAND_LEFT_DCLICK
;
4503 wxEventType wxEVT_COMMAND_RIGHT_CLICK
;
4504 wxEventType wxEVT_COMMAND_RIGHT_DCLICK
;
4505 wxEventType wxEVT_COMMAND_SET_FOCUS
;
4506 wxEventType wxEVT_COMMAND_KILL_FOCUS
;
4507 wxEventType wxEVT_COMMAND_ENTER
;
4508 wxEventType wxEVT_HELP
;
4509 wxEventType wxEVT_DETAILED_HELP
;
4510 wxEventType wxEVT_COMMAND_TEXT_UPDATED
;
4511 wxEventType wxEVT_COMMAND_TOOL_CLICKED
;
4512 wxEventType wxEVT_WINDOW_MODAL_DIALOG_CLOSED
;