1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxEvtHandler, wxEventBlocker and many
4 // wxEvent-derived classes
5 // Author: wxWidgets team
7 // Licence: wxWindows license
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 (3)-(5) are performed in ProcessEventHere() which is
493 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 event handler.
508 This method is called from ProcessEvent(), please see the detailed
509 description of the event processing logic there.
511 It is @em not virtual and so may not be overridden.
516 @true if this object itself defines a handler for this event and
517 the handler didn't skip the event.
519 bool ProcessEventHere(wxEvent
& event
);
522 Processes an event by calling ProcessEvent() and handles any exceptions
523 that occur in the process.
524 If an exception is thrown in event handler, wxApp::OnExceptionInMainLoop is called.
529 @return @true if the event was processed, @false if no handler was found
530 or an exception was thrown.
532 @see wxWindow::HandleWindowEvent
534 bool SafelyProcessEvent(wxEvent
& event
);
537 Processes the pending events previously queued using QueueEvent() or
538 AddPendingEvent(); you must call this function only if you are sure
539 there are pending events for this handler, otherwise a @c wxCHECK
542 The real processing still happens in ProcessEvent() which is called by this
545 Note that this function needs a valid application object (see
546 wxAppConsole::GetInstance()) because wxApp holds the list of the event
547 handlers with pending events and this function manipulates that list.
549 void ProcessPendingEvents();
552 Deletes all events queued on this event handler using QueueEvent() or
555 Use with care because the events which are deleted are (obviously) not
556 processed and this may have unwanted consequences (e.g. user actions events
559 void DeletePendingEvents();
562 Searches the event table, executing an event handler function if an appropriate
566 Event table to be searched.
568 Event to be matched against an event table entry.
570 @return @true if a suitable event handler function was found and
571 executed, and the function did not call wxEvent::Skip.
573 @remarks This function looks through the object's event table and tries
574 to find an entry that will match the event.
575 An entry will match if:
576 @li The event type matches, and
577 @li the identifier or identifier range matches, or the event table
578 entry's identifier is zero.
580 If a suitable function is called but calls wxEvent::Skip, this
581 function will fail, and searching will continue.
583 @todo this function in the header is listed as an "implementation only" function;
584 are we sure we want to document it?
588 virtual bool SearchEventTable(wxEventTable
& table
,
595 @name Connecting and disconnecting
600 Connects the given function dynamically with the event handler, id and
603 Notice that Bind() provides a more flexible and safer way to do the
604 same thing as Connect(), please use it in any new code -- while
605 Connect() is not formally deprecated due to its existing widespread
606 usage, it has no advantages compared to Bind().
608 This is an alternative to the use of static event tables. It is more
609 flexible as it allows to connect events generated by some object to an
610 event handler defined in a different object of a different class (which
611 is impossible to do directly with the event tables -- the events can be
612 only handled in another object if they are propagated upwards to it).
613 Do make sure to specify the correct @a eventSink when connecting to an
614 event of a different object.
616 See @ref overview_events_bind for more detailed explanation
617 of this function and the @ref page_samples_event sample for usage
620 This specific overload allows you to connect an event handler to a @e range
622 Do not confuse @e source IDs with event @e types: source IDs identify the
623 event generator objects (typically wxMenuItem or wxWindow objects) while the
624 event @e type identify which type of events should be handled by the
625 given @e function (an event generator object may generate many different
629 The first ID of the identifier range to be associated with the event
632 The last ID of the identifier range to be associated with the event
635 The event type to be associated with this event handler.
637 The event handler function. Note that this function should
638 be explicitly converted to the correct type which can be done using a macro
639 called @c wxFooEventHandler for the handler for any @c wxFooEvent.
641 Data to be associated with the event table entry.
643 Object whose member function should be called. It must be specified
644 when connecting an event generated by one object to a member
645 function of a different object. If it is omitted, @c this is used.
648 In wxPerl this function takes 4 arguments: @a id, @a lastid,
649 @a type, @a method; if @a method is undef, the handler is
655 void Connect(int id
, int lastId
, wxEventType eventType
,
656 wxObjectEventFunction function
,
657 wxObject
* userData
= NULL
,
658 wxEvtHandler
* eventSink
= NULL
);
661 See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
662 overload for more info.
664 This overload can be used to attach an event handler to a single source ID:
668 frame->Connect( wxID_EXIT,
669 wxEVT_COMMAND_MENU_SELECTED,
670 wxCommandEventHandler(MyFrame::OnQuit) );
674 Not supported by wxPerl.
677 void Connect(int id
, wxEventType eventType
,
678 wxObjectEventFunction function
,
679 wxObject
* userData
= NULL
,
680 wxEvtHandler
* eventSink
= NULL
);
683 See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
684 overload for more info.
686 This overload will connect the given event handler so that regardless of the
687 ID of the event source, the handler will be called.
690 Not supported by wxPerl.
693 void Connect(wxEventType eventType
,
694 wxObjectEventFunction function
,
695 wxObject
* userData
= NULL
,
696 wxEvtHandler
* eventSink
= NULL
);
699 Disconnects the given function dynamically from the event handler, using the
700 specified parameters as search criteria and returning @true if a matching
701 function has been found and removed.
703 This method can only disconnect functions which have been added using the
704 Connect() method. There is no way to disconnect functions connected using
705 the (static) event tables.
708 The event type associated with this event handler.
710 The event handler function.
712 Data associated with the event table entry.
714 Object whose member function should be called.
717 Not supported by wxPerl.
720 bool Disconnect(wxEventType eventType
,
721 wxObjectEventFunction function
,
722 wxObject
* userData
= NULL
,
723 wxEvtHandler
* eventSink
= NULL
);
726 See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
727 overload for more info.
729 This overload takes the additional @a id parameter.
732 Not supported by wxPerl.
735 bool Disconnect(int id
= wxID_ANY
,
736 wxEventType eventType
= wxEVT_NULL
,
737 wxObjectEventFunction function
= NULL
,
738 wxObject
* userData
= NULL
,
739 wxEvtHandler
* eventSink
= NULL
);
742 See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
743 overload for more info.
745 This overload takes an additional range of source IDs.
748 In wxPerl this function takes 3 arguments: @a id,
752 bool Disconnect(int id
, int lastId
,
753 wxEventType eventType
,
754 wxObjectEventFunction function
= NULL
,
755 wxObject
* userData
= NULL
,
756 wxEvtHandler
* eventSink
= NULL
);
761 @name Binding and Unbinding
766 Binds the given function, functor or method dynamically with the event.
768 This offers basically the same functionality as Connect(), but it is
769 more flexible as it also allows you to use ordinary functions and
770 arbitrary functors as event handlers. It is also less restrictive then
771 Connect() because you can use an arbitrary method as an event handler,
772 where as Connect() requires a wxEvtHandler derived handler.
774 See @ref overview_events_bind for more detailed explanation
775 of this function and the @ref page_samples_event sample for usage
779 The event type to be associated with this event handler.
781 The event handler functor. This can be an ordinary function but also
782 an arbitrary functor like boost::function<>.
784 The first ID of the identifier range to be associated with the event
787 The last ID of the identifier range to be associated with the event
790 Data to be associated with the event table entry.
792 @see @ref overview_cpp_rtti_disabled
796 template <typename EventTag
, typename Functor
>
797 void Bind(const EventTag
& eventType
,
800 int lastId
= wxID_ANY
,
801 wxObject
*userData
= NULL
);
804 See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for
807 This overload will bind the given method as the event handler.
810 The event type to be associated with this event handler.
812 The event handler method. This can be an arbitrary method (doesn't need
813 to be from a wxEvtHandler derived class).
815 Object whose method should be called. It must always be specified
816 so it can be checked at compile time whether the given method is an
817 actual member of the given handler.
819 The first ID of the identifier range to be associated with the event
822 The last ID of the identifier range to be associated with the event
825 Data to be associated with the event table entry.
827 @see @ref overview_cpp_rtti_disabled
831 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
832 void Bind(const EventTag
&eventType
,
833 void (Class::*method
)(EventArg
&),
834 EventHandler
*handler
,
836 int lastId
= wxID_ANY
,
837 wxObject
*userData
= NULL
);
839 Unbinds the given function, functor or method dynamically from the
840 event handler, using the specified parameters as search criteria and
841 returning @true if a matching function has been found and removed.
843 This method can only unbind functions, functors or methods which have
844 been added using the Bind<>() method. There is no way to unbind
845 functions bound using the (static) event tables.
848 The event type associated with this event handler.
850 The event handler functor. This can be an ordinary function but also
851 an arbitrary functor like boost::function<>.
853 The first ID of the identifier range associated with the event
856 The last ID of the identifier range associated with the event
859 Data associated with the event table entry.
861 @see @ref overview_cpp_rtti_disabled
865 template <typename EventTag
, typename Functor
>
866 bool Unbind(const EventTag
& eventType
,
869 int lastId
= wxID_ANY
,
870 wxObject
*userData
= NULL
);
873 See the Unbind<>(const EventTag&, Functor, int, int, wxObject*)
874 overload for more info.
876 This overload unbinds the given method from the event..
879 The event type associated with this event handler.
881 The event handler method associated with this event.
883 Object whose method was called.
885 The first ID of the identifier range associated with the event
888 The last ID of the identifier range associated with the event
891 Data associated with the event table entry.
893 @see @ref overview_cpp_rtti_disabled
897 template <typename EventTag
, typename Class
, typename EventArg
, typename EventHandler
>
898 bool Unbind(const EventTag
&eventType
,
899 void (Class::*method
)(EventArg
&),
900 EventHandler
*handler
,
902 int lastId
= wxID_ANY
,
903 wxObject
*userData
= NULL
);
906 @name User-supplied data
911 Returns user-supplied client data.
913 @remarks Normally, any extra data the programmer wishes to associate with
914 the object should be made available by deriving a new class with
919 void* GetClientData() const;
922 Returns a pointer to the user-supplied client data object.
924 @see SetClientObject(), wxClientData
926 wxClientData
* GetClientObject() const;
929 Sets user-supplied client data.
932 Data to be associated with the event handler.
934 @remarks Normally, any extra data the programmer wishes to associate
935 with the object should be made available by deriving a new
936 class with new data members. You must not call this method
937 and SetClientObject on the same class - only one of them.
941 void SetClientData(void* data
);
944 Set the client data object. Any previous object will be deleted.
946 @see GetClientObject(), wxClientData
948 void SetClientObject(wxClientData
* data
);
954 @name Event handler chaining
956 wxEvtHandler can be arranged in a double-linked list of handlers
957 which is automatically iterated by ProcessEvent() if needed.
962 Returns @true if the event handler is enabled, @false otherwise.
964 @see SetEvtHandlerEnabled()
966 bool GetEvtHandlerEnabled() const;
969 Returns the pointer to the next handler in the chain.
971 @see SetNextHandler(), GetPreviousHandler(), SetPreviousHandler(),
972 wxWindow::PushEventHandler, wxWindow::PopEventHandler
974 wxEvtHandler
* GetNextHandler() const;
977 Returns the pointer to the previous handler in the chain.
979 @see SetPreviousHandler(), GetNextHandler(), SetNextHandler(),
980 wxWindow::PushEventHandler, wxWindow::PopEventHandler
982 wxEvtHandler
* GetPreviousHandler() const;
985 Enables or disables the event handler.
988 @true if the event handler is to be enabled, @false if it is to be disabled.
990 @remarks You can use this function to avoid having to remove the event
991 handler from the chain, for example when implementing a
992 dialog editor and changing from edit to test mode.
994 @see GetEvtHandlerEnabled()
996 void SetEvtHandlerEnabled(bool enabled
);
999 Sets the pointer to the next handler.
1002 See ProcessEvent() for more info about how the chains of event handlers
1003 are internally used.
1004 Also remember that wxEvtHandler uses double-linked lists and thus if you
1005 use this function, you should also call SetPreviousHandler() on the
1006 argument passed to this function:
1008 handlerA->SetNextHandler(handlerB);
1009 handlerB->SetPreviousHandler(handlerA);
1013 The event handler to be set as the next handler.
1016 @see @ref overview_events_processing
1018 virtual void SetNextHandler(wxEvtHandler
* handler
);
1021 Sets the pointer to the previous handler.
1022 All remarks about SetNextHandler() apply to this function as well.
1025 The event handler to be set as the previous handler.
1028 @see @ref overview_events_processing
1030 virtual void SetPreviousHandler(wxEvtHandler
* handler
);
1033 Unlinks this event handler from the chain it's part of (if any);
1034 then links the "previous" event handler to the "next" one
1035 (so that the chain won't be interrupted).
1037 E.g. if before calling Unlink() you have the following chain:
1038 @image html evthandler_unlink_before.png
1039 then after calling @c B->Unlink() you'll have:
1040 @image html evthandler_unlink_after.png
1047 Returns @true if the next and the previous handler pointers of this
1048 event handler instance are @NULL.
1052 @see SetPreviousHandler(), SetNextHandler()
1054 bool IsUnlinked() const;
1060 Method called by ProcessEvent() before examining this object event
1063 This method can be overridden to hook into the event processing logic
1064 as early as possible. You should usually call the base class version
1065 when overriding this method, even if wxEvtHandler itself does nothing
1066 here, some derived classes do use this method, e.g. wxWindow implements
1067 support for wxValidator in it.
1071 class MyClass : public BaseClass // inheriting from wxEvtHandler
1075 virtual bool TryBefore(wxEvent& event)
1077 if ( MyPreProcess(event) )
1080 return BaseClass::TryBefore(event);
1085 @see ProcessEvent(), ProcessEventHere()
1087 virtual bool TryBefore(wxEvent
& event
);
1090 Method called by ProcessEvent() as last resort.
1092 This method can be overridden to implement post-processing for the
1093 events which were not processed anywhere else.
1095 The base class version handles forwarding the unprocessed events to
1096 wxApp at wxEvtHandler level and propagating them upwards the window
1097 child-parent chain at wxWindow level and so should usually be called
1098 when overriding this method:
1100 class MyClass : public BaseClass // inheriting from wxEvtHandler
1104 virtual bool TryAfter(wxEvent& event)
1106 if ( BaseClass::TryAfter(event) )
1109 return MyPostProcess(event);
1114 @see ProcessEvent(), ProcessEventHere()
1116 virtual bool TryAfter(wxEvent
& event
);
1121 Flags for categories of keys.
1123 These values are used by wxKeyEvent::IsKeyInCategory(). They may be
1124 combined via the bitwise operators |, &, and ~.
1128 enum wxKeyCategoryFlags
1130 /// arrow keys, on and off numeric keypads
1133 /// page up and page down keys, on and off numeric keypads
1134 WXK_CATEGORY_PAGING
,
1136 /// home and end keys, on and off numeric keypads
1139 /// tab key, on and off numeric keypads
1142 /// backspace and delete keys, on and off numeric keypads
1145 /// union of WXK_CATEGORY_ARROW, WXK_CATEGORY_PAGING, and WXK_CATEGORY_JUMP categories
1146 WXK_CATEGORY_NAVIGATION
1153 This event class contains information about keypress (character) events.
1155 Notice that there are three different kinds of keyboard events in wxWidgets:
1156 key down and up events and char events. The difference between the first two
1157 is clear - the first corresponds to a key press and the second to a key
1158 release - otherwise they are identical. Just note that if the key is
1159 maintained in a pressed state you will typically get a lot of (automatically
1160 generated) down events but only one up so it is wrong to assume that there is
1161 one up event corresponding to each down one.
1163 Both key events provide untranslated key codes while the char event carries
1164 the translated one. The untranslated code for alphanumeric keys is always
1165 an upper case value. For the other keys it is one of @c WXK_XXX values
1166 from the ::wxKeyCode enumeration.
1167 The translated key is, in general, the character the user expects to appear
1168 as the result of the key combination when typing the text into a text entry
1171 A few examples to clarify this (all assume that CAPS LOCK is unpressed
1172 and the standard US keyboard): when the @c 'A' key is pressed, the key down
1173 event key code is equal to @c ASCII A == 65. But the char event key code
1174 is @c ASCII a == 97. On the other hand, if you press both SHIFT and
1175 @c 'A' keys simultaneously , the key code in key down event will still be
1176 just @c 'A' while the char event key code parameter will now be @c 'A'
1179 Although in this simple case it is clear that the correct key code could be
1180 found in the key down event handler by checking the value returned by
1181 wxKeyEvent::ShiftDown(), in general you should use @c EVT_CHAR for this as
1182 for non-alphanumeric keys the translation is keyboard-layout dependent and
1183 can only be done properly by the system itself.
1185 Another kind of translation is done when the control key is pressed: for
1186 example, for CTRL-A key press the key down event still carries the
1187 same key code @c 'a' as usual but the char event will have key code of 1,
1188 the ASCII value of this key combination.
1190 You may discover how the other keys on your system behave interactively by
1191 running the @ref page_samples_text wxWidgets sample and pressing some keys
1192 in any of the text controls shown in it.
1194 @b Tip: be sure to call @c event.Skip() for events that you don't process in
1195 key event function, otherwise menu shortcuts may cease to work under Windows.
1197 @note If a key down (@c EVT_KEY_DOWN) event is caught and the event handler
1198 does not call @c event.Skip() then the corresponding char event
1199 (@c EVT_CHAR) will not happen.
1200 This is by design and enables the programs that handle both types of
1201 events to be a bit simpler.
1203 @note For Windows programmers: The key and char events in wxWidgets are
1204 similar to but slightly different from Windows @c WM_KEYDOWN and
1205 @c WM_CHAR events. In particular, Alt-x combination will generate a
1206 char event in wxWidgets (unless it is used as an accelerator).
1209 @beginEventTable{wxKeyEvent}
1210 @event{EVT_KEY_DOWN(func)}
1211 Process a @c wxEVT_KEY_DOWN event (any key has been pressed).
1212 @event{EVT_KEY_UP(func)}
1213 Process a @c wxEVT_KEY_UP event (any key has been released).
1214 @event{EVT_CHAR(func)}
1215 Process a @c wxEVT_CHAR event.
1218 @see wxKeyboardState
1223 class wxKeyEvent
: public wxEvent
,
1224 public wxKeyboardState
1229 Currently, the only valid event types are @c wxEVT_CHAR and @c wxEVT_CHAR_HOOK.
1231 wxKeyEvent(wxEventType keyEventType
= wxEVT_NULL
);
1234 Returns the virtual key code. ASCII events return normal ASCII values,
1235 while non-ASCII events return values such as @b WXK_LEFT for the left cursor
1236 key. See ::wxKeyCode for a full list of the virtual key codes.
1238 Note that in Unicode build, the returned value is meaningful only if the
1239 user entered a character that can be represented in current locale's default
1240 charset. You can obtain the corresponding Unicode character using GetUnicodeKey().
1242 int GetKeyCode() const;
1245 Returns true if the key is in the given key category.
1248 A bitwise combination of named ::wxKeyCategoryFlags constants.
1252 bool IsKeyInCategory(int category
) const;
1256 Obtains the position (in client coordinates) at which the key was pressed.
1258 wxPoint
GetPosition() const;
1259 void GetPosition(long* x
, long* y
) const;
1263 Returns the raw key code for this event. This is a platform-dependent scan code
1264 which should only be used in advanced applications.
1266 @note Currently the raw key codes are not supported by all ports, use
1267 @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
1269 wxUint32
GetRawKeyCode() const;
1272 Returns the low level key flags for this event. The flags are
1273 platform-dependent and should only be used in advanced applications.
1275 @note Currently the raw key flags are not supported by all ports, use
1276 @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
1278 wxUint32
GetRawKeyFlags() const;
1281 Returns the Unicode character corresponding to this key event.
1283 This function is only available in Unicode build, i.e. when
1284 @c wxUSE_UNICODE is 1.
1286 wxChar
GetUnicodeKey() const;
1289 Returns the X position (in client coordinates) of the event.
1291 wxCoord
GetX() const;
1294 Returns the Y position (in client coordinates) of the event.
1296 wxCoord
GetY() const;
1302 @class wxJoystickEvent
1304 This event class contains information about joystick events, particularly
1305 events received by windows.
1307 @beginEventTable{wxJoystickEvent}
1308 @event{EVT_JOY_BUTTON_DOWN(func)}
1309 Process a @c wxEVT_JOY_BUTTON_DOWN event.
1310 @event{EVT_JOY_BUTTON_UP(func)}
1311 Process a @c wxEVT_JOY_BUTTON_UP event.
1312 @event{EVT_JOY_MOVE(func)}
1313 Process a @c wxEVT_JOY_MOVE event.
1314 @event{EVT_JOY_ZMOVE(func)}
1315 Process a @c wxEVT_JOY_ZMOVE event.
1316 @event{EVT_JOYSTICK_EVENTS(func)}
1317 Processes all joystick events.
1325 class wxJoystickEvent
: public wxEvent
1331 wxJoystickEvent(wxEventType eventType
= wxEVT_NULL
, int state
= 0,
1332 int joystick
= wxJOYSTICK1
,
1336 Returns @true if the event was a down event from the specified button
1340 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1341 indicate any button down event.
1343 bool ButtonDown(int button
= wxJOY_BUTTON_ANY
) const;
1346 Returns @true if the specified button (or any button) was in a down state.
1349 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1350 indicate any button down event.
1352 bool ButtonIsDown(int button
= wxJOY_BUTTON_ANY
) const;
1355 Returns @true if the event was an up event from the specified button
1359 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1360 indicate any button down event.
1362 bool ButtonUp(int button
= wxJOY_BUTTON_ANY
) const;
1365 Returns the identifier of the button changing state.
1367 This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
1369 int GetButtonChange() const;
1372 Returns the down state of the buttons.
1374 This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
1376 int GetButtonState() const;
1379 Returns the identifier of the joystick generating the event - one of
1380 wxJOYSTICK1 and wxJOYSTICK2.
1382 int GetJoystick() const;
1385 Returns the x, y position of the joystick event.
1387 wxPoint
GetPosition() const;
1390 Returns the z position of the joystick event.
1392 int GetZPosition() const;
1395 Returns @true if this was a button up or down event
1396 (@e not 'is any button down?').
1398 bool IsButton() const;
1401 Returns @true if this was an x, y move event.
1403 bool IsMove() const;
1406 Returns @true if this was a z move event.
1408 bool IsZMove() const;
1414 @class wxScrollWinEvent
1416 A scroll event holds information about events sent from scrolling windows.
1418 Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events
1419 from the receiving window.
1421 @beginEventTable{wxScrollWinEvent}
1422 @event{EVT_SCROLLWIN(func)}
1423 Process all scroll events.
1424 @event{EVT_SCROLLWIN_TOP(func)}
1425 Process wxEVT_SCROLLWIN_TOP scroll-to-top events.
1426 @event{EVT_SCROLLWIN_BOTTOM(func)}
1427 Process wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
1428 @event{EVT_SCROLLWIN_LINEUP(func)}
1429 Process wxEVT_SCROLLWIN_LINEUP line up events.
1430 @event{EVT_SCROLLWIN_LINEDOWN(func)}
1431 Process wxEVT_SCROLLWIN_LINEDOWN line down events.
1432 @event{EVT_SCROLLWIN_PAGEUP(func)}
1433 Process wxEVT_SCROLLWIN_PAGEUP page up events.
1434 @event{EVT_SCROLLWIN_PAGEDOWN(func)}
1435 Process wxEVT_SCROLLWIN_PAGEDOWN page down events.
1436 @event{EVT_SCROLLWIN_THUMBTRACK(func)}
1437 Process wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
1438 (frequent events sent as the user drags the thumbtrack).
1439 @event{EVT_SCROLLWIN_THUMBRELEASE(func)}
1440 Process wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
1447 @see wxScrollEvent, @ref overview_events
1449 class wxScrollWinEvent
: public wxEvent
1455 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
, int pos
= 0,
1456 int orientation
= 0);
1459 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
1462 @todo wxHORIZONTAL and wxVERTICAL should go in their own enum
1464 int GetOrientation() const;
1467 Returns the position of the scrollbar for the thumb track and release events.
1469 Note that this field can't be used for the other events, you need to query
1470 the window itself for the current position in that case.
1472 int GetPosition() const;
1478 @class wxSysColourChangedEvent
1480 This class is used for system colour change events, which are generated
1481 when the user changes the colour settings using the control panel.
1482 This is only appropriate under Windows.
1485 The default event handler for this event propagates the event to child windows,
1486 since Windows only sends the events to top-level windows.
1487 If intercepting this event for a top-level window, remember to call the base
1488 class handler, or to pass the event on to the window's children explicitly.
1490 @beginEventTable{wxSysColourChangedEvent}
1491 @event{EVT_SYS_COLOUR_CHANGED(func)}
1492 Process a @c wxEVT_SYS_COLOUR_CHANGED event.
1498 @see @ref overview_events
1500 class wxSysColourChangedEvent
: public wxEvent
1506 wxSysColourChangedEvent();
1512 @class wxWindowCreateEvent
1514 This event is sent just after the actual window associated with a wxWindow
1515 object has been created.
1517 Since it is derived from wxCommandEvent, the event propagates up
1518 the window hierarchy.
1520 @beginEventTable{wxWindowCreateEvent}
1521 @event{EVT_WINDOW_CREATE(func)}
1522 Process a @c wxEVT_CREATE event.
1528 @see @ref overview_events, wxWindowDestroyEvent
1530 class wxWindowCreateEvent
: public wxCommandEvent
1536 wxWindowCreateEvent(wxWindow
* win
= NULL
);
1538 /// Retutn the window being created.
1539 wxWindow
*GetWindow() const;
1547 A paint event is sent when a window's contents needs to be repainted.
1549 The handler of this event must create a wxPaintDC object and use it for
1550 painting the window contents. For example:
1552 void MyWindow::OnPaint(wxPaintEvent& event)
1560 Notice that you must @e not create other kinds of wxDC (e.g. wxClientDC or
1561 wxWindowDC) in EVT_PAINT handlers and also don't create wxPaintDC outside
1562 of this event handlers.
1565 You can optimize painting by retrieving the rectangles that have been damaged
1566 and only repainting these. The rectangles are in terms of the client area,
1567 and are unscrolled, so you will need to do some calculations using the current
1568 view position to obtain logical, scrolled units.
1569 Here is an example of using the wxRegionIterator class:
1571 // Called when window needs to be repainted.
1572 void MyWindow::OnPaint(wxPaintEvent& event)
1576 // Find Out where the window is scrolled to
1577 int vbX,vbY; // Top left corner of client
1578 GetViewStart(&vbX,&vbY);
1580 int vX,vY,vW,vH; // Dimensions of client area in pixels
1581 wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
1590 // Alternatively we can do this:
1591 // wxRect rect(upd.GetRect());
1593 // Repaint this rectangle
1602 Please notice that in general it is impossible to change the drawing of a
1603 standard control (such as wxButton) and so you shouldn't attempt to handle
1604 paint events for them as even if it might work on some platforms, this is
1605 inherently not portable and won't work everywhere.
1608 @beginEventTable{wxPaintEvent}
1609 @event{EVT_PAINT(func)}
1610 Process a @c wxEVT_PAINT event.
1616 @see @ref overview_events
1618 class wxPaintEvent
: public wxEvent
1624 wxPaintEvent(int id
= 0);
1630 @class wxMaximizeEvent
1632 An event being sent when a top level window is maximized. Notice that it is
1633 not sent when the window is restored to its original size after it had been
1634 maximized, only a normal wxSizeEvent is generated in this case.
1636 @beginEventTable{wxMaximizeEvent}
1637 @event{EVT_MAXIMIZE(func)}
1638 Process a @c wxEVT_MAXIMIZE event.
1644 @see @ref overview_events, wxTopLevelWindow::Maximize,
1645 wxTopLevelWindow::IsMaximized
1647 class wxMaximizeEvent
: public wxEvent
1651 Constructor. Only used by wxWidgets internally.
1653 wxMaximizeEvent(int id
= 0);
1657 The possibles modes to pass to wxUpdateUIEvent::SetMode().
1661 /** Send UI update events to all windows. */
1662 wxUPDATE_UI_PROCESS_ALL
,
1664 /** Send UI update events to windows that have
1665 the wxWS_EX_PROCESS_UI_UPDATES flag specified. */
1666 wxUPDATE_UI_PROCESS_SPECIFIED
1671 @class wxUpdateUIEvent
1673 This class is used for pseudo-events which are called by wxWidgets
1674 to give an application the chance to update various user interface elements.
1676 Without update UI events, an application has to work hard to check/uncheck,
1677 enable/disable, show/hide, and set the text for elements such as menu items
1678 and toolbar buttons. The code for doing this has to be mixed up with the code
1679 that is invoked when an action is invoked for a menu item or button.
1681 With update UI events, you define an event handler to look at the state of the
1682 application and change UI elements accordingly. wxWidgets will call your member
1683 functions in idle time, so you don't have to worry where to call this code.
1685 In addition to being a clearer and more declarative method, it also means you don't
1686 have to worry whether you're updating a toolbar or menubar identifier. The same
1687 handler can update a menu item and toolbar button, if the identifier is the same.
1688 Instead of directly manipulating the menu or button, you call functions in the event
1689 object, such as wxUpdateUIEvent::Check. wxWidgets will determine whether such a
1690 call has been made, and which UI element to update.
1692 These events will work for popup menus as well as menubars. Just before a menu is
1693 popped up, wxMenu::UpdateUI is called to process any UI events for the window that
1696 If you find that the overhead of UI update processing is affecting your application,
1697 you can do one or both of the following:
1698 @li Call wxUpdateUIEvent::SetMode with a value of wxUPDATE_UI_PROCESS_SPECIFIED,
1699 and set the extra style wxWS_EX_PROCESS_UI_UPDATES for every window that should
1700 receive update events. No other windows will receive update events.
1701 @li Call wxUpdateUIEvent::SetUpdateInterval with a millisecond value to set the delay
1702 between updates. You may need to call wxWindow::UpdateWindowUI at critical points,
1703 for example when a dialog is about to be shown, in case the user sees a slight
1704 delay before windows are updated.
1706 Note that although events are sent in idle time, defining a wxIdleEvent handler
1707 for a window does not affect this because the events are sent from wxWindow::OnInternalIdle
1708 which is always called in idle time.
1710 wxWidgets tries to optimize update events on some platforms.
1711 On Windows and GTK+, events for menubar items are only sent when the menu is about
1712 to be shown, and not in idle time.
1715 @beginEventTable{wxUpdateUIEvent}
1716 @event{EVT_UPDATE_UI(id, func)}
1717 Process a @c wxEVT_UPDATE_UI event for the command with the given id.
1718 @event{EVT_UPDATE_UI_RANGE(id1, id2, func)}
1719 Process a @c wxEVT_UPDATE_UI event for any command with id included in the given range.
1725 @see @ref overview_events
1727 class wxUpdateUIEvent
: public wxCommandEvent
1733 wxUpdateUIEvent(wxWindowID commandId
= 0);
1736 Returns @true if it is appropriate to update (send UI update events to)
1739 This function looks at the mode used (see wxUpdateUIEvent::SetMode),
1740 the wxWS_EX_PROCESS_UI_UPDATES flag in @a window, the time update events
1741 were last sent in idle time, and the update interval, to determine whether
1742 events should be sent to this window now. By default this will always
1743 return @true because the update mode is initially wxUPDATE_UI_PROCESS_ALL
1744 and the interval is set to 0; so update events will be sent as often as
1745 possible. You can reduce the frequency that events are sent by changing the
1746 mode and/or setting an update interval.
1748 @see ResetUpdateTime(), SetUpdateInterval(), SetMode()
1750 static bool CanUpdate(wxWindow
* window
);
1753 Check or uncheck the UI element.
1755 void Check(bool check
);
1758 Enable or disable the UI element.
1760 void Enable(bool enable
);
1763 Returns @true if the UI element should be checked.
1765 bool GetChecked() const;
1768 Returns @true if the UI element should be enabled.
1770 bool GetEnabled() const;
1773 Static function returning a value specifying how wxWidgets will send update
1774 events: to all windows, or only to those which specify that they will process
1779 static wxUpdateUIMode
GetMode();
1782 Returns @true if the application has called Check().
1783 For wxWidgets internal use only.
1785 bool GetSetChecked() const;
1788 Returns @true if the application has called Enable().
1789 For wxWidgets internal use only.
1791 bool GetSetEnabled() const;
1794 Returns @true if the application has called Show().
1795 For wxWidgets internal use only.
1797 bool GetSetShown() const;
1800 Returns @true if the application has called SetText().
1801 For wxWidgets internal use only.
1803 bool GetSetText() const;
1806 Returns @true if the UI element should be shown.
1808 bool GetShown() const;
1811 Returns the text that should be set for the UI element.
1813 wxString
GetText() const;
1816 Returns the current interval between updates in milliseconds.
1817 The value -1 disables updates, 0 updates as frequently as possible.
1819 @see SetUpdateInterval().
1821 static long GetUpdateInterval();
1824 Used internally to reset the last-updated time to the current time.
1826 It is assumed that update events are normally sent in idle time, so this
1827 is called at the end of idle processing.
1829 @see CanUpdate(), SetUpdateInterval(), SetMode()
1831 static void ResetUpdateTime();
1834 Specify how wxWidgets will send update events: to all windows, or only to
1835 those which specify that they will process the events.
1838 this parameter may be one of the ::wxUpdateUIMode enumeration values.
1839 The default mode is wxUPDATE_UI_PROCESS_ALL.
1841 static void SetMode(wxUpdateUIMode mode
);
1844 Sets the text for this UI element.
1846 void SetText(const wxString
& text
);
1849 Sets the interval between updates in milliseconds.
1851 Set to -1 to disable updates, or to 0 to update as frequently as possible.
1854 Use this to reduce the overhead of UI update events if your application
1855 has a lot of windows. If you set the value to -1 or greater than 0,
1856 you may also need to call wxWindow::UpdateWindowUI at appropriate points
1857 in your application, such as when a dialog is about to be shown.
1859 static void SetUpdateInterval(long updateInterval
);
1862 Show or hide the UI element.
1864 void Show(bool show
);
1870 @class wxClipboardTextEvent
1872 This class represents the events generated by a control (typically a
1873 wxTextCtrl but other windows can generate these events as well) when its
1874 content gets copied or cut to, or pasted from the clipboard.
1876 There are three types of corresponding events wxEVT_COMMAND_TEXT_COPY,
1877 wxEVT_COMMAND_TEXT_CUT and wxEVT_COMMAND_TEXT_PASTE.
1879 If any of these events is processed (without being skipped) by an event
1880 handler, the corresponding operation doesn't take place which allows to
1881 prevent the text from being copied from or pasted to a control. It is also
1882 possible to examine the clipboard contents in the PASTE event handler and
1883 transform it in some way before inserting in a control -- for example,
1884 changing its case or removing invalid characters.
1886 Finally notice that a CUT event is always preceded by the COPY event which
1887 makes it possible to only process the latter if it doesn't matter if the
1888 text was copied or cut.
1891 These events are currently only generated by wxTextCtrl under GTK+.
1892 They are generated by all controls under Windows.
1894 @beginEventTable{wxClipboardTextEvent}
1895 @event{EVT_TEXT_COPY(id, func)}
1896 Some or all of the controls content was copied to the clipboard.
1897 @event{EVT_TEXT_CUT(id, func)}
1898 Some or all of the controls content was cut (i.e. copied and
1900 @event{EVT_TEXT_PASTE(id, func)}
1901 Clipboard content was pasted into the control.
1910 class wxClipboardTextEvent
: public wxCommandEvent
1916 wxClipboardTextEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0);
1924 This event class contains information about the events generated by the mouse:
1925 they include mouse buttons press and release events and mouse move events.
1927 All mouse events involving the buttons use @c wxMOUSE_BTN_LEFT for the
1928 left mouse button, @c wxMOUSE_BTN_MIDDLE for the middle one and
1929 @c wxMOUSE_BTN_RIGHT for the right one. And if the system supports more
1930 buttons, the @c wxMOUSE_BTN_AUX1 and @c wxMOUSE_BTN_AUX2 events
1931 can also be generated. Note that not all mice have even a middle button so a
1932 portable application should avoid relying on the events from it (but the right
1933 button click can be emulated using the left mouse button with the control key
1934 under Mac platforms with a single button mouse).
1936 For the @c wxEVT_ENTER_WINDOW and @c wxEVT_LEAVE_WINDOW events
1937 purposes, the mouse is considered to be inside the window if it is in the
1938 window client area and not inside one of its children. In other words, the
1939 parent window receives @c wxEVT_LEAVE_WINDOW event not only when the
1940 mouse leaves the window entirely but also when it enters one of its children.
1942 The position associated with a mouse event is expressed in the window
1943 coordinates of the window which generated the event, you can use
1944 wxWindow::ClientToScreen() to convert it to screen coordinates and possibly
1945 call wxWindow::ScreenToClient() next to convert it to window coordinates of
1948 @note Note that under Windows CE mouse enter and leave events are not natively
1949 supported by the system but are generated by wxWidgets itself. This has several
1950 drawbacks: the LEAVE_WINDOW event might be received some time after the mouse
1951 left the window and the state variables for it may have changed during this time.
1953 @note Note the difference between methods like wxMouseEvent::LeftDown and
1954 the inherited wxMouseState::LeftIsDown: the former returns @true when
1955 the event corresponds to the left mouse button click while the latter
1956 returns @true if the left mouse button is currently being pressed.
1957 For example, when the user is dragging the mouse you can use
1958 wxMouseEvent::LeftIsDown to test whether the left mouse button is
1959 (still) depressed. Also, by convention, if wxMouseEvent::LeftDown
1960 returns @true, wxMouseEvent::LeftIsDown will also return @true in
1961 wxWidgets whatever the underlying GUI behaviour is (which is
1962 platform-dependent). The same applies, of course, to other mouse
1966 @beginEventTable{wxMouseEvent}
1967 @event{EVT_LEFT_DOWN(func)}
1968 Process a @c wxEVT_LEFT_DOWN event. The handler of this event should normally
1969 call event.Skip() to allow the default processing to take place as otherwise
1970 the window under mouse wouldn't get the focus.
1971 @event{EVT_LEFT_UP(func)}
1972 Process a @c wxEVT_LEFT_UP event.
1973 @event{EVT_LEFT_DCLICK(func)}
1974 Process a @c wxEVT_LEFT_DCLICK event.
1975 @event{EVT_MIDDLE_DOWN(func)}
1976 Process a @c wxEVT_MIDDLE_DOWN event.
1977 @event{EVT_MIDDLE_UP(func)}
1978 Process a @c wxEVT_MIDDLE_UP event.
1979 @event{EVT_MIDDLE_DCLICK(func)}
1980 Process a @c wxEVT_MIDDLE_DCLICK event.
1981 @event{EVT_RIGHT_DOWN(func)}
1982 Process a @c wxEVT_RIGHT_DOWN event.
1983 @event{EVT_RIGHT_UP(func)}
1984 Process a @c wxEVT_RIGHT_UP event.
1985 @event{EVT_RIGHT_DCLICK(func)}
1986 Process a @c wxEVT_RIGHT_DCLICK event.
1987 @event{EVT_MOUSE_AUX1_DOWN(func)}
1988 Process a @c wxEVT_MOUSE_AUX1_DOWN event.
1989 @event{EVT_MOUSE_AUX1_UP(func)}
1990 Process a @c wxEVT_MOUSE_AUX1_UP event.
1991 @event{EVT_MOUSE_AUX1_DCLICK(func)}
1992 Process a @c wxEVT_MOUSE_AUX1_DCLICK event.
1993 @event{EVT_MOUSE_AUX2_DOWN(func)}
1994 Process a @c wxEVT_MOUSE_AUX2_DOWN event.
1995 @event{EVT_MOUSE_AUX2_UP(func)}
1996 Process a @c wxEVT_MOUSE_AUX2_UP event.
1997 @event{EVT_MOUSE_AUX2_DCLICK(func)}
1998 Process a @c wxEVT_MOUSE_AUX2_DCLICK event.
1999 @event{EVT_MOTION(func)}
2000 Process a @c wxEVT_MOTION event.
2001 @event{EVT_ENTER_WINDOW(func)}
2002 Process a @c wxEVT_ENTER_WINDOW event.
2003 @event{EVT_LEAVE_WINDOW(func)}
2004 Process a @c wxEVT_LEAVE_WINDOW event.
2005 @event{EVT_MOUSEWHEEL(func)}
2006 Process a @c wxEVT_MOUSEWHEEL event.
2007 @event{EVT_MOUSE_EVENTS(func)}
2008 Process all mouse events.
2016 class wxMouseEvent
: public wxEvent
,
2021 Constructor. Valid event types are:
2023 @li wxEVT_ENTER_WINDOW
2024 @li wxEVT_LEAVE_WINDOW
2027 @li wxEVT_LEFT_DCLICK
2028 @li wxEVT_MIDDLE_DOWN
2030 @li wxEVT_MIDDLE_DCLICK
2031 @li wxEVT_RIGHT_DOWN
2033 @li wxEVT_RIGHT_DCLICK
2034 @li wxEVT_MOUSE_AUX1_DOWN
2035 @li wxEVT_MOUSE_AUX1_UP
2036 @li wxEVT_MOUSE_AUX1_DCLICK
2037 @li wxEVT_MOUSE_AUX2_DOWN
2038 @li wxEVT_MOUSE_AUX2_UP
2039 @li wxEVT_MOUSE_AUX2_DCLICK
2041 @li wxEVT_MOUSEWHEEL
2043 wxMouseEvent(wxEventType mouseEventType
= wxEVT_NULL
);
2046 Returns @true if the event was a first extra button double click.
2048 bool Aux1DClick() const;
2051 Returns @true if the first extra button mouse button changed to down.
2053 bool Aux1Down() const;
2056 Returns @true if the first extra button mouse button changed to up.
2058 bool Aux1Up() const;
2061 Returns @true if the event was a second extra button double click.
2063 bool Aux2DClick() const;
2066 Returns @true if the second extra button mouse button changed to down.
2068 bool Aux2Down() const;
2071 Returns @true if the second extra button mouse button changed to up.
2073 bool Aux2Up() const;
2076 Returns @true if the event was generated by the specified button.
2078 @see wxMouseState::ButtoinIsDown()
2080 bool Button(wxMouseButton but
) const;
2083 If the argument is omitted, this returns @true if the event was a mouse
2084 double click event. Otherwise the argument specifies which double click event
2085 was generated (see Button() for the possible values).
2087 bool ButtonDClick(wxMouseButton but
= wxMOUSE_BTN_ANY
) const;
2090 If the argument is omitted, this returns @true if the event was a mouse
2091 button down event. Otherwise the argument specifies which button-down event
2092 was generated (see Button() for the possible values).
2094 bool ButtonDown(wxMouseButton but
= wxMOUSE_BTN_ANY
) const;
2097 If the argument is omitted, this returns @true if the event was a mouse
2098 button up event. Otherwise the argument specifies which button-up event
2099 was generated (see Button() for the possible values).
2101 bool ButtonUp(wxMouseButton but
= wxMOUSE_BTN_ANY
) const;
2104 Returns @true if this was a dragging event (motion while a button is depressed).
2108 bool Dragging() const;
2111 Returns @true if the mouse was entering the window.
2115 bool Entering() const;
2118 Returns the mouse button which generated this event or @c wxMOUSE_BTN_NONE
2119 if no button is involved (for mouse move, enter or leave event, for example).
2120 Otherwise @c wxMOUSE_BTN_LEFT is returned for the left button down, up and
2121 double click events, @c wxMOUSE_BTN_MIDDLE and @c wxMOUSE_BTN_RIGHT
2122 for the same events for the middle and the right buttons respectively.
2124 int GetButton() const;
2127 Returns the number of mouse clicks for this event: 1 for a simple click, 2
2128 for a double-click, 3 for a triple-click and so on.
2130 Currently this function is implemented only in wxMac and returns -1 for the
2131 other platforms (you can still distinguish simple clicks from double-clicks as
2132 they generate different kinds of events however).
2136 int GetClickCount() const;
2139 Returns the configured number of lines (or whatever) to be scrolled per
2140 wheel action. Defaults to three.
2142 int GetLinesPerAction() const;
2145 Returns the logical mouse position in pixels (i.e. translated according to the
2146 translation set for the DC, which usually indicates that the window has been
2149 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
2152 Get wheel delta, normally 120.
2154 This is the threshold for action to be taken, and one such action
2155 (for example, scrolling one increment) should occur for each delta.
2157 int GetWheelDelta() const;
2160 Get wheel rotation, positive or negative indicates direction of rotation.
2162 Current devices all send an event when rotation is at least +/-WheelDelta, but
2163 finer resolution devices can be created in the future.
2165 Because of this you shouldn't assume that one event is equal to 1 line, but you
2166 should be able to either do partial line scrolling or wait until several
2167 events accumulate before scrolling.
2169 int GetWheelRotation() const;
2172 Gets the axis the wheel operation concerns; @c 0 is the Y axis as on
2173 most mouse wheels, @c 1 is the X axis.
2175 Note that only some models of mouse have horizontal wheel axis.
2177 int GetWheelAxis() const;
2180 Returns @true if the event was a mouse button event (not necessarily a button
2181 down event - that may be tested using ButtonDown()).
2183 bool IsButton() const;
2186 Returns @true if the system has been setup to do page scrolling with
2187 the mouse wheel instead of line scrolling.
2189 bool IsPageScroll() const;
2192 Returns @true if the mouse was leaving the window.
2196 bool Leaving() const;
2199 Returns @true if the event was a left double click.
2201 bool LeftDClick() const;
2204 Returns @true if the left mouse button changed to down.
2206 bool LeftDown() const;
2209 Returns @true if the left mouse button changed to up.
2211 bool LeftUp() const;
2214 Returns @true if the Meta key was down at the time of the event.
2216 bool MetaDown() const;
2219 Returns @true if the event was a middle double click.
2221 bool MiddleDClick() const;
2224 Returns @true if the middle mouse button changed to down.
2226 bool MiddleDown() const;
2229 Returns @true if the middle mouse button changed to up.
2231 bool MiddleUp() const;
2234 Returns @true if this was a motion event and no mouse buttons were pressed.
2235 If any mouse button is held pressed, then this method returns @false and
2236 Dragging() returns @true.
2238 bool Moving() const;
2241 Returns @true if the event was a right double click.
2243 bool RightDClick() const;
2246 Returns @true if the right mouse button changed to down.
2248 bool RightDown() const;
2251 Returns @true if the right mouse button changed to up.
2253 bool RightUp() const;
2259 @class wxDropFilesEvent
2261 This class is used for drop files events, that is, when files have been dropped
2262 onto the window. This functionality is currently only available under Windows.
2264 The window must have previously been enabled for dropping by calling
2265 wxWindow::DragAcceptFiles().
2267 Important note: this is a separate implementation to the more general drag and drop
2268 implementation documented in the @ref overview_dnd. It uses the older, Windows
2269 message-based approach of dropping files.
2271 @beginEventTable{wxDropFilesEvent}
2272 @event{EVT_DROP_FILES(func)}
2273 Process a @c wxEVT_DROP_FILES event.
2281 @see @ref overview_events
2283 class wxDropFilesEvent
: public wxEvent
2289 wxDropFilesEvent(wxEventType id
= 0, int noFiles
= 0,
2290 wxString
* files
= NULL
);
2293 Returns an array of filenames.
2295 wxString
* GetFiles() const;
2298 Returns the number of files dropped.
2300 int GetNumberOfFiles() const;
2303 Returns the position at which the files were dropped.
2304 Returns an array of filenames.
2306 wxPoint
GetPosition() const;
2312 @class wxCommandEvent
2314 This event class contains information about command events, which originate
2315 from a variety of simple controls.
2317 Note that wxCommandEvents and wxCommandEvent-derived event classes by default
2318 and unlike other wxEvent-derived classes propagate upward from the source
2319 window (the window which emits the event) up to the first parent which processes
2320 the event. Be sure to read @ref overview_events_propagation.
2322 More complex controls, such as wxTreeCtrl, have separate command event classes.
2324 @beginEventTable{wxCommandEvent}
2325 @event{EVT_COMMAND(id, event, func)}
2326 Process a command, supplying the window identifier, command event identifier,
2327 and member function.
2328 @event{EVT_COMMAND_RANGE(id1, id2, event, func)}
2329 Process a command for a range of window identifiers, supplying the minimum and
2330 maximum window identifiers, command event identifier, and member function.
2331 @event{EVT_BUTTON(id, func)}
2332 Process a @c wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wxButton control.
2333 @event{EVT_CHECKBOX(id, func)}
2334 Process a @c wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wxCheckBox control.
2335 @event{EVT_CHOICE(id, func)}
2336 Process a @c wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wxChoice control.
2337 @event{EVT_COMBOBOX(id, func)}
2338 Process a @c wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wxComboBox control.
2339 @event{EVT_LISTBOX(id, func)}
2340 Process a @c wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.
2341 @event{EVT_LISTBOX_DCLICK(id, func)}
2342 Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.
2343 @event{EVT_CHECKLISTBOX(id, func)}
2344 Process a @c wxEVT_COMMAND_CHECKLISTBOX_TOGGLED command, which is generated by a wxCheckListBox control.
2345 @event{EVT_MENU(id, func)}
2346 Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
2347 @event{EVT_MENU_RANGE(id1, id2, func)}
2348 Process a @c wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.
2349 @event{EVT_CONTEXT_MENU(func)}
2350 Process the event generated when the user has requested a popup menu to appear by
2351 pressing a special keyboard key (under Windows) or by right clicking the mouse.
2352 @event{EVT_RADIOBOX(id, func)}
2353 Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wxRadioBox control.
2354 @event{EVT_RADIOBUTTON(id, func)}
2355 Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wxRadioButton control.
2356 @event{EVT_SCROLLBAR(id, func)}
2357 Process a @c wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a wxScrollBar
2358 control. This is provided for compatibility only; more specific scrollbar event macros
2359 should be used instead (see wxScrollEvent).
2360 @event{EVT_SLIDER(id, func)}
2361 Process a @c wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wxSlider control.
2362 @event{EVT_TEXT(id, func)}
2363 Process a @c wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wxTextCtrl control.
2364 @event{EVT_TEXT_ENTER(id, func)}
2365 Process a @c wxEVT_COMMAND_TEXT_ENTER command, which is generated by a wxTextCtrl control.
2366 Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it
2367 to generate such events.
2368 @event{EVT_TEXT_MAXLEN(id, func)}
2369 Process a @c wxEVT_COMMAND_TEXT_MAXLEN command, which is generated by a wxTextCtrl control
2370 when the user tries to enter more characters into it than the limit previously set
2371 with SetMaxLength().
2372 @event{EVT_TOGGLEBUTTON(id, func)}
2373 Process a @c wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event.
2374 @event{EVT_TOOL(id, func)}
2375 Process a @c wxEVT_COMMAND_TOOL_CLICKED event (a synonym for @c wxEVT_COMMAND_MENU_SELECTED).
2376 Pass the id of the tool.
2377 @event{EVT_TOOL_RANGE(id1, id2, func)}
2378 Process a @c wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools.
2379 @event{EVT_TOOL_RCLICKED(id, func)}
2380 Process a @c wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool. (Not available on wxOSX.)
2381 @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}
2382 Process a @c wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. (Not available on wxOSX.)
2383 @event{EVT_TOOL_ENTER(id, func)}
2384 Process a @c wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself.
2385 The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor
2386 has moved off a tool. (Not available on wxOSX.)
2387 @event{EVT_COMMAND_LEFT_CLICK(id, func)}
2388 Process a @c wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only).
2389 @event{EVT_COMMAND_LEFT_DCLICK(id, func)}
2390 Process a @c wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (wxMSW only).
2391 @event{EVT_COMMAND_RIGHT_CLICK(id, func)}
2392 Process a @c wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (wxMSW only).
2393 @event{EVT_COMMAND_SET_FOCUS(id, func)}
2394 Process a @c wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (wxMSW only).
2395 @event{EVT_COMMAND_KILL_FOCUS(id, func)}
2396 Process a @c wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (wxMSW only).
2397 @event{EVT_COMMAND_ENTER(id, func)}
2398 Process a @c wxEVT_COMMAND_ENTER command, which is generated by a control.
2404 class wxCommandEvent
: public wxEvent
2410 wxCommandEvent(wxEventType commandEventType
= wxEVT_NULL
, int id
= 0);
2413 Returns client data pointer for a listbox or choice selection event
2414 (not valid for a deselection).
2416 void* GetClientData() const;
2419 Returns client object pointer for a listbox or choice selection event
2420 (not valid for a deselection).
2422 wxClientData
* GetClientObject() const;
2425 Returns extra information dependant on the event objects type.
2427 If the event comes from a listbox selection, it is a boolean
2428 determining whether the event was a selection (@true) or a
2429 deselection (@false). A listbox deselection only occurs for
2430 multiple-selection boxes, and in this case the index and string values
2431 are indeterminate and the listbox must be examined by the application.
2433 long GetExtraLong() const;
2436 Returns the integer identifier corresponding to a listbox, choice or
2437 radiobox selection (only if the event was a selection, not a deselection),
2438 or a boolean value representing the value of a checkbox.
2443 Returns item index for a listbox or choice selection event (not valid for
2446 int GetSelection() const;
2449 Returns item string for a listbox or choice selection event. If one
2450 or several items have been deselected, returns the index of the first
2451 deselected item. If some items have been selected and others deselected
2452 at the same time, it will return the index of the first selected item.
2454 wxString
GetString() const;
2457 This method can be used with checkbox and menu events: for the checkboxes, the
2458 method returns @true for a selection event and @false for a deselection one.
2459 For the menu events, this method indicates if the menu item just has become
2460 checked or unchecked (and thus only makes sense for checkable menu items).
2462 Notice that this method can not be used with wxCheckListBox currently.
2464 bool IsChecked() const;
2467 For a listbox or similar event, returns @true if it is a selection, @false
2468 if it is a deselection. If some items have been selected and others deselected
2469 at the same time, it will return @true.
2471 bool IsSelection() const;
2474 Sets the client data for this event.
2476 void SetClientData(void* clientData
);
2479 Sets the client object for this event. The client object is not owned by the
2480 event object and the event object will not delete the client object in its destructor.
2482 The client object must be owned and deleted by another object (e.g. a control)
2483 that has longer life time than the event object.
2485 void SetClientObject(wxClientData
* clientObject
);
2488 Sets the @b m_extraLong member.
2490 void SetExtraLong(long extraLong
);
2493 Sets the @b m_commandInt member.
2495 void SetInt(int intCommand
);
2498 Sets the @b m_commandString member.
2500 void SetString(const wxString
& string
);
2506 @class wxActivateEvent
2508 An activate event is sent when a window or application is being activated
2511 @beginEventTable{wxActivateEvent}
2512 @event{EVT_ACTIVATE(func)}
2513 Process a @c wxEVT_ACTIVATE event.
2514 @event{EVT_ACTIVATE_APP(func)}
2515 Process a @c wxEVT_ACTIVATE_APP event.
2516 This event is received by the wxApp-derived instance only.
2517 @event{EVT_HIBERNATE(func)}
2518 Process a hibernate event, supplying the member function. This event applies
2519 to wxApp only, and only on Windows SmartPhone and PocketPC.
2520 It is generated when the system is low on memory; the application should free
2521 up as much memory as possible, and restore full working state when it receives
2522 a wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP event.
2528 @see @ref overview_events, wxApp::IsActive
2530 class wxActivateEvent
: public wxEvent
2536 wxActivateEvent(wxEventType eventType
= wxEVT_NULL
, bool active
= true,
2540 Returns @true if the application or window is being activated, @false otherwise.
2542 bool GetActive() const;
2548 @class wxContextMenuEvent
2550 This class is used for context menu events, sent to give
2551 the application a chance to show a context (popup) menu for a wxWindow.
2553 Note that if wxContextMenuEvent::GetPosition returns wxDefaultPosition, this
2554 means that the event originated from a keyboard context button event, and you
2555 should compute a suitable position yourself, for example by calling wxGetMousePosition().
2557 When a keyboard context menu button is pressed on Windows, a right-click event
2558 with default position is sent first, and if this event is not processed, the
2559 context menu event is sent. So if you process mouse events and you find your
2560 context menu event handler is not being called, you could call wxEvent::Skip()
2561 for mouse right-down events.
2563 @beginEventTable{wxContextMenuEvent}
2564 @event{EVT_CONTEXT_MENU(func)}
2565 A right click (or other context menu command depending on platform) has been detected.
2572 @see wxCommandEvent, @ref overview_events
2574 class wxContextMenuEvent
: public wxCommandEvent
2580 wxContextMenuEvent(wxEventType id
= wxEVT_NULL
, int id
= 0,
2581 const wxPoint
& pos
= wxDefaultPosition
);
2584 Returns the position in screen coordinates at which the menu should be shown.
2585 Use wxWindow::ScreenToClient to convert to client coordinates.
2587 You can also omit a position from wxWindow::PopupMenu in order to use
2588 the current mouse pointer position.
2590 If the event originated from a keyboard event, the value returned from this
2591 function will be wxDefaultPosition.
2593 const wxPoint
& GetPosition() const;
2596 Sets the position at which the menu should be shown.
2598 void SetPosition(const wxPoint
& point
);
2606 An erase event is sent when a window's background needs to be repainted.
2608 On some platforms, such as GTK+, this event is simulated (simply generated just
2609 before the paint event) and may cause flicker. It is therefore recommended that
2610 you set the text background colour explicitly in order to prevent flicker.
2611 The default background colour under GTK+ is grey.
2613 To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table
2616 You must call wxEraseEvent::GetDC and use the returned device context if it is
2617 non-@NULL. If it is @NULL, create your own temporary wxClientDC object.
2620 Use the device context returned by GetDC to draw on, don't create
2621 a wxPaintDC in the event handler.
2623 @beginEventTable{wxEraseEvent}
2624 @event{EVT_ERASE_BACKGROUND(func)}
2625 Process a @c wxEVT_ERASE_BACKGROUND event.
2631 @see @ref overview_events
2633 class wxEraseEvent
: public wxEvent
2639 wxEraseEvent(int id
= 0, wxDC
* dc
= NULL
);
2642 Returns the device context associated with the erase event to draw on.
2644 wxDC
* GetDC() const;
2652 A focus event is sent when a window's focus changes. The window losing focus
2653 receives a "kill focus" event while the window gaining it gets a "set focus" one.
2655 Notice that the set focus event happens both when the user gives focus to the
2656 window (whether using the mouse or keyboard) and when it is done from the
2657 program itself using wxWindow::SetFocus.
2659 @beginEventTable{wxFocusEvent}
2660 @event{EVT_SET_FOCUS(func)}
2661 Process a @c wxEVT_SET_FOCUS event.
2662 @event{EVT_KILL_FOCUS(func)}
2663 Process a @c wxEVT_KILL_FOCUS event.
2669 @see @ref overview_events
2671 class wxFocusEvent
: public wxEvent
2677 wxFocusEvent(wxEventType eventType
= wxEVT_NULL
, int id
= 0);
2680 Returns the window associated with this event, that is the window which had the
2681 focus before for the @c wxEVT_SET_FOCUS event and the window which is
2682 going to receive focus for the @c wxEVT_KILL_FOCUS one.
2684 Warning: the window pointer may be @NULL!
2686 wxWindow
*GetWindow() const;
2692 @class wxChildFocusEvent
2694 A child focus event is sent to a (parent-)window when one of its child windows
2695 gains focus, so that the window could restore the focus back to its corresponding
2696 child if it loses it now and regains later.
2698 Notice that child window is the direct child of the window receiving event.
2699 Use wxWindow::FindFocus() to retreive the window which is actually getting focus.
2701 @beginEventTable{wxChildFocusEvent}
2702 @event{EVT_CHILD_FOCUS(func)}
2703 Process a @c wxEVT_CHILD_FOCUS event.
2709 @see @ref overview_events
2711 class wxChildFocusEvent
: public wxCommandEvent
2718 The direct child which is (or which contains the window which is) receiving
2721 wxChildFocusEvent(wxWindow
* win
= NULL
);
2724 Returns the direct child which receives the focus, or a (grand-)parent of the
2725 control receiving the focus.
2727 To get the actually focused control use wxWindow::FindFocus.
2729 wxWindow
*GetWindow() const;
2735 @class wxMouseCaptureLostEvent
2737 An mouse capture lost event is sent to a window that obtained mouse capture,
2738 which was subsequently loss due to "external" event, for example when a dialog
2739 box is shown or if another application captures the mouse.
2741 If this happens, this event is sent to all windows that are on capture stack
2742 (i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is
2743 not sent if the capture changes because of a call to CaptureMouse or
2746 This event is currently emitted under Windows only.
2748 @beginEventTable{wxMouseCaptureLostEvent}
2749 @event{EVT_MOUSE_CAPTURE_LOST(func)}
2750 Process a @c wxEVT_MOUSE_CAPTURE_LOST event.
2758 @see wxMouseCaptureChangedEvent, @ref overview_events,
2759 wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
2761 class wxMouseCaptureLostEvent
: public wxEvent
2767 wxMouseCaptureLostEvent(wxWindowID windowId
= 0);
2773 @class wxNotifyEvent
2775 This class is not used by the event handlers by itself, but is a base class
2776 for other event classes (such as wxBookCtrlEvent).
2778 It (or an object of a derived class) is sent when the controls state is being
2779 changed and allows the program to wxNotifyEvent::Veto() this change if it wants
2780 to prevent it from happening.
2785 @see wxBookCtrlEvent
2787 class wxNotifyEvent
: public wxCommandEvent
2791 Constructor (used internally by wxWidgets only).
2793 wxNotifyEvent(wxEventType eventType
= wxEVT_NULL
, int id
= 0);
2796 This is the opposite of Veto(): it explicitly allows the event to be processed.
2797 For most events it is not necessary to call this method as the events are allowed
2798 anyhow but some are forbidden by default (this will be mentioned in the corresponding
2804 Returns @true if the change is allowed (Veto() hasn't been called) or @false
2805 otherwise (if it was).
2807 bool IsAllowed() const;
2810 Prevents the change announced by this event from happening.
2812 It is in general a good idea to notify the user about the reasons for vetoing
2813 the change because otherwise the applications behaviour (which just refuses to
2814 do what the user wants) might be quite surprising.
2821 @class wxThreadEvent
2823 This class adds some simple functionalities to wxCommandEvent coinceived
2824 for inter-threads communications.
2826 This event is not natively emitted by any control/class: this is just
2827 an helper class for the user.
2828 Its most important feature is the GetEventCategory() implementation which
2829 allows thread events to @b NOT be processed by wxEventLoopBase::YieldFor calls
2830 (unless the @c wxEVT_CATEGORY_THREAD is specified - which is never in wx code).
2833 @category{events,threading}
2835 @see @ref overview_thread, wxEventLoopBase::YieldFor
2837 class wxThreadEvent
: public wxCommandEvent
2843 wxThreadEvent(wxEventType eventType
= wxEVT_COMMAND_THREAD
, int id
= wxID_ANY
);
2846 Clones this event making sure that all internal members which use
2847 COW (only @c m_commandString for now; see @ref overview_refcount)
2848 are unshared (see wxObject::UnShare).
2850 virtual wxEvent
*Clone() const;
2853 Returns @c wxEVT_CATEGORY_THREAD.
2855 This is important to avoid unwanted processing of thread events
2856 when calling wxEventLoopBase::YieldFor().
2858 virtual wxEventCategory
GetEventCategory() const;
2861 Sets custom data payload.
2863 The @a payload argument may be of any type that wxAny can handle
2864 (i.e. pretty much anything). Note that T's copy constructor must be
2865 thread-safe, i.e. create a copy that doesn't share anything with
2866 the original (see Clone()).
2868 @note This method is not available with Visual C++ 6.
2872 @see GetPayload(), wxAny
2874 template<typename T
>
2875 void SetPayload(const T
& payload
);
2878 Get custom data payload.
2880 Correct type is checked in debug builds.
2882 @note This method is not available with Visual C++ 6.
2886 @see SetPayload(), wxAny
2888 template<typename T
>
2889 T
GetPayload() const;
2896 A help event is sent when the user has requested context-sensitive help.
2897 This can either be caused by the application requesting context-sensitive help mode
2898 via wxContextHelp, or (on MS Windows) by the system generating a WM_HELP message when
2899 the user pressed F1 or clicked on the query button in a dialog caption.
2901 A help event is sent to the window that the user clicked on, and is propagated
2902 up the window hierarchy until the event is processed or there are no more event
2905 The application should call wxEvent::GetId to check the identity of the
2906 clicked-on window, and then either show some suitable help or call wxEvent::Skip()
2907 if the identifier is unrecognised.
2909 Calling Skip is important because it allows wxWidgets to generate further
2910 events for ancestors of the clicked-on window. Otherwise it would be impossible to
2911 show help for container windows, since processing would stop after the first window
2914 @beginEventTable{wxHelpEvent}
2915 @event{EVT_HELP(id, func)}
2916 Process a @c wxEVT_HELP event.
2917 @event{EVT_HELP_RANGE(id1, id2, func)}
2918 Process a @c wxEVT_HELP event for a range of ids.
2924 @see wxContextHelp, wxDialog, @ref overview_events
2926 class wxHelpEvent
: public wxCommandEvent
2930 Indicates how a wxHelpEvent was generated.
2934 Origin_Unknown
, /**< unrecognized event source. */
2935 Origin_Keyboard
, /**< event generated from F1 key press. */
2937 /** event generated by wxContextHelp or from the [?] button on
2938 the title bar (Windows). */
2945 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2946 wxWindowID winid
= 0,
2947 const wxPoint
& pt
= wxDefaultPosition
,
2948 wxHelpEvent::Origin origin
= Origin_Unknown
);
2951 Returns the origin of the help event which is one of the ::wxHelpEventOrigin
2954 The application may handle events generated using the keyboard or mouse
2955 differently, e.g. by using wxGetMousePosition() for the mouse events.
2959 wxHelpEvent::Origin
GetOrigin() const;
2962 Returns the left-click position of the mouse, in screen coordinates.
2963 This allows the application to position the help appropriately.
2965 const wxPoint
& GetPosition() const;
2968 Set the help event origin, only used internally by wxWidgets normally.
2972 void SetOrigin(wxHelpEvent::Origin origin
);
2975 Sets the left-click position of the mouse, in screen coordinates.
2977 void SetPosition(const wxPoint
& pt
);
2983 @class wxScrollEvent
2985 A scroll event holds information about events sent from stand-alone
2986 scrollbars (see wxScrollBar) and sliders (see wxSlider).
2988 Note that scrolled windows send the wxScrollWinEvent which does not derive from
2989 wxCommandEvent, but from wxEvent directly - don't confuse these two kinds of
2990 events and use the event table macros mentioned below only for the scrollbar-like
2993 @section scrollevent_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
2995 The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb
2996 using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed
2997 by an EVT_SCROLL_CHANGED event).
2999 The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb
3000 position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE
3001 event does not happen).
3003 In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving has finished
3004 independently of the way it had started. Please see the widgets sample ("Slider" page)
3005 to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
3008 Note that unless specifying a scroll control identifier, you will need to test for scrollbar
3009 orientation with wxScrollEvent::GetOrientation, since horizontal and vertical scroll events
3010 are processed using the same event handler.
3012 @beginEventTable{wxScrollEvent}
3013 You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting
3014 scroll events from controls, or EVT_SCROLL... macros without window IDs for
3015 intercepting scroll events from the receiving window -- except for this, the
3016 macros behave exactly the same.
3017 @event{EVT_SCROLL(func)}
3018 Process all scroll events.
3019 @event{EVT_SCROLL_TOP(func)}
3020 Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
3021 @event{EVT_SCROLL_BOTTOM(func)}
3022 Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
3023 @event{EVT_SCROLL_LINEUP(func)}
3024 Process wxEVT_SCROLL_LINEUP line up events.
3025 @event{EVT_SCROLL_LINEDOWN(func)}
3026 Process wxEVT_SCROLL_LINEDOWN line down events.
3027 @event{EVT_SCROLL_PAGEUP(func)}
3028 Process wxEVT_SCROLL_PAGEUP page up events.
3029 @event{EVT_SCROLL_PAGEDOWN(func)}
3030 Process wxEVT_SCROLL_PAGEDOWN page down events.
3031 @event{EVT_SCROLL_THUMBTRACK(func)}
3032 Process wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the
3033 user drags the thumbtrack).
3034 @event{EVT_SCROLL_THUMBRELEASE(func)}
3035 Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
3036 @event{EVT_SCROLL_CHANGED(func)}
3037 Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
3038 @event{EVT_COMMAND_SCROLL(id, func)}
3039 Process all scroll events.
3040 @event{EVT_COMMAND_SCROLL_TOP(id, func)}
3041 Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
3042 @event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
3043 Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
3044 @event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
3045 Process wxEVT_SCROLL_LINEUP line up events.
3046 @event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
3047 Process wxEVT_SCROLL_LINEDOWN line down events.
3048 @event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
3049 Process wxEVT_SCROLL_PAGEUP page up events.
3050 @event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
3051 Process wxEVT_SCROLL_PAGEDOWN page down events.
3052 @event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
3053 Process wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent
3054 as the user drags the thumbtrack).
3055 @event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
3056 Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
3057 @event{EVT_COMMAND_SCROLL_CHANGED(func)}
3058 Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
3064 @see wxScrollBar, wxSlider, wxSpinButton, wxScrollWinEvent, @ref overview_events
3066 class wxScrollEvent
: public wxCommandEvent
3072 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0, int pos
= 0,
3073 int orientation
= 0);
3076 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
3079 int GetOrientation() const;
3082 Returns the position of the scrollbar.
3084 int GetPosition() const;
3088 See wxIdleEvent::SetMode() for more info.
3092 /** Send idle events to all windows */
3095 /** Send idle events to windows that have the wxWS_EX_PROCESS_IDLE flag specified */
3096 wxIDLE_PROCESS_SPECIFIED
3103 This class is used for idle events, which are generated when the system becomes
3104 idle. Note that, unless you do something specifically, the idle events are not
3105 sent if the system remains idle once it has become it, e.g. only a single idle
3106 event will be generated until something else resulting in more normal events
3107 happens and only then is the next idle event sent again.
3109 If you need to ensure a continuous stream of idle events, you can either use
3110 wxIdleEvent::RequestMore method in your handler or call wxWakeUpIdle() periodically
3111 (for example from a timer event handler), but note that both of these approaches
3112 (and especially the first one) increase the system load and so should be avoided
3115 By default, idle events are sent to all windows (and also wxApp, as usual).
3116 If this is causing a significant overhead in your application, you can call
3117 wxIdleEvent::SetMode with the value wxIDLE_PROCESS_SPECIFIED, and set the
3118 wxWS_EX_PROCESS_IDLE extra window style for every window which should receive
3121 @beginEventTable{wxIdleEvent}
3122 @event{EVT_IDLE(func)}
3123 Process a @c wxEVT_IDLE event.
3129 @see @ref overview_events, wxUpdateUIEvent, wxWindow::OnInternalIdle
3131 class wxIdleEvent
: public wxEvent
3140 Returns @true if it is appropriate to send idle events to this window.
3142 This function looks at the mode used (see wxIdleEvent::SetMode),
3143 and the wxWS_EX_PROCESS_IDLE style in @a window to determine whether idle
3144 events should be sent to this window now.
3146 By default this will always return @true because the update mode is initially
3147 wxIDLE_PROCESS_ALL. You can change the mode to only send idle events to
3148 windows with the wxWS_EX_PROCESS_IDLE extra window style set.
3152 static bool CanSend(wxWindow
* window
);
3155 Static function returning a value specifying how wxWidgets will send idle
3156 events: to all windows, or only to those which specify that they
3157 will process the events.
3161 static wxIdleMode
GetMode();
3164 Returns @true if the OnIdle function processing this event requested more
3169 bool MoreRequested() const;
3172 Tells wxWidgets that more processing is required.
3174 This function can be called by an OnIdle handler for a window or window event
3175 handler to indicate that wxApp::OnIdle should forward the OnIdle event once
3176 more to the application windows.
3178 If no window calls this function during OnIdle, then the application will
3179 remain in a passive event loop (not calling OnIdle) until a new event is
3180 posted to the application by the windowing system.
3182 @see MoreRequested()
3184 void RequestMore(bool needMore
= true);
3187 Static function for specifying how wxWidgets will send idle events: to
3188 all windows, or only to those which specify that they will process the events.
3191 Can be one of the ::wxIdleMode values.
3192 The default is wxIDLE_PROCESS_ALL.
3194 static void SetMode(wxIdleMode mode
);
3200 @class wxInitDialogEvent
3202 A wxInitDialogEvent is sent as a dialog or panel is being initialised.
3203 Handlers for this event can transfer data to the window.
3205 The default handler calls wxWindow::TransferDataToWindow.
3207 @beginEventTable{wxInitDialogEvent}
3208 @event{EVT_INIT_DIALOG(func)}
3209 Process a @c wxEVT_INIT_DIALOG event.
3215 @see @ref overview_events
3217 class wxInitDialogEvent
: public wxEvent
3223 wxInitDialogEvent(int id
= 0);
3229 @class wxWindowDestroyEvent
3231 This event is sent as early as possible during the window destruction
3234 For the top level windows, as early as possible means that this is done by
3235 wxFrame or wxDialog destructor, i.e. after the destructor of the derived
3236 class was executed and so any methods specific to the derived class can't
3237 be called any more from this event handler. If you need to do this, you
3238 must call wxWindow::SendDestroyEvent() from your derived class destructor.
3240 For the child windows, this event is generated just before deleting the
3241 window from wxWindow::Destroy() (which is also called when the parent
3242 window is deleted) or from the window destructor if operator @c delete was
3243 used directly (which is not recommended for this very reason).
3245 It is usually pointless to handle this event in the window itself but it ca
3246 be very useful to receive notifications about the window destruction in the
3247 parent window or in any other object interested in this window.
3252 @see @ref overview_events, wxWindowCreateEvent
3254 class wxWindowDestroyEvent
: public wxCommandEvent
3260 wxWindowDestroyEvent(wxWindow
* win
= NULL
);
3262 /// Retutn the window being destroyed.
3263 wxWindow
*GetWindow() const;
3268 @class wxNavigationKeyEvent
3270 This event class contains information about navigation events,
3271 generated by navigation keys such as tab and page down.
3273 This event is mainly used by wxWidgets implementations.
3274 A wxNavigationKeyEvent handler is automatically provided by wxWidgets
3275 when you make a class into a control container with the macro
3276 WX_DECLARE_CONTROL_CONTAINER.
3278 @beginEventTable{wxNavigationKeyEvent}
3279 @event{EVT_NAVIGATION_KEY(func)}
3280 Process a navigation key event.
3286 @see wxWindow::Navigate, wxWindow::NavigateIn
3288 class wxNavigationKeyEvent
: public wxEvent
3292 Flags which can be used with wxNavigationKeyEvent.
3294 enum wxNavigationKeyEventFlags
3296 IsBackward
= 0x0000,
3302 wxNavigationKeyEvent();
3303 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
);
3306 Returns the child that has the focus, or @NULL.
3308 wxWindow
* GetCurrentFocus() const;
3311 Returns @true if the navigation was in the forward direction.
3313 bool GetDirection() const;
3316 Returns @true if the navigation event was from a tab key.
3317 This is required for proper navigation over radio buttons.
3319 bool IsFromTab() const;
3322 Returns @true if the navigation event represents a window change
3323 (for example, from Ctrl-Page Down in a notebook).
3325 bool IsWindowChange() const;
3328 Sets the current focus window member.
3330 void SetCurrentFocus(wxWindow
* currentFocus
);
3333 Sets the direction to forward if @a direction is @true, or backward
3336 void SetDirection(bool direction
);
3339 Sets the flags for this event.
3340 The @a flags can be a combination of the ::wxNavigationKeyEventFlags values.
3342 void SetFlags(long flags
);
3345 Marks the navigation event as from a tab key.
3347 void SetFromTab(bool fromTab
);
3350 Marks the event as a window change event.
3352 void SetWindowChange(bool windowChange
);
3358 @class wxMouseCaptureChangedEvent
3360 An mouse capture changed event is sent to a window that loses its
3361 mouse capture. This is called even if wxWindow::ReleaseMouse
3362 was called by the application code. Handling this event allows
3363 an application to cater for unexpected capture releases which
3364 might otherwise confuse mouse handling code.
3368 @beginEventTable{wxMouseCaptureChangedEvent}
3369 @event{EVT_MOUSE_CAPTURE_CHANGED(func)}
3370 Process a @c wxEVT_MOUSE_CAPTURE_CHANGED event.
3376 @see wxMouseCaptureLostEvent, @ref overview_events,
3377 wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
3379 class wxMouseCaptureChangedEvent
: public wxEvent
3385 wxMouseCaptureChangedEvent(wxWindowID windowId
= 0,
3386 wxWindow
* gainedCapture
= NULL
);
3389 Returns the window that gained the capture, or @NULL if it was a
3390 non-wxWidgets window.
3392 wxWindow
* GetCapturedWindow() const;
3400 This event class contains information about window and session close events.
3402 The handler function for EVT_CLOSE is called when the user has tried to close a
3403 a frame or dialog box using the window manager (X) or system menu (Windows).
3404 It can also be invoked by the application itself programmatically, for example by
3405 calling the wxWindow::Close function.
3407 You should check whether the application is forcing the deletion of the window
3408 using wxCloseEvent::CanVeto. If this is @false, you @e must destroy the window
3409 using wxWindow::Destroy.
3411 If the return value is @true, it is up to you whether you respond by destroying
3414 If you don't destroy the window, you should call wxCloseEvent::Veto to
3415 let the calling code know that you did not destroy the window.
3416 This allows the wxWindow::Close function to return @true or @false depending
3417 on whether the close instruction was honoured or not.
3419 Example of a wxCloseEvent handler:
3422 void MyFrame::OnClose(wxCloseEvent& event)
3424 if ( event.CanVeto() && m_bFileNotSaved )
3426 if ( wxMessageBox("The file has not been saved... continue closing?",
3428 wxICON_QUESTION | wxYES_NO) != wxYES )
3435 Destroy(); // you may also do: event.Skip();
3436 // since the default event handler does call Destroy(), too
3440 The EVT_END_SESSION event is slightly different as it is sent by the system
3441 when the user session is ending (e.g. because of log out or shutdown) and
3442 so all windows are being forcefully closed. At least under MSW, after the
3443 handler for this event is executed the program is simply killed by the
3444 system. Because of this, the default handler for this event provided by
3445 wxWidgets calls all the usual cleanup code (including wxApp::OnExit()) so
3446 that it could still be executed and exit()s the process itself, without
3447 waiting for being killed. If this behaviour is for some reason undesirable,
3448 make sure that you define a handler for this event in your wxApp-derived
3449 class and do not call @c event.Skip() in it (but be aware that the system
3450 will still kill your application).
3452 @beginEventTable{wxCloseEvent}
3453 @event{EVT_CLOSE(func)}
3454 Process a @c wxEVT_CLOSE_WINDOW command event, supplying the member function.
3455 This event applies to wxFrame and wxDialog classes.
3456 @event{EVT_QUERY_END_SESSION(func)}
3457 Process a @c wxEVT_QUERY_END_SESSION session event, supplying the member function.
3458 This event can be handled in wxApp-derived class only.
3459 @event{EVT_END_SESSION(func)}
3460 Process a @c wxEVT_END_SESSION session event, supplying the member function.
3461 This event can be handled in wxApp-derived class only.
3467 @see wxWindow::Close, @ref overview_windowdeletion
3469 class wxCloseEvent
: public wxEvent
3475 wxCloseEvent(wxEventType commandEventType
= wxEVT_NULL
, int id
= 0);
3478 Returns @true if you can veto a system shutdown or a window close event.
3479 Vetoing a window close event is not possible if the calling code wishes to
3480 force the application to exit, and so this function must be called to check this.
3482 bool CanVeto() const;
3485 Returns @true if the user is just logging off or @false if the system is
3486 shutting down. This method can only be called for end session and query end
3487 session events, it doesn't make sense for close window event.
3489 bool GetLoggingOff() const;
3492 Sets the 'can veto' flag.
3494 void SetCanVeto(bool canVeto
);
3497 Sets the 'logging off' flag.
3499 void SetLoggingOff(bool loggingOff
);
3502 Call this from your event handler to veto a system shutdown or to signal
3503 to the calling application that a window close did not happen.
3505 You can only veto a shutdown if CanVeto() returns @true.
3507 void Veto(bool veto
= true);
3515 This class is used for a variety of menu-related events. Note that
3516 these do not include menu command events, which are
3517 handled using wxCommandEvent objects.
3519 The default handler for @c wxEVT_MENU_HIGHLIGHT displays help
3520 text in the first field of the status bar.
3522 @beginEventTable{wxMenuEvent}
3523 @event{EVT_MENU_OPEN(func)}
3524 A menu is about to be opened. On Windows, this is only sent once for each
3525 navigation of the menubar (up until all menus have closed).
3526 @event{EVT_MENU_CLOSE(func)}
3527 A menu has been just closed.
3528 @event{EVT_MENU_HIGHLIGHT(id, func)}
3529 The menu item with the specified id has been highlighted: used to show
3530 help prompts in the status bar by wxFrame
3531 @event{EVT_MENU_HIGHLIGHT_ALL(func)}
3532 A menu item has been highlighted, i.e. the currently selected menu item has changed.
3538 @see wxCommandEvent, @ref overview_events
3540 class wxMenuEvent
: public wxEvent
3546 wxMenuEvent(wxEventType id
= wxEVT_NULL
, int id
= 0, wxMenu
* menu
= NULL
);
3549 Returns the menu which is being opened or closed. This method should only be
3550 used with the @c OPEN and @c CLOSE events and even for them the
3551 returned pointer may be @NULL in some ports.
3553 wxMenu
* GetMenu() const;
3556 Returns the menu identifier associated with the event.
3557 This method should be only used with the @c HIGHLIGHT events.
3559 int GetMenuId() const;
3562 Returns @true if the menu which is being opened or closed is a popup menu,
3563 @false if it is a normal one.
3565 This method should only be used with the @c OPEN and @c CLOSE events.
3567 bool IsPopup() const;
3573 An event being sent when the window is shown or hidden.
3575 Currently only wxMSW, wxGTK and wxOS2 generate such events.
3577 @onlyfor{wxmsw,wxgtk,wxos2}
3579 @beginEventTable{wxShowEvent}
3580 @event{EVT_SHOW(func)}
3581 Process a @c wxEVT_SHOW event.
3587 @see @ref overview_events, wxWindow::Show,
3591 class wxShowEvent
: public wxEvent
3597 wxShowEvent(int winid
= 0, bool show
= false);
3600 Set whether the windows was shown or hidden.
3602 void SetShow(bool show
);
3605 Return @true if the window has been shown, @false if it has been
3608 bool IsShown() const;
3611 @deprecated This function is deprecated in favour of IsShown().
3613 bool GetShow() const;
3619 @class wxIconizeEvent
3621 An event being sent when the frame is iconized (minimized) or restored.
3623 Currently only wxMSW and wxGTK generate such events.
3625 @onlyfor{wxmsw,wxgtk}
3627 @beginEventTable{wxIconizeEvent}
3628 @event{EVT_ICONIZE(func)}
3629 Process a @c wxEVT_ICONIZE event.
3635 @see @ref overview_events, wxTopLevelWindow::Iconize,
3636 wxTopLevelWindow::IsIconized
3638 class wxIconizeEvent
: public wxEvent
3644 wxIconizeEvent(int id
= 0, bool iconized
= true);
3647 Returns @true if the frame has been iconized, @false if it has been
3650 bool IsIconized() const;
3653 @deprecated This function is deprecated in favour of IsIconized().
3655 bool Iconized() const;
3663 A move event holds information about wxTopLevelWindow move change events.
3665 @beginEventTable{wxMoveEvent}
3666 @event{EVT_MOVE(func)}
3667 Process a @c wxEVT_MOVE event, which is generated when a window is moved.
3668 @event{EVT_MOVE_START(func)}
3669 Process a @c wxEVT_MOVE_START event, which is generated when the user starts
3670 to move or size a window. wxMSW only.
3671 @event{EVT_MOVE_END(func)}
3672 Process a @c wxEVT_MOVE_END event, which is generated when the user stops
3673 moving or sizing a window. wxMSW only.
3679 @see wxPoint, @ref overview_events
3681 class wxMoveEvent
: public wxEvent
3687 wxMoveEvent(const wxPoint
& pt
, int id
= 0);
3690 Returns the position of the window generating the move change event.
3692 wxPoint
GetPosition() const;
3699 A size event holds information about size change events of wxWindow.
3701 The EVT_SIZE handler function will be called when the window has been resized.
3703 You may wish to use this for frames to resize their child windows as appropriate.
3705 Note that the size passed is of the whole window: call wxWindow::GetClientSize()
3706 for the area which may be used by the application.
3708 When a window is resized, usually only a small part of the window is damaged
3709 and you may only need to repaint that area. However, if your drawing depends on the
3710 size of the window, you may need to clear the DC explicitly and repaint the whole window.
3711 In which case, you may need to call wxWindow::Refresh to invalidate the entire window.
3713 @beginEventTable{wxSizeEvent}
3714 @event{EVT_SIZE(func)}
3715 Process a @c wxEVT_SIZE event.
3721 @see wxSize, @ref overview_events
3723 class wxSizeEvent
: public wxEvent
3729 wxSizeEvent(const wxSize
& sz
, int id
= 0);
3732 Returns the entire size of the window generating the size change event.
3734 This is the new total size of the window, i.e. the same size as would
3735 be returned by wxWindow::GetSize() if it were called now. Use
3736 wxWindow::GetClientSize() if you catch this event in a top level window
3737 such as wxFrame to find the size available for the window contents.
3739 wxSize
GetSize() const;
3745 @class wxSetCursorEvent
3747 A wxSetCursorEvent is generated from wxWindow when the mouse cursor is about
3748 to be set as a result of mouse motion.
3750 This event gives the application the chance to perform specific mouse cursor
3751 processing based on the current position of the mouse within the window.
3752 Use wxSetCursorEvent::SetCursor to specify the cursor you want to be displayed.
3754 @beginEventTable{wxSetCursorEvent}
3755 @event{EVT_SET_CURSOR(func)}
3756 Process a @c wxEVT_SET_CURSOR event.
3762 @see ::wxSetCursor, wxWindow::wxSetCursor
3764 class wxSetCursorEvent
: public wxEvent
3768 Constructor, used by the library itself internally to initialize the event
3771 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0);
3774 Returns a reference to the cursor specified by this event.
3776 const wxCursor
& GetCursor() const;
3779 Returns the X coordinate of the mouse in client coordinates.
3781 wxCoord
GetX() const;
3784 Returns the Y coordinate of the mouse in client coordinates.
3786 wxCoord
GetY() const;
3789 Returns @true if the cursor specified by this event is a valid cursor.
3791 @remarks You cannot specify wxNullCursor with this event, as it is not
3792 considered a valid cursor.
3794 bool HasCursor() const;
3797 Sets the cursor associated with this event.
3799 void SetCursor(const wxCursor
& cursor
);
3804 // ============================================================================
3805 // Global functions/macros
3806 // ============================================================================
3808 /** @addtogroup group_funcmacro_events */
3812 A value uniquely identifying the type of the event.
3814 The values of this type should only be created using wxNewEventType().
3816 See the macro DEFINE_EVENT_TYPE() for more info.
3818 @see @ref overview_events_introduction
3820 typedef int wxEventType
;
3823 A special event type usually used to indicate that some wxEvent has yet
3826 wxEventType wxEVT_NULL
;
3829 Initializes a new event type using wxNewEventType().
3831 @deprecated Use wxDEFINE_EVENT() instead
3833 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
3836 Generates a new unique event type.
3838 Usually this function is only used by wxDEFINE_EVENT() and not called
3841 wxEventType
wxNewEventType();
3844 Define a new event type associated with the specified event class.
3846 This macro defines a new unique event type @a name associated with the
3851 wxDEFINE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
3853 class MyCustomEvent : public wxEvent { ... };
3854 wxDEFINE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
3857 @see wxDECLARE_EVENT(), @ref overview_events_custom
3859 #define wxDEFINE_EVENT(name, cls) \
3860 const wxEventTypeTag< cls > name(wxNewEventType())
3863 Declares a custom event type.
3865 This macro declares a variable called @a name which must be defined
3866 elsewhere using wxDEFINE_EVENT().
3868 The class @a cls must be the wxEvent-derived class associated with the
3869 events of this type and its full declaration must be visible from the point
3870 of use of this macro.
3874 wxDECLARE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
3876 class MyCustomEvent : public wxEvent { ... };
3877 wxDECLARE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
3880 #define wxDECLARE_EVENT(name, cls) \
3881 wxDECLARE_EXPORTED_EVENT(wxEMPTY_PARAMETER_VALUE, name, cls)
3884 Variant of wxDECLARE_EVENT() used for event types defined inside a shared
3887 This is mostly used by wxWidgets internally, e.g.
3889 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent)
3892 #define wxDECLARE_EXPORTED_EVENT( expdecl, name, cls ) \
3893 extern const expdecl wxEventTypeTag< cls > name;
3896 Helper macro for definition of custom event table macros.
3898 This macro must only be used if wxEVENTS_COMPATIBILITY_2_8 is 1, otherwise
3899 it is better and more clear to just use the address of the function
3900 directly as this is all this macro does in this case. However it needs to
3901 explicitly cast @a func to @a functype, which is the type of wxEvtHandler
3902 member function taking the custom event argument when
3903 wxEVENTS_COMPATIBILITY_2_8 is 0.
3905 See wx__DECLARE_EVT0 for an example of use.
3907 @see @ref overview_events_custom_ownclass
3909 #define wxEVENT_HANDLER_CAST(functype, func) (&func)
3912 This macro is used to define event table macros for handling custom
3917 class MyEvent : public wxEvent { ... };
3919 // note that this is not necessary unless using old compilers: for the
3920 // reasonably new ones just use &func instead of MyEventHandler(func)
3921 typedef void (wxEvtHandler::*MyEventFunction)(MyEvent&);
3922 #define MyEventHandler(func) wxEVENT_HANDLER_CAST(MyEventFunction, func)
3924 wxDEFINE_EVENT(MY_EVENT_TYPE, MyEvent);
3926 #define EVT_MY(id, func) \
3927 wx__DECLARE_EVT1(MY_EVENT_TYPE, id, MyEventHandler(func))
3931 BEGIN_EVENT_TABLE(MyFrame, wxFrame)
3932 EVT_MY(wxID_ANY, MyFrame::OnMyEvent)
3937 The event type to handle.
3939 The identifier of events to handle.
3941 The event handler method.
3943 #define wx__DECLARE_EVT1(evt, id, fn) \
3944 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
3947 Generalized version of the wx__DECLARE_EVT1() macro taking a range of
3948 IDs instead of a single one.
3949 Argument @a id1 is the first identifier of the range, @a id2 is the
3950 second identifier of the range.
3952 #define wx__DECLARE_EVT2(evt, id1, id2, fn) \
3953 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
3956 Simplified version of the wx__DECLARE_EVT1() macro, to be used when the
3957 event type must be handled regardless of the ID associated with the
3958 specific event instances.
3960 #define wx__DECLARE_EVT0(evt, fn) \
3961 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
3965 Use this macro inside a class declaration to declare a @e static event table
3968 In the implementation file you'll need to use the BEGIN_EVENT_TABLE()
3969 and the END_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro
3972 @see @ref overview_events_eventtables
3974 #define DECLARE_EVENT_TABLE()
3977 Use this macro in a source file to start listing @e static event handlers
3978 for a specific class.
3980 Use END_EVENT_TABLE() to terminate the event-declaration block.
3982 @see @ref overview_events_eventtables
3984 #define BEGIN_EVENT_TABLE(theClass, baseClass)
3987 Use this macro in a source file to end listing @e static event handlers
3988 for a specific class.
3990 Use BEGIN_EVENT_TABLE() to start the event-declaration block.
3992 @see @ref overview_events_eventtables
3994 #define END_EVENT_TABLE()
3997 In a GUI application, this function posts @a event to the specified @e dest
3998 object using wxEvtHandler::AddPendingEvent().
4000 Otherwise, it dispatches @a event immediately using
4001 wxEvtHandler::ProcessEvent(). See the respective documentation for details
4002 (and caveats). Because of limitation of wxEvtHandler::AddPendingEvent()
4003 this function is not thread-safe for event objects having wxString fields,
4004 use wxQueueEvent() instead.
4008 void wxPostEvent(wxEvtHandler
* dest
, const wxEvent
& event
);
4011 Queue an event for processing on the given object.
4013 This is a wrapper around wxEvtHandler::QueueEvent(), see its documentation
4019 The object to queue the event on, can't be @c NULL.
4021 The heap-allocated and non-@c NULL event to queue, the function takes
4024 void wxQueueEvent(wxEvtHandler
* dest
, wxEvent
*event
);