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 which is sent to the active
1369 wxTopLevelWindow (i.e. the one containing the currently focused window)
1370 or wxApp global object if there is no active window before any other
1371 keyboard events are generated giving the parent window the opportunity
1372 to intercept all the keyboard entry. If the event is handled, i.e. the
1373 handler doesn't call wxEvent::Skip(), neither @c wxEVT_KEY_DOWN nor @c
1374 wxEVT_CHAR events will be generated (although @c wxEVT_KEY_UP still
1375 will be). Notice that this event is not generated when the mouse is
1376 captured as it is considered that the window which has the capture
1377 should receive all the keyboard events too without allowing its parent
1378 wxTopLevelWindow to interfere with their processing.
1381 @see wxKeyboardState
1386 class wxKeyEvent
: public wxEvent
,
1387 public wxKeyboardState
1392 Currently, the only valid event types are @c wxEVT_CHAR and @c wxEVT_CHAR_HOOK.
1394 wxKeyEvent(wxEventType keyEventType
= wxEVT_NULL
);
1397 Returns the key code of the key that generated this event.
1399 ASCII symbols return normal ASCII values, while events from special
1400 keys such as "left cursor arrow" (@c WXK_LEFT) return values outside of
1401 the ASCII range. See ::wxKeyCode for a full list of the virtual key
1404 Note that this method returns a meaningful value only for special
1405 non-alphanumeric keys or if the user entered a character that can be
1406 represented in current locale's default charset. Otherwise, e.g. if the
1407 user enters a Japanese character in a program not using Japanese
1408 locale, this method returns @c WXK_NONE and GetUnicodeKey() should be
1409 used to obtain the corresponding Unicode character.
1411 Using GetUnicodeKey() is in general the right thing to do if you are
1412 interested in the characters typed by the user, GetKeyCode() should be
1413 only used for special keys (for which GetUnicodeKey() returns @c
1414 WXK_NONE). To handle both kinds of keys you might write:
1416 void MyHandler::OnChar(wxKeyEvent& event)
1418 if ( event.GetUnicodeKey() != WXK_NONE )
1420 // It's a printable character
1421 wxLogMessage("You pressed '%c'", event.GetUnicodeKey());
1425 // It's a special key, deal with all the known ones:
1441 int GetKeyCode() const;
1444 Returns true if the key is in the given key category.
1447 A bitwise combination of named ::wxKeyCategoryFlags constants.
1451 bool IsKeyInCategory(int category
) const;
1455 Obtains the position (in client coordinates) at which the key was pressed.
1457 wxPoint
GetPosition() const;
1458 void GetPosition(long* x
, long* y
) const;
1462 Returns the raw key code for this event.
1464 The flags are platform-dependent and should only be used if the
1465 functionality provided by other wxKeyEvent methods is insufficient.
1467 Under MSW, the raw key code is the value of @c wParam parameter of the
1468 corresponding message.
1470 Under GTK, the raw key code is the @c keyval field of the corresponding
1473 Under OS X, the raw key code is the @c keyCode field of the
1474 corresponding NSEvent.
1476 @note Currently the raw key codes are not supported by all ports, use
1477 @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
1479 wxUint32
GetRawKeyCode() const;
1482 Returns the low level key flags for this event.
1484 The flags are platform-dependent and should only be used if the
1485 functionality provided by other wxKeyEvent methods is insufficient.
1487 Under MSW, the raw flags are just the value of @c lParam parameter of
1488 the corresponding message.
1490 Under GTK, the raw flags contain the @c hardware_keycode field of the
1491 corresponding GDK event.
1493 Under OS X, the raw flags contain the modifiers state.
1495 @note Currently the raw key flags are not supported by all ports, use
1496 @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
1498 wxUint32
GetRawKeyFlags() const;
1501 Returns the Unicode character corresponding to this key event.
1503 If the key pressed doesn't have any character value (e.g. a cursor key)
1504 this method will return @c WXK_NONE. In this case you should use
1505 GetKeyCode() to retrieve the value of the key.
1507 This function is only available in Unicode build, i.e. when
1508 @c wxUSE_UNICODE is 1.
1510 wxChar
GetUnicodeKey() const;
1513 Returns the X position (in client coordinates) of the event.
1515 wxCoord
GetX() const;
1518 Returns the Y position (in client coordinates) of the event.
1520 wxCoord
GetY() const;
1526 @class wxJoystickEvent
1528 This event class contains information about joystick events, particularly
1529 events received by windows.
1531 @beginEventTable{wxJoystickEvent}
1532 @event{EVT_JOY_BUTTON_DOWN(func)}
1533 Process a @c wxEVT_JOY_BUTTON_DOWN event.
1534 @event{EVT_JOY_BUTTON_UP(func)}
1535 Process a @c wxEVT_JOY_BUTTON_UP event.
1536 @event{EVT_JOY_MOVE(func)}
1537 Process a @c wxEVT_JOY_MOVE event.
1538 @event{EVT_JOY_ZMOVE(func)}
1539 Process a @c wxEVT_JOY_ZMOVE event.
1540 @event{EVT_JOYSTICK_EVENTS(func)}
1541 Processes all joystick events.
1549 class wxJoystickEvent
: public wxEvent
1555 wxJoystickEvent(wxEventType eventType
= wxEVT_NULL
, int state
= 0,
1556 int joystick
= wxJOYSTICK1
,
1560 Returns @true if the event was a down event from the specified button
1564 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1565 indicate any button down event.
1567 bool ButtonDown(int button
= wxJOY_BUTTON_ANY
) const;
1570 Returns @true if the specified button (or any button) was in a down state.
1573 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1574 indicate any button down event.
1576 bool ButtonIsDown(int button
= wxJOY_BUTTON_ANY
) const;
1579 Returns @true if the event was an up event from the specified button
1583 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1584 indicate any button down event.
1586 bool ButtonUp(int button
= wxJOY_BUTTON_ANY
) const;
1589 Returns the identifier of the button changing state.
1591 This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
1593 int GetButtonChange() const;
1596 Returns the down state of the buttons.
1598 This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
1600 int GetButtonState() const;
1603 Returns the identifier of the joystick generating the event - one of
1604 wxJOYSTICK1 and wxJOYSTICK2.
1606 int GetJoystick() const;
1609 Returns the x, y position of the joystick event.
1611 wxPoint
GetPosition() const;
1614 Returns the z position of the joystick event.
1616 int GetZPosition() const;
1619 Returns @true if this was a button up or down event
1620 (@e not 'is any button down?').
1622 bool IsButton() const;
1625 Returns @true if this was an x, y move event.
1627 bool IsMove() const;
1630 Returns @true if this was a z move event.
1632 bool IsZMove() const;
1638 @class wxScrollWinEvent
1640 A scroll event holds information about events sent from scrolling windows.
1642 Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events
1643 from the receiving window.
1645 @beginEventTable{wxScrollWinEvent}
1646 @event{EVT_SCROLLWIN(func)}
1647 Process all scroll events.
1648 @event{EVT_SCROLLWIN_TOP(func)}
1649 Process @c wxEVT_SCROLLWIN_TOP scroll-to-top events.
1650 @event{EVT_SCROLLWIN_BOTTOM(func)}
1651 Process @c wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
1652 @event{EVT_SCROLLWIN_LINEUP(func)}
1653 Process @c wxEVT_SCROLLWIN_LINEUP line up events.
1654 @event{EVT_SCROLLWIN_LINEDOWN(func)}
1655 Process @c wxEVT_SCROLLWIN_LINEDOWN line down events.
1656 @event{EVT_SCROLLWIN_PAGEUP(func)}
1657 Process @c wxEVT_SCROLLWIN_PAGEUP page up events.
1658 @event{EVT_SCROLLWIN_PAGEDOWN(func)}
1659 Process @c wxEVT_SCROLLWIN_PAGEDOWN page down events.
1660 @event{EVT_SCROLLWIN_THUMBTRACK(func)}
1661 Process @c wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
1662 (frequent events sent as the user drags the thumbtrack).
1663 @event{EVT_SCROLLWIN_THUMBRELEASE(func)}
1664 Process @c wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
1671 @see wxScrollEvent, @ref overview_events
1673 class wxScrollWinEvent
: public wxEvent
1679 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
, int pos
= 0,
1680 int orientation
= 0);
1683 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
1686 @todo wxHORIZONTAL and wxVERTICAL should go in their own enum
1688 int GetOrientation() const;
1691 Returns the position of the scrollbar for the thumb track and release events.
1693 Note that this field can't be used for the other events, you need to query
1694 the window itself for the current position in that case.
1696 int GetPosition() const;
1698 void SetOrientation(int orient
);
1699 void SetPosition(int pos
);
1705 @class wxSysColourChangedEvent
1707 This class is used for system colour change events, which are generated
1708 when the user changes the colour settings using the control panel.
1709 This is only appropriate under Windows.
1712 The default event handler for this event propagates the event to child windows,
1713 since Windows only sends the events to top-level windows.
1714 If intercepting this event for a top-level window, remember to call the base
1715 class handler, or to pass the event on to the window's children explicitly.
1717 @beginEventTable{wxSysColourChangedEvent}
1718 @event{EVT_SYS_COLOUR_CHANGED(func)}
1719 Process a @c wxEVT_SYS_COLOUR_CHANGED event.
1725 @see @ref overview_events
1727 class wxSysColourChangedEvent
: public wxEvent
1733 wxSysColourChangedEvent();
1739 @class wxWindowCreateEvent
1741 This event is sent just after the actual window associated with a wxWindow
1742 object has been created.
1744 Since it is derived from wxCommandEvent, the event propagates up
1745 the window hierarchy.
1747 @beginEventTable{wxWindowCreateEvent}
1748 @event{EVT_WINDOW_CREATE(func)}
1749 Process a @c wxEVT_CREATE event.
1755 @see @ref overview_events, wxWindowDestroyEvent
1757 class wxWindowCreateEvent
: public wxCommandEvent
1763 wxWindowCreateEvent(wxWindow
* win
= NULL
);
1765 /// Return the window being created.
1766 wxWindow
*GetWindow() const;
1774 A paint event is sent when a window's contents needs to be repainted.
1776 The handler of this event must create a wxPaintDC object and use it for
1777 painting the window contents. For example:
1779 void MyWindow::OnPaint(wxPaintEvent& event)
1787 Notice that you must @e not create other kinds of wxDC (e.g. wxClientDC or
1788 wxWindowDC) in EVT_PAINT handlers and also don't create wxPaintDC outside
1789 of this event handlers.
1792 You can optimize painting by retrieving the rectangles that have been damaged
1793 and only repainting these. The rectangles are in terms of the client area,
1794 and are unscrolled, so you will need to do some calculations using the current
1795 view position to obtain logical, scrolled units.
1796 Here is an example of using the wxRegionIterator class:
1798 // Called when window needs to be repainted.
1799 void MyWindow::OnPaint(wxPaintEvent& event)
1803 // Find Out where the window is scrolled to
1804 int vbX,vbY; // Top left corner of client
1805 GetViewStart(&vbX,&vbY);
1807 int vX,vY,vW,vH; // Dimensions of client area in pixels
1808 wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
1817 // Alternatively we can do this:
1818 // wxRect rect(upd.GetRect());
1820 // Repaint this rectangle
1829 Please notice that in general it is impossible to change the drawing of a
1830 standard control (such as wxButton) and so you shouldn't attempt to handle
1831 paint events for them as even if it might work on some platforms, this is
1832 inherently not portable and won't work everywhere.
1835 @beginEventTable{wxPaintEvent}
1836 @event{EVT_PAINT(func)}
1837 Process a @c wxEVT_PAINT event.
1843 @see @ref overview_events
1845 class wxPaintEvent
: public wxEvent
1851 wxPaintEvent(int id
= 0);
1857 @class wxMaximizeEvent
1859 An event being sent when a top level window is maximized. Notice that it is
1860 not sent when the window is restored to its original size after it had been
1861 maximized, only a normal wxSizeEvent is generated in this case.
1863 Currently this event is only generated in wxMSW, wxGTK, wxOSX/Cocoa and wxOS2
1864 ports so portable programs should only rely on receiving @c wxEVT_SIZE and
1865 not necessarily this event when the window is maximized.
1867 @beginEventTable{wxMaximizeEvent}
1868 @event{EVT_MAXIMIZE(func)}
1869 Process a @c wxEVT_MAXIMIZE event.
1875 @see @ref overview_events, wxTopLevelWindow::Maximize,
1876 wxTopLevelWindow::IsMaximized
1878 class wxMaximizeEvent
: public wxEvent
1882 Constructor. Only used by wxWidgets internally.
1884 wxMaximizeEvent(int id
= 0);
1888 The possibles modes to pass to wxUpdateUIEvent::SetMode().
1892 /** Send UI update events to all windows. */
1893 wxUPDATE_UI_PROCESS_ALL
,
1895 /** Send UI update events to windows that have
1896 the wxWS_EX_PROCESS_UI_UPDATES flag specified. */
1897 wxUPDATE_UI_PROCESS_SPECIFIED
1902 @class wxUpdateUIEvent
1904 This class is used for pseudo-events which are called by wxWidgets
1905 to give an application the chance to update various user interface elements.
1907 Without update UI events, an application has to work hard to check/uncheck,
1908 enable/disable, show/hide, and set the text for elements such as menu items
1909 and toolbar buttons. The code for doing this has to be mixed up with the code
1910 that is invoked when an action is invoked for a menu item or button.
1912 With update UI events, you define an event handler to look at the state of the
1913 application and change UI elements accordingly. wxWidgets will call your member
1914 functions in idle time, so you don't have to worry where to call this code.
1916 In addition to being a clearer and more declarative method, it also means you don't
1917 have to worry whether you're updating a toolbar or menubar identifier. The same
1918 handler can update a menu item and toolbar button, if the identifier is the same.
1919 Instead of directly manipulating the menu or button, you call functions in the event
1920 object, such as wxUpdateUIEvent::Check. wxWidgets will determine whether such a
1921 call has been made, and which UI element to update.
1923 These events will work for popup menus as well as menubars. Just before a menu is
1924 popped up, wxMenu::UpdateUI is called to process any UI events for the window that
1927 If you find that the overhead of UI update processing is affecting your application,
1928 you can do one or both of the following:
1929 @li Call wxUpdateUIEvent::SetMode with a value of wxUPDATE_UI_PROCESS_SPECIFIED,
1930 and set the extra style wxWS_EX_PROCESS_UI_UPDATES for every window that should
1931 receive update events. No other windows will receive update events.
1932 @li Call wxUpdateUIEvent::SetUpdateInterval with a millisecond value to set the delay
1933 between updates. You may need to call wxWindow::UpdateWindowUI at critical points,
1934 for example when a dialog is about to be shown, in case the user sees a slight
1935 delay before windows are updated.
1937 Note that although events are sent in idle time, defining a wxIdleEvent handler
1938 for a window does not affect this because the events are sent from wxWindow::OnInternalIdle
1939 which is always called in idle time.
1941 wxWidgets tries to optimize update events on some platforms.
1942 On Windows and GTK+, events for menubar items are only sent when the menu is about
1943 to be shown, and not in idle time.
1946 @beginEventTable{wxUpdateUIEvent}
1947 @event{EVT_UPDATE_UI(id, func)}
1948 Process a @c wxEVT_UPDATE_UI event for the command with the given id.
1949 @event{EVT_UPDATE_UI_RANGE(id1, id2, func)}
1950 Process a @c wxEVT_UPDATE_UI event for any command with id included in the given range.
1956 @see @ref overview_events
1958 class wxUpdateUIEvent
: public wxCommandEvent
1964 wxUpdateUIEvent(wxWindowID commandId
= 0);
1967 Returns @true if it is appropriate to update (send UI update events to)
1970 This function looks at the mode used (see wxUpdateUIEvent::SetMode),
1971 the wxWS_EX_PROCESS_UI_UPDATES flag in @a window, the time update events
1972 were last sent in idle time, and the update interval, to determine whether
1973 events should be sent to this window now. By default this will always
1974 return @true because the update mode is initially wxUPDATE_UI_PROCESS_ALL
1975 and the interval is set to 0; so update events will be sent as often as
1976 possible. You can reduce the frequency that events are sent by changing the
1977 mode and/or setting an update interval.
1979 @see ResetUpdateTime(), SetUpdateInterval(), SetMode()
1981 static bool CanUpdate(wxWindow
* window
);
1984 Check or uncheck the UI element.
1986 void Check(bool check
);
1989 Enable or disable the UI element.
1991 void Enable(bool enable
);
1994 Returns @true if the UI element should be checked.
1996 bool GetChecked() const;
1999 Returns @true if the UI element should be enabled.
2001 bool GetEnabled() const;
2004 Static function returning a value specifying how wxWidgets will send update
2005 events: to all windows, or only to those which specify that they will process
2010 static wxUpdateUIMode
GetMode();
2013 Returns @true if the application has called Check().
2014 For wxWidgets internal use only.
2016 bool GetSetChecked() const;
2019 Returns @true if the application has called Enable().
2020 For wxWidgets internal use only.
2022 bool GetSetEnabled() const;
2025 Returns @true if the application has called Show().
2026 For wxWidgets internal use only.
2028 bool GetSetShown() const;
2031 Returns @true if the application has called SetText().
2032 For wxWidgets internal use only.
2034 bool GetSetText() const;
2037 Returns @true if the UI element should be shown.
2039 bool GetShown() const;
2042 Returns the text that should be set for the UI element.
2044 wxString
GetText() const;
2047 Returns the current interval between updates in milliseconds.
2048 The value -1 disables updates, 0 updates as frequently as possible.
2050 @see SetUpdateInterval().
2052 static long GetUpdateInterval();
2055 Used internally to reset the last-updated time to the current time.
2057 It is assumed that update events are normally sent in idle time, so this
2058 is called at the end of idle processing.
2060 @see CanUpdate(), SetUpdateInterval(), SetMode()
2062 static void ResetUpdateTime();
2065 Specify how wxWidgets will send update events: to all windows, or only to
2066 those which specify that they will process the events.
2069 this parameter may be one of the ::wxUpdateUIMode enumeration values.
2070 The default mode is wxUPDATE_UI_PROCESS_ALL.
2072 static void SetMode(wxUpdateUIMode mode
);
2075 Sets the text for this UI element.
2077 void SetText(const wxString
& text
);
2080 Sets the interval between updates in milliseconds.
2082 Set to -1 to disable updates, or to 0 to update as frequently as possible.
2085 Use this to reduce the overhead of UI update events if your application
2086 has a lot of windows. If you set the value to -1 or greater than 0,
2087 you may also need to call wxWindow::UpdateWindowUI at appropriate points
2088 in your application, such as when a dialog is about to be shown.
2090 static void SetUpdateInterval(long updateInterval
);
2093 Show or hide the UI element.
2095 void Show(bool show
);
2101 @class wxClipboardTextEvent
2103 This class represents the events generated by a control (typically a
2104 wxTextCtrl but other windows can generate these events as well) when its
2105 content gets copied or cut to, or pasted from the clipboard.
2107 There are three types of corresponding events @c wxEVT_COMMAND_TEXT_COPY,
2108 @c wxEVT_COMMAND_TEXT_CUT and @c wxEVT_COMMAND_TEXT_PASTE.
2110 If any of these events is processed (without being skipped) by an event
2111 handler, the corresponding operation doesn't take place which allows to
2112 prevent the text from being copied from or pasted to a control. It is also
2113 possible to examine the clipboard contents in the PASTE event handler and
2114 transform it in some way before inserting in a control -- for example,
2115 changing its case or removing invalid characters.
2117 Finally notice that a CUT event is always preceded by the COPY event which
2118 makes it possible to only process the latter if it doesn't matter if the
2119 text was copied or cut.
2122 These events are currently only generated by wxTextCtrl under GTK+.
2123 They are generated by all controls under Windows.
2125 @beginEventTable{wxClipboardTextEvent}
2126 @event{EVT_TEXT_COPY(id, func)}
2127 Some or all of the controls content was copied to the clipboard.
2128 @event{EVT_TEXT_CUT(id, func)}
2129 Some or all of the controls content was cut (i.e. copied and
2131 @event{EVT_TEXT_PASTE(id, func)}
2132 Clipboard content was pasted into the control.
2141 class wxClipboardTextEvent
: public wxCommandEvent
2147 wxClipboardTextEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0);
2155 This event class contains information about the events generated by the mouse:
2156 they include mouse buttons press and release events and mouse move events.
2158 All mouse events involving the buttons use @c wxMOUSE_BTN_LEFT for the
2159 left mouse button, @c wxMOUSE_BTN_MIDDLE for the middle one and
2160 @c wxMOUSE_BTN_RIGHT for the right one. And if the system supports more
2161 buttons, the @c wxMOUSE_BTN_AUX1 and @c wxMOUSE_BTN_AUX2 events
2162 can also be generated. Note that not all mice have even a middle button so a
2163 portable application should avoid relying on the events from it (but the right
2164 button click can be emulated using the left mouse button with the control key
2165 under Mac platforms with a single button mouse).
2167 For the @c wxEVT_ENTER_WINDOW and @c wxEVT_LEAVE_WINDOW events
2168 purposes, the mouse is considered to be inside the window if it is in the
2169 window client area and not inside one of its children. In other words, the
2170 parent window receives @c wxEVT_LEAVE_WINDOW event not only when the
2171 mouse leaves the window entirely but also when it enters one of its children.
2173 The position associated with a mouse event is expressed in the window
2174 coordinates of the window which generated the event, you can use
2175 wxWindow::ClientToScreen() to convert it to screen coordinates and possibly
2176 call wxWindow::ScreenToClient() next to convert it to window coordinates of
2179 @note Note that under Windows CE mouse enter and leave events are not natively
2180 supported by the system but are generated by wxWidgets itself. This has several
2181 drawbacks: the LEAVE_WINDOW event might be received some time after the mouse
2182 left the window and the state variables for it may have changed during this time.
2184 @note Note the difference between methods like wxMouseEvent::LeftDown and
2185 the inherited wxMouseState::LeftIsDown: the former returns @true when
2186 the event corresponds to the left mouse button click while the latter
2187 returns @true if the left mouse button is currently being pressed.
2188 For example, when the user is dragging the mouse you can use
2189 wxMouseEvent::LeftIsDown to test whether the left mouse button is
2190 (still) depressed. Also, by convention, if wxMouseEvent::LeftDown
2191 returns @true, wxMouseEvent::LeftIsDown will also return @true in
2192 wxWidgets whatever the underlying GUI behaviour is (which is
2193 platform-dependent). The same applies, of course, to other mouse
2197 @beginEventTable{wxMouseEvent}
2198 @event{EVT_LEFT_DOWN(func)}
2199 Process a @c wxEVT_LEFT_DOWN event. The handler of this event should normally
2200 call event.Skip() to allow the default processing to take place as otherwise
2201 the window under mouse wouldn't get the focus.
2202 @event{EVT_LEFT_UP(func)}
2203 Process a @c wxEVT_LEFT_UP event.
2204 @event{EVT_LEFT_DCLICK(func)}
2205 Process a @c wxEVT_LEFT_DCLICK event.
2206 @event{EVT_MIDDLE_DOWN(func)}
2207 Process a @c wxEVT_MIDDLE_DOWN event.
2208 @event{EVT_MIDDLE_UP(func)}
2209 Process a @c wxEVT_MIDDLE_UP event.
2210 @event{EVT_MIDDLE_DCLICK(func)}
2211 Process a @c wxEVT_MIDDLE_DCLICK event.
2212 @event{EVT_RIGHT_DOWN(func)}
2213 Process a @c wxEVT_RIGHT_DOWN event.
2214 @event{EVT_RIGHT_UP(func)}
2215 Process a @c wxEVT_RIGHT_UP event.
2216 @event{EVT_RIGHT_DCLICK(func)}
2217 Process a @c wxEVT_RIGHT_DCLICK event.
2218 @event{EVT_MOUSE_AUX1_DOWN(func)}
2219 Process a @c wxEVT_AUX1_DOWN event.
2220 @event{EVT_MOUSE_AUX1_UP(func)}
2221 Process a @c wxEVT_AUX1_UP event.
2222 @event{EVT_MOUSE_AUX1_DCLICK(func)}
2223 Process a @c wxEVT_AUX1_DCLICK event.
2224 @event{EVT_MOUSE_AUX2_DOWN(func)}
2225 Process a @c wxEVT_AUX2_DOWN event.
2226 @event{EVT_MOUSE_AUX2_UP(func)}
2227 Process a @c wxEVT_AUX2_UP event.
2228 @event{EVT_MOUSE_AUX2_DCLICK(func)}
2229 Process a @c wxEVT_AUX2_DCLICK event.
2230 @event{EVT_MOTION(func)}
2231 Process a @c wxEVT_MOTION event.
2232 @event{EVT_ENTER_WINDOW(func)}
2233 Process a @c wxEVT_ENTER_WINDOW event.
2234 @event{EVT_LEAVE_WINDOW(func)}
2235 Process a @c wxEVT_LEAVE_WINDOW event.
2236 @event{EVT_MOUSEWHEEL(func)}
2237 Process a @c wxEVT_MOUSEWHEEL event.
2238 @event{EVT_MOUSE_EVENTS(func)}
2239 Process all mouse events.
2247 class wxMouseEvent
: public wxEvent
,
2252 Constructor. Valid event types are:
2254 @li @c wxEVT_ENTER_WINDOW
2255 @li @c wxEVT_LEAVE_WINDOW
2256 @li @c wxEVT_LEFT_DOWN
2257 @li @c wxEVT_LEFT_UP
2258 @li @c wxEVT_LEFT_DCLICK
2259 @li @c wxEVT_MIDDLE_DOWN
2260 @li @c wxEVT_MIDDLE_UP
2261 @li @c wxEVT_MIDDLE_DCLICK
2262 @li @c wxEVT_RIGHT_DOWN
2263 @li @c wxEVT_RIGHT_UP
2264 @li @c wxEVT_RIGHT_DCLICK
2265 @li @c wxEVT_AUX1_DOWN
2266 @li @c wxEVT_AUX1_UP
2267 @li @c wxEVT_AUX1_DCLICK
2268 @li @c wxEVT_AUX2_DOWN
2269 @li @c wxEVT_AUX2_UP
2270 @li @c wxEVT_AUX2_DCLICK
2272 @li @c wxEVT_MOUSEWHEEL
2274 wxMouseEvent(wxEventType mouseEventType
= wxEVT_NULL
);
2277 Returns @true if the event was a first extra button double click.
2279 bool Aux1DClick() const;
2282 Returns @true if the first extra button mouse button changed to down.
2284 bool Aux1Down() const;
2287 Returns @true if the first extra button mouse button changed to up.
2289 bool Aux1Up() const;
2292 Returns @true if the event was a second extra button double click.
2294 bool Aux2DClick() const;
2297 Returns @true if the second extra button mouse button changed to down.
2299 bool Aux2Down() const;
2302 Returns @true if the second extra button mouse button changed to up.
2304 bool Aux2Up() const;
2307 Returns @true if the event was generated by the specified button.
2309 @see wxMouseState::ButtoinIsDown()
2311 bool Button(wxMouseButton but
) const;
2314 If the argument is omitted, this returns @true if the event was a mouse
2315 double click event. Otherwise the argument specifies which double click event
2316 was generated (see Button() for the possible values).
2318 bool ButtonDClick(wxMouseButton but
= wxMOUSE_BTN_ANY
) const;
2321 If the argument is omitted, this returns @true if the event was a mouse
2322 button down event. Otherwise the argument specifies which button-down event
2323 was generated (see Button() for the possible values).
2325 bool ButtonDown(wxMouseButton but
= wxMOUSE_BTN_ANY
) const;
2328 If the argument is omitted, this returns @true if the event was a mouse
2329 button up event. Otherwise the argument specifies which button-up event
2330 was generated (see Button() for the possible values).
2332 bool ButtonUp(wxMouseButton but
= wxMOUSE_BTN_ANY
) const;
2335 Returns @true if this was a dragging event (motion while a button is depressed).
2339 bool Dragging() const;
2342 Returns @true if the mouse was entering the window.
2346 bool Entering() const;
2349 Returns the mouse button which generated this event or @c wxMOUSE_BTN_NONE
2350 if no button is involved (for mouse move, enter or leave event, for example).
2351 Otherwise @c wxMOUSE_BTN_LEFT is returned for the left button down, up and
2352 double click events, @c wxMOUSE_BTN_MIDDLE and @c wxMOUSE_BTN_RIGHT
2353 for the same events for the middle and the right buttons respectively.
2355 int GetButton() const;
2358 Returns the number of mouse clicks for this event: 1 for a simple click, 2
2359 for a double-click, 3 for a triple-click and so on.
2361 Currently this function is implemented only in wxMac and returns -1 for the
2362 other platforms (you can still distinguish simple clicks from double-clicks as
2363 they generate different kinds of events however).
2367 int GetClickCount() const;
2370 Returns the configured number of lines (or whatever) to be scrolled per
2371 wheel action. Defaults to three.
2373 int GetLinesPerAction() const;
2376 Returns the logical mouse position in pixels (i.e. translated according to the
2377 translation set for the DC, which usually indicates that the window has been
2380 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
2383 Get wheel delta, normally 120.
2385 This is the threshold for action to be taken, and one such action
2386 (for example, scrolling one increment) should occur for each delta.
2388 int GetWheelDelta() const;
2391 Get wheel rotation, positive or negative indicates direction of rotation.
2393 Current devices all send an event when rotation is at least +/-WheelDelta, but
2394 finer resolution devices can be created in the future.
2396 Because of this you shouldn't assume that one event is equal to 1 line, but you
2397 should be able to either do partial line scrolling or wait until several
2398 events accumulate before scrolling.
2400 int GetWheelRotation() const;
2403 Gets the axis the wheel operation concerns; @c 0 is the Y axis as on
2404 most mouse wheels, @c 1 is the X axis.
2406 Note that only some models of mouse have horizontal wheel axis.
2408 int GetWheelAxis() const;
2411 Returns @true if the event was a mouse button event (not necessarily a button
2412 down event - that may be tested using ButtonDown()).
2414 bool IsButton() const;
2417 Returns @true if the system has been setup to do page scrolling with
2418 the mouse wheel instead of line scrolling.
2420 bool IsPageScroll() const;
2423 Returns @true if the mouse was leaving the window.
2427 bool Leaving() const;
2430 Returns @true if the event was a left double click.
2432 bool LeftDClick() const;
2435 Returns @true if the left mouse button changed to down.
2437 bool LeftDown() const;
2440 Returns @true if the left mouse button changed to up.
2442 bool LeftUp() const;
2445 Returns @true if the Meta key was down at the time of the event.
2447 bool MetaDown() const;
2450 Returns @true if the event was a middle double click.
2452 bool MiddleDClick() const;
2455 Returns @true if the middle mouse button changed to down.
2457 bool MiddleDown() const;
2460 Returns @true if the middle mouse button changed to up.
2462 bool MiddleUp() const;
2465 Returns @true if this was a motion event and no mouse buttons were pressed.
2466 If any mouse button is held pressed, then this method returns @false and
2467 Dragging() returns @true.
2469 bool Moving() const;
2472 Returns @true if the event was a right double click.
2474 bool RightDClick() const;
2477 Returns @true if the right mouse button changed to down.
2479 bool RightDown() const;
2482 Returns @true if the right mouse button changed to up.
2484 bool RightUp() const;
2490 @class wxDropFilesEvent
2492 This class is used for drop files events, that is, when files have been dropped
2493 onto the window. This functionality is currently only available under Windows.
2495 The window must have previously been enabled for dropping by calling
2496 wxWindow::DragAcceptFiles().
2498 Important note: this is a separate implementation to the more general drag and drop
2499 implementation documented in the @ref overview_dnd. It uses the older, Windows
2500 message-based approach of dropping files.
2502 @beginEventTable{wxDropFilesEvent}
2503 @event{EVT_DROP_FILES(func)}
2504 Process a @c wxEVT_DROP_FILES event.
2512 @see @ref overview_events
2514 class wxDropFilesEvent
: public wxEvent
2520 wxDropFilesEvent(wxEventType id
= 0, int noFiles
= 0,
2521 wxString
* files
= NULL
);
2524 Returns an array of filenames.
2526 wxString
* GetFiles() const;
2529 Returns the number of files dropped.
2531 int GetNumberOfFiles() const;
2534 Returns the position at which the files were dropped.
2535 Returns an array of filenames.
2537 wxPoint
GetPosition() const;
2543 @class wxCommandEvent
2545 This event class contains information about command events, which originate
2546 from a variety of simple controls.
2548 Note that wxCommandEvents and wxCommandEvent-derived event classes by default
2549 and unlike other wxEvent-derived classes propagate upward from the source
2550 window (the window which emits the event) up to the first parent which processes
2551 the event. Be sure to read @ref overview_events_propagation.
2553 More complex controls, such as wxTreeCtrl, have separate command event classes.
2555 @beginEventTable{wxCommandEvent}
2556 @event{EVT_COMMAND(id, event, func)}
2557 Process a command, supplying the window identifier, command event identifier,
2558 and member function.
2559 @event{EVT_COMMAND_RANGE(id1, id2, event, func)}
2560 Process a command for a range of window identifiers, supplying the minimum and
2561 maximum window identifiers, command event identifier, and member function.
2562 @event{EVT_BUTTON(id, func)}
2563 Process a @c wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wxButton control.
2564 @event{EVT_CHECKBOX(id, func)}
2565 Process a @c wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wxCheckBox control.
2566 @event{EVT_CHOICE(id, func)}
2567 Process a @c wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wxChoice control.
2568 @event{EVT_COMBOBOX(id, func)}
2569 Process a @c wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wxComboBox control.
2570 @event{EVT_LISTBOX(id, func)}
2571 Process a @c wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.
2572 @event{EVT_LISTBOX_DCLICK(id, func)}
2573 Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.
2574 @event{EVT_CHECKLISTBOX(id, func)}
2575 Process a @c wxEVT_COMMAND_CHECKLISTBOX_TOGGLED command, which is generated by a wxCheckListBox control.
2576 @event{EVT_MENU(id, func)}
2577 Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
2578 @event{EVT_MENU_RANGE(id1, id2, func)}
2579 Process a @c wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.
2580 @event{EVT_CONTEXT_MENU(func)}
2581 Process the event generated when the user has requested a popup menu to appear by
2582 pressing a special keyboard key (under Windows) or by right clicking the mouse.
2583 @event{EVT_RADIOBOX(id, func)}
2584 Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wxRadioBox control.
2585 @event{EVT_RADIOBUTTON(id, func)}
2586 Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wxRadioButton control.
2587 @event{EVT_SCROLLBAR(id, func)}
2588 Process a @c wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a wxScrollBar
2589 control. This is provided for compatibility only; more specific scrollbar event macros
2590 should be used instead (see wxScrollEvent).
2591 @event{EVT_SLIDER(id, func)}
2592 Process a @c wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wxSlider control.
2593 @event{EVT_TEXT(id, func)}
2594 Process a @c wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wxTextCtrl control.
2595 @event{EVT_TEXT_ENTER(id, func)}
2596 Process a @c wxEVT_COMMAND_TEXT_ENTER command, which is generated by a wxTextCtrl control.
2597 Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it
2598 to generate such events.
2599 @event{EVT_TEXT_MAXLEN(id, func)}
2600 Process a @c wxEVT_COMMAND_TEXT_MAXLEN command, which is generated by a wxTextCtrl control
2601 when the user tries to enter more characters into it than the limit previously set
2602 with SetMaxLength().
2603 @event{EVT_TOGGLEBUTTON(id, func)}
2604 Process a @c wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event.
2605 @event{EVT_TOOL(id, func)}
2606 Process a @c wxEVT_COMMAND_TOOL_CLICKED event (a synonym for @c wxEVT_COMMAND_MENU_SELECTED).
2607 Pass the id of the tool.
2608 @event{EVT_TOOL_RANGE(id1, id2, func)}
2609 Process a @c wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools.
2610 @event{EVT_TOOL_RCLICKED(id, func)}
2611 Process a @c wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool. (Not available on wxOSX.)
2612 @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}
2613 Process a @c wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. (Not available on wxOSX.)
2614 @event{EVT_TOOL_ENTER(id, func)}
2615 Process a @c wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself.
2616 The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor
2617 has moved off a tool. (Not available on wxOSX.)
2618 @event{EVT_COMMAND_LEFT_CLICK(id, func)}
2619 Process a @c wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only).
2620 @event{EVT_COMMAND_LEFT_DCLICK(id, func)}
2621 Process a @c wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (wxMSW only).
2622 @event{EVT_COMMAND_RIGHT_CLICK(id, func)}
2623 Process a @c wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (wxMSW only).
2624 @event{EVT_COMMAND_SET_FOCUS(id, func)}
2625 Process a @c wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (wxMSW only).
2626 @event{EVT_COMMAND_KILL_FOCUS(id, func)}
2627 Process a @c wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (wxMSW only).
2628 @event{EVT_COMMAND_ENTER(id, func)}
2629 Process a @c wxEVT_COMMAND_ENTER command, which is generated by a control.
2635 class wxCommandEvent
: public wxEvent
2641 wxCommandEvent(wxEventType commandEventType
= wxEVT_NULL
, int id
= 0);
2644 Returns client data pointer for a listbox or choice selection event
2645 (not valid for a deselection).
2647 void* GetClientData() const;
2650 Returns client object pointer for a listbox or choice selection event
2651 (not valid for a deselection).
2653 wxClientData
* GetClientObject() const;
2656 Returns extra information dependant on the event objects type.
2658 If the event comes from a listbox selection, it is a boolean
2659 determining whether the event was a selection (@true) or a
2660 deselection (@false). A listbox deselection only occurs for
2661 multiple-selection boxes, and in this case the index and string values
2662 are indeterminate and the listbox must be examined by the application.
2664 long GetExtraLong() const;
2667 Returns the integer identifier corresponding to a listbox, choice or
2668 radiobox selection (only if the event was a selection, not a deselection),
2669 or a boolean value representing the value of a checkbox.
2671 For a menu item, this method returns -1 if the item is not checkable or
2672 a boolean value (true or false) for checkable items indicating the new
2678 Returns item index for a listbox or choice selection event (not valid for
2681 int GetSelection() const;
2684 Returns item string for a listbox or choice selection event. If one
2685 or several items have been deselected, returns the index of the first
2686 deselected item. If some items have been selected and others deselected
2687 at the same time, it will return the index of the first selected item.
2689 wxString
GetString() const;
2692 This method can be used with checkbox and menu events: for the checkboxes, the
2693 method returns @true for a selection event and @false for a deselection one.
2694 For the menu events, this method indicates if the menu item just has become
2695 checked or unchecked (and thus only makes sense for checkable menu items).
2697 Notice that this method cannot be used with wxCheckListBox currently.
2699 bool IsChecked() const;
2702 For a listbox or similar event, returns @true if it is a selection, @false
2703 if it is a deselection. If some items have been selected and others deselected
2704 at the same time, it will return @true.
2706 bool IsSelection() const;
2709 Sets the client data for this event.
2711 void SetClientData(void* clientData
);
2714 Sets the client object for this event. The client object is not owned by the
2715 event object and the event object will not delete the client object in its destructor.
2717 The client object must be owned and deleted by another object (e.g. a control)
2718 that has longer life time than the event object.
2720 void SetClientObject(wxClientData
* clientObject
);
2723 Sets the @b m_extraLong member.
2725 void SetExtraLong(long extraLong
);
2728 Sets the @b m_commandInt member.
2730 void SetInt(int intCommand
);
2733 Sets the @b m_commandString member.
2735 void SetString(const wxString
& string
);
2741 @class wxActivateEvent
2743 An activate event is sent when a window or application is being activated
2746 @beginEventTable{wxActivateEvent}
2747 @event{EVT_ACTIVATE(func)}
2748 Process a @c wxEVT_ACTIVATE event.
2749 @event{EVT_ACTIVATE_APP(func)}
2750 Process a @c wxEVT_ACTIVATE_APP event.
2751 This event is received by the wxApp-derived instance only.
2752 @event{EVT_HIBERNATE(func)}
2753 Process a hibernate event, supplying the member function. This event applies
2754 to wxApp only, and only on Windows SmartPhone and PocketPC.
2755 It is generated when the system is low on memory; the application should free
2756 up as much memory as possible, and restore full working state when it receives
2757 a @c wxEVT_ACTIVATE or @c wxEVT_ACTIVATE_APP event.
2763 @see @ref overview_events, wxApp::IsActive
2765 class wxActivateEvent
: public wxEvent
2771 wxActivateEvent(wxEventType eventType
= wxEVT_NULL
, bool active
= true,
2775 Returns @true if the application or window is being activated, @false otherwise.
2777 bool GetActive() const;
2783 @class wxContextMenuEvent
2785 This class is used for context menu events, sent to give
2786 the application a chance to show a context (popup) menu for a wxWindow.
2788 Note that if wxContextMenuEvent::GetPosition returns wxDefaultPosition, this
2789 means that the event originated from a keyboard context button event, and you
2790 should compute a suitable position yourself, for example by calling wxGetMousePosition().
2792 When a keyboard context menu button is pressed on Windows, a right-click event
2793 with default position is sent first, and if this event is not processed, the
2794 context menu event is sent. So if you process mouse events and you find your
2795 context menu event handler is not being called, you could call wxEvent::Skip()
2796 for mouse right-down events.
2798 @beginEventTable{wxContextMenuEvent}
2799 @event{EVT_CONTEXT_MENU(func)}
2800 A right click (or other context menu command depending on platform) has been detected.
2807 @see wxCommandEvent, @ref overview_events
2809 class wxContextMenuEvent
: public wxCommandEvent
2815 wxContextMenuEvent(wxEventType type
= wxEVT_NULL
, int id
= 0,
2816 const wxPoint
& pos
= wxDefaultPosition
);
2819 Returns the position in screen coordinates at which the menu should be shown.
2820 Use wxWindow::ScreenToClient to convert to client coordinates.
2822 You can also omit a position from wxWindow::PopupMenu in order to use
2823 the current mouse pointer position.
2825 If the event originated from a keyboard event, the value returned from this
2826 function will be wxDefaultPosition.
2828 const wxPoint
& GetPosition() const;
2831 Sets the position at which the menu should be shown.
2833 void SetPosition(const wxPoint
& point
);
2841 An erase event is sent when a window's background needs to be repainted.
2843 On some platforms, such as GTK+, this event is simulated (simply generated just
2844 before the paint event) and may cause flicker. It is therefore recommended that
2845 you set the text background colour explicitly in order to prevent flicker.
2846 The default background colour under GTK+ is grey.
2848 To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table
2851 You must call wxEraseEvent::GetDC and use the returned device context if it is
2852 non-@NULL. If it is @NULL, create your own temporary wxClientDC object.
2855 Use the device context returned by GetDC to draw on, don't create
2856 a wxPaintDC in the event handler.
2858 @beginEventTable{wxEraseEvent}
2859 @event{EVT_ERASE_BACKGROUND(func)}
2860 Process a @c wxEVT_ERASE_BACKGROUND event.
2866 @see @ref overview_events
2868 class wxEraseEvent
: public wxEvent
2874 wxEraseEvent(int id
= 0, wxDC
* dc
= NULL
);
2877 Returns the device context associated with the erase event to draw on.
2879 wxDC
* GetDC() const;
2887 A focus event is sent when a window's focus changes. The window losing focus
2888 receives a "kill focus" event while the window gaining it gets a "set focus" one.
2890 Notice that the set focus event happens both when the user gives focus to the
2891 window (whether using the mouse or keyboard) and when it is done from the
2892 program itself using wxWindow::SetFocus.
2894 @beginEventTable{wxFocusEvent}
2895 @event{EVT_SET_FOCUS(func)}
2896 Process a @c wxEVT_SET_FOCUS event.
2897 @event{EVT_KILL_FOCUS(func)}
2898 Process a @c wxEVT_KILL_FOCUS event.
2904 @see @ref overview_events
2906 class wxFocusEvent
: public wxEvent
2912 wxFocusEvent(wxEventType eventType
= wxEVT_NULL
, int id
= 0);
2915 Returns the window associated with this event, that is the window which had the
2916 focus before for the @c wxEVT_SET_FOCUS event and the window which is
2917 going to receive focus for the @c wxEVT_KILL_FOCUS one.
2919 Warning: the window pointer may be @NULL!
2921 wxWindow
*GetWindow() const;
2923 void SetWindow(wxWindow
*win
);
2929 @class wxChildFocusEvent
2931 A child focus event is sent to a (parent-)window when one of its child windows
2932 gains focus, so that the window could restore the focus back to its corresponding
2933 child if it loses it now and regains later.
2935 Notice that child window is the direct child of the window receiving event.
2936 Use wxWindow::FindFocus() to retrieve the window which is actually getting focus.
2938 @beginEventTable{wxChildFocusEvent}
2939 @event{EVT_CHILD_FOCUS(func)}
2940 Process a @c wxEVT_CHILD_FOCUS event.
2946 @see @ref overview_events
2948 class wxChildFocusEvent
: public wxCommandEvent
2955 The direct child which is (or which contains the window which is) receiving
2958 wxChildFocusEvent(wxWindow
* win
= NULL
);
2961 Returns the direct child which receives the focus, or a (grand-)parent of the
2962 control receiving the focus.
2964 To get the actually focused control use wxWindow::FindFocus.
2966 wxWindow
*GetWindow() const;
2972 @class wxMouseCaptureLostEvent
2974 A mouse capture lost event is sent to a window that had obtained mouse capture,
2975 which was subsequently lost due to an "external" event (for example, when a dialog
2976 box is shown or if another application captures the mouse).
2978 If this happens, this event is sent to all windows that are on the capture stack
2979 (i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is
2980 not sent if the capture changes because of a call to CaptureMouse or
2983 This event is currently emitted under Windows only.
2985 @beginEventTable{wxMouseCaptureLostEvent}
2986 @event{EVT_MOUSE_CAPTURE_LOST(func)}
2987 Process a @c wxEVT_MOUSE_CAPTURE_LOST event.
2995 @see wxMouseCaptureChangedEvent, @ref overview_events,
2996 wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
2998 class wxMouseCaptureLostEvent
: public wxEvent
3004 wxMouseCaptureLostEvent(wxWindowID windowId
= 0);
3009 class wxDisplayChangedEvent
: public wxEvent
3012 wxDisplayChangedEvent();
3016 class wxPaletteChangedEvent
: public wxEvent
3019 wxPaletteChangedEvent(wxWindowID winid
= 0);
3021 void SetChangedWindow(wxWindow
* win
);
3022 wxWindow
* GetChangedWindow() const;
3026 class wxQueryNewPaletteEvent
: public wxEvent
3029 wxQueryNewPaletteEvent(wxWindowID winid
= 0);
3031 void SetPaletteRealized(bool realized
);
3032 bool GetPaletteRealized();
3039 @class wxNotifyEvent
3041 This class is not used by the event handlers by itself, but is a base class
3042 for other event classes (such as wxBookCtrlEvent).
3044 It (or an object of a derived class) is sent when the controls state is being
3045 changed and allows the program to wxNotifyEvent::Veto() this change if it wants
3046 to prevent it from happening.
3051 @see wxBookCtrlEvent
3053 class wxNotifyEvent
: public wxCommandEvent
3057 Constructor (used internally by wxWidgets only).
3059 wxNotifyEvent(wxEventType eventType
= wxEVT_NULL
, int id
= 0);
3062 This is the opposite of Veto(): it explicitly allows the event to be processed.
3063 For most events it is not necessary to call this method as the events are allowed
3064 anyhow but some are forbidden by default (this will be mentioned in the corresponding
3070 Returns @true if the change is allowed (Veto() hasn't been called) or @false
3071 otherwise (if it was).
3073 bool IsAllowed() const;
3076 Prevents the change announced by this event from happening.
3078 It is in general a good idea to notify the user about the reasons for vetoing
3079 the change because otherwise the applications behaviour (which just refuses to
3080 do what the user wants) might be quite surprising.
3087 @class wxThreadEvent
3089 This class adds some simple functionality to wxEvent to facilitate
3090 inter-thread communication.
3092 This event is not natively emitted by any control/class: it is just
3093 a helper class for the user.
3094 Its most important feature is the GetEventCategory() implementation which
3095 allows thread events @b NOT to be processed by wxEventLoopBase::YieldFor calls
3096 (unless the @c wxEVT_CATEGORY_THREAD is specified - which is never in wx code).
3099 @category{events,threading}
3101 @see @ref overview_thread, wxEventLoopBase::YieldFor
3105 class wxThreadEvent
: public wxEvent
3111 wxThreadEvent(wxEventType eventType
= wxEVT_THREAD
, int id
= wxID_ANY
);
3114 Clones this event making sure that all internal members which use
3115 COW (only @c m_commandString for now; see @ref overview_refcount)
3116 are unshared (see wxObject::UnShare).
3118 virtual wxEvent
*Clone() const;
3121 Returns @c wxEVT_CATEGORY_THREAD.
3123 This is important to avoid unwanted processing of thread events
3124 when calling wxEventLoopBase::YieldFor().
3126 virtual wxEventCategory
GetEventCategory() const;
3129 Sets custom data payload.
3131 The @a payload argument may be of any type that wxAny can handle
3132 (i.e. pretty much anything). Note that T's copy constructor must be
3133 thread-safe, i.e. create a copy that doesn't share anything with
3134 the original (see Clone()).
3136 @note This method is not available with Visual C++ 6.
3140 @see GetPayload(), wxAny
3142 template<typename T
>
3143 void SetPayload(const T
& payload
);
3146 Get custom data payload.
3148 Correct type is checked in debug builds.
3150 @note This method is not available with Visual C++ 6.
3154 @see SetPayload(), wxAny
3156 template<typename T
>
3157 T
GetPayload() const;
3160 Returns extra information integer value.
3162 long GetExtraLong() const;
3165 Returns stored integer value.
3170 Returns stored string value.
3172 wxString
GetString() const;
3176 Sets the extra information value.
3178 void SetExtraLong(long extraLong
);
3181 Sets the integer value.
3183 void SetInt(int intCommand
);
3186 Sets the string value.
3188 void SetString(const wxString
& string
);
3195 A help event is sent when the user has requested context-sensitive help.
3196 This can either be caused by the application requesting context-sensitive help mode
3197 via wxContextHelp, or (on MS Windows) by the system generating a WM_HELP message when
3198 the user pressed F1 or clicked on the query button in a dialog caption.
3200 A help event is sent to the window that the user clicked on, and is propagated
3201 up the window hierarchy until the event is processed or there are no more event
3204 The application should call wxEvent::GetId to check the identity of the
3205 clicked-on window, and then either show some suitable help or call wxEvent::Skip()
3206 if the identifier is unrecognised.
3208 Calling Skip is important because it allows wxWidgets to generate further
3209 events for ancestors of the clicked-on window. Otherwise it would be impossible to
3210 show help for container windows, since processing would stop after the first window
3213 @beginEventTable{wxHelpEvent}
3214 @event{EVT_HELP(id, func)}
3215 Process a @c wxEVT_HELP event.
3216 @event{EVT_HELP_RANGE(id1, id2, func)}
3217 Process a @c wxEVT_HELP event for a range of ids.
3223 @see wxContextHelp, wxDialog, @ref overview_events
3225 class wxHelpEvent
: public wxCommandEvent
3229 Indicates how a wxHelpEvent was generated.
3233 Origin_Unknown
, /**< unrecognized event source. */
3234 Origin_Keyboard
, /**< event generated from F1 key press. */
3236 /** event generated by wxContextHelp or from the [?] button on
3237 the title bar (Windows). */
3244 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
3245 wxWindowID winid
= 0,
3246 const wxPoint
& pt
= wxDefaultPosition
,
3247 wxHelpEvent
::Origin origin
= Origin_Unknown
);
3250 Returns the origin of the help event which is one of the ::wxHelpEventOrigin
3253 The application may handle events generated using the keyboard or mouse
3254 differently, e.g. by using wxGetMousePosition() for the mouse events.
3258 wxHelpEvent
::Origin
GetOrigin() const;
3261 Returns the left-click position of the mouse, in screen coordinates.
3262 This allows the application to position the help appropriately.
3264 const wxPoint
& GetPosition() const;
3267 Set the help event origin, only used internally by wxWidgets normally.
3271 void SetOrigin(wxHelpEvent
::Origin origin
);
3274 Sets the left-click position of the mouse, in screen coordinates.
3276 void SetPosition(const wxPoint
& pt
);
3282 @class wxScrollEvent
3284 A scroll event holds information about events sent from stand-alone
3285 scrollbars (see wxScrollBar) and sliders (see wxSlider).
3287 Note that scrolled windows send the wxScrollWinEvent which does not derive from
3288 wxCommandEvent, but from wxEvent directly - don't confuse these two kinds of
3289 events and use the event table macros mentioned below only for the scrollbar-like
3292 @section scrollevent_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
3294 The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb
3295 using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed
3296 by an EVT_SCROLL_CHANGED event).
3298 The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb
3299 position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE
3300 event does not happen).
3302 In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving has finished
3303 independently of the way it had started. Please see the widgets sample ("Slider" page)
3304 to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
3307 Note that unless specifying a scroll control identifier, you will need to test for scrollbar
3308 orientation with wxScrollEvent::GetOrientation, since horizontal and vertical scroll events
3309 are processed using the same event handler.
3311 @beginEventTable{wxScrollEvent}
3312 You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting
3313 scroll events from controls, or EVT_SCROLL... macros without window IDs for
3314 intercepting scroll events from the receiving window -- except for this, the
3315 macros behave exactly the same.
3316 @event{EVT_SCROLL(func)}
3317 Process all scroll events.
3318 @event{EVT_SCROLL_TOP(func)}
3319 Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
3320 @event{EVT_SCROLL_BOTTOM(func)}
3321 Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
3322 @event{EVT_SCROLL_LINEUP(func)}
3323 Process @c wxEVT_SCROLL_LINEUP line up events.
3324 @event{EVT_SCROLL_LINEDOWN(func)}
3325 Process @c wxEVT_SCROLL_LINEDOWN line down events.
3326 @event{EVT_SCROLL_PAGEUP(func)}
3327 Process @c wxEVT_SCROLL_PAGEUP page up events.
3328 @event{EVT_SCROLL_PAGEDOWN(func)}
3329 Process @c wxEVT_SCROLL_PAGEDOWN page down events.
3330 @event{EVT_SCROLL_THUMBTRACK(func)}
3331 Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the
3332 user drags the thumbtrack).
3333 @event{EVT_SCROLL_THUMBRELEASE(func)}
3334 Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
3335 @event{EVT_SCROLL_CHANGED(func)}
3336 Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
3337 @event{EVT_COMMAND_SCROLL(id, func)}
3338 Process all scroll events.
3339 @event{EVT_COMMAND_SCROLL_TOP(id, func)}
3340 Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
3341 @event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
3342 Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
3343 @event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
3344 Process @c wxEVT_SCROLL_LINEUP line up events.
3345 @event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
3346 Process @c wxEVT_SCROLL_LINEDOWN line down events.
3347 @event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
3348 Process @c wxEVT_SCROLL_PAGEUP page up events.
3349 @event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
3350 Process @c wxEVT_SCROLL_PAGEDOWN page down events.
3351 @event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
3352 Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent
3353 as the user drags the thumbtrack).
3354 @event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
3355 Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
3356 @event{EVT_COMMAND_SCROLL_CHANGED(func)}
3357 Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
3363 @see wxScrollBar, wxSlider, wxSpinButton, wxScrollWinEvent, @ref overview_events
3365 class wxScrollEvent
: public wxCommandEvent
3371 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0, int pos
= 0,
3372 int orientation
= 0);
3375 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
3378 int GetOrientation() const;
3381 Returns the position of the scrollbar.
3383 int GetPosition() const;
3386 void SetOrientation(int orient
);
3387 void SetPosition(int pos
);
3391 See wxIdleEvent::SetMode() for more info.
3395 /** Send idle events to all windows */
3398 /** Send idle events to windows that have the wxWS_EX_PROCESS_IDLE flag specified */
3399 wxIDLE_PROCESS_SPECIFIED
3406 This class is used for idle events, which are generated when the system becomes
3407 idle. Note that, unless you do something specifically, the idle events are not
3408 sent if the system remains idle once it has become it, e.g. only a single idle
3409 event will be generated until something else resulting in more normal events
3410 happens and only then is the next idle event sent again.
3412 If you need to ensure a continuous stream of idle events, you can either use
3413 wxIdleEvent::RequestMore method in your handler or call wxWakeUpIdle() periodically
3414 (for example from a timer event handler), but note that both of these approaches
3415 (and especially the first one) increase the system load and so should be avoided
3418 By default, idle events are sent to all windows (and also wxApp, as usual).
3419 If this is causing a significant overhead in your application, you can call
3420 wxIdleEvent::SetMode with the value wxIDLE_PROCESS_SPECIFIED, and set the
3421 wxWS_EX_PROCESS_IDLE extra window style for every window which should receive
3424 @beginEventTable{wxIdleEvent}
3425 @event{EVT_IDLE(func)}
3426 Process a @c wxEVT_IDLE event.
3432 @see @ref overview_events, wxUpdateUIEvent, wxWindow::OnInternalIdle
3434 class wxIdleEvent
: public wxEvent
3443 Static function returning a value specifying how wxWidgets will send idle
3444 events: to all windows, or only to those which specify that they
3445 will process the events.
3449 static wxIdleMode
GetMode();
3452 Returns @true if the OnIdle function processing this event requested more
3457 bool MoreRequested() const;
3460 Tells wxWidgets that more processing is required.
3462 This function can be called by an OnIdle handler for a window or window event
3463 handler to indicate that wxApp::OnIdle should forward the OnIdle event once
3464 more to the application windows.
3466 If no window calls this function during OnIdle, then the application will
3467 remain in a passive event loop (not calling OnIdle) until a new event is
3468 posted to the application by the windowing system.
3470 @see MoreRequested()
3472 void RequestMore(bool needMore
= true);
3475 Static function for specifying how wxWidgets will send idle events: to
3476 all windows, or only to those which specify that they will process the events.
3479 Can be one of the ::wxIdleMode values.
3480 The default is wxIDLE_PROCESS_ALL.
3482 static void SetMode(wxIdleMode mode
);
3488 @class wxInitDialogEvent
3490 A wxInitDialogEvent is sent as a dialog or panel is being initialised.
3491 Handlers for this event can transfer data to the window.
3493 The default handler calls wxWindow::TransferDataToWindow.
3495 @beginEventTable{wxInitDialogEvent}
3496 @event{EVT_INIT_DIALOG(func)}
3497 Process a @c wxEVT_INIT_DIALOG event.
3503 @see @ref overview_events
3505 class wxInitDialogEvent
: public wxEvent
3511 wxInitDialogEvent(int id
= 0);
3517 @class wxWindowDestroyEvent
3519 This event is sent as early as possible during the window destruction
3522 For the top level windows, as early as possible means that this is done by
3523 wxFrame or wxDialog destructor, i.e. after the destructor of the derived
3524 class was executed and so any methods specific to the derived class can't
3525 be called any more from this event handler. If you need to do this, you
3526 must call wxWindow::SendDestroyEvent() from your derived class destructor.
3528 For the child windows, this event is generated just before deleting the
3529 window from wxWindow::Destroy() (which is also called when the parent
3530 window is deleted) or from the window destructor if operator @c delete was
3531 used directly (which is not recommended for this very reason).
3533 It is usually pointless to handle this event in the window itself but it ca
3534 be very useful to receive notifications about the window destruction in the
3535 parent window or in any other object interested in this window.
3540 @see @ref overview_events, wxWindowCreateEvent
3542 class wxWindowDestroyEvent
: public wxCommandEvent
3548 wxWindowDestroyEvent(wxWindow
* win
= NULL
);
3550 /// Return the window being destroyed.
3551 wxWindow
*GetWindow() const;
3556 @class wxNavigationKeyEvent
3558 This event class contains information about navigation events,
3559 generated by navigation keys such as tab and page down.
3561 This event is mainly used by wxWidgets implementations.
3562 A wxNavigationKeyEvent handler is automatically provided by wxWidgets
3563 when you enable keyboard navigation inside a window by inheriting it from
3564 wxNavigationEnabled<>.
3566 @beginEventTable{wxNavigationKeyEvent}
3567 @event{EVT_NAVIGATION_KEY(func)}
3568 Process a navigation key event.
3574 @see wxWindow::Navigate, wxWindow::NavigateIn
3576 class wxNavigationKeyEvent
: public wxEvent
3580 Flags which can be used with wxNavigationKeyEvent.
3582 enum wxNavigationKeyEventFlags
3584 IsBackward
= 0x0000,
3590 wxNavigationKeyEvent();
3591 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
);
3594 Returns the child that has the focus, or @NULL.
3596 wxWindow
* GetCurrentFocus() const;
3599 Returns @true if the navigation was in the forward direction.
3601 bool GetDirection() const;
3604 Returns @true if the navigation event was from a tab key.
3605 This is required for proper navigation over radio buttons.
3607 bool IsFromTab() const;
3610 Returns @true if the navigation event represents a window change
3611 (for example, from Ctrl-Page Down in a notebook).
3613 bool IsWindowChange() const;
3616 Sets the current focus window member.
3618 void SetCurrentFocus(wxWindow
* currentFocus
);
3621 Sets the direction to forward if @a direction is @true, or backward
3624 void SetDirection(bool direction
);
3627 Sets the flags for this event.
3628 The @a flags can be a combination of the ::wxNavigationKeyEventFlags values.
3630 void SetFlags(long flags
);
3633 Marks the navigation event as from a tab key.
3635 void SetFromTab(bool fromTab
);
3638 Marks the event as a window change event.
3640 void SetWindowChange(bool windowChange
);
3646 @class wxMouseCaptureChangedEvent
3648 An mouse capture changed event is sent to a window that loses its
3649 mouse capture. This is called even if wxWindow::ReleaseMouse
3650 was called by the application code. Handling this event allows
3651 an application to cater for unexpected capture releases which
3652 might otherwise confuse mouse handling code.
3656 @beginEventTable{wxMouseCaptureChangedEvent}
3657 @event{EVT_MOUSE_CAPTURE_CHANGED(func)}
3658 Process a @c wxEVT_MOUSE_CAPTURE_CHANGED event.
3664 @see wxMouseCaptureLostEvent, @ref overview_events,
3665 wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
3667 class wxMouseCaptureChangedEvent
: public wxEvent
3673 wxMouseCaptureChangedEvent(wxWindowID windowId
= 0,
3674 wxWindow
* gainedCapture
= NULL
);
3677 Returns the window that gained the capture, or @NULL if it was a
3678 non-wxWidgets window.
3680 wxWindow
* GetCapturedWindow() const;
3688 This event class contains information about window and session close events.
3690 The handler function for EVT_CLOSE is called when the user has tried to close a
3691 a frame or dialog box using the window manager (X) or system menu (Windows).
3692 It can also be invoked by the application itself programmatically, for example by
3693 calling the wxWindow::Close function.
3695 You should check whether the application is forcing the deletion of the window
3696 using wxCloseEvent::CanVeto. If this is @false, you @e must destroy the window
3697 using wxWindow::Destroy.
3699 If the return value is @true, it is up to you whether you respond by destroying
3702 If you don't destroy the window, you should call wxCloseEvent::Veto to
3703 let the calling code know that you did not destroy the window.
3704 This allows the wxWindow::Close function to return @true or @false depending
3705 on whether the close instruction was honoured or not.
3707 Example of a wxCloseEvent handler:
3710 void MyFrame::OnClose(wxCloseEvent& event)
3712 if ( event.CanVeto() && m_bFileNotSaved )
3714 if ( wxMessageBox("The file has not been saved... continue closing?",
3716 wxICON_QUESTION | wxYES_NO) != wxYES )
3723 Destroy(); // you may also do: event.Skip();
3724 // since the default event handler does call Destroy(), too
3728 The EVT_END_SESSION event is slightly different as it is sent by the system
3729 when the user session is ending (e.g. because of log out or shutdown) and
3730 so all windows are being forcefully closed. At least under MSW, after the
3731 handler for this event is executed the program is simply killed by the
3732 system. Because of this, the default handler for this event provided by
3733 wxWidgets calls all the usual cleanup code (including wxApp::OnExit()) so
3734 that it could still be executed and exit()s the process itself, without
3735 waiting for being killed. If this behaviour is for some reason undesirable,
3736 make sure that you define a handler for this event in your wxApp-derived
3737 class and do not call @c event.Skip() in it (but be aware that the system
3738 will still kill your application).
3740 @beginEventTable{wxCloseEvent}
3741 @event{EVT_CLOSE(func)}
3742 Process a @c wxEVT_CLOSE_WINDOW command event, supplying the member function.
3743 This event applies to wxFrame and wxDialog classes.
3744 @event{EVT_QUERY_END_SESSION(func)}
3745 Process a @c wxEVT_QUERY_END_SESSION session event, supplying the member function.
3746 This event can be handled in wxApp-derived class only.
3747 @event{EVT_END_SESSION(func)}
3748 Process a @c wxEVT_END_SESSION session event, supplying the member function.
3749 This event can be handled in wxApp-derived class only.
3755 @see wxWindow::Close, @ref overview_windowdeletion
3757 class wxCloseEvent
: public wxEvent
3763 wxCloseEvent(wxEventType commandEventType
= wxEVT_NULL
, int id
= 0);
3766 Returns @true if you can veto a system shutdown or a window close event.
3767 Vetoing a window close event is not possible if the calling code wishes to
3768 force the application to exit, and so this function must be called to check this.
3770 bool CanVeto() const;
3773 Returns @true if the user is just logging off or @false if the system is
3774 shutting down. This method can only be called for end session and query end
3775 session events, it doesn't make sense for close window event.
3777 bool GetLoggingOff() const;
3780 Sets the 'can veto' flag.
3782 void SetCanVeto(bool canVeto
);
3785 Sets the 'logging off' flag.
3787 void SetLoggingOff(bool loggingOff
);
3790 Call this from your event handler to veto a system shutdown or to signal
3791 to the calling application that a window close did not happen.
3793 You can only veto a shutdown if CanVeto() returns @true.
3795 void Veto(bool veto
= true);
3803 This class is used for a variety of menu-related events. Note that
3804 these do not include menu command events, which are
3805 handled using wxCommandEvent objects.
3807 The default handler for @c wxEVT_MENU_HIGHLIGHT displays help
3808 text in the first field of the status bar.
3810 @beginEventTable{wxMenuEvent}
3811 @event{EVT_MENU_OPEN(func)}
3812 A menu is about to be opened. On Windows, this is only sent once for each
3813 navigation of the menubar (up until all menus have closed).
3814 @event{EVT_MENU_CLOSE(func)}
3815 A menu has been just closed.
3816 @event{EVT_MENU_HIGHLIGHT(id, func)}
3817 The menu item with the specified id has been highlighted: used to show
3818 help prompts in the status bar by wxFrame
3819 @event{EVT_MENU_HIGHLIGHT_ALL(func)}
3820 A menu item has been highlighted, i.e. the currently selected menu item has changed.
3826 @see wxCommandEvent, @ref overview_events
3828 class wxMenuEvent
: public wxEvent
3834 wxMenuEvent(wxEventType type
= wxEVT_NULL
, int id
= 0, wxMenu
* menu
= NULL
);
3837 Returns the menu which is being opened or closed. This method should only be
3838 used with the @c OPEN and @c CLOSE events and even for them the
3839 returned pointer may be @NULL in some ports.
3841 wxMenu
* GetMenu() const;
3844 Returns the menu identifier associated with the event.
3845 This method should be only used with the @c HIGHLIGHT events.
3847 int GetMenuId() const;
3850 Returns @true if the menu which is being opened or closed is a popup menu,
3851 @false if it is a normal one.
3853 This method should only be used with the @c OPEN and @c CLOSE events.
3855 bool IsPopup() const;
3861 An event being sent when the window is shown or hidden.
3862 The event is triggered by calls to wxWindow::Show(), and any user
3863 action showing a previously hidden window or vice versa (if allowed by
3864 the current platform and/or window manager).
3865 Notice that the event is not triggered when the application is iconized
3866 (minimized) or restored under wxMSW.
3868 @onlyfor{wxmsw,wxgtk,wxos2}
3870 @beginEventTable{wxShowEvent}
3871 @event{EVT_SHOW(func)}
3872 Process a @c wxEVT_SHOW event.
3878 @see @ref overview_events, wxWindow::Show,
3882 class wxShowEvent
: public wxEvent
3888 wxShowEvent(int winid
= 0, bool show
= false);
3891 Set whether the windows was shown or hidden.
3893 void SetShow(bool show
);
3896 Return @true if the window has been shown, @false if it has been
3899 bool IsShown() const;
3902 @deprecated This function is deprecated in favour of IsShown().
3904 bool GetShow() const;
3910 @class wxIconizeEvent
3912 An event being sent when the frame is iconized (minimized) or restored.
3914 Currently only wxMSW and wxGTK generate such events.
3916 @onlyfor{wxmsw,wxgtk}
3918 @beginEventTable{wxIconizeEvent}
3919 @event{EVT_ICONIZE(func)}
3920 Process a @c wxEVT_ICONIZE event.
3926 @see @ref overview_events, wxTopLevelWindow::Iconize,
3927 wxTopLevelWindow::IsIconized
3929 class wxIconizeEvent
: public wxEvent
3935 wxIconizeEvent(int id
= 0, bool iconized
= true);
3938 Returns @true if the frame has been iconized, @false if it has been
3941 bool IsIconized() const;
3944 @deprecated This function is deprecated in favour of IsIconized().
3946 bool Iconized() const;
3954 A move event holds information about wxTopLevelWindow move change events.
3956 These events are currently only generated by wxMSW port.
3958 @beginEventTable{wxMoveEvent}
3959 @event{EVT_MOVE(func)}
3960 Process a @c wxEVT_MOVE event, which is generated when a window is moved.
3961 @event{EVT_MOVE_START(func)}
3962 Process a @c wxEVT_MOVE_START event, which is generated when the user starts
3963 to move or size a window. wxMSW only.
3964 @event{EVT_MOVE_END(func)}
3965 Process a @c wxEVT_MOVE_END event, which is generated when the user stops
3966 moving or sizing a window. wxMSW only.
3972 @see wxPoint, @ref overview_events
3974 class wxMoveEvent
: public wxEvent
3980 wxMoveEvent(const wxPoint
& pt
, int id
= 0);
3983 Returns the position of the window generating the move change event.
3985 wxPoint
GetPosition() const;
3987 wxRect
GetRect() const;
3988 void SetRect(const wxRect
& rect
);
3989 void SetPosition(const wxPoint
& pos
);
3996 A size event holds information about size change events of wxWindow.
3998 The EVT_SIZE handler function will be called when the window has been resized.
4000 You may wish to use this for frames to resize their child windows as appropriate.
4002 Note that the size passed is of the whole window: call wxWindow::GetClientSize()
4003 for the area which may be used by the application.
4005 When a window is resized, usually only a small part of the window is damaged
4006 and you may only need to repaint that area. However, if your drawing depends on the
4007 size of the window, you may need to clear the DC explicitly and repaint the whole window.
4008 In which case, you may need to call wxWindow::Refresh to invalidate the entire window.
4010 @b Important : Sizers ( see @ref overview_sizer ) rely on size events to function
4011 correctly. Therefore, in a sizer-based layout, do not forget to call Skip on all
4012 size events you catch (and don't catch size events at all when you don't need to).
4014 @beginEventTable{wxSizeEvent}
4015 @event{EVT_SIZE(func)}
4016 Process a @c wxEVT_SIZE event.
4022 @see wxSize, @ref overview_events
4024 class wxSizeEvent
: public wxEvent
4030 wxSizeEvent(const wxSize
& sz
, int id
= 0);
4033 Returns the entire size of the window generating the size change event.
4035 This is the new total size of the window, i.e. the same size as would
4036 be returned by wxWindow::GetSize() if it were called now. Use
4037 wxWindow::GetClientSize() if you catch this event in a top level window
4038 such as wxFrame to find the size available for the window contents.
4040 wxSize
GetSize() const;
4041 void SetSize(wxSize size
);
4043 wxRect
GetRect() const;
4044 void SetRect(wxRect rect
);
4050 @class wxSetCursorEvent
4052 A wxSetCursorEvent is generated from wxWindow when the mouse cursor is about
4053 to be set as a result of mouse motion.
4055 This event gives the application the chance to perform specific mouse cursor
4056 processing based on the current position of the mouse within the window.
4057 Use wxSetCursorEvent::SetCursor to specify the cursor you want to be displayed.
4059 @beginEventTable{wxSetCursorEvent}
4060 @event{EVT_SET_CURSOR(func)}
4061 Process a @c wxEVT_SET_CURSOR event.
4067 @see ::wxSetCursor, wxWindow::wxSetCursor
4069 class wxSetCursorEvent
: public wxEvent
4073 Constructor, used by the library itself internally to initialize the event
4076 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0);
4079 Returns a reference to the cursor specified by this event.
4081 const wxCursor
& GetCursor() const;
4084 Returns the X coordinate of the mouse in client coordinates.
4086 wxCoord
GetX() const;
4089 Returns the Y coordinate of the mouse in client coordinates.
4091 wxCoord
GetY() const;
4094 Returns @true if the cursor specified by this event is a valid cursor.
4096 @remarks You cannot specify wxNullCursor with this event, as it is not
4097 considered a valid cursor.
4099 bool HasCursor() const;
4102 Sets the cursor associated with this event.
4104 void SetCursor(const wxCursor
& cursor
);
4109 // ============================================================================
4110 // Global functions/macros
4111 // ============================================================================
4113 /** @addtogroup group_funcmacro_events */
4117 A value uniquely identifying the type of the event.
4119 The values of this type should only be created using wxNewEventType().
4121 See the macro DEFINE_EVENT_TYPE() for more info.
4123 @see @ref overview_events_introduction
4125 typedef int wxEventType
;
4128 A special event type usually used to indicate that some wxEvent has yet
4131 wxEventType wxEVT_NULL
;
4133 wxEventType wxEVT_ANY
;
4136 Generates a new unique event type.
4138 Usually this function is only used by wxDEFINE_EVENT() and not called
4141 wxEventType
wxNewEventType();
4144 Define a new event type associated with the specified event class.
4146 This macro defines a new unique event type @a name associated with the
4151 wxDEFINE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
4153 class MyCustomEvent : public wxEvent { ... };
4154 wxDEFINE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
4157 @see wxDECLARE_EVENT(), @ref overview_events_custom
4159 #define wxDEFINE_EVENT(name, cls) \
4160 const wxEventTypeTag< cls > name(wxNewEventType())
4163 Declares a custom event type.
4165 This macro declares a variable called @a name which must be defined
4166 elsewhere using wxDEFINE_EVENT().
4168 The class @a cls must be the wxEvent-derived class associated with the
4169 events of this type and its full declaration must be visible from the point
4170 of use of this macro.
4174 wxDECLARE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
4176 class MyCustomEvent : public wxEvent { ... };
4177 wxDECLARE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
4180 #define wxDECLARE_EVENT(name, cls) \
4181 wxDECLARE_EXPORTED_EVENT(wxEMPTY_PARAMETER_VALUE, name, cls)
4184 Variant of wxDECLARE_EVENT() used for event types defined inside a shared
4187 This is mostly used by wxWidgets internally, e.g.
4189 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent)
4192 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, cls ) \
4193 extern const expdecl wxEventTypeTag< cls > name;
4196 Helper macro for definition of custom event table macros.
4198 This macro must only be used if wxEVENTS_COMPATIBILITY_2_8 is 1, otherwise
4199 it is better and more clear to just use the address of the function
4200 directly as this is all this macro does in this case. However it needs to
4201 explicitly cast @a func to @a functype, which is the type of wxEvtHandler
4202 member function taking the custom event argument when
4203 wxEVENTS_COMPATIBILITY_2_8 is 0.
4205 See wx__DECLARE_EVT0 for an example of use.
4207 @see @ref overview_events_custom_ownclass
4209 #define wxEVENT_HANDLER_CAST(functype, func) (&func)
4212 This macro is used to define event table macros for handling custom
4217 class MyEvent : public wxEvent { ... };
4219 // note that this is not necessary unless using old compilers: for the
4220 // reasonably new ones just use &func instead of MyEventHandler(func)
4221 typedef void (wxEvtHandler::*MyEventFunction)(MyEvent&);
4222 #define MyEventHandler(func) wxEVENT_HANDLER_CAST(MyEventFunction, func)
4224 wxDEFINE_EVENT(MY_EVENT_TYPE, MyEvent);
4226 #define EVT_MY(id, func) \
4227 wx__DECLARE_EVT1(MY_EVENT_TYPE, id, MyEventHandler(func))
4231 wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)
4232 EVT_MY(wxID_ANY, MyFrame::OnMyEvent)
4237 The event type to handle.
4239 The identifier of events to handle.
4241 The event handler method.
4243 #define wx__DECLARE_EVT1(evt, id, fn) \
4244 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
4247 Generalized version of the wx__DECLARE_EVT1() macro taking a range of
4248 IDs instead of a single one.
4249 Argument @a id1 is the first identifier of the range, @a id2 is the
4250 second identifier of the range.
4252 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
4253 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
4256 Simplified version of the wx__DECLARE_EVT1() macro, to be used when the
4257 event type must be handled regardless of the ID associated with the
4258 specific event instances.
4260 #define wx__DECLARE_EVT0(evt, fn) \
4261 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
4264 Use this macro inside a class declaration to declare a @e static event table
4267 In the implementation file you'll need to use the wxBEGIN_EVENT_TABLE()
4268 and the wxEND_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro
4271 Note that this macro requires a final semicolon.
4273 @see @ref overview_events_eventtables
4275 #define wxDECLARE_EVENT_TABLE()
4278 Use this macro in a source file to start listing @e static event handlers
4279 for a specific class.
4281 Use wxEND_EVENT_TABLE() to terminate the event-declaration block.
4283 @see @ref overview_events_eventtables
4285 #define wxBEGIN_EVENT_TABLE(theClass, baseClass)
4288 Use this macro in a source file to end listing @e static event handlers
4289 for a specific class.
4291 Use wxBEGIN_EVENT_TABLE() to start the event-declaration block.
4293 @see @ref overview_events_eventtables
4295 #define wxEND_EVENT_TABLE()
4298 In a GUI application, this function posts @a event to the specified @e dest
4299 object using wxEvtHandler::AddPendingEvent().
4301 Otherwise, it dispatches @a event immediately using
4302 wxEvtHandler::ProcessEvent(). See the respective documentation for details
4303 (and caveats). Because of limitation of wxEvtHandler::AddPendingEvent()
4304 this function is not thread-safe for event objects having wxString fields,
4305 use wxQueueEvent() instead.
4309 void wxPostEvent(wxEvtHandler
* dest
, const wxEvent
& event
);
4312 Queue an event for processing on the given object.
4314 This is a wrapper around wxEvtHandler::QueueEvent(), see its documentation
4320 The object to queue the event on, can't be @c NULL.
4322 The heap-allocated and non-@c NULL event to queue, the function takes
4325 void wxQueueEvent(wxEvtHandler
* dest
, wxEvent
*event
);
4329 wxEventType wxEVT_COMMAND_BUTTON_CLICKED
;
4330 wxEventType wxEVT_COMMAND_CHECKBOX_CLICKED
;
4331 wxEventType wxEVT_COMMAND_CHOICE_SELECTED
;
4332 wxEventType wxEVT_COMMAND_LISTBOX_SELECTED
;
4333 wxEventType wxEVT_COMMAND_LISTBOX_DOUBLECLICKED
;
4334 wxEventType wxEVT_COMMAND_CHECKLISTBOX_TOGGLED
;
4335 wxEventType wxEVT_COMMAND_MENU_SELECTED
;
4336 wxEventType wxEVT_COMMAND_SLIDER_UPDATED
;
4337 wxEventType wxEVT_COMMAND_RADIOBOX_SELECTED
;
4338 wxEventType wxEVT_COMMAND_RADIOBUTTON_SELECTED
;
4339 wxEventType wxEVT_COMMAND_SCROLLBAR_UPDATED
;
4340 wxEventType wxEVT_COMMAND_VLBOX_SELECTED
;
4341 wxEventType wxEVT_COMMAND_COMBOBOX_SELECTED
;
4342 wxEventType wxEVT_COMMAND_TOOL_RCLICKED
;
4343 wxEventType wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED
;
4344 wxEventType wxEVT_COMMAND_TOOL_ENTER
;
4345 wxEventType wxEVT_COMMAND_COMBOBOX_DROPDOWN
;
4346 wxEventType wxEVT_COMMAND_COMBOBOX_CLOSEUP
;
4347 wxEventType wxEVT_THREAD
;
4348 wxEventType wxEVT_LEFT_DOWN
;
4349 wxEventType wxEVT_LEFT_UP
;
4350 wxEventType wxEVT_MIDDLE_DOWN
;
4351 wxEventType wxEVT_MIDDLE_UP
;
4352 wxEventType wxEVT_RIGHT_DOWN
;
4353 wxEventType wxEVT_RIGHT_UP
;
4354 wxEventType wxEVT_MOTION
;
4355 wxEventType wxEVT_ENTER_WINDOW
;
4356 wxEventType wxEVT_LEAVE_WINDOW
;
4357 wxEventType wxEVT_LEFT_DCLICK
;
4358 wxEventType wxEVT_MIDDLE_DCLICK
;
4359 wxEventType wxEVT_RIGHT_DCLICK
;
4360 wxEventType wxEVT_SET_FOCUS
;
4361 wxEventType wxEVT_KILL_FOCUS
;
4362 wxEventType wxEVT_CHILD_FOCUS
;
4363 wxEventType wxEVT_MOUSEWHEEL
;
4364 wxEventType wxEVT_AUX1_DOWN
;
4365 wxEventType wxEVT_AUX1_UP
;
4366 wxEventType wxEVT_AUX1_DCLICK
;
4367 wxEventType wxEVT_AUX2_DOWN
;
4368 wxEventType wxEVT_AUX2_UP
;
4369 wxEventType wxEVT_AUX2_DCLICK
;
4370 wxEventType wxEVT_CHAR
;
4371 wxEventType wxEVT_CHAR_HOOK
;
4372 wxEventType wxEVT_NAVIGATION_KEY
;
4373 wxEventType wxEVT_KEY_DOWN
;
4374 wxEventType wxEVT_KEY_UP
;
4375 wxEventType wxEVT_HOTKEY
;
4376 wxEventType wxEVT_SET_CURSOR
;
4377 wxEventType wxEVT_SCROLL_TOP
;
4378 wxEventType wxEVT_SCROLL_BOTTOM
;
4379 wxEventType wxEVT_SCROLL_LINEUP
;
4380 wxEventType wxEVT_SCROLL_LINEDOWN
;
4381 wxEventType wxEVT_SCROLL_PAGEUP
;
4382 wxEventType wxEVT_SCROLL_PAGEDOWN
;
4383 wxEventType wxEVT_SCROLL_THUMBTRACK
;
4384 wxEventType wxEVT_SCROLL_THUMBRELEASE
;
4385 wxEventType wxEVT_SCROLL_CHANGED
;
4386 wxEventType wxEVT_SPIN_UP
;
4387 wxEventType wxEVT_SPIN_DOWN
;
4388 wxEventType wxEVT_SPIN
;
4389 wxEventType wxEVT_SCROLLWIN_TOP
;
4390 wxEventType wxEVT_SCROLLWIN_BOTTOM
;
4391 wxEventType wxEVT_SCROLLWIN_LINEUP
;
4392 wxEventType wxEVT_SCROLLWIN_LINEDOWN
;
4393 wxEventType wxEVT_SCROLLWIN_PAGEUP
;
4394 wxEventType wxEVT_SCROLLWIN_PAGEDOWN
;
4395 wxEventType wxEVT_SCROLLWIN_THUMBTRACK
;
4396 wxEventType wxEVT_SCROLLWIN_THUMBRELEASE
;
4397 wxEventType wxEVT_SIZE
;
4398 wxEventType wxEVT_MOVE
;
4399 wxEventType wxEVT_CLOSE_WINDOW
;
4400 wxEventType wxEVT_END_SESSION
;
4401 wxEventType wxEVT_QUERY_END_SESSION
;
4402 wxEventType wxEVT_ACTIVATE_APP
;
4403 wxEventType wxEVT_ACTIVATE
;
4404 wxEventType wxEVT_CREATE
;
4405 wxEventType wxEVT_DESTROY
;
4406 wxEventType wxEVT_SHOW
;
4407 wxEventType wxEVT_ICONIZE
;
4408 wxEventType wxEVT_MAXIMIZE
;
4409 wxEventType wxEVT_MOUSE_CAPTURE_CHANGED
;
4410 wxEventType wxEVT_MOUSE_CAPTURE_LOST
;
4411 wxEventType wxEVT_PAINT
;
4412 wxEventType wxEVT_ERASE_BACKGROUND
;
4413 wxEventType wxEVT_NC_PAINT
;
4414 wxEventType wxEVT_MENU_OPEN
;
4415 wxEventType wxEVT_MENU_CLOSE
;
4416 wxEventType wxEVT_MENU_HIGHLIGHT
;
4417 wxEventType wxEVT_CONTEXT_MENU
;
4418 wxEventType wxEVT_SYS_COLOUR_CHANGED
;
4419 wxEventType wxEVT_DISPLAY_CHANGED
;
4420 wxEventType wxEVT_QUERY_NEW_PALETTE
;
4421 wxEventType wxEVT_PALETTE_CHANGED
;
4422 wxEventType wxEVT_JOY_BUTTON_DOWN
;
4423 wxEventType wxEVT_JOY_BUTTON_UP
;
4424 wxEventType wxEVT_JOY_MOVE
;
4425 wxEventType wxEVT_JOY_ZMOVE
;
4426 wxEventType wxEVT_DROP_FILES
;
4427 wxEventType wxEVT_INIT_DIALOG
;
4428 wxEventType wxEVT_IDLE
;
4429 wxEventType wxEVT_UPDATE_UI
;
4430 wxEventType wxEVT_SIZING
;
4431 wxEventType wxEVT_MOVING
;
4432 wxEventType wxEVT_MOVE_START
;
4433 wxEventType wxEVT_MOVE_END
;
4434 wxEventType wxEVT_HIBERNATE
;
4435 wxEventType wxEVT_COMMAND_TEXT_COPY
;
4436 wxEventType wxEVT_COMMAND_TEXT_CUT
;
4437 wxEventType wxEVT_COMMAND_TEXT_PASTE
;
4438 wxEventType wxEVT_COMMAND_LEFT_CLICK
;
4439 wxEventType wxEVT_COMMAND_LEFT_DCLICK
;
4440 wxEventType wxEVT_COMMAND_RIGHT_CLICK
;
4441 wxEventType wxEVT_COMMAND_RIGHT_DCLICK
;
4442 wxEventType wxEVT_COMMAND_SET_FOCUS
;
4443 wxEventType wxEVT_COMMAND_KILL_FOCUS
;
4444 wxEventType wxEVT_COMMAND_ENTER
;
4445 wxEventType wxEVT_HELP
;
4446 wxEventType wxEVT_DETAILED_HELP
;
4447 wxEventType wxEVT_COMMAND_TEXT_UPDATED
;
4448 wxEventType wxEVT_COMMAND_TOOL_CLICKED
;
4449 wxEventType wxEVT_WINDOW_MODAL_DIALOG_CLOSED
;