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. wxEVT_PAINT, wxEVT_SIZE or
114 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
);
324 A class that can handle events from the windowing system.
325 wxWindow is (and therefore all window classes are) derived from this class.
327 When events are received, wxEvtHandler invokes the method listed in the
328 event table using itself as the object. When using multiple inheritance
329 <b>it is imperative that the wxEvtHandler(-derived) class is the first
330 class inherited</b> such that the @c this pointer for the overall object
331 will be identical to the @c this pointer of the wxEvtHandler portion.
336 @see @ref overview_events_processing, wxEventBlocker, wxEventLoopBase
338 class wxEvtHandler
: public wxObject
, public wxTrackable
349 If the handler is part of a chain, the destructor will unlink itself
352 virtual ~wxEvtHandler();
356 @name Event queuing and processing
361 Queue event for a later processing.
363 This method is similar to ProcessEvent() but while the latter is
364 synchronous, i.e. the event is processed immediately, before the
365 function returns, this one is asynchronous and returns immediately
366 while the event will be processed at some later time (usually during
367 the next event loop iteration).
369 Another important difference is that this method takes ownership of the
370 @a event parameter, i.e. it will delete it itself. This implies that
371 the event should be allocated on the heap and that the pointer can't be
372 used any more after the function returns (as it can be deleted at any
375 QueueEvent() can be used for inter-thread communication from the worker
376 threads to the main thread, it is safe in the sense that it uses
377 locking internally and avoids the problem mentioned in AddPendingEvent()
378 documentation by ensuring that the @a event object is not used by the
379 calling thread any more. Care should still be taken to avoid that some
380 fields of this object are used by it, notably any wxString members of
381 the event object must not be shallow copies of another wxString object
382 as this would result in them still using the same string buffer behind
383 the scenes. For example:
385 void FunctionInAWorkerThread(const wxString& str)
387 wxCommandEvent* evt = new wxCommandEvent;
389 // NOT evt->SetString(str) as this would be a shallow copy
390 evt->SetString(str.c_str()); // make a deep copy
392 wxTheApp->QueueEvent( evt );
396 Note that you can use wxThreadEvent instead of wxCommandEvent
397 to avoid this problem:
399 void FunctionInAWorkerThread(const wxString& str)
404 // wxThreadEvent::Clone() makes sure that the internal wxString
405 // member is not shared by other wxString instances:
406 wxTheApp->QueueEvent( evt.Clone() );
410 Finally notice that this method automatically wakes up the event loop
411 if it is currently idle by calling ::wxWakeUpIdle() so there is no need
412 to do it manually when using it.
417 A heap-allocated event to be queued, QueueEvent() takes ownership
418 of it. This parameter shouldn't be @c NULL.
420 virtual void QueueEvent(wxEvent
*event
);
423 Post an event to be processed later.
425 This function is similar to QueueEvent() but can't be used to post
426 events from worker threads for the event objects with wxString fields
427 (i.e. in practice most of them) because of an unsafe use of the same
428 wxString object which happens because the wxString field in the
429 original @a event object and its copy made internally by this function
430 share the same string buffer internally. Use QueueEvent() to avoid
433 A copy of @a event is made by the function, so the original can be deleted
434 as soon as function returns (it is common that the original is created
435 on the stack). This requires that the wxEvent::Clone() method be
436 implemented by event so that it can be duplicated and stored until it
440 Event to add to the pending events queue.
442 virtual void AddPendingEvent(const wxEvent
& event
);
445 Processes an event, searching event tables and calling zero or more suitable
446 event handler function(s).
448 Normally, your application would not call this function: it is called in the
449 wxWidgets implementation to dispatch incoming user interface events to the
450 framework (and application).
452 However, you might need to call it if implementing new functionality
453 (such as a new control) where you define new event types, as opposed to
454 allowing the user to override virtual functions.
456 Notice that you don't usually need to override ProcessEvent() to
457 customize the event handling, overriding the specially provided
458 TryBefore() and TryAfter() functions is usually enough. For example,
459 wxMDIParentFrame may override TryBefore() to ensure that the menu
460 events are processed in the active child frame before being processed
461 in the parent frame itself.
463 The normal order of event table searching is as follows:
464 -# wxApp::FilterEvent() is called. If it returns anything but @c -1
465 (default) the processing stops here.
466 -# TryBefore() is called (this is where wxValidator are taken into
467 account for wxWindow objects). If this returns @true, the function exits.
468 -# If the object is disabled (via a call to wxEvtHandler::SetEvtHandlerEnabled)
469 the function skips to step (7).
470 -# Dynamic event table of the handlers bound using Bind<>() is
471 searched. If a handler is found, it is executed and the function
472 returns @true unless the handler used wxEvent::Skip() to indicate
473 that it didn't handle the event in which case the search continues.
474 -# Static events table of the handlers bound using event table
475 macros is searched for this event handler. If this fails, the base
476 class event table table is tried, and so on until no more tables
477 exist or an appropriate function was found. If a handler is found,
478 the same logic as in the previous step applies.
479 -# The search is applied down the entire chain of event handlers (usually the
480 chain has a length of one). This chain can be formed using wxEvtHandler::SetNextHandler():
481 @image html overview_events_chain.png
482 (referring to the image, if @c A->ProcessEvent is called and it doesn't handle
483 the event, @c B->ProcessEvent will be called and so on...).
484 Note that in the case of wxWindow you can build a stack of event handlers
485 (see wxWindow::PushEventHandler() for more info).
486 If any of the handlers of the chain return @true, the function exits.
487 -# TryAfter() is called: for the wxWindow object this may propagate the
488 event to the window parent (recursively). If the event is still not
489 processed, ProcessEvent() on wxTheApp object is called as the last
492 Notice that steps (2)-(6) are performed in ProcessEventLocally()
493 which is called by this function.
498 @true if a suitable event handler function was found and executed,
499 and the function did not call wxEvent::Skip.
501 @see SearchEventTable()
503 virtual bool ProcessEvent(wxEvent
& event
);
506 Try to process the event in this handler and all those chained to it.
508 As explained in ProcessEvent() documentation, the event handlers may be
509 chained in a doubly-linked list. This function tries to process the
510 event in this handler (including performing any pre-processing done in
511 TryBefore(), e.g. applying validators) and all those following it in
512 the chain until the event is processed or the chain is exhausted.
514 This function is called from ProcessEvent() and, in turn, calls
515 TryThis() for each handler in turn. It is not virtual and so cannot be
516 overridden but can, and should, be called to forward an event to
517 another handler instead of ProcessEvent() which would result in a
518 duplicate call to TryAfter(), e.g. resulting in all unprocessed events
519 being sent to the application object multiple times.
526 @true if this handler of one of those chained to it processed the
529 bool ProcessEventLocally(wxEvent
& event
);
532 Processes an event by calling ProcessEvent() and handles any exceptions
533 that occur in the process.
534 If an exception is thrown in event handler, wxApp::OnExceptionInMainLoop is called.
539 @return @true if the event was processed, @false if no handler was found
540 or an exception was thrown.
542 @see wxWindow::HandleWindowEvent
544 bool SafelyProcessEvent(wxEvent
& event
);
547 Processes the pending events previously queued using QueueEvent() or
548 AddPendingEvent(); you must call this function only if you are sure
549 there are pending events for this handler, otherwise a @c wxCHECK
552 The real processing still happens in ProcessEvent() which is called by this
555 Note that this function needs a valid application object (see
556 wxAppConsole::GetInstance()) because wxApp holds the list of the event
557 handlers with pending events and this function manipulates that list.
559 void ProcessPendingEvents();
562 Deletes all events queued on this event handler using QueueEvent() or
565 Use with care because the events which are deleted are (obviously) not
566 processed and this may have unwanted consequences (e.g. user actions events
569 void DeletePendingEvents();
572 Searches the event table, executing an event handler function if an appropriate
576 Event table to be searched.
578 Event to be matched against an event table entry.
580 @return @true if a suitable event handler function was found and
581 executed, and the function did not call wxEvent::Skip.
583 @remarks This function looks through the object's event table and tries
584 to find an entry that will match the event.
585 An entry will match if:
586 @li The event type matches, and
587 @li the identifier or identifier range matches, or the event table
588 entry's identifier is zero.
590 If a suitable function is called but calls wxEvent::Skip, this
591 function will fail, and searching will continue.
593 @todo this function in the header is listed as an "implementation only" function;
594 are we sure we want to document it?
598 virtual bool SearchEventTable(wxEventTable
& table
,
605 @name Connecting and disconnecting
610 Connects the given function dynamically with the event handler, id and
613 Notice that Bind() provides a more flexible and safer way to do the
614 same thing as Connect(), please use it in any new code -- while
615 Connect() is not formally deprecated due to its existing widespread
616 usage, it has no advantages compared to Bind().
618 This is an alternative to the use of static event tables. It is more
619 flexible as it allows to connect events generated by some object to an
620 event handler defined in a different object of a different class (which
621 is impossible to do directly with the event tables -- the events can be
622 only handled in another object if they are propagated upwards to it).
623 Do make sure to specify the correct @a eventSink when connecting to an
624 event of a different object.
626 See @ref overview_events_bind for more detailed explanation
627 of this function and the @ref page_samples_event sample for usage
630 This specific overload allows you to connect an event handler to a @e range
632 Do not confuse @e source IDs with event @e types: source IDs identify the
633 event generator objects (typically wxMenuItem or wxWindow objects) while the
634 event @e type identify which type of events should be handled by the
635 given @e function (an event generator object may generate many different
639 The first ID of the identifier range to be associated with the event
642 The last ID of the identifier range to be associated with the event
645 The event type to be associated with this event handler.
647 The event handler function. Note that this function should
648 be explicitly converted to the correct type which can be done using a macro
649 called @c wxFooEventHandler for the handler for any @c wxFooEvent.
651 Data to be associated with the event table entry.
653 Object whose member function should be called. It must be specified
654 when connecting an event generated by one object to a member
655 function of a different object. If it is omitted, @c this is used.
658 In wxPerl this function takes 4 arguments: @a id, @a lastid,
659 @a type, @a method; if @a method is undef, the handler is
665 void Connect(int id
, int lastId
, wxEventType eventType
,
666 wxObjectEventFunction function
,
667 wxObject
* userData
= NULL
,
668 wxEvtHandler
* eventSink
= NULL
);
671 See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
672 overload for more info.
674 This overload can be used to attach an event handler to a single source ID:
678 frame->Connect( wxID_EXIT,
679 wxEVT_COMMAND_MENU_SELECTED,
680 wxCommandEventHandler(MyFrame::OnQuit) );
684 Not supported by wxPerl.
687 void Connect(int id
, wxEventType eventType
,
688 wxObjectEventFunction function
,
689 wxObject
* userData
= NULL
,
690 wxEvtHandler
* eventSink
= NULL
);
693 See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
694 overload for more info.
696 This overload will connect the given event handler so that regardless of the
697 ID of the event source, the handler will be called.
700 Not supported by wxPerl.
703 void Connect(wxEventType eventType
,
704 wxObjectEventFunction function
,
705 wxObject
* userData
= NULL
,
706 wxEvtHandler
* eventSink
= NULL
);
709 Disconnects the given function dynamically from the event handler, using the
710 specified parameters as search criteria and returning @true if a matching
711 function has been found and removed.
713 This method can only disconnect functions which have been added using the
714 Connect() method. There is no way to disconnect functions connected using
715 the (static) event tables.
718 The event type associated with this event handler.
720 The event handler function.
722 Data associated with the event table entry.
724 Object whose member function should be called.
727 Not supported by wxPerl.
730 bool Disconnect(wxEventType eventType
,
731 wxObjectEventFunction function
,
732 wxObject
* userData
= NULL
,
733 wxEvtHandler
* eventSink
= NULL
);
736 See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
737 overload for more info.
739 This overload takes the additional @a id parameter.
742 Not supported by wxPerl.
745 bool Disconnect(int id
= wxID_ANY
,
746 wxEventType eventType
= wxEVT_NULL
,
747 wxObjectEventFunction function
= NULL
,
748 wxObject
* userData
= NULL
,
749 wxEvtHandler
* eventSink
= NULL
);
752 See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
753 overload for more info.
755 This overload takes an additional range of source IDs.
758 In wxPerl this function takes 3 arguments: @a id,
762 bool Disconnect(int id
, int lastId
,
763 wxEventType eventType
,
764 wxObjectEventFunction function
= NULL
,
765 wxObject
* userData
= NULL
,
766 wxEvtHandler
* eventSink
= NULL
);
771 @name Binding and Unbinding
776 Binds the given function, functor or method dynamically with the event.
778 This offers basically the same functionality as Connect(), but it is
779 more flexible as it also allows you to use ordinary functions and
780 arbitrary functors as event handlers. It is also less restrictive then
781 Connect() because you can use an arbitrary method as an event handler,
782 where as Connect() requires a wxEvtHandler derived handler.
784 See @ref overview_events_bind for more detailed explanation
785 of this function and the @ref page_samples_event sample for usage
789 The event type to be associated with this event handler.
791 The event handler functor. This can be an ordinary function but also
792 an arbitrary functor like boost::function<>.
794 The first ID of the identifier range to be associated with the event
797 The last ID of the identifier range to be associated with the event
800 Data to be associated with the event table entry.
802 @see @ref overview_cpp_rtti_disabled
806 template <typename EventTag
, typename Functor
>
807 void Bind(const EventTag
& eventType
,
810 int lastId
= wxID_ANY
,
811 wxObject
*userData
= NULL
);
814 See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for
817 This overload will bind the given method as the event handler.
820 The event type to be associated with this event handler.
822 The event handler method. This can be an arbitrary method (doesn't need
823 to be from a wxEvtHandler derived class).
825 Object whose method should be called. It must always be specified
826 so it can be checked at compile time whether the given method is an
827 actual member of the given handler.
829 The first ID of the identifier range to be associated with the event
832 The last ID of the identifier range to be associated with the event
835 Data to be associated with the event table entry.
837 @see @ref overview_cpp_rtti_disabled
841 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
842 void Bind(const EventTag
&eventType
,
843 void (Class
::*method
)(EventArg
&),
844 EventHandler
*handler
,
846 int lastId
= wxID_ANY
,
847 wxObject
*userData
= NULL
);
849 Unbinds the given function, functor or method dynamically from the
850 event handler, using the specified parameters as search criteria and
851 returning @true if a matching function has been found and removed.
853 This method can only unbind functions, functors or methods which have
854 been added using the Bind<>() method. There is no way to unbind
855 functions bound using the (static) event tables.
858 The event type associated with this event handler.
860 The event handler functor. This can be an ordinary function but also
861 an arbitrary functor like boost::function<>.
863 The first ID of the identifier range associated with the event
866 The last ID of the identifier range associated with the event
869 Data associated with the event table entry.
871 @see @ref overview_cpp_rtti_disabled
875 template <typename EventTag
, typename Functor
>
876 bool Unbind(const EventTag
& eventType
,
879 int lastId
= wxID_ANY
,
880 wxObject
*userData
= NULL
);
883 See the Unbind<>(const EventTag&, Functor, int, int, wxObject*)
884 overload for more info.
886 This overload unbinds the given method from the event..
889 The event type associated with this event handler.
891 The event handler method associated with this event.
893 Object whose method was called.
895 The first ID of the identifier range associated with the event
898 The last ID of the identifier range associated with the event
901 Data associated with the event table entry.
903 @see @ref overview_cpp_rtti_disabled
907 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
908 bool Unbind(const EventTag
&eventType
,
909 void (Class
::*method
)(EventArg
&),
910 EventHandler
*handler
,
912 int lastId
= wxID_ANY
,
913 wxObject
*userData
= NULL
);
916 @name User-supplied data
921 Returns user-supplied client data.
923 @remarks Normally, any extra data the programmer wishes to associate with
924 the object should be made available by deriving a new class with
929 void* GetClientData() const;
932 Returns a pointer to the user-supplied client data object.
934 @see SetClientObject(), wxClientData
936 wxClientData
* GetClientObject() const;
939 Sets user-supplied client data.
942 Data to be associated with the event handler.
944 @remarks Normally, any extra data the programmer wishes to associate
945 with the object should be made available by deriving a new
946 class with new data members. You must not call this method
947 and SetClientObject on the same class - only one of them.
951 void SetClientData(void* data
);
954 Set the client data object. Any previous object will be deleted.
956 @see GetClientObject(), wxClientData
958 void SetClientObject(wxClientData
* data
);
964 @name Event handler chaining
966 wxEvtHandler can be arranged in a double-linked list of handlers
967 which is automatically iterated by ProcessEvent() if needed.
972 Returns @true if the event handler is enabled, @false otherwise.
974 @see SetEvtHandlerEnabled()
976 bool GetEvtHandlerEnabled() const;
979 Returns the pointer to the next handler in the chain.
981 @see SetNextHandler(), GetPreviousHandler(), SetPreviousHandler(),
982 wxWindow::PushEventHandler, wxWindow::PopEventHandler
984 wxEvtHandler
* GetNextHandler() const;
987 Returns the pointer to the previous handler in the chain.
989 @see SetPreviousHandler(), GetNextHandler(), SetNextHandler(),
990 wxWindow::PushEventHandler, wxWindow::PopEventHandler
992 wxEvtHandler
* GetPreviousHandler() const;
995 Enables or disables the event handler.
998 @true if the event handler is to be enabled, @false if it is to be disabled.
1000 @remarks You can use this function to avoid having to remove the event
1001 handler from the chain, for example when implementing a
1002 dialog editor and changing from edit to test mode.
1004 @see GetEvtHandlerEnabled()
1006 void SetEvtHandlerEnabled(bool enabled
);
1009 Sets the pointer to the next handler.
1012 See ProcessEvent() for more info about how the chains of event handlers
1013 are internally used.
1014 Also remember that wxEvtHandler uses double-linked lists and thus if you
1015 use this function, you should also call SetPreviousHandler() on the
1016 argument passed to this function:
1018 handlerA->SetNextHandler(handlerB);
1019 handlerB->SetPreviousHandler(handlerA);
1023 The event handler to be set as the next handler.
1026 @see @ref overview_events_processing
1028 virtual void SetNextHandler(wxEvtHandler
* handler
);
1031 Sets the pointer to the previous handler.
1032 All remarks about SetNextHandler() apply to this function as well.
1035 The event handler to be set as the previous handler.
1038 @see @ref overview_events_processing
1040 virtual void SetPreviousHandler(wxEvtHandler
* handler
);
1043 Unlinks this event handler from the chain it's part of (if any);
1044 then links the "previous" event handler to the "next" one
1045 (so that the chain won't be interrupted).
1047 E.g. if before calling Unlink() you have the following chain:
1048 @image html evthandler_unlink_before.png
1049 then after calling @c B->Unlink() you'll have:
1050 @image html evthandler_unlink_after.png
1057 Returns @true if the next and the previous handler pointers of this
1058 event handler instance are @NULL.
1062 @see SetPreviousHandler(), SetNextHandler()
1064 bool IsUnlinked() const;
1070 Method called by ProcessEvent() before examining this object event
1073 This method can be overridden to hook into the event processing logic
1074 as early as possible. You should usually call the base class version
1075 when overriding this method, even if wxEvtHandler itself does nothing
1076 here, some derived classes do use this method, e.g. wxWindow implements
1077 support for wxValidator in it.
1081 class MyClass : public BaseClass // inheriting from wxEvtHandler
1085 virtual bool TryBefore(wxEvent& event)
1087 if ( MyPreProcess(event) )
1090 return BaseClass::TryBefore(event);
1097 virtual bool TryBefore(wxEvent
& event
);
1100 Try to process the event in this event handler.
1102 This method is called from ProcessEventLocally() and thus, indirectly,
1103 from ProcessEvent(), please see the detailed description of the event
1104 processing logic there.
1106 It is currently @em not virtual and so may not be overridden.
1113 @true if this object itself defines a handler for this event and
1114 the handler didn't skip the event.
1116 bool TryThis(wxEvent
& event
);
1119 Method called by ProcessEvent() as last resort.
1121 This method can be overridden to implement post-processing for the
1122 events which were not processed anywhere else.
1124 The base class version handles forwarding the unprocessed events to
1125 wxApp at wxEvtHandler level and propagating them upwards the window
1126 child-parent chain at wxWindow level and so should usually be called
1127 when overriding this method:
1129 class MyClass : public BaseClass // inheriting from wxEvtHandler
1133 virtual bool TryAfter(wxEvent& event)
1135 if ( BaseClass::TryAfter(event) )
1138 return MyPostProcess(event);
1145 virtual bool TryAfter(wxEvent
& event
);
1150 Flags for categories of keys.
1152 These values are used by wxKeyEvent::IsKeyInCategory(). They may be
1153 combined via the bitwise operators |, &, and ~.
1157 enum wxKeyCategoryFlags
1159 /// arrow keys, on and off numeric keypads
1162 /// page up and page down keys, on and off numeric keypads
1163 WXK_CATEGORY_PAGING
,
1165 /// home and end keys, on and off numeric keypads
1168 /// tab key, on and off numeric keypads
1171 /// backspace and delete keys, on and off numeric keypads
1174 /// union of WXK_CATEGORY_ARROW, WXK_CATEGORY_PAGING, and WXK_CATEGORY_JUMP categories
1175 WXK_CATEGORY_NAVIGATION
1182 This event class contains information about key press and release events.
1184 The main information carried by this event is the key being pressed or
1185 released. It can be accessed using either GetKeyCode() function or
1186 GetUnicodeKey(). For the printable characters, the latter should be used as
1187 it works for any keys, including non-Latin-1 characters that can be entered
1188 when using national keyboard layouts. GetKeyCode() should be used to handle
1189 special characters (such as cursor arrows keys or @c HOME or @c INS and so
1190 on) which correspond to ::wxKeyCode enum elements above the @c WXK_START
1191 constant. While GetKeyCode() also returns the character code for Latin-1
1192 keys for compatibility, it doesn't work for Unicode characters in general
1193 and will return @c WXK_NONE for any non-Latin-1 ones. For this reason, it's
1194 recommended to always use GetUnicodeKey() and only fall back to GetKeyCode()
1195 if GetUnicodeKey() returned @c WXK_NONE meaning that the event corresponds
1196 to a non-printable special keys.
1198 While both of these functions can be used with the events of @c
1199 wxEVT_KEY_DOWN, @c wxEVT_KEY_UP and @c wxEVT_CHAR types, the values
1200 returned by them are different for the first two events and the last one.
1201 For the latter, the key returned corresponds to the character that would
1202 appear in e.g. a text zone if the user pressed the key in it. As such, its
1203 value depends on the current state of the Shift key and, for the letters,
1204 on the state of Caps Lock modifier. For example, if @c A key is pressed
1205 without Shift being held down, wxKeyEvent of type @c wxEVT_CHAR generated
1206 for this key press will return (from either GetKeyCode() or GetUnicodeKey()
1207 as their meanings coincide for ASCII characters) key code of 97
1208 corresponding the ASCII value of @c a. And if the same key is pressed but
1209 with Shift being held (or Caps Lock being active), then the key could would
1210 be 65, i.e. ASCII value of capital @c A.
1212 However for the key down and up events the returned key code will instead
1213 be @c A independently of the state of the modifier keys i.e. it depends
1214 only on physical key being pressed and is not translated to its logical
1215 representation using the current keyboard state. Such untranslated key
1216 codes are defined as follows:
1217 - For the letters they correspond to the @e upper case value of the
1219 - For the other alphanumeric keys (e.g. @c 7 or @c +), the untranslated
1220 key code corresponds to the character produced by the key when it is
1221 pressed without Shift. E.g. in standard US keyboard layout the
1222 untranslated key code for the key @c =/+ in the upper right corner of
1223 the keyboard is 61 which is the ASCII value of @c =.
1224 - For the rest of the keys (i.e. special non-printable keys) it is the
1225 same as the normal key code as no translation is used anyhow.
1227 Notice that the first rule applies to all Unicode letters, not just the
1228 usual Latin-1 ones. However for non-Latin-1 letters only GetUnicodeKey()
1229 can be used to retrieve the key code as GetKeyCode() just returns @c
1230 WXK_NONE in this case.
1232 To summarize: you should handle @c wxEVT_CHAR if you need the translated
1233 key and @c wxEVT_KEY_DOWN if you only need the value of the key itself,
1234 independent of the current keyboard state.
1236 @note Not all key down events may be generated by the user. As an example,
1237 @c wxEVT_KEY_DOWN with @c = key code can be generated using the
1238 standard US keyboard layout but not using the German one because the @c
1239 = key corresponds to Shift-0 key combination in this layout and the key
1240 code for it is @c 0, not @c =. Because of this you should avoid
1241 requiring your users to type key events that might be impossible to
1242 enter on their keyboard.
1245 Another difference between key and char events is that another kind of
1246 translation is done for the latter ones when the Control key is pressed:
1247 char events for ASCII letters in this case carry codes corresponding to the
1248 ASCII value of Ctrl-Latter, i.e. 1 for Ctrl-A, 2 for Ctrl-B and so on until
1249 26 for Ctrl-Z. This is convenient for terminal-like applications and can be
1250 completely ignored by all the other ones (if you need to handle Ctrl-A it
1251 is probably a better idea to use the key event rather than the char one).
1252 Notice that currently no translation is done for the presses of @c [, @c
1253 \\, @c ], @c ^ and @c _ keys which might be mapped to ASCII values from 27
1256 Finally, modifier keys only generate key events but no char events at all.
1257 The modifiers keys are @c WXK_SHIFT, @c WXK_CONTROL, @c WXK_ALT and various
1258 @c WXK_WINDOWS_XXX from ::wxKeyCode enum.
1261 You may discover how the other keys on your system behave interactively by
1262 running the @ref page_samples_keyboard wxWidgets sample and pressing some
1265 @b Tip: be sure to call @c event.Skip() for events that you don't process in
1266 key event function, otherwise menu shortcuts may cease to work under Windows.
1268 @note If a key down (@c EVT_KEY_DOWN) event is caught and the event handler
1269 does not call @c event.Skip() then the corresponding char event
1270 (@c EVT_CHAR) will not happen.
1271 This is by design and enables the programs that handle both types of
1272 events to be a bit simpler.
1274 @note For Windows programmers: The key and char events in wxWidgets are
1275 similar to but slightly different from Windows @c WM_KEYDOWN and
1276 @c WM_CHAR events. In particular, Alt-x combination will generate a
1277 char event in wxWidgets (unless it is used as an accelerator) and
1278 almost all keys, including ones without ASCII equivalents, generate
1282 @beginEventTable{wxKeyEvent}
1283 @event{EVT_KEY_DOWN(func)}
1284 Process a @c wxEVT_KEY_DOWN event (any key has been pressed).
1285 @event{EVT_KEY_UP(func)}
1286 Process a @c wxEVT_KEY_UP event (any key has been released).
1287 @event{EVT_CHAR(func)}
1288 Process a @c wxEVT_CHAR event.
1291 @see wxKeyboardState
1296 class wxKeyEvent
: public wxEvent
,
1297 public wxKeyboardState
1302 Currently, the only valid event types are @c wxEVT_CHAR and @c wxEVT_CHAR_HOOK.
1304 wxKeyEvent(wxEventType keyEventType
= wxEVT_NULL
);
1307 Returns the key code of the key that generated this event.
1309 ASCII symbols return normal ASCII values, while events from special
1310 keys such as "left cursor arrow" (@c WXK_LEFT) return values outside of
1311 the ASCII range. See ::wxKeyCode for a full list of the virtual key
1314 Note that this method returns a meaningful value only for special
1315 non-alphanumeric keys or if the user entered a character that can be
1316 represented in current locale's default charset. Otherwise, e.g. if the
1317 user enters a Japanese character in a program not using Japanese
1318 locale, this method returns @c WXK_NONE and GetUnicodeKey() should be
1319 used to obtain the corresponding Unicode character.
1321 Using GetUnicodeKey() is in general the right thing to do if you are
1322 interested in the characters typed by the user, GetKeyCode() should be
1323 only used for special keys (for which GetUnicodeKey() returns @c
1324 WXK_NONE). To handle both kinds of keys you might write:
1326 void MyHandler::OnChar(wxKeyEvent& event)
1328 if ( event.GetUnicodeKey() != WXK_NONE )
1330 // It's a printable character
1331 wxLogMessage("You pressed '%c'", event.GetUnicodeKey());
1335 // It's a special key, deal with all the known ones:
1351 int GetKeyCode() const;
1354 Returns true if the key is in the given key category.
1357 A bitwise combination of named ::wxKeyCategoryFlags constants.
1361 bool IsKeyInCategory(int category
) const;
1365 Obtains the position (in client coordinates) at which the key was pressed.
1367 wxPoint
GetPosition() const;
1368 void GetPosition(long* x
, long* y
) const;
1372 Returns the raw key code for this event. This is a platform-dependent scan code
1373 which should only be used in advanced applications.
1375 @note Currently the raw key codes are not supported by all ports, use
1376 @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
1378 wxUint32
GetRawKeyCode() const;
1381 Returns the low level key flags for this event. The flags are
1382 platform-dependent and should only be used in advanced applications.
1384 @note Currently the raw key flags are not supported by all ports, use
1385 @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
1387 wxUint32
GetRawKeyFlags() const;
1390 Returns the Unicode character corresponding to this key event.
1392 If the key pressed doesn't have any character value (e.g. a cursor key)
1393 this method will return @c WXK_NONE. In this case you should use
1394 GetKeyCode() to retrieve the value of the key.
1396 This function is only available in Unicode build, i.e. when
1397 @c wxUSE_UNICODE is 1.
1399 wxChar
GetUnicodeKey() const;
1402 Returns the X position (in client coordinates) of the event.
1404 wxCoord
GetX() const;
1407 Returns the Y position (in client coordinates) of the event.
1409 wxCoord
GetY() const;
1415 @class wxJoystickEvent
1417 This event class contains information about joystick events, particularly
1418 events received by windows.
1420 @beginEventTable{wxJoystickEvent}
1421 @event{EVT_JOY_BUTTON_DOWN(func)}
1422 Process a @c wxEVT_JOY_BUTTON_DOWN event.
1423 @event{EVT_JOY_BUTTON_UP(func)}
1424 Process a @c wxEVT_JOY_BUTTON_UP event.
1425 @event{EVT_JOY_MOVE(func)}
1426 Process a @c wxEVT_JOY_MOVE event.
1427 @event{EVT_JOY_ZMOVE(func)}
1428 Process a @c wxEVT_JOY_ZMOVE event.
1429 @event{EVT_JOYSTICK_EVENTS(func)}
1430 Processes all joystick events.
1438 class wxJoystickEvent
: public wxEvent
1444 wxJoystickEvent(wxEventType eventType
= wxEVT_NULL
, int state
= 0,
1445 int joystick
= wxJOYSTICK1
,
1449 Returns @true if the event was a down event from the specified button
1453 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1454 indicate any button down event.
1456 bool ButtonDown(int button
= wxJOY_BUTTON_ANY
) const;
1459 Returns @true if the specified button (or any button) was in a down state.
1462 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1463 indicate any button down event.
1465 bool ButtonIsDown(int button
= wxJOY_BUTTON_ANY
) const;
1468 Returns @true if the event was an up event from the specified button
1472 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1473 indicate any button down event.
1475 bool ButtonUp(int button
= wxJOY_BUTTON_ANY
) const;
1478 Returns the identifier of the button changing state.
1480 This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
1482 int GetButtonChange() const;
1485 Returns the down state of the buttons.
1487 This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
1489 int GetButtonState() const;
1492 Returns the identifier of the joystick generating the event - one of
1493 wxJOYSTICK1 and wxJOYSTICK2.
1495 int GetJoystick() const;
1498 Returns the x, y position of the joystick event.
1500 wxPoint
GetPosition() const;
1503 Returns the z position of the joystick event.
1505 int GetZPosition() const;
1508 Returns @true if this was a button up or down event
1509 (@e not 'is any button down?').
1511 bool IsButton() const;
1514 Returns @true if this was an x, y move event.
1516 bool IsMove() const;
1519 Returns @true if this was a z move event.
1521 bool IsZMove() const;
1527 @class wxScrollWinEvent
1529 A scroll event holds information about events sent from scrolling windows.
1531 Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events
1532 from the receiving window.
1534 @beginEventTable{wxScrollWinEvent}
1535 @event{EVT_SCROLLWIN(func)}
1536 Process all scroll events.
1537 @event{EVT_SCROLLWIN_TOP(func)}
1538 Process wxEVT_SCROLLWIN_TOP scroll-to-top events.
1539 @event{EVT_SCROLLWIN_BOTTOM(func)}
1540 Process wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
1541 @event{EVT_SCROLLWIN_LINEUP(func)}
1542 Process wxEVT_SCROLLWIN_LINEUP line up events.
1543 @event{EVT_SCROLLWIN_LINEDOWN(func)}
1544 Process wxEVT_SCROLLWIN_LINEDOWN line down events.
1545 @event{EVT_SCROLLWIN_PAGEUP(func)}
1546 Process wxEVT_SCROLLWIN_PAGEUP page up events.
1547 @event{EVT_SCROLLWIN_PAGEDOWN(func)}
1548 Process wxEVT_SCROLLWIN_PAGEDOWN page down events.
1549 @event{EVT_SCROLLWIN_THUMBTRACK(func)}
1550 Process wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
1551 (frequent events sent as the user drags the thumbtrack).
1552 @event{EVT_SCROLLWIN_THUMBRELEASE(func)}
1553 Process wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
1560 @see wxScrollEvent, @ref overview_events
1562 class wxScrollWinEvent
: public wxEvent
1568 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
, int pos
= 0,
1569 int orientation
= 0);
1572 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
1575 @todo wxHORIZONTAL and wxVERTICAL should go in their own enum
1577 int GetOrientation() const;
1580 Returns the position of the scrollbar for the thumb track and release events.
1582 Note that this field can't be used for the other events, you need to query
1583 the window itself for the current position in that case.
1585 int GetPosition() const;
1591 @class wxSysColourChangedEvent
1593 This class is used for system colour change events, which are generated
1594 when the user changes the colour settings using the control panel.
1595 This is only appropriate under Windows.
1598 The default event handler for this event propagates the event to child windows,
1599 since Windows only sends the events to top-level windows.
1600 If intercepting this event for a top-level window, remember to call the base
1601 class handler, or to pass the event on to the window's children explicitly.
1603 @beginEventTable{wxSysColourChangedEvent}
1604 @event{EVT_SYS_COLOUR_CHANGED(func)}
1605 Process a @c wxEVT_SYS_COLOUR_CHANGED event.
1611 @see @ref overview_events
1613 class wxSysColourChangedEvent
: public wxEvent
1619 wxSysColourChangedEvent();
1625 @class wxWindowCreateEvent
1627 This event is sent just after the actual window associated with a wxWindow
1628 object has been created.
1630 Since it is derived from wxCommandEvent, the event propagates up
1631 the window hierarchy.
1633 @beginEventTable{wxWindowCreateEvent}
1634 @event{EVT_WINDOW_CREATE(func)}
1635 Process a @c wxEVT_CREATE event.
1641 @see @ref overview_events, wxWindowDestroyEvent
1643 class wxWindowCreateEvent
: public wxCommandEvent
1649 wxWindowCreateEvent(wxWindow
* win
= NULL
);
1651 /// Retutn the window being created.
1652 wxWindow
*GetWindow() const;
1660 A paint event is sent when a window's contents needs to be repainted.
1662 The handler of this event must create a wxPaintDC object and use it for
1663 painting the window contents. For example:
1665 void MyWindow::OnPaint(wxPaintEvent& event)
1673 Notice that you must @e not create other kinds of wxDC (e.g. wxClientDC or
1674 wxWindowDC) in EVT_PAINT handlers and also don't create wxPaintDC outside
1675 of this event handlers.
1678 You can optimize painting by retrieving the rectangles that have been damaged
1679 and only repainting these. The rectangles are in terms of the client area,
1680 and are unscrolled, so you will need to do some calculations using the current
1681 view position to obtain logical, scrolled units.
1682 Here is an example of using the wxRegionIterator class:
1684 // Called when window needs to be repainted.
1685 void MyWindow::OnPaint(wxPaintEvent& event)
1689 // Find Out where the window is scrolled to
1690 int vbX,vbY; // Top left corner of client
1691 GetViewStart(&vbX,&vbY);
1693 int vX,vY,vW,vH; // Dimensions of client area in pixels
1694 wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
1703 // Alternatively we can do this:
1704 // wxRect rect(upd.GetRect());
1706 // Repaint this rectangle
1715 Please notice that in general it is impossible to change the drawing of a
1716 standard control (such as wxButton) and so you shouldn't attempt to handle
1717 paint events for them as even if it might work on some platforms, this is
1718 inherently not portable and won't work everywhere.
1721 @beginEventTable{wxPaintEvent}
1722 @event{EVT_PAINT(func)}
1723 Process a @c wxEVT_PAINT event.
1729 @see @ref overview_events
1731 class wxPaintEvent
: public wxEvent
1737 wxPaintEvent(int id
= 0);
1743 @class wxMaximizeEvent
1745 An event being sent when a top level window is maximized. Notice that it is
1746 not sent when the window is restored to its original size after it had been
1747 maximized, only a normal wxSizeEvent is generated in this case.
1749 @beginEventTable{wxMaximizeEvent}
1750 @event{EVT_MAXIMIZE(func)}
1751 Process a @c wxEVT_MAXIMIZE event.
1757 @see @ref overview_events, wxTopLevelWindow::Maximize,
1758 wxTopLevelWindow::IsMaximized
1760 class wxMaximizeEvent
: public wxEvent
1764 Constructor. Only used by wxWidgets internally.
1766 wxMaximizeEvent(int id
= 0);
1770 The possibles modes to pass to wxUpdateUIEvent::SetMode().
1774 /** Send UI update events to all windows. */
1775 wxUPDATE_UI_PROCESS_ALL
,
1777 /** Send UI update events to windows that have
1778 the wxWS_EX_PROCESS_UI_UPDATES flag specified. */
1779 wxUPDATE_UI_PROCESS_SPECIFIED
1784 @class wxUpdateUIEvent
1786 This class is used for pseudo-events which are called by wxWidgets
1787 to give an application the chance to update various user interface elements.
1789 Without update UI events, an application has to work hard to check/uncheck,
1790 enable/disable, show/hide, and set the text for elements such as menu items
1791 and toolbar buttons. The code for doing this has to be mixed up with the code
1792 that is invoked when an action is invoked for a menu item or button.
1794 With update UI events, you define an event handler to look at the state of the
1795 application and change UI elements accordingly. wxWidgets will call your member
1796 functions in idle time, so you don't have to worry where to call this code.
1798 In addition to being a clearer and more declarative method, it also means you don't
1799 have to worry whether you're updating a toolbar or menubar identifier. The same
1800 handler can update a menu item and toolbar button, if the identifier is the same.
1801 Instead of directly manipulating the menu or button, you call functions in the event
1802 object, such as wxUpdateUIEvent::Check. wxWidgets will determine whether such a
1803 call has been made, and which UI element to update.
1805 These events will work for popup menus as well as menubars. Just before a menu is
1806 popped up, wxMenu::UpdateUI is called to process any UI events for the window that
1809 If you find that the overhead of UI update processing is affecting your application,
1810 you can do one or both of the following:
1811 @li Call wxUpdateUIEvent::SetMode with a value of wxUPDATE_UI_PROCESS_SPECIFIED,
1812 and set the extra style wxWS_EX_PROCESS_UI_UPDATES for every window that should
1813 receive update events. No other windows will receive update events.
1814 @li Call wxUpdateUIEvent::SetUpdateInterval with a millisecond value to set the delay
1815 between updates. You may need to call wxWindow::UpdateWindowUI at critical points,
1816 for example when a dialog is about to be shown, in case the user sees a slight
1817 delay before windows are updated.
1819 Note that although events are sent in idle time, defining a wxIdleEvent handler
1820 for a window does not affect this because the events are sent from wxWindow::OnInternalIdle
1821 which is always called in idle time.
1823 wxWidgets tries to optimize update events on some platforms.
1824 On Windows and GTK+, events for menubar items are only sent when the menu is about
1825 to be shown, and not in idle time.
1828 @beginEventTable{wxUpdateUIEvent}
1829 @event{EVT_UPDATE_UI(id, func)}
1830 Process a @c wxEVT_UPDATE_UI event for the command with the given id.
1831 @event{EVT_UPDATE_UI_RANGE(id1, id2, func)}
1832 Process a @c wxEVT_UPDATE_UI event for any command with id included in the given range.
1838 @see @ref overview_events
1840 class wxUpdateUIEvent
: public wxCommandEvent
1846 wxUpdateUIEvent(wxWindowID commandId
= 0);
1849 Returns @true if it is appropriate to update (send UI update events to)
1852 This function looks at the mode used (see wxUpdateUIEvent::SetMode),
1853 the wxWS_EX_PROCESS_UI_UPDATES flag in @a window, the time update events
1854 were last sent in idle time, and the update interval, to determine whether
1855 events should be sent to this window now. By default this will always
1856 return @true because the update mode is initially wxUPDATE_UI_PROCESS_ALL
1857 and the interval is set to 0; so update events will be sent as often as
1858 possible. You can reduce the frequency that events are sent by changing the
1859 mode and/or setting an update interval.
1861 @see ResetUpdateTime(), SetUpdateInterval(), SetMode()
1863 static bool CanUpdate(wxWindow
* window
);
1866 Check or uncheck the UI element.
1868 void Check(bool check
);
1871 Enable or disable the UI element.
1873 void Enable(bool enable
);
1876 Returns @true if the UI element should be checked.
1878 bool GetChecked() const;
1881 Returns @true if the UI element should be enabled.
1883 bool GetEnabled() const;
1886 Static function returning a value specifying how wxWidgets will send update
1887 events: to all windows, or only to those which specify that they will process
1892 static wxUpdateUIMode
GetMode();
1895 Returns @true if the application has called Check().
1896 For wxWidgets internal use only.
1898 bool GetSetChecked() const;
1901 Returns @true if the application has called Enable().
1902 For wxWidgets internal use only.
1904 bool GetSetEnabled() const;
1907 Returns @true if the application has called Show().
1908 For wxWidgets internal use only.
1910 bool GetSetShown() const;
1913 Returns @true if the application has called SetText().
1914 For wxWidgets internal use only.
1916 bool GetSetText() const;
1919 Returns @true if the UI element should be shown.
1921 bool GetShown() const;
1924 Returns the text that should be set for the UI element.
1926 wxString
GetText() const;
1929 Returns the current interval between updates in milliseconds.
1930 The value -1 disables updates, 0 updates as frequently as possible.
1932 @see SetUpdateInterval().
1934 static long GetUpdateInterval();
1937 Used internally to reset the last-updated time to the current time.
1939 It is assumed that update events are normally sent in idle time, so this
1940 is called at the end of idle processing.
1942 @see CanUpdate(), SetUpdateInterval(), SetMode()
1944 static void ResetUpdateTime();
1947 Specify how wxWidgets will send update events: to all windows, or only to
1948 those which specify that they will process the events.
1951 this parameter may be one of the ::wxUpdateUIMode enumeration values.
1952 The default mode is wxUPDATE_UI_PROCESS_ALL.
1954 static void SetMode(wxUpdateUIMode mode
);
1957 Sets the text for this UI element.
1959 void SetText(const wxString
& text
);
1962 Sets the interval between updates in milliseconds.
1964 Set to -1 to disable updates, or to 0 to update as frequently as possible.
1967 Use this to reduce the overhead of UI update events if your application
1968 has a lot of windows. If you set the value to -1 or greater than 0,
1969 you may also need to call wxWindow::UpdateWindowUI at appropriate points
1970 in your application, such as when a dialog is about to be shown.
1972 static void SetUpdateInterval(long updateInterval
);
1975 Show or hide the UI element.
1977 void Show(bool show
);
1983 @class wxClipboardTextEvent
1985 This class represents the events generated by a control (typically a
1986 wxTextCtrl but other windows can generate these events as well) when its
1987 content gets copied or cut to, or pasted from the clipboard.
1989 There are three types of corresponding events wxEVT_COMMAND_TEXT_COPY,
1990 wxEVT_COMMAND_TEXT_CUT and wxEVT_COMMAND_TEXT_PASTE.
1992 If any of these events is processed (without being skipped) by an event
1993 handler, the corresponding operation doesn't take place which allows to
1994 prevent the text from being copied from or pasted to a control. It is also
1995 possible to examine the clipboard contents in the PASTE event handler and
1996 transform it in some way before inserting in a control -- for example,
1997 changing its case or removing invalid characters.
1999 Finally notice that a CUT event is always preceded by the COPY event which
2000 makes it possible to only process the latter if it doesn't matter if the
2001 text was copied or cut.
2004 These events are currently only generated by wxTextCtrl under GTK+.
2005 They are generated by all controls under Windows.
2007 @beginEventTable{wxClipboardTextEvent}
2008 @event{EVT_TEXT_COPY(id, func)}
2009 Some or all of the controls content was copied to the clipboard.
2010 @event{EVT_TEXT_CUT(id, func)}
2011 Some or all of the controls content was cut (i.e. copied and
2013 @event{EVT_TEXT_PASTE(id, func)}
2014 Clipboard content was pasted into the control.
2023 class wxClipboardTextEvent
: public wxCommandEvent
2029 wxClipboardTextEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0);
2037 This event class contains information about the events generated by the mouse:
2038 they include mouse buttons press and release events and mouse move events.
2040 All mouse events involving the buttons use @c wxMOUSE_BTN_LEFT for the
2041 left mouse button, @c wxMOUSE_BTN_MIDDLE for the middle one and
2042 @c wxMOUSE_BTN_RIGHT for the right one. And if the system supports more
2043 buttons, the @c wxMOUSE_BTN_AUX1 and @c wxMOUSE_BTN_AUX2 events
2044 can also be generated. Note that not all mice have even a middle button so a
2045 portable application should avoid relying on the events from it (but the right
2046 button click can be emulated using the left mouse button with the control key
2047 under Mac platforms with a single button mouse).
2049 For the @c wxEVT_ENTER_WINDOW and @c wxEVT_LEAVE_WINDOW events
2050 purposes, the mouse is considered to be inside the window if it is in the
2051 window client area and not inside one of its children. In other words, the
2052 parent window receives @c wxEVT_LEAVE_WINDOW event not only when the
2053 mouse leaves the window entirely but also when it enters one of its children.
2055 The position associated with a mouse event is expressed in the window
2056 coordinates of the window which generated the event, you can use
2057 wxWindow::ClientToScreen() to convert it to screen coordinates and possibly
2058 call wxWindow::ScreenToClient() next to convert it to window coordinates of
2061 @note Note that under Windows CE mouse enter and leave events are not natively
2062 supported by the system but are generated by wxWidgets itself. This has several
2063 drawbacks: the LEAVE_WINDOW event might be received some time after the mouse
2064 left the window and the state variables for it may have changed during this time.
2066 @note Note the difference between methods like wxMouseEvent::LeftDown and
2067 the inherited wxMouseState::LeftIsDown: the former returns @true when
2068 the event corresponds to the left mouse button click while the latter
2069 returns @true if the left mouse button is currently being pressed.
2070 For example, when the user is dragging the mouse you can use
2071 wxMouseEvent::LeftIsDown to test whether the left mouse button is
2072 (still) depressed. Also, by convention, if wxMouseEvent::LeftDown
2073 returns @true, wxMouseEvent::LeftIsDown will also return @true in
2074 wxWidgets whatever the underlying GUI behaviour is (which is
2075 platform-dependent). The same applies, of course, to other mouse
2079 @beginEventTable{wxMouseEvent}
2080 @event{EVT_LEFT_DOWN(func)}
2081 Process a @c wxEVT_LEFT_DOWN event. The handler of this event should normally
2082 call event.Skip() to allow the default processing to take place as otherwise
2083 the window under mouse wouldn't get the focus.
2084 @event{EVT_LEFT_UP(func)}
2085 Process a @c wxEVT_LEFT_UP event.
2086 @event{EVT_LEFT_DCLICK(func)}
2087 Process a @c wxEVT_LEFT_DCLICK event.
2088 @event{EVT_MIDDLE_DOWN(func)}
2089 Process a @c wxEVT_MIDDLE_DOWN event.
2090 @event{EVT_MIDDLE_UP(func)}
2091 Process a @c wxEVT_MIDDLE_UP event.
2092 @event{EVT_MIDDLE_DCLICK(func)}
2093 Process a @c wxEVT_MIDDLE_DCLICK event.
2094 @event{EVT_RIGHT_DOWN(func)}
2095 Process a @c wxEVT_RIGHT_DOWN event.
2096 @event{EVT_RIGHT_UP(func)}
2097 Process a @c wxEVT_RIGHT_UP event.
2098 @event{EVT_RIGHT_DCLICK(func)}
2099 Process a @c wxEVT_RIGHT_DCLICK event.
2100 @event{EVT_MOUSE_AUX1_DOWN(func)}
2101 Process a @c wxEVT_AUX1_DOWN event.
2102 @event{EVT_MOUSE_AUX1_UP(func)}
2103 Process a @c wxEVT_AUX1_UP event.
2104 @event{EVT_MOUSE_AUX1_DCLICK(func)}
2105 Process a @c wxEVT_AUX1_DCLICK event.
2106 @event{EVT_MOUSE_AUX2_DOWN(func)}
2107 Process a @c wxEVT_AUX2_DOWN event.
2108 @event{EVT_MOUSE_AUX2_UP(func)}
2109 Process a @c wxEVT_AUX2_UP event.
2110 @event{EVT_MOUSE_AUX2_DCLICK(func)}
2111 Process a @c wxEVT_AUX2_DCLICK event.
2112 @event{EVT_MOTION(func)}
2113 Process a @c wxEVT_MOTION event.
2114 @event{EVT_ENTER_WINDOW(func)}
2115 Process a @c wxEVT_ENTER_WINDOW event.
2116 @event{EVT_LEAVE_WINDOW(func)}
2117 Process a @c wxEVT_LEAVE_WINDOW event.
2118 @event{EVT_MOUSEWHEEL(func)}
2119 Process a @c wxEVT_MOUSEWHEEL event.
2120 @event{EVT_MOUSE_EVENTS(func)}
2121 Process all mouse events.
2129 class wxMouseEvent
: public wxEvent
,
2134 Constructor. Valid event types are:
2136 @li wxEVT_ENTER_WINDOW
2137 @li wxEVT_LEAVE_WINDOW
2140 @li wxEVT_LEFT_DCLICK
2141 @li wxEVT_MIDDLE_DOWN
2143 @li wxEVT_MIDDLE_DCLICK
2144 @li wxEVT_RIGHT_DOWN
2146 @li wxEVT_RIGHT_DCLICK
2147 @li wxEVT_MOUSE_AUX1_DOWN
2148 @li wxEVT_MOUSE_AUX1_UP
2149 @li wxEVT_MOUSE_AUX1_DCLICK
2150 @li wxEVT_MOUSE_AUX2_DOWN
2151 @li wxEVT_MOUSE_AUX2_UP
2152 @li wxEVT_MOUSE_AUX2_DCLICK
2154 @li wxEVT_MOUSEWHEEL
2156 wxMouseEvent(wxEventType mouseEventType
= wxEVT_NULL
);
2159 Returns @true if the event was a first extra button double click.
2161 bool Aux1DClick() const;
2164 Returns @true if the first extra button mouse button changed to down.
2166 bool Aux1Down() const;
2169 Returns @true if the first extra button mouse button changed to up.
2171 bool Aux1Up() const;
2174 Returns @true if the event was a second extra button double click.
2176 bool Aux2DClick() const;
2179 Returns @true if the second extra button mouse button changed to down.
2181 bool Aux2Down() const;
2184 Returns @true if the second extra button mouse button changed to up.
2186 bool Aux2Up() const;
2189 Returns @true if the event was generated by the specified button.
2191 @see wxMouseState::ButtoinIsDown()
2193 bool Button(wxMouseButton but
) const;
2196 If the argument is omitted, this returns @true if the event was a mouse
2197 double click event. Otherwise the argument specifies which double click event
2198 was generated (see Button() for the possible values).
2200 bool ButtonDClick(wxMouseButton but
= wxMOUSE_BTN_ANY
) const;
2203 If the argument is omitted, this returns @true if the event was a mouse
2204 button down event. Otherwise the argument specifies which button-down event
2205 was generated (see Button() for the possible values).
2207 bool ButtonDown(wxMouseButton but
= wxMOUSE_BTN_ANY
) const;
2210 If the argument is omitted, this returns @true if the event was a mouse
2211 button up event. Otherwise the argument specifies which button-up event
2212 was generated (see Button() for the possible values).
2214 bool ButtonUp(wxMouseButton but
= wxMOUSE_BTN_ANY
) const;
2217 Returns @true if this was a dragging event (motion while a button is depressed).
2221 bool Dragging() const;
2224 Returns @true if the mouse was entering the window.
2228 bool Entering() const;
2231 Returns the mouse button which generated this event or @c wxMOUSE_BTN_NONE
2232 if no button is involved (for mouse move, enter or leave event, for example).
2233 Otherwise @c wxMOUSE_BTN_LEFT is returned for the left button down, up and
2234 double click events, @c wxMOUSE_BTN_MIDDLE and @c wxMOUSE_BTN_RIGHT
2235 for the same events for the middle and the right buttons respectively.
2237 int GetButton() const;
2240 Returns the number of mouse clicks for this event: 1 for a simple click, 2
2241 for a double-click, 3 for a triple-click and so on.
2243 Currently this function is implemented only in wxMac and returns -1 for the
2244 other platforms (you can still distinguish simple clicks from double-clicks as
2245 they generate different kinds of events however).
2249 int GetClickCount() const;
2252 Returns the configured number of lines (or whatever) to be scrolled per
2253 wheel action. Defaults to three.
2255 int GetLinesPerAction() const;
2258 Returns the logical mouse position in pixels (i.e. translated according to the
2259 translation set for the DC, which usually indicates that the window has been
2262 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
2265 Get wheel delta, normally 120.
2267 This is the threshold for action to be taken, and one such action
2268 (for example, scrolling one increment) should occur for each delta.
2270 int GetWheelDelta() const;
2273 Get wheel rotation, positive or negative indicates direction of rotation.
2275 Current devices all send an event when rotation is at least +/-WheelDelta, but
2276 finer resolution devices can be created in the future.
2278 Because of this you shouldn't assume that one event is equal to 1 line, but you
2279 should be able to either do partial line scrolling or wait until several
2280 events accumulate before scrolling.
2282 int GetWheelRotation() const;
2285 Gets the axis the wheel operation concerns; @c 0 is the Y axis as on
2286 most mouse wheels, @c 1 is the X axis.
2288 Note that only some models of mouse have horizontal wheel axis.
2290 int GetWheelAxis() const;
2293 Returns @true if the event was a mouse button event (not necessarily a button
2294 down event - that may be tested using ButtonDown()).
2296 bool IsButton() const;
2299 Returns @true if the system has been setup to do page scrolling with
2300 the mouse wheel instead of line scrolling.
2302 bool IsPageScroll() const;
2305 Returns @true if the mouse was leaving the window.
2309 bool Leaving() const;
2312 Returns @true if the event was a left double click.
2314 bool LeftDClick() const;
2317 Returns @true if the left mouse button changed to down.
2319 bool LeftDown() const;
2322 Returns @true if the left mouse button changed to up.
2324 bool LeftUp() const;
2327 Returns @true if the Meta key was down at the time of the event.
2329 bool MetaDown() const;
2332 Returns @true if the event was a middle double click.
2334 bool MiddleDClick() const;
2337 Returns @true if the middle mouse button changed to down.
2339 bool MiddleDown() const;
2342 Returns @true if the middle mouse button changed to up.
2344 bool MiddleUp() const;
2347 Returns @true if this was a motion event and no mouse buttons were pressed.
2348 If any mouse button is held pressed, then this method returns @false and
2349 Dragging() returns @true.
2351 bool Moving() const;
2354 Returns @true if the event was a right double click.
2356 bool RightDClick() const;
2359 Returns @true if the right mouse button changed to down.
2361 bool RightDown() const;
2364 Returns @true if the right mouse button changed to up.
2366 bool RightUp() const;
2372 @class wxDropFilesEvent
2374 This class is used for drop files events, that is, when files have been dropped
2375 onto the window. This functionality is currently only available under Windows.
2377 The window must have previously been enabled for dropping by calling
2378 wxWindow::DragAcceptFiles().
2380 Important note: this is a separate implementation to the more general drag and drop
2381 implementation documented in the @ref overview_dnd. It uses the older, Windows
2382 message-based approach of dropping files.
2384 @beginEventTable{wxDropFilesEvent}
2385 @event{EVT_DROP_FILES(func)}
2386 Process a @c wxEVT_DROP_FILES event.
2394 @see @ref overview_events
2396 class wxDropFilesEvent
: public wxEvent
2402 wxDropFilesEvent(wxEventType id
= 0, int noFiles
= 0,
2403 wxString
* files
= NULL
);
2406 Returns an array of filenames.
2408 wxString
* GetFiles() const;
2411 Returns the number of files dropped.
2413 int GetNumberOfFiles() const;
2416 Returns the position at which the files were dropped.
2417 Returns an array of filenames.
2419 wxPoint
GetPosition() const;
2425 @class wxCommandEvent
2427 This event class contains information about command events, which originate
2428 from a variety of simple controls.
2430 Note that wxCommandEvents and wxCommandEvent-derived event classes by default
2431 and unlike other wxEvent-derived classes propagate upward from the source
2432 window (the window which emits the event) up to the first parent which processes
2433 the event. Be sure to read @ref overview_events_propagation.
2435 More complex controls, such as wxTreeCtrl, have separate command event classes.
2437 @beginEventTable{wxCommandEvent}
2438 @event{EVT_COMMAND(id, event, func)}
2439 Process a command, supplying the window identifier, command event identifier,
2440 and member function.
2441 @event{EVT_COMMAND_RANGE(id1, id2, event, func)}
2442 Process a command for a range of window identifiers, supplying the minimum and
2443 maximum window identifiers, command event identifier, and member function.
2444 @event{EVT_BUTTON(id, func)}
2445 Process a @c wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wxButton control.
2446 @event{EVT_CHECKBOX(id, func)}
2447 Process a @c wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wxCheckBox control.
2448 @event{EVT_CHOICE(id, func)}
2449 Process a @c wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wxChoice control.
2450 @event{EVT_COMBOBOX(id, func)}
2451 Process a @c wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wxComboBox control.
2452 @event{EVT_LISTBOX(id, func)}
2453 Process a @c wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.
2454 @event{EVT_LISTBOX_DCLICK(id, func)}
2455 Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.
2456 @event{EVT_CHECKLISTBOX(id, func)}
2457 Process a @c wxEVT_COMMAND_CHECKLISTBOX_TOGGLED command, which is generated by a wxCheckListBox control.
2458 @event{EVT_MENU(id, func)}
2459 Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
2460 @event{EVT_MENU_RANGE(id1, id2, func)}
2461 Process a @c wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.
2462 @event{EVT_CONTEXT_MENU(func)}
2463 Process the event generated when the user has requested a popup menu to appear by
2464 pressing a special keyboard key (under Windows) or by right clicking the mouse.
2465 @event{EVT_RADIOBOX(id, func)}
2466 Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wxRadioBox control.
2467 @event{EVT_RADIOBUTTON(id, func)}
2468 Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wxRadioButton control.
2469 @event{EVT_SCROLLBAR(id, func)}
2470 Process a @c wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a wxScrollBar
2471 control. This is provided for compatibility only; more specific scrollbar event macros
2472 should be used instead (see wxScrollEvent).
2473 @event{EVT_SLIDER(id, func)}
2474 Process a @c wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wxSlider control.
2475 @event{EVT_TEXT(id, func)}
2476 Process a @c wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wxTextCtrl control.
2477 @event{EVT_TEXT_ENTER(id, func)}
2478 Process a @c wxEVT_COMMAND_TEXT_ENTER command, which is generated by a wxTextCtrl control.
2479 Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it
2480 to generate such events.
2481 @event{EVT_TEXT_MAXLEN(id, func)}
2482 Process a @c wxEVT_COMMAND_TEXT_MAXLEN command, which is generated by a wxTextCtrl control
2483 when the user tries to enter more characters into it than the limit previously set
2484 with SetMaxLength().
2485 @event{EVT_TOGGLEBUTTON(id, func)}
2486 Process a @c wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event.
2487 @event{EVT_TOOL(id, func)}
2488 Process a @c wxEVT_COMMAND_TOOL_CLICKED event (a synonym for @c wxEVT_COMMAND_MENU_SELECTED).
2489 Pass the id of the tool.
2490 @event{EVT_TOOL_RANGE(id1, id2, func)}
2491 Process a @c wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools.
2492 @event{EVT_TOOL_RCLICKED(id, func)}
2493 Process a @c wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool. (Not available on wxOSX.)
2494 @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}
2495 Process a @c wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. (Not available on wxOSX.)
2496 @event{EVT_TOOL_ENTER(id, func)}
2497 Process a @c wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself.
2498 The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor
2499 has moved off a tool. (Not available on wxOSX.)
2500 @event{EVT_COMMAND_LEFT_CLICK(id, func)}
2501 Process a @c wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only).
2502 @event{EVT_COMMAND_LEFT_DCLICK(id, func)}
2503 Process a @c wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (wxMSW only).
2504 @event{EVT_COMMAND_RIGHT_CLICK(id, func)}
2505 Process a @c wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (wxMSW only).
2506 @event{EVT_COMMAND_SET_FOCUS(id, func)}
2507 Process a @c wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (wxMSW only).
2508 @event{EVT_COMMAND_KILL_FOCUS(id, func)}
2509 Process a @c wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (wxMSW only).
2510 @event{EVT_COMMAND_ENTER(id, func)}
2511 Process a @c wxEVT_COMMAND_ENTER command, which is generated by a control.
2517 class wxCommandEvent
: public wxEvent
2523 wxCommandEvent(wxEventType commandEventType
= wxEVT_NULL
, int id
= 0);
2526 Returns client data pointer for a listbox or choice selection event
2527 (not valid for a deselection).
2529 void* GetClientData() const;
2532 Returns client object pointer for a listbox or choice selection event
2533 (not valid for a deselection).
2535 wxClientData
* GetClientObject() const;
2538 Returns extra information dependant on the event objects type.
2540 If the event comes from a listbox selection, it is a boolean
2541 determining whether the event was a selection (@true) or a
2542 deselection (@false). A listbox deselection only occurs for
2543 multiple-selection boxes, and in this case the index and string values
2544 are indeterminate and the listbox must be examined by the application.
2546 long GetExtraLong() const;
2549 Returns the integer identifier corresponding to a listbox, choice or
2550 radiobox selection (only if the event was a selection, not a deselection),
2551 or a boolean value representing the value of a checkbox.
2556 Returns item index for a listbox or choice selection event (not valid for
2559 int GetSelection() const;
2562 Returns item string for a listbox or choice selection event. If one
2563 or several items have been deselected, returns the index of the first
2564 deselected item. If some items have been selected and others deselected
2565 at the same time, it will return the index of the first selected item.
2567 wxString
GetString() const;
2570 This method can be used with checkbox and menu events: for the checkboxes, the
2571 method returns @true for a selection event and @false for a deselection one.
2572 For the menu events, this method indicates if the menu item just has become
2573 checked or unchecked (and thus only makes sense for checkable menu items).
2575 Notice that this method can not be used with wxCheckListBox currently.
2577 bool IsChecked() const;
2580 For a listbox or similar event, returns @true if it is a selection, @false
2581 if it is a deselection. If some items have been selected and others deselected
2582 at the same time, it will return @true.
2584 bool IsSelection() const;
2587 Sets the client data for this event.
2589 void SetClientData(void* clientData
);
2592 Sets the client object for this event. The client object is not owned by the
2593 event object and the event object will not delete the client object in its destructor.
2595 The client object must be owned and deleted by another object (e.g. a control)
2596 that has longer life time than the event object.
2598 void SetClientObject(wxClientData
* clientObject
);
2601 Sets the @b m_extraLong member.
2603 void SetExtraLong(long extraLong
);
2606 Sets the @b m_commandInt member.
2608 void SetInt(int intCommand
);
2611 Sets the @b m_commandString member.
2613 void SetString(const wxString
& string
);
2619 @class wxActivateEvent
2621 An activate event is sent when a window or application is being activated
2624 @beginEventTable{wxActivateEvent}
2625 @event{EVT_ACTIVATE(func)}
2626 Process a @c wxEVT_ACTIVATE event.
2627 @event{EVT_ACTIVATE_APP(func)}
2628 Process a @c wxEVT_ACTIVATE_APP event.
2629 This event is received by the wxApp-derived instance only.
2630 @event{EVT_HIBERNATE(func)}
2631 Process a hibernate event, supplying the member function. This event applies
2632 to wxApp only, and only on Windows SmartPhone and PocketPC.
2633 It is generated when the system is low on memory; the application should free
2634 up as much memory as possible, and restore full working state when it receives
2635 a wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP event.
2641 @see @ref overview_events, wxApp::IsActive
2643 class wxActivateEvent
: public wxEvent
2649 wxActivateEvent(wxEventType eventType
= wxEVT_NULL
, bool active
= true,
2653 Returns @true if the application or window is being activated, @false otherwise.
2655 bool GetActive() const;
2661 @class wxContextMenuEvent
2663 This class is used for context menu events, sent to give
2664 the application a chance to show a context (popup) menu for a wxWindow.
2666 Note that if wxContextMenuEvent::GetPosition returns wxDefaultPosition, this
2667 means that the event originated from a keyboard context button event, and you
2668 should compute a suitable position yourself, for example by calling wxGetMousePosition().
2670 When a keyboard context menu button is pressed on Windows, a right-click event
2671 with default position is sent first, and if this event is not processed, the
2672 context menu event is sent. So if you process mouse events and you find your
2673 context menu event handler is not being called, you could call wxEvent::Skip()
2674 for mouse right-down events.
2676 @beginEventTable{wxContextMenuEvent}
2677 @event{EVT_CONTEXT_MENU(func)}
2678 A right click (or other context menu command depending on platform) has been detected.
2685 @see wxCommandEvent, @ref overview_events
2687 class wxContextMenuEvent
: public wxCommandEvent
2693 wxContextMenuEvent(wxEventType id
= wxEVT_NULL
, int id
= 0,
2694 const wxPoint
& pos
= wxDefaultPosition
);
2697 Returns the position in screen coordinates at which the menu should be shown.
2698 Use wxWindow::ScreenToClient to convert to client coordinates.
2700 You can also omit a position from wxWindow::PopupMenu in order to use
2701 the current mouse pointer position.
2703 If the event originated from a keyboard event, the value returned from this
2704 function will be wxDefaultPosition.
2706 const wxPoint
& GetPosition() const;
2709 Sets the position at which the menu should be shown.
2711 void SetPosition(const wxPoint
& point
);
2719 An erase event is sent when a window's background needs to be repainted.
2721 On some platforms, such as GTK+, this event is simulated (simply generated just
2722 before the paint event) and may cause flicker. It is therefore recommended that
2723 you set the text background colour explicitly in order to prevent flicker.
2724 The default background colour under GTK+ is grey.
2726 To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table
2729 You must call wxEraseEvent::GetDC and use the returned device context if it is
2730 non-@NULL. If it is @NULL, create your own temporary wxClientDC object.
2733 Use the device context returned by GetDC to draw on, don't create
2734 a wxPaintDC in the event handler.
2736 @beginEventTable{wxEraseEvent}
2737 @event{EVT_ERASE_BACKGROUND(func)}
2738 Process a @c wxEVT_ERASE_BACKGROUND event.
2744 @see @ref overview_events
2746 class wxEraseEvent
: public wxEvent
2752 wxEraseEvent(int id
= 0, wxDC
* dc
= NULL
);
2755 Returns the device context associated with the erase event to draw on.
2757 wxDC
* GetDC() const;
2765 A focus event is sent when a window's focus changes. The window losing focus
2766 receives a "kill focus" event while the window gaining it gets a "set focus" one.
2768 Notice that the set focus event happens both when the user gives focus to the
2769 window (whether using the mouse or keyboard) and when it is done from the
2770 program itself using wxWindow::SetFocus.
2772 @beginEventTable{wxFocusEvent}
2773 @event{EVT_SET_FOCUS(func)}
2774 Process a @c wxEVT_SET_FOCUS event.
2775 @event{EVT_KILL_FOCUS(func)}
2776 Process a @c wxEVT_KILL_FOCUS event.
2782 @see @ref overview_events
2784 class wxFocusEvent
: public wxEvent
2790 wxFocusEvent(wxEventType eventType
= wxEVT_NULL
, int id
= 0);
2793 Returns the window associated with this event, that is the window which had the
2794 focus before for the @c wxEVT_SET_FOCUS event and the window which is
2795 going to receive focus for the @c wxEVT_KILL_FOCUS one.
2797 Warning: the window pointer may be @NULL!
2799 wxWindow
*GetWindow() const;
2805 @class wxChildFocusEvent
2807 A child focus event is sent to a (parent-)window when one of its child windows
2808 gains focus, so that the window could restore the focus back to its corresponding
2809 child if it loses it now and regains later.
2811 Notice that child window is the direct child of the window receiving event.
2812 Use wxWindow::FindFocus() to retreive the window which is actually getting focus.
2814 @beginEventTable{wxChildFocusEvent}
2815 @event{EVT_CHILD_FOCUS(func)}
2816 Process a @c wxEVT_CHILD_FOCUS event.
2822 @see @ref overview_events
2824 class wxChildFocusEvent
: public wxCommandEvent
2831 The direct child which is (or which contains the window which is) receiving
2834 wxChildFocusEvent(wxWindow
* win
= NULL
);
2837 Returns the direct child which receives the focus, or a (grand-)parent of the
2838 control receiving the focus.
2840 To get the actually focused control use wxWindow::FindFocus.
2842 wxWindow
*GetWindow() const;
2848 @class wxMouseCaptureLostEvent
2850 An mouse capture lost event is sent to a window that obtained mouse capture,
2851 which was subsequently loss due to "external" event, for example when a dialog
2852 box is shown or if another application captures the mouse.
2854 If this happens, this event is sent to all windows that are on capture stack
2855 (i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is
2856 not sent if the capture changes because of a call to CaptureMouse or
2859 This event is currently emitted under Windows only.
2861 @beginEventTable{wxMouseCaptureLostEvent}
2862 @event{EVT_MOUSE_CAPTURE_LOST(func)}
2863 Process a @c wxEVT_MOUSE_CAPTURE_LOST event.
2871 @see wxMouseCaptureChangedEvent, @ref overview_events,
2872 wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
2874 class wxMouseCaptureLostEvent
: public wxEvent
2880 wxMouseCaptureLostEvent(wxWindowID windowId
= 0);
2886 @class wxNotifyEvent
2888 This class is not used by the event handlers by itself, but is a base class
2889 for other event classes (such as wxBookCtrlEvent).
2891 It (or an object of a derived class) is sent when the controls state is being
2892 changed and allows the program to wxNotifyEvent::Veto() this change if it wants
2893 to prevent it from happening.
2898 @see wxBookCtrlEvent
2900 class wxNotifyEvent
: public wxCommandEvent
2904 Constructor (used internally by wxWidgets only).
2906 wxNotifyEvent(wxEventType eventType
= wxEVT_NULL
, int id
= 0);
2909 This is the opposite of Veto(): it explicitly allows the event to be processed.
2910 For most events it is not necessary to call this method as the events are allowed
2911 anyhow but some are forbidden by default (this will be mentioned in the corresponding
2917 Returns @true if the change is allowed (Veto() hasn't been called) or @false
2918 otherwise (if it was).
2920 bool IsAllowed() const;
2923 Prevents the change announced by this event from happening.
2925 It is in general a good idea to notify the user about the reasons for vetoing
2926 the change because otherwise the applications behaviour (which just refuses to
2927 do what the user wants) might be quite surprising.
2934 @class wxThreadEvent
2936 This class adds some simple functionalities to wxCommandEvent coinceived
2937 for inter-threads communications.
2939 This event is not natively emitted by any control/class: this is just
2940 an helper class for the user.
2941 Its most important feature is the GetEventCategory() implementation which
2942 allows thread events to @b NOT be processed by wxEventLoopBase::YieldFor calls
2943 (unless the @c wxEVT_CATEGORY_THREAD is specified - which is never in wx code).
2946 @category{events,threading}
2948 @see @ref overview_thread, wxEventLoopBase::YieldFor
2950 class wxThreadEvent
: public wxCommandEvent
2956 wxThreadEvent(wxEventType eventType
= wxEVT_COMMAND_THREAD
, int id
= wxID_ANY
);
2959 Clones this event making sure that all internal members which use
2960 COW (only @c m_commandString for now; see @ref overview_refcount)
2961 are unshared (see wxObject::UnShare).
2963 virtual wxEvent
*Clone() const;
2966 Returns @c wxEVT_CATEGORY_THREAD.
2968 This is important to avoid unwanted processing of thread events
2969 when calling wxEventLoopBase::YieldFor().
2971 virtual wxEventCategory
GetEventCategory() const;
2974 Sets custom data payload.
2976 The @a payload argument may be of any type that wxAny can handle
2977 (i.e. pretty much anything). Note that T's copy constructor must be
2978 thread-safe, i.e. create a copy that doesn't share anything with
2979 the original (see Clone()).
2981 @note This method is not available with Visual C++ 6.
2985 @see GetPayload(), wxAny
2987 template<typename T
>
2988 void SetPayload(const T
& payload
);
2991 Get custom data payload.
2993 Correct type is checked in debug builds.
2995 @note This method is not available with Visual C++ 6.
2999 @see SetPayload(), wxAny
3001 template<typename T
>
3002 T
GetPayload() const;
3009 A help event is sent when the user has requested context-sensitive help.
3010 This can either be caused by the application requesting context-sensitive help mode
3011 via wxContextHelp, or (on MS Windows) by the system generating a WM_HELP message when
3012 the user pressed F1 or clicked on the query button in a dialog caption.
3014 A help event is sent to the window that the user clicked on, and is propagated
3015 up the window hierarchy until the event is processed or there are no more event
3018 The application should call wxEvent::GetId to check the identity of the
3019 clicked-on window, and then either show some suitable help or call wxEvent::Skip()
3020 if the identifier is unrecognised.
3022 Calling Skip is important because it allows wxWidgets to generate further
3023 events for ancestors of the clicked-on window. Otherwise it would be impossible to
3024 show help for container windows, since processing would stop after the first window
3027 @beginEventTable{wxHelpEvent}
3028 @event{EVT_HELP(id, func)}
3029 Process a @c wxEVT_HELP event.
3030 @event{EVT_HELP_RANGE(id1, id2, func)}
3031 Process a @c wxEVT_HELP event for a range of ids.
3037 @see wxContextHelp, wxDialog, @ref overview_events
3039 class wxHelpEvent
: public wxCommandEvent
3043 Indicates how a wxHelpEvent was generated.
3047 Origin_Unknown
, /**< unrecognized event source. */
3048 Origin_Keyboard
, /**< event generated from F1 key press. */
3050 /** event generated by wxContextHelp or from the [?] button on
3051 the title bar (Windows). */
3058 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
3059 wxWindowID winid
= 0,
3060 const wxPoint
& pt
= wxDefaultPosition
,
3061 wxHelpEvent
::Origin origin
= Origin_Unknown
);
3064 Returns the origin of the help event which is one of the ::wxHelpEventOrigin
3067 The application may handle events generated using the keyboard or mouse
3068 differently, e.g. by using wxGetMousePosition() for the mouse events.
3072 wxHelpEvent
::Origin
GetOrigin() const;
3075 Returns the left-click position of the mouse, in screen coordinates.
3076 This allows the application to position the help appropriately.
3078 const wxPoint
& GetPosition() const;
3081 Set the help event origin, only used internally by wxWidgets normally.
3085 void SetOrigin(wxHelpEvent
::Origin origin
);
3088 Sets the left-click position of the mouse, in screen coordinates.
3090 void SetPosition(const wxPoint
& pt
);
3096 @class wxScrollEvent
3098 A scroll event holds information about events sent from stand-alone
3099 scrollbars (see wxScrollBar) and sliders (see wxSlider).
3101 Note that scrolled windows send the wxScrollWinEvent which does not derive from
3102 wxCommandEvent, but from wxEvent directly - don't confuse these two kinds of
3103 events and use the event table macros mentioned below only for the scrollbar-like
3106 @section scrollevent_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
3108 The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb
3109 using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed
3110 by an EVT_SCROLL_CHANGED event).
3112 The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb
3113 position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE
3114 event does not happen).
3116 In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving has finished
3117 independently of the way it had started. Please see the widgets sample ("Slider" page)
3118 to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
3121 Note that unless specifying a scroll control identifier, you will need to test for scrollbar
3122 orientation with wxScrollEvent::GetOrientation, since horizontal and vertical scroll events
3123 are processed using the same event handler.
3125 @beginEventTable{wxScrollEvent}
3126 You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting
3127 scroll events from controls, or EVT_SCROLL... macros without window IDs for
3128 intercepting scroll events from the receiving window -- except for this, the
3129 macros behave exactly the same.
3130 @event{EVT_SCROLL(func)}
3131 Process all scroll events.
3132 @event{EVT_SCROLL_TOP(func)}
3133 Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
3134 @event{EVT_SCROLL_BOTTOM(func)}
3135 Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
3136 @event{EVT_SCROLL_LINEUP(func)}
3137 Process wxEVT_SCROLL_LINEUP line up events.
3138 @event{EVT_SCROLL_LINEDOWN(func)}
3139 Process wxEVT_SCROLL_LINEDOWN line down events.
3140 @event{EVT_SCROLL_PAGEUP(func)}
3141 Process wxEVT_SCROLL_PAGEUP page up events.
3142 @event{EVT_SCROLL_PAGEDOWN(func)}
3143 Process wxEVT_SCROLL_PAGEDOWN page down events.
3144 @event{EVT_SCROLL_THUMBTRACK(func)}
3145 Process wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the
3146 user drags the thumbtrack).
3147 @event{EVT_SCROLL_THUMBRELEASE(func)}
3148 Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
3149 @event{EVT_SCROLL_CHANGED(func)}
3150 Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
3151 @event{EVT_COMMAND_SCROLL(id, func)}
3152 Process all scroll events.
3153 @event{EVT_COMMAND_SCROLL_TOP(id, func)}
3154 Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
3155 @event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
3156 Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
3157 @event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
3158 Process wxEVT_SCROLL_LINEUP line up events.
3159 @event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
3160 Process wxEVT_SCROLL_LINEDOWN line down events.
3161 @event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
3162 Process wxEVT_SCROLL_PAGEUP page up events.
3163 @event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
3164 Process wxEVT_SCROLL_PAGEDOWN page down events.
3165 @event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
3166 Process wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent
3167 as the user drags the thumbtrack).
3168 @event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
3169 Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
3170 @event{EVT_COMMAND_SCROLL_CHANGED(func)}
3171 Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
3177 @see wxScrollBar, wxSlider, wxSpinButton, wxScrollWinEvent, @ref overview_events
3179 class wxScrollEvent
: public wxCommandEvent
3185 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0, int pos
= 0,
3186 int orientation
= 0);
3189 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
3192 int GetOrientation() const;
3195 Returns the position of the scrollbar.
3197 int GetPosition() const;
3201 See wxIdleEvent::SetMode() for more info.
3205 /** Send idle events to all windows */
3208 /** Send idle events to windows that have the wxWS_EX_PROCESS_IDLE flag specified */
3209 wxIDLE_PROCESS_SPECIFIED
3216 This class is used for idle events, which are generated when the system becomes
3217 idle. Note that, unless you do something specifically, the idle events are not
3218 sent if the system remains idle once it has become it, e.g. only a single idle
3219 event will be generated until something else resulting in more normal events
3220 happens and only then is the next idle event sent again.
3222 If you need to ensure a continuous stream of idle events, you can either use
3223 wxIdleEvent::RequestMore method in your handler or call wxWakeUpIdle() periodically
3224 (for example from a timer event handler), but note that both of these approaches
3225 (and especially the first one) increase the system load and so should be avoided
3228 By default, idle events are sent to all windows (and also wxApp, as usual).
3229 If this is causing a significant overhead in your application, you can call
3230 wxIdleEvent::SetMode with the value wxIDLE_PROCESS_SPECIFIED, and set the
3231 wxWS_EX_PROCESS_IDLE extra window style for every window which should receive
3234 @beginEventTable{wxIdleEvent}
3235 @event{EVT_IDLE(func)}
3236 Process a @c wxEVT_IDLE event.
3242 @see @ref overview_events, wxUpdateUIEvent, wxWindow::OnInternalIdle
3244 class wxIdleEvent
: public wxEvent
3253 Returns @true if it is appropriate to send idle events to this window.
3255 This function looks at the mode used (see wxIdleEvent::SetMode),
3256 and the wxWS_EX_PROCESS_IDLE style in @a window to determine whether idle
3257 events should be sent to this window now.
3259 By default this will always return @true because the update mode is initially
3260 wxIDLE_PROCESS_ALL. You can change the mode to only send idle events to
3261 windows with the wxWS_EX_PROCESS_IDLE extra window style set.
3265 static bool CanSend(wxWindow
* window
);
3268 Static function returning a value specifying how wxWidgets will send idle
3269 events: to all windows, or only to those which specify that they
3270 will process the events.
3274 static wxIdleMode
GetMode();
3277 Returns @true if the OnIdle function processing this event requested more
3282 bool MoreRequested() const;
3285 Tells wxWidgets that more processing is required.
3287 This function can be called by an OnIdle handler for a window or window event
3288 handler to indicate that wxApp::OnIdle should forward the OnIdle event once
3289 more to the application windows.
3291 If no window calls this function during OnIdle, then the application will
3292 remain in a passive event loop (not calling OnIdle) until a new event is
3293 posted to the application by the windowing system.
3295 @see MoreRequested()
3297 void RequestMore(bool needMore
= true);
3300 Static function for specifying how wxWidgets will send idle events: to
3301 all windows, or only to those which specify that they will process the events.
3304 Can be one of the ::wxIdleMode values.
3305 The default is wxIDLE_PROCESS_ALL.
3307 static void SetMode(wxIdleMode mode
);
3313 @class wxInitDialogEvent
3315 A wxInitDialogEvent is sent as a dialog or panel is being initialised.
3316 Handlers for this event can transfer data to the window.
3318 The default handler calls wxWindow::TransferDataToWindow.
3320 @beginEventTable{wxInitDialogEvent}
3321 @event{EVT_INIT_DIALOG(func)}
3322 Process a @c wxEVT_INIT_DIALOG event.
3328 @see @ref overview_events
3330 class wxInitDialogEvent
: public wxEvent
3336 wxInitDialogEvent(int id
= 0);
3342 @class wxWindowDestroyEvent
3344 This event is sent as early as possible during the window destruction
3347 For the top level windows, as early as possible means that this is done by
3348 wxFrame or wxDialog destructor, i.e. after the destructor of the derived
3349 class was executed and so any methods specific to the derived class can't
3350 be called any more from this event handler. If you need to do this, you
3351 must call wxWindow::SendDestroyEvent() from your derived class destructor.
3353 For the child windows, this event is generated just before deleting the
3354 window from wxWindow::Destroy() (which is also called when the parent
3355 window is deleted) or from the window destructor if operator @c delete was
3356 used directly (which is not recommended for this very reason).
3358 It is usually pointless to handle this event in the window itself but it ca
3359 be very useful to receive notifications about the window destruction in the
3360 parent window or in any other object interested in this window.
3365 @see @ref overview_events, wxWindowCreateEvent
3367 class wxWindowDestroyEvent
: public wxCommandEvent
3373 wxWindowDestroyEvent(wxWindow
* win
= NULL
);
3375 /// Retutn the window being destroyed.
3376 wxWindow
*GetWindow() const;
3381 @class wxNavigationKeyEvent
3383 This event class contains information about navigation events,
3384 generated by navigation keys such as tab and page down.
3386 This event is mainly used by wxWidgets implementations.
3387 A wxNavigationKeyEvent handler is automatically provided by wxWidgets
3388 when you make a class into a control container with the macro
3389 WX_DECLARE_CONTROL_CONTAINER.
3391 @beginEventTable{wxNavigationKeyEvent}
3392 @event{EVT_NAVIGATION_KEY(func)}
3393 Process a navigation key event.
3399 @see wxWindow::Navigate, wxWindow::NavigateIn
3401 class wxNavigationKeyEvent
: public wxEvent
3405 Flags which can be used with wxNavigationKeyEvent.
3407 enum wxNavigationKeyEventFlags
3409 IsBackward
= 0x0000,
3415 wxNavigationKeyEvent();
3416 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
);
3419 Returns the child that has the focus, or @NULL.
3421 wxWindow
* GetCurrentFocus() const;
3424 Returns @true if the navigation was in the forward direction.
3426 bool GetDirection() const;
3429 Returns @true if the navigation event was from a tab key.
3430 This is required for proper navigation over radio buttons.
3432 bool IsFromTab() const;
3435 Returns @true if the navigation event represents a window change
3436 (for example, from Ctrl-Page Down in a notebook).
3438 bool IsWindowChange() const;
3441 Sets the current focus window member.
3443 void SetCurrentFocus(wxWindow
* currentFocus
);
3446 Sets the direction to forward if @a direction is @true, or backward
3449 void SetDirection(bool direction
);
3452 Sets the flags for this event.
3453 The @a flags can be a combination of the ::wxNavigationKeyEventFlags values.
3455 void SetFlags(long flags
);
3458 Marks the navigation event as from a tab key.
3460 void SetFromTab(bool fromTab
);
3463 Marks the event as a window change event.
3465 void SetWindowChange(bool windowChange
);
3471 @class wxMouseCaptureChangedEvent
3473 An mouse capture changed event is sent to a window that loses its
3474 mouse capture. This is called even if wxWindow::ReleaseMouse
3475 was called by the application code. Handling this event allows
3476 an application to cater for unexpected capture releases which
3477 might otherwise confuse mouse handling code.
3481 @beginEventTable{wxMouseCaptureChangedEvent}
3482 @event{EVT_MOUSE_CAPTURE_CHANGED(func)}
3483 Process a @c wxEVT_MOUSE_CAPTURE_CHANGED event.
3489 @see wxMouseCaptureLostEvent, @ref overview_events,
3490 wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
3492 class wxMouseCaptureChangedEvent
: public wxEvent
3498 wxMouseCaptureChangedEvent(wxWindowID windowId
= 0,
3499 wxWindow
* gainedCapture
= NULL
);
3502 Returns the window that gained the capture, or @NULL if it was a
3503 non-wxWidgets window.
3505 wxWindow
* GetCapturedWindow() const;
3513 This event class contains information about window and session close events.
3515 The handler function for EVT_CLOSE is called when the user has tried to close a
3516 a frame or dialog box using the window manager (X) or system menu (Windows).
3517 It can also be invoked by the application itself programmatically, for example by
3518 calling the wxWindow::Close function.
3520 You should check whether the application is forcing the deletion of the window
3521 using wxCloseEvent::CanVeto. If this is @false, you @e must destroy the window
3522 using wxWindow::Destroy.
3524 If the return value is @true, it is up to you whether you respond by destroying
3527 If you don't destroy the window, you should call wxCloseEvent::Veto to
3528 let the calling code know that you did not destroy the window.
3529 This allows the wxWindow::Close function to return @true or @false depending
3530 on whether the close instruction was honoured or not.
3532 Example of a wxCloseEvent handler:
3535 void MyFrame::OnClose(wxCloseEvent& event)
3537 if ( event.CanVeto() && m_bFileNotSaved )
3539 if ( wxMessageBox("The file has not been saved... continue closing?",
3541 wxICON_QUESTION | wxYES_NO) != wxYES )
3548 Destroy(); // you may also do: event.Skip();
3549 // since the default event handler does call Destroy(), too
3553 The EVT_END_SESSION event is slightly different as it is sent by the system
3554 when the user session is ending (e.g. because of log out or shutdown) and
3555 so all windows are being forcefully closed. At least under MSW, after the
3556 handler for this event is executed the program is simply killed by the
3557 system. Because of this, the default handler for this event provided by
3558 wxWidgets calls all the usual cleanup code (including wxApp::OnExit()) so
3559 that it could still be executed and exit()s the process itself, without
3560 waiting for being killed. If this behaviour is for some reason undesirable,
3561 make sure that you define a handler for this event in your wxApp-derived
3562 class and do not call @c event.Skip() in it (but be aware that the system
3563 will still kill your application).
3565 @beginEventTable{wxCloseEvent}
3566 @event{EVT_CLOSE(func)}
3567 Process a @c wxEVT_CLOSE_WINDOW command event, supplying the member function.
3568 This event applies to wxFrame and wxDialog classes.
3569 @event{EVT_QUERY_END_SESSION(func)}
3570 Process a @c wxEVT_QUERY_END_SESSION session event, supplying the member function.
3571 This event can be handled in wxApp-derived class only.
3572 @event{EVT_END_SESSION(func)}
3573 Process a @c wxEVT_END_SESSION session event, supplying the member function.
3574 This event can be handled in wxApp-derived class only.
3580 @see wxWindow::Close, @ref overview_windowdeletion
3582 class wxCloseEvent
: public wxEvent
3588 wxCloseEvent(wxEventType commandEventType
= wxEVT_NULL
, int id
= 0);
3591 Returns @true if you can veto a system shutdown or a window close event.
3592 Vetoing a window close event is not possible if the calling code wishes to
3593 force the application to exit, and so this function must be called to check this.
3595 bool CanVeto() const;
3598 Returns @true if the user is just logging off or @false if the system is
3599 shutting down. This method can only be called for end session and query end
3600 session events, it doesn't make sense for close window event.
3602 bool GetLoggingOff() const;
3605 Sets the 'can veto' flag.
3607 void SetCanVeto(bool canVeto
);
3610 Sets the 'logging off' flag.
3612 void SetLoggingOff(bool loggingOff
);
3615 Call this from your event handler to veto a system shutdown or to signal
3616 to the calling application that a window close did not happen.
3618 You can only veto a shutdown if CanVeto() returns @true.
3620 void Veto(bool veto
= true);
3628 This class is used for a variety of menu-related events. Note that
3629 these do not include menu command events, which are
3630 handled using wxCommandEvent objects.
3632 The default handler for @c wxEVT_MENU_HIGHLIGHT displays help
3633 text in the first field of the status bar.
3635 @beginEventTable{wxMenuEvent}
3636 @event{EVT_MENU_OPEN(func)}
3637 A menu is about to be opened. On Windows, this is only sent once for each
3638 navigation of the menubar (up until all menus have closed).
3639 @event{EVT_MENU_CLOSE(func)}
3640 A menu has been just closed.
3641 @event{EVT_MENU_HIGHLIGHT(id, func)}
3642 The menu item with the specified id has been highlighted: used to show
3643 help prompts in the status bar by wxFrame
3644 @event{EVT_MENU_HIGHLIGHT_ALL(func)}
3645 A menu item has been highlighted, i.e. the currently selected menu item has changed.
3651 @see wxCommandEvent, @ref overview_events
3653 class wxMenuEvent
: public wxEvent
3659 wxMenuEvent(wxEventType id
= wxEVT_NULL
, int id
= 0, wxMenu
* menu
= NULL
);
3662 Returns the menu which is being opened or closed. This method should only be
3663 used with the @c OPEN and @c CLOSE events and even for them the
3664 returned pointer may be @NULL in some ports.
3666 wxMenu
* GetMenu() const;
3669 Returns the menu identifier associated with the event.
3670 This method should be only used with the @c HIGHLIGHT events.
3672 int GetMenuId() const;
3675 Returns @true if the menu which is being opened or closed is a popup menu,
3676 @false if it is a normal one.
3678 This method should only be used with the @c OPEN and @c CLOSE events.
3680 bool IsPopup() const;
3686 An event being sent when the window is shown or hidden.
3687 The event is triggered by calls to wxWindow::Show(), and any user
3688 action showing a previously hidden window or vice versa (if allowed by
3689 the current platform and/or window manager).
3690 Notice that the event is not triggered when the application is iconized
3691 (minimized) or restored under wxMSW.
3693 Currently only wxMSW, wxGTK and wxOS2 generate such events.
3695 @onlyfor{wxmsw,wxgtk,wxos2}
3697 @beginEventTable{wxShowEvent}
3698 @event{EVT_SHOW(func)}
3699 Process a @c wxEVT_SHOW event.
3705 @see @ref overview_events, wxWindow::Show,
3709 class wxShowEvent
: public wxEvent
3715 wxShowEvent(int winid
= 0, bool show
= false);
3718 Set whether the windows was shown or hidden.
3720 void SetShow(bool show
);
3723 Return @true if the window has been shown, @false if it has been
3726 bool IsShown() const;
3729 @deprecated This function is deprecated in favour of IsShown().
3731 bool GetShow() const;
3737 @class wxIconizeEvent
3739 An event being sent when the frame is iconized (minimized) or restored.
3741 Currently only wxMSW and wxGTK generate such events.
3743 @onlyfor{wxmsw,wxgtk}
3745 @beginEventTable{wxIconizeEvent}
3746 @event{EVT_ICONIZE(func)}
3747 Process a @c wxEVT_ICONIZE event.
3753 @see @ref overview_events, wxTopLevelWindow::Iconize,
3754 wxTopLevelWindow::IsIconized
3756 class wxIconizeEvent
: public wxEvent
3762 wxIconizeEvent(int id
= 0, bool iconized
= true);
3765 Returns @true if the frame has been iconized, @false if it has been
3768 bool IsIconized() const;
3771 @deprecated This function is deprecated in favour of IsIconized().
3773 bool Iconized() const;
3781 A move event holds information about wxTopLevelWindow move change events.
3783 @beginEventTable{wxMoveEvent}
3784 @event{EVT_MOVE(func)}
3785 Process a @c wxEVT_MOVE event, which is generated when a window is moved.
3786 @event{EVT_MOVE_START(func)}
3787 Process a @c wxEVT_MOVE_START event, which is generated when the user starts
3788 to move or size a window. wxMSW only.
3789 @event{EVT_MOVE_END(func)}
3790 Process a @c wxEVT_MOVE_END event, which is generated when the user stops
3791 moving or sizing a window. wxMSW only.
3797 @see wxPoint, @ref overview_events
3799 class wxMoveEvent
: public wxEvent
3805 wxMoveEvent(const wxPoint
& pt
, int id
= 0);
3808 Returns the position of the window generating the move change event.
3810 wxPoint
GetPosition() const;
3817 A size event holds information about size change events of wxWindow.
3819 The EVT_SIZE handler function will be called when the window has been resized.
3821 You may wish to use this for frames to resize their child windows as appropriate.
3823 Note that the size passed is of the whole window: call wxWindow::GetClientSize()
3824 for the area which may be used by the application.
3826 When a window is resized, usually only a small part of the window is damaged
3827 and you may only need to repaint that area. However, if your drawing depends on the
3828 size of the window, you may need to clear the DC explicitly and repaint the whole window.
3829 In which case, you may need to call wxWindow::Refresh to invalidate the entire window.
3831 @beginEventTable{wxSizeEvent}
3832 @event{EVT_SIZE(func)}
3833 Process a @c wxEVT_SIZE event.
3839 @see wxSize, @ref overview_events
3841 class wxSizeEvent
: public wxEvent
3847 wxSizeEvent(const wxSize
& sz
, int id
= 0);
3850 Returns the entire size of the window generating the size change event.
3852 This is the new total size of the window, i.e. the same size as would
3853 be returned by wxWindow::GetSize() if it were called now. Use
3854 wxWindow::GetClientSize() if you catch this event in a top level window
3855 such as wxFrame to find the size available for the window contents.
3857 wxSize
GetSize() const;
3863 @class wxSetCursorEvent
3865 A wxSetCursorEvent is generated from wxWindow when the mouse cursor is about
3866 to be set as a result of mouse motion.
3868 This event gives the application the chance to perform specific mouse cursor
3869 processing based on the current position of the mouse within the window.
3870 Use wxSetCursorEvent::SetCursor to specify the cursor you want to be displayed.
3872 @beginEventTable{wxSetCursorEvent}
3873 @event{EVT_SET_CURSOR(func)}
3874 Process a @c wxEVT_SET_CURSOR event.
3880 @see ::wxSetCursor, wxWindow::wxSetCursor
3882 class wxSetCursorEvent
: public wxEvent
3886 Constructor, used by the library itself internally to initialize the event
3889 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0);
3892 Returns a reference to the cursor specified by this event.
3894 const wxCursor
& GetCursor() const;
3897 Returns the X coordinate of the mouse in client coordinates.
3899 wxCoord
GetX() const;
3902 Returns the Y coordinate of the mouse in client coordinates.
3904 wxCoord
GetY() const;
3907 Returns @true if the cursor specified by this event is a valid cursor.
3909 @remarks You cannot specify wxNullCursor with this event, as it is not
3910 considered a valid cursor.
3912 bool HasCursor() const;
3915 Sets the cursor associated with this event.
3917 void SetCursor(const wxCursor
& cursor
);
3922 // ============================================================================
3923 // Global functions/macros
3924 // ============================================================================
3926 /** @addtogroup group_funcmacro_events */
3930 A value uniquely identifying the type of the event.
3932 The values of this type should only be created using wxNewEventType().
3934 See the macro DEFINE_EVENT_TYPE() for more info.
3936 @see @ref overview_events_introduction
3938 typedef int wxEventType
;
3941 A special event type usually used to indicate that some wxEvent has yet
3944 wxEventType wxEVT_NULL
;
3947 Generates a new unique event type.
3949 Usually this function is only used by wxDEFINE_EVENT() and not called
3952 wxEventType
wxNewEventType();
3955 Define a new event type associated with the specified event class.
3957 This macro defines a new unique event type @a name associated with the
3962 wxDEFINE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
3964 class MyCustomEvent : public wxEvent { ... };
3965 wxDEFINE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
3968 @see wxDECLARE_EVENT(), @ref overview_events_custom
3970 #define wxDEFINE_EVENT(name, cls) \
3971 const wxEventTypeTag< cls > name(wxNewEventType())
3974 Declares a custom event type.
3976 This macro declares a variable called @a name which must be defined
3977 elsewhere using wxDEFINE_EVENT().
3979 The class @a cls must be the wxEvent-derived class associated with the
3980 events of this type and its full declaration must be visible from the point
3981 of use of this macro.
3985 wxDECLARE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
3987 class MyCustomEvent : public wxEvent { ... };
3988 wxDECLARE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
3991 #define wxDECLARE_EVENT(name, cls) \
3992 wxDECLARE_EXPORTED_EVENT(wxEMPTY_PARAMETER_VALUE, name, cls)
3995 Variant of wxDECLARE_EVENT() used for event types defined inside a shared
3998 This is mostly used by wxWidgets internally, e.g.
4000 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent)
4003 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, cls ) \
4004 extern const expdecl wxEventTypeTag< cls > name;
4007 Helper macro for definition of custom event table macros.
4009 This macro must only be used if wxEVENTS_COMPATIBILITY_2_8 is 1, otherwise
4010 it is better and more clear to just use the address of the function
4011 directly as this is all this macro does in this case. However it needs to
4012 explicitly cast @a func to @a functype, which is the type of wxEvtHandler
4013 member function taking the custom event argument when
4014 wxEVENTS_COMPATIBILITY_2_8 is 0.
4016 See wx__DECLARE_EVT0 for an example of use.
4018 @see @ref overview_events_custom_ownclass
4020 #define wxEVENT_HANDLER_CAST(functype, func) (&func)
4023 This macro is used to define event table macros for handling custom
4028 class MyEvent : public wxEvent { ... };
4030 // note that this is not necessary unless using old compilers: for the
4031 // reasonably new ones just use &func instead of MyEventHandler(func)
4032 typedef void (wxEvtHandler::*MyEventFunction)(MyEvent&);
4033 #define MyEventHandler(func) wxEVENT_HANDLER_CAST(MyEventFunction, func)
4035 wxDEFINE_EVENT(MY_EVENT_TYPE, MyEvent);
4037 #define EVT_MY(id, func) \
4038 wx__DECLARE_EVT1(MY_EVENT_TYPE, id, MyEventHandler(func))
4042 wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)
4043 EVT_MY(wxID_ANY, MyFrame::OnMyEvent)
4048 The event type to handle.
4050 The identifier of events to handle.
4052 The event handler method.
4054 #define wx__DECLARE_EVT1(evt, id, fn) \
4055 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
4058 Generalized version of the wx__DECLARE_EVT1() macro taking a range of
4059 IDs instead of a single one.
4060 Argument @a id1 is the first identifier of the range, @a id2 is the
4061 second identifier of the range.
4063 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
4064 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
4067 Simplified version of the wx__DECLARE_EVT1() macro, to be used when the
4068 event type must be handled regardless of the ID associated with the
4069 specific event instances.
4071 #define wx__DECLARE_EVT0(evt, fn) \
4072 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
4075 Use this macro inside a class declaration to declare a @e static event table
4078 In the implementation file you'll need to use the wxBEGIN_EVENT_TABLE()
4079 and the wxEND_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro
4082 Note that this macro requires a final semicolon.
4084 @see @ref overview_events_eventtables
4086 #define wxDECLARE_EVENT_TABLE()
4089 Use this macro in a source file to start listing @e static event handlers
4090 for a specific class.
4092 Use wxEND_EVENT_TABLE() to terminate the event-declaration block.
4094 @see @ref overview_events_eventtables
4096 #define wxBEGIN_EVENT_TABLE(theClass, baseClass)
4099 Use this macro in a source file to end listing @e static event handlers
4100 for a specific class.
4102 Use wxBEGIN_EVENT_TABLE() to start the event-declaration block.
4104 @see @ref overview_events_eventtables
4106 #define wxEND_EVENT_TABLE()
4109 In a GUI application, this function posts @a event to the specified @e dest
4110 object using wxEvtHandler::AddPendingEvent().
4112 Otherwise, it dispatches @a event immediately using
4113 wxEvtHandler::ProcessEvent(). See the respective documentation for details
4114 (and caveats). Because of limitation of wxEvtHandler::AddPendingEvent()
4115 this function is not thread-safe for event objects having wxString fields,
4116 use wxQueueEvent() instead.
4120 void wxPostEvent(wxEvtHandler
* dest
, const wxEvent
& event
);
4123 Queue an event for processing on the given object.
4125 This is a wrapper around wxEvtHandler::QueueEvent(), see its documentation
4131 The object to queue the event on, can't be @c NULL.
4133 The heap-allocated and non-@c NULL event to queue, the function takes
4136 void wxQueueEvent(wxEvtHandler
* dest
, wxEvent
*event
);