1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxEvtHandler, wxEventBlocker and many
4 // wxEvent-derived classes
5 // Author: wxWidgets team
7 // Licence: wxWindows license
8 /////////////////////////////////////////////////////////////////////////////
14 An event is a structure holding information about an event passed to a
15 callback or member function.
17 wxEvent used to be a multipurpose event object, and is an abstract base class
18 for other event classes (see below).
20 For more information about events, see the @ref overview_eventhandling overview.
23 In wxPerl custom event classes should be derived from
24 @c Wx::PlEvent and @c Wx::PlCommandEvent.
30 @see wxCommandEvent, wxMouseEvent
32 class wxEvent
: public wxObject
38 Notice that events are usually created by wxWidgets itself and creating
39 e.g. a wxPaintEvent in your code and sending it to e.g. a wxTextCtrl
40 will not usually affect it at all as native controls have no specific
41 knowledge about wxWidgets events. However you may construct objects of
42 specific types and pass them to wxEvtHandler::ProcessEvent() if you
43 want to create your own custom control and want to process its events
44 in the same manner as the standard ones.
46 Also please notice that the order of parameters in this constructor is
47 different from almost all the derived classes which specify the event
48 type as the first argument.
51 The identifier of the object (window, timer, ...) which generated
54 The unique type of event, e.g. wxEVT_PAINT, wxEVT_SIZE or
55 wxEVT_COMMAND_BUTTON_CLICKED.
57 wxEvent(int id
= 0, wxEventType eventType
= wxEVT_NULL
);
60 Returns a copy of the event.
62 Any event that is posted to the wxWidgets event system for later action
63 (via wxEvtHandler::AddPendingEvent or wxPostEvent()) must implement
66 All wxWidgets events fully implement this method, but any derived events
67 implemented by the user should also implement this method just in case they
68 (or some event derived from them) are ever posted.
70 All wxWidgets events implement a copy constructor, so the easiest way of
71 implementing the Clone function is to implement a copy constructor for
72 a new event (call it MyEvent) and then define the Clone function like this:
75 wxEvent *Clone() const { return new MyEvent(*this); }
78 virtual wxEvent
* Clone() const = 0;
81 Returns the object (usually a window) associated with the event, if any.
83 wxObject
* GetEventObject() const;
86 Returns the identifier of the given event type, such as @c wxEVT_COMMAND_BUTTON_CLICKED.
88 wxEventType
GetEventType() const;
91 Returns the identifier associated with this event, such as a button command id.
96 Returns @true if the event handler should be skipped, @false otherwise.
98 bool GetSkipped() const;
101 Gets the timestamp for the event. The timestamp is the time in milliseconds
102 since some fixed moment (not necessarily the standard Unix Epoch, so only
103 differences between the timestamps and not their absolute values usually make sense).
106 wxWidgets returns a non-NULL timestamp only for mouse and key events
107 (see wxMouseEvent and wxKeyEvent).
109 long GetTimestamp() const;
112 Returns @true if the event is or is derived from wxCommandEvent else it returns @false.
114 @note exists only for optimization purposes.
116 bool IsCommandEvent() const;
119 Sets the propagation level to the given value (for example returned from an
120 earlier call to wxEvent::StopPropagation).
122 void ResumePropagation(int propagationLevel
);
125 Sets the originating object.
127 void SetEventObject(wxObject
* object
);
132 void SetEventType(wxEventType type
);
135 Sets the identifier associated with this event, such as a button command id.
140 Sets the timestamp for the event.
142 void SetTimestamp(long timeStamp
= 0);
145 Test if this event should be propagated or not, i.e. if the propagation level
146 is currently greater than 0.
148 bool ShouldPropagate() const;
151 This method can be used inside an event handler to control whether further
152 event handlers bound to this event will be called after the current one returns.
154 Without Skip() (or equivalently if Skip(@false) is used), the event will not
155 be processed any more. If Skip(@true) is called, the event processing system
156 continues searching for a further handler function for this event, even though
157 it has been processed already in the current handler.
159 In general, it is recommended to skip all non-command events to allow the
160 default handling to take place. The command events are, however, normally not
161 skipped as usually a single command such as a button click or menu item
162 selection must only be processed by one handler.
164 void Skip(bool skip
= true);
167 Stop the event from propagating to its parent window.
169 Returns the old propagation level value which may be later passed to
170 ResumePropagation() to allow propagating the event again.
172 int StopPropagation();
176 Indicates how many levels the event can propagate.
178 This member is protected and should typically only be set in the constructors
179 of the derived classes. It may be temporarily changed by StopPropagation()
180 and ResumePropagation() and tested with ShouldPropagate().
182 The initial value is set to either @c wxEVENT_PROPAGATE_NONE (by default)
183 meaning that the event shouldn't be propagated at all or to
184 @c wxEVENT_PROPAGATE_MAX (for command events) meaning that it should be
185 propagated as much as necessary.
187 Any positive number means that the event should be propagated but no more than
188 the given number of times. E.g. the propagation level may be set to 1 to
189 propagate the event to its parent only, but not to its grandparent.
191 int m_propagationLevel
;
195 @class wxEventBlocker
197 This class is a special event handler which allows to discard
198 any event (or a set of event types) directed to a specific window.
203 void MyWindow::DoSomething()
206 // block all events directed to this window while
207 // we do the 1000 FunctionWhichSendsEvents() calls
208 wxEventBlocker blocker(this);
210 for ( int i = 0; i 1000; i++ )
211 FunctionWhichSendsEvents(i);
213 } // ~wxEventBlocker called, old event handler is restored
215 // the event generated by this call will be processed:
216 FunctionWhichSendsEvents(0)
223 @see @ref overview_eventhandling, wxEvtHandler
225 class wxEventBlocker
: public wxEvtHandler
229 Constructs the blocker for the given window and for the given event type.
231 If @a type is @c wxEVT_ANY, then all events for that window are blocked.
232 You can call Block() after creation to add other event types to the list
235 Note that the @a win window @b must remain alive until the
236 wxEventBlocker object destruction.
238 wxEventBlocker(wxWindow
* win
, wxEventType type
= -1);
241 Destructor. The blocker will remove itself from the chain of event handlers for
242 the window provided in the constructor, thus restoring normal processing of events.
244 virtual ~wxEventBlocker();
247 Adds to the list of event types which should be blocked the given @a eventType.
249 void Block(wxEventType eventType
);
257 A class that can handle events from the windowing system.
258 wxWindow is (and therefore all window classes are) derived from this class.
260 When events are received, wxEvtHandler invokes the method listed in the
261 event table using itself as the object. When using multiple inheritance
262 <b>it is imperative that the wxEvtHandler(-derived) class is the first
263 class inherited</b> such that the @c this pointer for the overall object
264 will be identical to the @c this pointer of the wxEvtHandler portion.
269 @see @ref overview_eventhandling
271 class wxEvtHandler
: public wxObject
282 If the handler is part of a chain, the destructor will unlink itself and
283 restore the previous and next handlers so that they point to each other.
285 virtual ~wxEvtHandler();
288 Queue event for a later processing.
290 This method is similar to ProcessEvent() but while the latter is
291 synchronous, i.e. the event is processed immediately, before the
292 function returns, this one is asynchronous and returns immediately
293 while the event will be processed at some later time (usually during
294 the next event loop iteration).
296 Another important difference is that this method takes ownership of the
297 @a event parameter, i.e. it will delete it itself. This implies that
298 the event should be allocated on the heap and that the pointer can't be
299 used any more after the function returns (as it can be deleted at any
302 QueueEvent() can be used for inter-thread communication from the worker
303 threads to the main thread, it is safe in the sense that it uses
304 locking internally and avoids the problem mentioned in AddPendingEvent()
305 documentation by ensuring that the @a event object is not used by the
306 calling thread any more. Care should still be taken to avoid that some
307 fields of this object are used by it, notably any wxString members of
308 the event object must not be shallow copies of another wxString object
309 as this would result in them still using the same string buffer behind
310 the scenes. For example
312 void FunctionInAWorkerThread(const wxString& str)
314 wxCommandEvent* evt = new wxCommandEvent;
316 // NOT evt->SetString(str) as this would be a shallow copy
317 evt->SetString(str.c_str()); // make a deep copy
319 wxTheApp->QueueEvent( evt );
323 Finally notice that this method automatically wakes up the event loop
324 if it is currently idle by calling ::wxWakeUpIdle() so there is no need
325 to do it manually when using it.
330 A heap-allocated event to be queued, QueueEvent() takes ownership
331 of it. This parameter shouldn't be @c NULL.
333 virtual void QueueEvent(wxEvent
*event
);
336 Post an event to be processed later.
338 This function is similar to QueueEvent() but can't be used to post
339 events from worker threads for the event objects with wxString fields
340 (i.e. in practice most of them) because of an unsafe use of the same
341 wxString object which happens because the wxString field in the
342 original @a event object and its copy made internally by this function
343 share the same string buffer internally. Use QueueEvent() to avoid
346 A copy of @a event is made by the function, so the original can be deleted
347 as soon as function returns (it is common that the original is created
348 on the stack). This requires that the wxEvent::Clone() method be
349 implemented by event so that it can be duplicated and stored until it
353 Event to add to the pending events queue.
355 virtual void AddPendingEvent(const wxEvent
& event
);
358 Connects the given function dynamically with the event handler, id and event type.
359 This is an alternative to the use of static event tables.
361 See the @ref page_samples_event sample for usage.
363 This specific overload allows you to connect an event handler to a @e range
365 Do not confuse @e source IDs with event @e types: source IDs identify the
366 event generator objects (typically wxMenuItem or wxWindow objects) while the
367 event @e type identify which type of events should be handled by the
368 given @e function (an event generator object may generate many different
372 The first ID of the identifier range to be associated with the event
375 The last ID of the identifier range to be associated with the event
378 The event type to be associated with this event handler.
380 The event handler function. Note that this function should
381 be explicitly converted to the correct type which can be done using a macro
382 called @c wxFooEventHandler for the handler for any @c wxFooEvent.
384 Data to be associated with the event table entry.
386 Object whose member function should be called.
387 If this is @NULL, @c *this will be used.
389 void Connect(int id
, int lastId
, wxEventType eventType
,
390 wxObjectEventFunction function
,
391 wxObject
* userData
= NULL
,
392 wxEvtHandler
* eventSink
= NULL
);
395 See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
396 overload for more info.
398 This overload can be used to attach an event handler to a single source ID:
402 frame->Connect( wxID_EXIT,
403 wxEVT_COMMAND_MENU_SELECTED,
404 wxCommandEventHandler(MyFrame::OnQuit) );
407 void Connect(int id
, wxEventType eventType
,
408 wxObjectEventFunction function
,
409 wxObject
* userData
= NULL
,
410 wxEvtHandler
* eventSink
= NULL
);
413 See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
414 overload for more info.
416 This overload will connect the given event handler so that regardless of the
417 ID of the event source, the handler will be called.
419 void Connect(wxEventType eventType
,
420 wxObjectEventFunction function
,
421 wxObject
* userData
= NULL
,
422 wxEvtHandler
* eventSink
= NULL
);
425 Disconnects the given function dynamically from the event handler, using the
426 specified parameters as search criteria and returning @true if a matching
427 function has been found and removed.
429 This method can only disconnect functions which have been added using the
430 Connect() method. There is no way to disconnect functions connected using
431 the (static) event tables.
434 The event type associated with this event handler.
436 The event handler function.
438 Data associated with the event table entry.
440 Object whose member function should be called.
442 bool Disconnect(wxEventType eventType
,
443 wxObjectEventFunction function
,
444 wxObject
* userData
= NULL
,
445 wxEvtHandler
* eventSink
= NULL
);
448 See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
449 overload for more info.
451 This overload takes the additional @a id parameter.
453 bool Disconnect(int id
= wxID_ANY
,
454 wxEventType eventType
= wxEVT_NULL
,
455 wxObjectEventFunction function
= NULL
,
456 wxObject
* userData
= NULL
,
457 wxEvtHandler
* eventSink
= NULL
);
460 See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
461 overload for more info.
463 This overload takes an additional range of source IDs.
465 bool Disconnect(int id
, int lastId
,
466 wxEventType eventType
,
467 wxObjectEventFunction function
= NULL
,
468 wxObject
* userData
= NULL
,
469 wxEvtHandler
* eventSink
= NULL
);
472 Returns user-supplied client data.
474 @remarks Normally, any extra data the programmer wishes to associate with
475 the object should be made available by deriving a new class with
480 void* GetClientData() const;
483 Returns a pointer to the user-supplied client data object.
485 @see SetClientObject(), wxClientData
487 wxClientData
* GetClientObject() const;
490 Returns @true if the event handler is enabled, @false otherwise.
492 @see SetEvtHandlerEnabled()
494 bool GetEvtHandlerEnabled() const;
497 Returns the pointer to the next handler in the chain.
499 @see SetNextHandler(), GetPreviousHandler(), SetPreviousHandler(),
500 wxWindow::PushEventHandler, wxWindow::PopEventHandler
502 wxEvtHandler
* GetNextHandler() const;
505 Returns the pointer to the previous handler in the chain.
507 @see SetPreviousHandler(), GetNextHandler(), SetNextHandler(),
508 wxWindow::PushEventHandler, wxWindow::PopEventHandler
510 wxEvtHandler
* GetPreviousHandler() const;
513 Processes an event, searching event tables and calling zero or more suitable
514 event handler function(s).
516 Normally, your application would not call this function: it is called in the
517 wxWidgets implementation to dispatch incoming user interface events to the
518 framework (and application).
520 However, you might need to call it if implementing new functionality
521 (such as a new control) where you define new event types, as opposed to
522 allowing the user to override virtual functions.
524 An instance where you might actually override the ProcessEvent() function is where
525 you want to direct event processing to event handlers not normally noticed by
526 wxWidgets. For example, in the document/view architecture, documents and views
527 are potential event handlers. When an event reaches a frame, ProcessEvent() will
528 need to be called on the associated document and view in case event handler functions
529 are associated with these objects. The property classes library (wxProperty) also
530 overrides ProcessEvent() for similar reasons.
532 The normal order of event table searching is as follows:
533 -# If the object is disabled (via a call to wxEvtHandler::SetEvtHandlerEnabled)
534 the function skips to step (6).
535 -# If the object is a wxWindow, ProcessEvent() is recursively called on the
536 window's wxValidator. If this returns @true, the function exits.
537 -# SearchEventTable() is called for this event handler. If this fails, the base
538 class table is tried, and so on until no more tables exist or an appropriate
539 function was found, in which case the function exits.
540 -# The search is applied down the entire chain of event handlers (usually the
541 chain has a length of one). If this succeeds, the function exits.
542 -# If the object is a wxWindow and the event is a wxCommandEvent, ProcessEvent()
543 is recursively applied to the parent window's event handler.
544 If this returns true, the function exits.
545 -# Finally, ProcessEvent() is called on the wxApp object.
550 @return @true if a suitable event handler function was found and
551 executed, and the function did not call wxEvent::Skip.
553 @see SearchEventTable()
555 virtual bool ProcessEvent(wxEvent
& event
);
558 Processes an event by calling ProcessEvent() and handles any exceptions
559 that occur in the process.
560 If an exception is thrown in event handler, wxApp::OnExceptionInMainLoop is called.
565 @return @true if the event was processed, @false if no handler was found
566 or an exception was thrown.
568 @see wxWindow::HandleWindowEvent
570 bool SafelyProcessEvent(wxEvent
& event
);
573 Searches the event table, executing an event handler function if an appropriate
577 Event table to be searched.
579 Event to be matched against an event table entry.
581 @return @true if a suitable event handler function was found and
582 executed, and the function did not call wxEvent::Skip.
584 @remarks This function looks through the object's event table and tries
585 to find an entry that will match the event.
586 An entry will match if:
587 @li The event type matches, and
588 @li the identifier or identifier range matches, or the event table
589 entry's identifier is zero.
591 If a suitable function is called but calls wxEvent::Skip, this
592 function will fail, and searching will continue.
596 virtual bool SearchEventTable(wxEventTable
& table
,
600 Sets user-supplied client data.
603 Data to be associated with the event handler.
605 @remarks Normally, any extra data the programmer wishes to associate
606 with the object should be made available by deriving a new
607 class with new data members. You must not call this method
608 and SetClientObject on the same class - only one of them.
612 void SetClientData(void* data
);
615 Set the client data object. Any previous object will be deleted.
617 @see GetClientObject(), wxClientData
619 void SetClientObject(wxClientData
* data
);
622 Enables or disables the event handler.
625 @true if the event handler is to be enabled, @false if it is to be disabled.
627 @remarks You can use this function to avoid having to remove the event
628 handler from the chain, for example when implementing a
629 dialog editor and changing from edit to test mode.
631 @see GetEvtHandlerEnabled()
633 void SetEvtHandlerEnabled(bool enabled
);
636 Sets the pointer to the next handler.
639 Event handler to be set as the next handler.
641 @see GetNextHandler(), SetPreviousHandler(), GetPreviousHandler(),
642 wxWindow::PushEventHandler, wxWindow::PopEventHandler
644 void SetNextHandler(wxEvtHandler
* handler
);
647 Sets the pointer to the previous handler.
650 Event handler to be set as the previous handler.
652 void SetPreviousHandler(wxEvtHandler
* handler
);
659 This event class contains information about keypress (character) events.
661 Notice that there are three different kinds of keyboard events in wxWidgets:
662 key down and up events and char events. The difference between the first two
663 is clear - the first corresponds to a key press and the second to a key
664 release - otherwise they are identical. Just note that if the key is
665 maintained in a pressed state you will typically get a lot of (automatically
666 generated) down events but only one up so it is wrong to assume that there is
667 one up event corresponding to each down one.
669 Both key events provide untranslated key codes while the char event carries
670 the translated one. The untranslated code for alphanumeric keys is always
671 an upper case value. For the other keys it is one of @c WXK_XXX values
672 from the @ref page_keycodes.
673 The translated key is, in general, the character the user expects to appear
674 as the result of the key combination when typing the text into a text entry
677 A few examples to clarify this (all assume that CAPS LOCK is unpressed
678 and the standard US keyboard): when the @c 'A' key is pressed, the key down
679 event key code is equal to @c ASCII A == 65. But the char event key code
680 is @c ASCII a == 97. On the other hand, if you press both SHIFT and
681 @c 'A' keys simultaneously , the key code in key down event will still be
682 just @c 'A' while the char event key code parameter will now be @c 'A'
685 Although in this simple case it is clear that the correct key code could be
686 found in the key down event handler by checking the value returned by
687 wxKeyEvent::ShiftDown(), in general you should use @c EVT_CHAR for this as
688 for non-alphanumeric keys the translation is keyboard-layout dependent and
689 can only be done properly by the system itself.
691 Another kind of translation is done when the control key is pressed: for
692 example, for CTRL-A key press the key down event still carries the
693 same key code @c 'a' as usual but the char event will have key code of 1,
694 the ASCII value of this key combination.
696 You may discover how the other keys on your system behave interactively by
697 running the @ref page_samples_text wxWidgets sample and pressing some keys
698 in any of the text controls shown in it.
700 @b Tip: be sure to call @c event.Skip() for events that you don't process in
701 key event function, otherwise menu shortcuts may cease to work under Windows.
703 @note If a key down (@c EVT_KEY_DOWN) event is caught and the event handler
704 does not call @c event.Skip() then the corresponding char event
705 (@c EVT_CHAR) will not happen.
706 This is by design and enables the programs that handle both types of
707 events to be a bit simpler.
709 @note For Windows programmers: The key and char events in wxWidgets are
710 similar to but slightly different from Windows @c WM_KEYDOWN and
711 @c WM_CHAR events. In particular, Alt-x combination will generate a
712 char event in wxWidgets (unless it is used as an accelerator).
715 @beginEventTable{wxKeyEvent}
716 @event{EVT_KEY_DOWN(func)}
717 Process a wxEVT_KEY_DOWN event (any key has been pressed).
718 @event{EVT_KEY_UP(func)}
719 Process a wxEVT_KEY_UP event (any key has been released).
720 @event{EVT_CHAR(func)}
721 Process a wxEVT_CHAR event.
729 class wxKeyEvent
: public wxEvent
,
730 public wxKeyboardState
735 Currently, the only valid event types are @c wxEVT_CHAR and @c wxEVT_CHAR_HOOK.
737 wxKeyEvent(wxEventType keyEventType
= wxEVT_NULL
);
740 Returns the virtual key code. ASCII events return normal ASCII values,
741 while non-ASCII events return values such as @b WXK_LEFT for the left cursor
742 key. See @ref page_keycodes for a full list of the virtual key codes.
744 Note that in Unicode build, the returned value is meaningful only if the
745 user entered a character that can be represented in current locale's default
746 charset. You can obtain the corresponding Unicode character using GetUnicodeKey().
748 int GetKeyCode() const;
752 Obtains the position (in client coordinates) at which the key was pressed.
754 wxPoint
GetPosition() const;
755 void GetPosition(long* x
, long* y
) const;
759 Returns the raw key code for this event. This is a platform-dependent scan code
760 which should only be used in advanced applications.
762 @note Currently the raw key codes are not supported by all ports, use
763 @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
765 wxUint32
GetRawKeyCode() const;
768 Returns the low level key flags for this event. The flags are
769 platform-dependent and should only be used in advanced applications.
771 @note Currently the raw key flags are not supported by all ports, use
772 @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
774 wxUint32
GetRawKeyFlags() const;
777 Returns the Unicode character corresponding to this key event.
779 This function is only available in Unicode build, i.e. when
780 @c wxUSE_UNICODE is 1.
782 wxChar
GetUnicodeKey() const;
785 Returns the X position (in client coordinates) of the event.
787 wxCoord
GetX() const;
790 Returns the Y position (in client coordinates) of the event.
792 wxCoord
GetY() const;
798 @class wxJoystickEvent
800 This event class contains information about joystick events, particularly
801 events received by windows.
803 @beginEventTable{wxJoystickEvent}
804 @style{EVT_JOY_BUTTON_DOWN(func)}
805 Process a wxEVT_JOY_BUTTON_DOWN event.
806 @style{EVT_JOY_BUTTON_UP(func)}
807 Process a wxEVT_JOY_BUTTON_UP event.
808 @style{EVT_JOY_MOVE(func)}
809 Process a wxEVT_JOY_MOVE event.
810 @style{EVT_JOY_ZMOVE(func)}
811 Process a wxEVT_JOY_ZMOVE event.
812 @style{EVT_JOYSTICK_EVENTS(func)}
813 Processes all joystick events.
821 class wxJoystickEvent
: public wxEvent
827 wxJoystickEvent(wxEventType eventType
= wxEVT_NULL
, int state
= 0,
828 int joystick
= wxJOYSTICK1
,
832 Returns @true if the event was a down event from the specified button
836 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
837 indicate any button down event.
839 bool ButtonDown(int button
= wxJOY_BUTTON_ANY
) const;
842 Returns @true if the specified button (or any button) was in a down state.
845 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
846 indicate any button down event.
848 bool ButtonIsDown(int button
= wxJOY_BUTTON_ANY
) const;
851 Returns @true if the event was an up event from the specified button
855 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
856 indicate any button down event.
858 bool ButtonUp(int button
= wxJOY_BUTTON_ANY
) const;
861 Returns the identifier of the button changing state.
863 This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
865 int GetButtonChange() const;
868 Returns the down state of the buttons.
870 This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
872 int GetButtonState() const;
875 Returns the identifier of the joystick generating the event - one of
876 wxJOYSTICK1 and wxJOYSTICK2.
878 int GetJoystick() const;
881 Returns the x, y position of the joystick event.
883 wxPoint
GetPosition() const;
886 Returns the z position of the joystick event.
888 int GetZPosition() const;
891 Returns @true if this was a button up or down event
892 (@e not 'is any button down?').
894 bool IsButton() const;
897 Returns @true if this was an x, y move event.
902 Returns @true if this was a z move event.
904 bool IsZMove() const;
910 @class wxScrollWinEvent
912 A scroll event holds information about events sent from scrolling windows.
915 @beginEventTable{wxScrollWinEvent}
916 You can use the EVT_SCROLLWIN* macros for intercepting scroll window events
917 from the receiving window.
918 @event{EVT_SCROLLWIN(func)}
919 Process all scroll events.
920 @event{EVT_SCROLLWIN_TOP(func)}
921 Process wxEVT_SCROLLWIN_TOP scroll-to-top events.
922 @event{EVT_SCROLLWIN_BOTTOM(func)}
923 Process wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
924 @event{EVT_SCROLLWIN_LINEUP(func)}
925 Process wxEVT_SCROLLWIN_LINEUP line up events.
926 @event{EVT_SCROLLWIN_LINEDOWN(func)}
927 Process wxEVT_SCROLLWIN_LINEDOWN line down events.
928 @event{EVT_SCROLLWIN_PAGEUP(func)}
929 Process wxEVT_SCROLLWIN_PAGEUP page up events.
930 @event{EVT_SCROLLWIN_PAGEDOWN(func)}
931 Process wxEVT_SCROLLWIN_PAGEDOWN page down events.
932 @event{EVT_SCROLLWIN_THUMBTRACK(func)}
933 Process wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
934 (frequent events sent as the user drags the thumbtrack).
935 @event{EVT_SCROLLWIN_THUMBRELEASE(func)}
936 Process wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
943 @see wxScrollEvent, @ref overview_eventhandling
945 class wxScrollWinEvent
: public wxEvent
951 wxScrollWinEvent(wxEventType commandType
= wxEVT_NULL
, int pos
= 0,
952 int orientation
= 0);
955 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
958 @todo wxHORIZONTAL and wxVERTICAL should go in their own enum
960 int GetOrientation() const;
963 Returns the position of the scrollbar for the thumb track and release events.
965 Note that this field can't be used for the other events, you need to query
966 the window itself for the current position in that case.
968 int GetPosition() const;
974 @class wxSysColourChangedEvent
976 This class is used for system colour change events, which are generated
977 when the user changes the colour settings using the control panel.
978 This is only appropriate under Windows.
981 The default event handler for this event propagates the event to child windows,
982 since Windows only sends the events to top-level windows.
983 If intercepting this event for a top-level window, remember to call the base
984 class handler, or to pass the event on to the window's children explicitly.
986 @beginEventTable{wxSysColourChangedEvent}
987 @event{EVT_SYS_COLOUR_CHANGED(func)}
988 Process a wxEVT_SYS_COLOUR_CHANGED event.
994 @see @ref overview_eventhandling
996 class wxSysColourChangedEvent
: public wxEvent
1002 wxSysColourChangedEvent();
1008 @class wxWindowCreateEvent
1010 This event is sent just after the actual window associated with a wxWindow
1011 object has been created.
1013 Since it is derived from wxCommandEvent, the event propagates up
1014 the window hierarchy.
1016 @beginEventTable{wxWindowCreateEvent}
1017 @event{EVT_WINDOW_CREATE(func)}
1018 Process a wxEVT_CREATE event.
1024 @see @ref overview_eventhandling, wxWindowDestroyEvent
1026 class wxWindowCreateEvent
: public wxCommandEvent
1032 wxWindowCreateEvent(wxWindow
* win
= NULL
);
1040 A paint event is sent when a window's contents needs to be repainted.
1042 Please notice that in general it is impossible to change the drawing of a
1043 standard control (such as wxButton) and so you shouldn't attempt to handle
1044 paint events for them as even if it might work on some platforms, this is
1045 inherently not portable and won't work everywhere.
1048 Note that in a paint event handler, the application must always create a
1049 wxPaintDC object, even if you do not use it. Otherwise, under MS Windows,
1050 refreshing for this and other windows will go wrong.
1053 void MyWindow::OnPaint(wxPaintEvent& event)
1060 You can optimize painting by retrieving the rectangles that have been damaged
1061 and only repainting these. The rectangles are in terms of the client area,
1062 and are unscrolled, so you will need to do some calculations using the current
1063 view position to obtain logical, scrolled units.
1064 Here is an example of using the wxRegionIterator class:
1066 // Called when window needs to be repainted.
1067 void MyWindow::OnPaint(wxPaintEvent& event)
1071 // Find Out where the window is scrolled to
1072 int vbX,vbY; // Top left corner of client
1073 GetViewStart(&vbX,&vbY);
1075 int vX,vY,vW,vH; // Dimensions of client area in pixels
1076 wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
1085 // Alternatively we can do this:
1086 // wxRect rect(upd.GetRect());
1088 // Repaint this rectangle
1097 @beginEventTable{wxPaintEvent}
1098 @event{EVT_PAINT(func)}
1099 Process a wxEVT_PAINT event.
1105 @see @ref overview_eventhandling
1107 class wxPaintEvent
: public wxEvent
1113 wxPaintEvent(int id
= 0);
1119 @class wxMaximizeEvent
1121 An event being sent when a top level window is maximized. Notice that it is
1122 not sent when the window is restored to its original size after it had been
1123 maximized, only a normal wxSizeEvent is generated in this case.
1125 @beginEventTable{wxMaximizeEvent}
1126 @event{EVT_MAXIMIZE(func)}
1127 Process a wxEVT_MAXIMIZE event.
1133 @see @ref overview_eventhandling, wxTopLevelWindow::Maximize,
1134 wxTopLevelWindow::IsMaximized
1136 class wxMaximizeEvent
: public wxEvent
1140 Constructor. Only used by wxWidgets internally.
1142 wxMaximizeEvent(int id
= 0);
1146 The possibles modes to pass to wxUpdateUIEvent::SetMode().
1150 /** Send UI update events to all windows. */
1151 wxUPDATE_UI_PROCESS_ALL
,
1153 /** Send UI update events to windows that have
1154 the wxWS_EX_PROCESS_UI_UPDATES flag specified. */
1155 wxUPDATE_UI_PROCESS_SPECIFIED
1160 @class wxUpdateUIEvent
1162 This class is used for pseudo-events which are called by wxWidgets
1163 to give an application the chance to update various user interface elements.
1165 Without update UI events, an application has to work hard to check/uncheck,
1166 enable/disable, show/hide, and set the text for elements such as menu items
1167 and toolbar buttons. The code for doing this has to be mixed up with the code
1168 that is invoked when an action is invoked for a menu item or button.
1170 With update UI events, you define an event handler to look at the state of the
1171 application and change UI elements accordingly. wxWidgets will call your member
1172 functions in idle time, so you don't have to worry where to call this code.
1174 In addition to being a clearer and more declarative method, it also means you don't
1175 have to worry whether you're updating a toolbar or menubar identifier. The same
1176 handler can update a menu item and toolbar button, if the identifier is the same.
1177 Instead of directly manipulating the menu or button, you call functions in the event
1178 object, such as wxUpdateUIEvent::Check. wxWidgets will determine whether such a
1179 call has been made, and which UI element to update.
1181 These events will work for popup menus as well as menubars. Just before a menu is
1182 popped up, wxMenu::UpdateUI is called to process any UI events for the window that
1185 If you find that the overhead of UI update processing is affecting your application,
1186 you can do one or both of the following:
1187 @li Call wxUpdateUIEvent::SetMode with a value of wxUPDATE_UI_PROCESS_SPECIFIED,
1188 and set the extra style wxWS_EX_PROCESS_UI_UPDATES for every window that should
1189 receive update events. No other windows will receive update events.
1190 @li Call wxUpdateUIEvent::SetUpdateInterval with a millisecond value to set the delay
1191 between updates. You may need to call wxWindow::UpdateWindowUI at critical points,
1192 for example when a dialog is about to be shown, in case the user sees a slight
1193 delay before windows are updated.
1195 Note that although events are sent in idle time, defining a wxIdleEvent handler
1196 for a window does not affect this because the events are sent from wxWindow::OnInternalIdle
1197 which is always called in idle time.
1199 wxWidgets tries to optimize update events on some platforms.
1200 On Windows and GTK+, events for menubar items are only sent when the menu is about
1201 to be shown, and not in idle time.
1204 @beginEventTable{wxUpdateUIEvent}
1205 @event{EVT_UPDATE_UI(id, func)}
1206 Process a wxEVT_UPDATE_UI event for the command with the given id.
1207 @event{EVT_UPDATE_UI_RANGE(id1, id2, func)}
1208 Process a wxEVT_UPDATE_UI event for any command with id included in the given range.
1214 @see @ref overview_eventhandling
1216 class wxUpdateUIEvent
: public wxCommandEvent
1222 wxUpdateUIEvent(wxWindowID commandId
= 0);
1225 Returns @true if it is appropriate to update (send UI update events to)
1228 This function looks at the mode used (see wxUpdateUIEvent::SetMode),
1229 the wxWS_EX_PROCESS_UI_UPDATES flag in @a window, the time update events
1230 were last sent in idle time, and the update interval, to determine whether
1231 events should be sent to this window now. By default this will always
1232 return @true because the update mode is initially wxUPDATE_UI_PROCESS_ALL
1233 and the interval is set to 0; so update events will be sent as often as
1234 possible. You can reduce the frequency that events are sent by changing the
1235 mode and/or setting an update interval.
1237 @see ResetUpdateTime(), SetUpdateInterval(), SetMode()
1239 static bool CanUpdate(wxWindow
* window
);
1242 Check or uncheck the UI element.
1244 void Check(bool check
);
1247 Enable or disable the UI element.
1249 void Enable(bool enable
);
1252 Returns @true if the UI element should be checked.
1254 bool GetChecked() const;
1257 Returns @true if the UI element should be enabled.
1259 bool GetEnabled() const;
1262 Static function returning a value specifying how wxWidgets will send update
1263 events: to all windows, or only to those which specify that they will process
1268 static wxUpdateUIMode
GetMode();
1271 Returns @true if the application has called Check().
1272 For wxWidgets internal use only.
1274 bool GetSetChecked() const;
1277 Returns @true if the application has called Enable().
1278 For wxWidgets internal use only.
1280 bool GetSetEnabled() const;
1283 Returns @true if the application has called Show().
1284 For wxWidgets internal use only.
1286 bool GetSetShown() const;
1289 Returns @true if the application has called SetText().
1290 For wxWidgets internal use only.
1292 bool GetSetText() const;
1295 Returns @true if the UI element should be shown.
1297 bool GetShown() const;
1300 Returns the text that should be set for the UI element.
1302 wxString
GetText() const;
1305 Returns the current interval between updates in milliseconds.
1306 The value -1 disables updates, 0 updates as frequently as possible.
1308 @see SetUpdateInterval().
1310 static long GetUpdateInterval();
1313 Used internally to reset the last-updated time to the current time.
1315 It is assumed that update events are normally sent in idle time, so this
1316 is called at the end of idle processing.
1318 @see CanUpdate(), SetUpdateInterval(), SetMode()
1320 static void ResetUpdateTime();
1323 Specify how wxWidgets will send update events: to all windows, or only to
1324 those which specify that they will process the events.
1327 this parameter may be one of the ::wxUpdateUIMode enumeration values.
1328 The default mode is wxUPDATE_UI_PROCESS_ALL.
1330 static void SetMode(wxUpdateUIMode mode
);
1333 Sets the text for this UI element.
1335 void SetText(const wxString
& text
);
1338 Sets the interval between updates in milliseconds.
1340 Set to -1 to disable updates, or to 0 to update as frequently as possible.
1343 Use this to reduce the overhead of UI update events if your application
1344 has a lot of windows. If you set the value to -1 or greater than 0,
1345 you may also need to call wxWindow::UpdateWindowUI at appropriate points
1346 in your application, such as when a dialog is about to be shown.
1348 static void SetUpdateInterval(long updateInterval
);
1351 Show or hide the UI element.
1353 void Show(bool show
);
1359 @class wxClipboardTextEvent
1361 This class represents the events generated by a control (typically a
1362 wxTextCtrl but other windows can generate these events as well) when its
1363 content gets copied or cut to, or pasted from the clipboard.
1365 There are three types of corresponding events wxEVT_COMMAND_TEXT_COPY,
1366 wxEVT_COMMAND_TEXT_CUT and wxEVT_COMMAND_TEXT_PASTE.
1368 If any of these events is processed (without being skipped) by an event
1369 handler, the corresponding operation doesn't take place which allows to
1370 prevent the text from being copied from or pasted to a control. It is also
1371 possible to examine the clipboard contents in the PASTE event handler and
1372 transform it in some way before inserting in a control -- for example,
1373 changing its case or removing invalid characters.
1375 Finally notice that a CUT event is always preceded by the COPY event which
1376 makes it possible to only process the latter if it doesn't matter if the
1377 text was copied or cut.
1380 These events are currently only generated by wxTextCtrl under GTK+.
1381 They are generated by all controls under Windows.
1383 @beginEventTable{wxClipboardTextEvent}
1384 @event{EVT_TEXT_COPY(id, func)}
1385 Some or all of the controls content was copied to the clipboard.
1386 @event{EVT_TEXT_CUT(id, func)}
1387 Some or all of the controls content was cut (i.e. copied and
1389 @event{EVT_TEXT_PASTE(id, func)}
1390 Clipboard content was pasted into the control.
1399 class wxClipboardTextEvent
: public wxCommandEvent
1405 wxClipboardTextEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0);
1413 This event class contains information about the events generated by the mouse:
1414 they include mouse buttons press and release events and mouse move events.
1416 All mouse events involving the buttons use @c wxMOUSE_BTN_LEFT for the
1417 left mouse button, @c wxMOUSE_BTN_MIDDLE for the middle one and
1418 @c wxMOUSE_BTN_RIGHT for the right one. And if the system supports more
1419 buttons, the @c wxMOUSE_BTN_AUX1 and @c wxMOUSE_BTN_AUX2 events
1420 can also be generated. Note that not all mice have even a middle button so a
1421 portable application should avoid relying on the events from it (but the right
1422 button click can be emulated using the left mouse button with the control key
1423 under Mac platforms with a single button mouse).
1425 For the @c wxEVT_ENTER_WINDOW and @c wxEVT_LEAVE_WINDOW events
1426 purposes, the mouse is considered to be inside the window if it is in the
1427 window client area and not inside one of its children. In other words, the
1428 parent window receives @c wxEVT_LEAVE_WINDOW event not only when the
1429 mouse leaves the window entirely but also when it enters one of its children.
1431 @note Note that under Windows CE mouse enter and leave events are not natively
1432 supported by the system but are generated by wxWidgets itself. This has several
1433 drawbacks: the LEAVE_WINDOW event might be received some time after the mouse
1434 left the window and the state variables for it may have changed during this time.
1436 @note Note the difference between methods like wxMouseEvent::LeftDown and
1437 wxMouseEvent::LeftIsDown: the former returns @true when the event corresponds
1438 to the left mouse button click while the latter returns @true if the left
1439 mouse button is currently being pressed. For example, when the user is dragging
1440 the mouse you can use wxMouseEvent::LeftIsDown to test whether the left mouse
1441 button is (still) depressed. Also, by convention, if wxMouseEvent::LeftDown
1442 returns @true, wxMouseEvent::LeftIsDown will also return @true in wxWidgets
1443 whatever the underlying GUI behaviour is (which is platform-dependent).
1444 The same applies, of course, to other mouse buttons as well.
1447 @beginEventTable{wxMouseEvent}
1448 @event{EVT_LEFT_DOWN(func)}
1449 Process a wxEVT_LEFT_DOWN event. The handler of this event should normally
1450 call event.Skip() to allow the default processing to take place as otherwise
1451 the window under mouse wouldn't get the focus.
1452 @event{EVT_LEFT_UP(func)}
1453 Process a wxEVT_LEFT_UP event.
1454 @event{EVT_LEFT_DCLICK(func)}
1455 Process a wxEVT_LEFT_DCLICK event.
1456 @event{EVT_MIDDLE_DOWN(func)}
1457 Process a wxEVT_MIDDLE_DOWN event.
1458 @event{EVT_MIDDLE_UP(func)}
1459 Process a wxEVT_MIDDLE_UP event.
1460 @event{EVT_MIDDLE_DCLICK(func)}
1461 Process a wxEVT_MIDDLE_DCLICK event.
1462 @event{EVT_RIGHT_DOWN(func)}
1463 Process a wxEVT_RIGHT_DOWN event.
1464 @event{EVT_RIGHT_UP(func)}
1465 Process a wxEVT_RIGHT_UP event.
1466 @event{EVT_RIGHT_DCLICK(func)}
1467 Process a wxEVT_RIGHT_DCLICK event.
1468 @event{EVT_MOUSE_AUX1_DOWN(func)}
1469 Process a wxEVT_MOUSE_AUX1_DOWN event.
1470 @event{EVT_MOUSE_AUX1_UP(func)}
1471 Process a wxEVT_MOUSE_AUX1_UP event.
1472 @event{EVT_MOUSE_AUX1_DCLICK(func)}
1473 Process a wxEVT_MOUSE_AUX1_DCLICK event.
1474 @event{EVT_MOUSE_AUX2_DOWN(func)}
1475 Process a wxEVT_MOUSE_AUX2_DOWN event.
1476 @event{EVT_MOUSE_AUX2_UP(func)}
1477 Process a wxEVT_MOUSE_AUX2_UP event.
1478 @event{EVT_MOUSE_AUX2_DCLICK(func)}
1479 Process a wxEVT_MOUSE_AUX2_DCLICK event.
1480 @event{EVT_MOTION(func)}
1481 Process a wxEVT_MOTION event.
1482 @event{EVT_ENTER_WINDOW(func)}
1483 Process a wxEVT_ENTER_WINDOW event.
1484 @event{EVT_LEAVE_WINDOW(func)}
1485 Process a wxEVT_LEAVE_WINDOW event.
1486 @event{EVT_MOUSEWHEEL(func)}
1487 Process a wxEVT_MOUSEWHEEL event.
1488 @event{EVT_MOUSE_EVENTS(func)}
1489 Process all mouse events.
1497 class wxMouseEvent
: public wxEvent
,
1502 Constructor. Valid event types are:
1504 @li wxEVT_ENTER_WINDOW
1505 @li wxEVT_LEAVE_WINDOW
1508 @li wxEVT_LEFT_DCLICK
1509 @li wxEVT_MIDDLE_DOWN
1511 @li wxEVT_MIDDLE_DCLICK
1512 @li wxEVT_RIGHT_DOWN
1514 @li wxEVT_RIGHT_DCLICK
1515 @li wxEVT_MOUSE_AUX1_DOWN
1516 @li wxEVT_MOUSE_AUX1_UP
1517 @li wxEVT_MOUSE_AUX1_DCLICK
1518 @li wxEVT_MOUSE_AUX2_DOWN
1519 @li wxEVT_MOUSE_AUX2_UP
1520 @li wxEVT_MOUSE_AUX2_DCLICK
1522 @li wxEVT_MOUSEWHEEL
1524 wxMouseEvent(wxEventType mouseEventType
= wxEVT_NULL
);
1527 Returns @true if the event was a first extra button double click.
1529 bool Aux1DClick() const;
1532 Returns @true if the first extra button mouse button changed to down.
1534 bool Aux1Down() const;
1537 Returns @true if the first extra button mouse button is currently down,
1538 independent of the current event type.
1540 bool Aux1IsDown() const;
1543 Returns @true if the first extra button mouse button changed to up.
1545 bool Aux1Up() const;
1548 Returns @true if the event was a second extra button double click.
1550 bool Aux2DClick() const;
1553 Returns @true if the second extra button mouse button changed to down.
1555 bool Aux2Down() const;
1558 Returns @true if the second extra button mouse button is currently down,
1559 independent of the current event type.
1561 bool Aux2IsDown() const;
1564 Returns @true if the second extra button mouse button changed to up.
1566 bool Aux2Up() const;
1569 Returns @true if the identified mouse button is changing state.
1570 Valid values of @a button are:
1572 @li @c wxMOUSE_BTN_LEFT: check if left button was pressed
1573 @li @c wxMOUSE_BTN_MIDDLE: check if middle button was pressed
1574 @li @c wxMOUSE_BTN_RIGHT: check if right button was pressed
1575 @li @c wxMOUSE_BTN_AUX1: check if the first extra button was pressed
1576 @li @c wxMOUSE_BTN_AUX2: check if the second extra button was pressed
1577 @li @c wxMOUSE_BTN_ANY: check if any button was pressed
1579 @todo introduce wxMouseButton enum
1581 bool Button(int button
) const;
1584 If the argument is omitted, this returns @true if the event was a mouse
1585 double click event. Otherwise the argument specifies which double click event
1586 was generated (see Button() for the possible values).
1588 bool ButtonDClick(int but
= wxMOUSE_BTN_ANY
) const;
1591 If the argument is omitted, this returns @true if the event was a mouse
1592 button down event. Otherwise the argument specifies which button-down event
1593 was generated (see Button() for the possible values).
1595 bool ButtonDown(int = wxMOUSE_BTN_ANY
) const;
1598 If the argument is omitted, this returns @true if the event was a mouse
1599 button up event. Otherwise the argument specifies which button-up event
1600 was generated (see Button() for the possible values).
1602 bool ButtonUp(int = wxMOUSE_BTN_ANY
) const;
1605 Returns @true if this was a dragging event (motion while a button is depressed).
1609 bool Dragging() const;
1612 Returns @true if the mouse was entering the window.
1616 bool Entering() const;
1619 Returns the mouse button which generated this event or @c wxMOUSE_BTN_NONE
1620 if no button is involved (for mouse move, enter or leave event, for example).
1621 Otherwise @c wxMOUSE_BTN_LEFT is returned for the left button down, up and
1622 double click events, @c wxMOUSE_BTN_MIDDLE and @c wxMOUSE_BTN_RIGHT
1623 for the same events for the middle and the right buttons respectively.
1625 int GetButton() const;
1628 Returns the number of mouse clicks for this event: 1 for a simple click, 2
1629 for a double-click, 3 for a triple-click and so on.
1631 Currently this function is implemented only in wxMac and returns -1 for the
1632 other platforms (you can still distinguish simple clicks from double-clicks as
1633 they generate different kinds of events however).
1637 int GetClickCount() const;
1640 Returns the configured number of lines (or whatever) to be scrolled per
1641 wheel action. Defaults to three.
1643 int GetLinesPerAction() const;
1646 Returns the logical mouse position in pixels (i.e. translated according to the
1647 translation set for the DC, which usually indicates that the window has been
1650 wxPoint
GetLogicalPosition(const wxDC
& dc
) const;
1654 Sets *x and *y to the position at which the event occurred.
1655 Returns the physical mouse position in pixels.
1657 Note that if the mouse event has been artificially generated from a special
1658 keyboard combination (e.g. under Windows when the "menu" key is pressed), the
1659 returned position is ::wxDefaultPosition.
1661 wxPoint
GetPosition() const;
1662 void GetPosition(wxCoord
* x
, wxCoord
* y
) const;
1663 void GetPosition(long* x
, long* y
) const;
1667 Get wheel delta, normally 120.
1669 This is the threshold for action to be taken, and one such action
1670 (for example, scrolling one increment) should occur for each delta.
1672 int GetWheelDelta() const;
1675 Get wheel rotation, positive or negative indicates direction of rotation.
1677 Current devices all send an event when rotation is at least +/-WheelDelta, but
1678 finer resolution devices can be created in the future.
1680 Because of this you shouldn't assume that one event is equal to 1 line, but you
1681 should be able to either do partial line scrolling or wait until several
1682 events accumulate before scrolling.
1684 int GetWheelRotation() const;
1687 Returns X coordinate of the physical mouse event position.
1689 wxCoord
GetX() const;
1692 Returns Y coordinate of the physical mouse event position.
1694 wxCoord
GetY() const;
1697 Returns @true if the event was a mouse button event (not necessarily a button
1698 down event - that may be tested using ButtonDown()).
1700 bool IsButton() const;
1703 Returns @true if the system has been setup to do page scrolling with
1704 the mouse wheel instead of line scrolling.
1706 bool IsPageScroll() const;
1709 Returns @true if the mouse was leaving the window.
1713 bool Leaving() const;
1716 Returns @true if the event was a left double click.
1718 bool LeftDClick() const;
1721 Returns @true if the left mouse button changed to down.
1723 bool LeftDown() const;
1726 Returns @true if the left mouse button is currently down, independent
1727 of the current event type.
1729 Please notice that it is not the same as LeftDown() which returns @true if the
1730 event was generated by the left mouse button being pressed. Rather, it simply
1731 describes the state of the left mouse button at the time when the event was
1732 generated (so while it will be @true for a left click event, it can also be @true
1733 for a right click if it happened while the left mouse button was pressed).
1735 This event is usually used in the mouse event handlers which process "move
1736 mouse" messages to determine whether the user is (still) dragging the mouse.
1738 bool LeftIsDown() const;
1741 Returns @true if the left mouse button changed to up.
1743 bool LeftUp() const;
1746 Returns @true if the Meta key was down at the time of the event.
1748 bool MetaDown() const;
1751 Returns @true if the event was a middle double click.
1753 bool MiddleDClick() const;
1756 Returns @true if the middle mouse button changed to down.
1758 bool MiddleDown() const;
1761 Returns @true if the middle mouse button is currently down, independent
1762 of the current event type.
1764 bool MiddleIsDown() const;
1767 Returns @true if the middle mouse button changed to up.
1769 bool MiddleUp() const;
1772 Returns @true if this was a motion event and no mouse buttons were pressed.
1773 If any mouse button is held pressed, then this method returns @false and
1774 Dragging() returns @true.
1776 bool Moving() const;
1779 Returns @true if the event was a right double click.
1781 bool RightDClick() const;
1784 Returns @true if the right mouse button changed to down.
1786 bool RightDown() const;
1789 Returns @true if the right mouse button is currently down, independent
1790 of the current event type.
1792 bool RightIsDown() const;
1795 Returns @true if the right mouse button changed to up.
1797 bool RightUp() const;
1803 @class wxDropFilesEvent
1805 This class is used for drop files events, that is, when files have been dropped
1806 onto the window. This functionality is currently only available under Windows.
1808 The window must have previously been enabled for dropping by calling
1809 wxWindow::DragAcceptFiles().
1811 Important note: this is a separate implementation to the more general drag and drop
1812 implementation documented in the @ref overview_dnd. It uses the older, Windows
1813 message-based approach of dropping files.
1815 @beginEventTable{wxDropFilesEvent}
1816 @event{EVT_DROP_FILES(func)}
1817 Process a wxEVT_DROP_FILES event.
1825 @see @ref overview_eventhandling
1827 class wxDropFilesEvent
: public wxEvent
1833 wxDropFilesEvent(wxEventType id
= 0, int noFiles
= 0,
1834 wxString
* files
= NULL
);
1837 Returns an array of filenames.
1839 wxString
* GetFiles() const;
1842 Returns the number of files dropped.
1844 int GetNumberOfFiles() const;
1847 Returns the position at which the files were dropped.
1848 Returns an array of filenames.
1850 wxPoint
GetPosition() const;
1856 @class wxCommandEvent
1858 This event class contains information about command events, which originate
1859 from a variety of simple controls.
1861 More complex controls, such as wxTreeCtrl, have separate command event classes.
1863 @beginEventTable{wxCommandEvent}
1864 @event{EVT_COMMAND(id, event, func)}
1865 Process a command, supplying the window identifier, command event identifier,
1866 and member function.
1867 @event{EVT_COMMAND_RANGE(id1, id2, event, func)}
1868 Process a command for a range of window identifiers, supplying the minimum and
1869 maximum window identifiers, command event identifier, and member function.
1870 @event{EVT_BUTTON(id, func)}
1871 Process a wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wxButton control.
1872 @event{EVT_CHECKBOX(id, func)}
1873 Process a wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wxCheckBox control.
1874 @event{EVT_CHOICE(id, func)}
1875 Process a wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wxChoice control.
1876 @event{EVT_COMBOBOX(id, func)}
1877 Process a wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wxComboBox control.
1878 @event{EVT_LISTBOX(id, func)}
1879 Process a wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.
1880 @event{EVT_LISTBOX_DCLICK(id, func)}
1881 Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.
1882 @event{EVT_MENU(id, func)}
1883 Process a wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
1884 @event{EVT_MENU_RANGE(id1, id2, func)}
1885 Process a wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.
1886 @event{EVT_CONTEXT_MENU(func)}
1887 Process the event generated when the user has requested a popup menu to appear by
1888 pressing a special keyboard key (under Windows) or by right clicking the mouse.
1889 @event{EVT_RADIOBOX(id, func)}
1890 Process a wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wxRadioBox control.
1891 @event{EVT_RADIOBUTTON(id, func)}
1892 Process a wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wxRadioButton control.
1893 @event{EVT_SCROLLBAR(id, func)}
1894 Process a wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a wxScrollBar
1895 control. This is provided for compatibility only; more specific scrollbar event macros
1896 should be used instead (see wxScrollEvent).
1897 @event{EVT_SLIDER(id, func)}
1898 Process a wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wxSlider control.
1899 @event{EVT_TEXT(id, func)}
1900 Process a wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wxTextCtrl control.
1901 @event{EVT_TEXT_ENTER(id, func)}
1902 Process a wxEVT_COMMAND_TEXT_ENTER command, which is generated by a wxTextCtrl control.
1903 Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it
1904 to generate such events.
1905 @event{EVT_TEXT_MAXLEN(id, func)}
1906 Process a wxEVT_COMMAND_TEXT_MAXLEN command, which is generated by a wxTextCtrl control
1907 when the user tries to enter more characters into it than the limit previously set
1908 with SetMaxLength().
1909 @event{EVT_TOGGLEBUTTON(id, func)}
1910 Process a wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event.
1911 @event{EVT_TOOL(id, func)}
1912 Process a wxEVT_COMMAND_TOOL_CLICKED event (a synonym for wxEVT_COMMAND_MENU_SELECTED).
1913 Pass the id of the tool.
1914 @event{EVT_TOOL_RANGE(id1, id2, func)}
1915 Process a wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools.
1916 @event{EVT_TOOL_RCLICKED(id, func)}
1917 Process a wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool.
1918 @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}
1919 Process a wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools.
1920 @event{EVT_TOOL_ENTER(id, func)}
1921 Process a wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself.
1922 The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor
1923 has moved off a tool.
1924 @event{EVT_COMMAND_LEFT_CLICK(id, func)}
1925 Process a wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only).
1926 @event{EVT_COMMAND_LEFT_DCLICK(id, func)}
1927 Process a wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (wxMSW only).
1928 @event{EVT_COMMAND_RIGHT_CLICK(id, func)}
1929 Process a wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (wxMSW only).
1930 @event{EVT_COMMAND_SET_FOCUS(id, func)}
1931 Process a wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (wxMSW only).
1932 @event{EVT_COMMAND_KILL_FOCUS(id, func)}
1933 Process a wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (wxMSW only).
1934 @event{EVT_COMMAND_ENTER(id, func)}
1935 Process a wxEVT_COMMAND_ENTER command, which is generated by a control.
1941 class wxCommandEvent
: public wxEvent
1947 wxCommandEvent(wxEventType commandEventType
= wxEVT_NULL
, int id
= 0);
1950 Returns client data pointer for a listbox or choice selection event
1951 (not valid for a deselection).
1953 void* GetClientData() const;
1956 Returns client object pointer for a listbox or choice selection event
1957 (not valid for a deselection).
1959 wxClientData
* GetClientObject() const;
1962 Returns extra information dependant on the event objects type.
1964 If the event comes from a listbox selection, it is a boolean
1965 determining whether the event was a selection (@true) or a
1966 deselection (@false). A listbox deselection only occurs for
1967 multiple-selection boxes, and in this case the index and string values
1968 are indeterminate and the listbox must be examined by the application.
1970 long GetExtraLong() const;
1973 Returns the integer identifier corresponding to a listbox, choice or
1974 radiobox selection (only if the event was a selection, not a deselection),
1975 or a boolean value representing the value of a checkbox.
1980 Returns item index for a listbox or choice selection event (not valid for
1983 int GetSelection() const;
1986 Returns item string for a listbox or choice selection event. If one
1987 or several items have been deselected, returns the index of the first
1988 deselected item. If some items have been selected and others deselected
1989 at the same time, it will return the index of the first selected item.
1991 wxString
GetString() const;
1994 This method can be used with checkbox and menu events: for the checkboxes, the
1995 method returns @true for a selection event and @false for a deselection one.
1996 For the menu events, this method indicates if the menu item just has become
1997 checked or unchecked (and thus only makes sense for checkable menu items).
1999 Notice that this method can not be used with wxCheckListBox currently.
2001 bool IsChecked() const;
2004 For a listbox or similar event, returns @true if it is a selection, @false
2005 if it is a deselection. If some items have been selected and others deselected
2006 at the same time, it will return @true.
2008 bool IsSelection() const;
2011 Sets the client data for this event.
2013 void SetClientData(void* clientData
);
2016 Sets the client object for this event. The client object is not owned by the
2017 event object and the event object will not delete the client object in its destructor.
2019 The client object must be owned and deleted by another object (e.g. a control)
2020 that has longer life time than the event object.
2022 void SetClientObject(wxClientData
* clientObject
);
2025 Sets the @b m_extraLong member.
2027 void SetExtraLong(long extraLong
);
2030 Sets the @b m_commandInt member.
2032 void SetInt(int intCommand
);
2035 Sets the @b m_commandString member.
2037 void SetString(const wxString
& string
);
2043 @class wxActivateEvent
2045 An activate event is sent when a window or application is being activated
2048 @beginEventTable{wxActivateEvent}
2049 @event{EVT_ACTIVATE(func)}
2050 Process a wxEVT_ACTIVATE event.
2051 @event{EVT_ACTIVATE_APP(func)}
2052 Process a wxEVT_ACTIVATE_APP event.
2053 @event{EVT_HIBERNATE(func)}
2054 Process a hibernate event, supplying the member function. This event applies
2055 to wxApp only, and only on Windows SmartPhone and PocketPC.
2056 It is generated when the system is low on memory; the application should free
2057 up as much memory as possible, and restore full working state when it receives
2058 a wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP event.
2065 @see @ref overview_eventhandling, wxApp::IsActive
2067 class wxActivateEvent
: public wxEvent
2073 wxActivateEvent(wxEventType eventType
= wxEVT_NULL
, bool active
= true,
2077 Returns @true if the application or window is being activated, @false otherwise.
2079 bool GetActive() const;
2085 @class wxContextMenuEvent
2087 This class is used for context menu events, sent to give
2088 the application a chance to show a context (popup) menu.
2090 Note that if wxContextMenuEvent::GetPosition returns wxDefaultPosition, this
2091 means that the event originated from a keyboard context button event, and you
2092 should compute a suitable position yourself, for example by calling wxGetMousePosition().
2094 When a keyboard context menu button is pressed on Windows, a right-click event
2095 with default position is sent first, and if this event is not processed, the
2096 context menu event is sent. So if you process mouse events and you find your
2097 context menu event handler is not being called, you could call wxEvent::Skip()
2098 for mouse right-down events.
2100 @beginEventTable{wxContextMenuEvent}
2101 @event{EVT_CONTEXT_MENU(func)}
2102 A right click (or other context menu command depending on platform) has been detected.
2109 @see wxCommandEvent, @ref overview_eventhandling
2111 class wxContextMenuEvent
: public wxCommandEvent
2117 wxContextMenuEvent(wxEventType id
= wxEVT_NULL
, int id
= 0,
2118 const wxPoint
& pos
= wxDefaultPosition
);
2121 Returns the position in screen coordinates at which the menu should be shown.
2122 Use wxWindow::ScreenToClient to convert to client coordinates.
2124 You can also omit a position from wxWindow::PopupMenu in order to use
2125 the current mouse pointer position.
2127 If the event originated from a keyboard event, the value returned from this
2128 function will be wxDefaultPosition.
2130 const wxPoint
& GetPosition() const;
2133 Sets the position at which the menu should be shown.
2135 void SetPosition(const wxPoint
& point
);
2143 An erase event is sent when a window's background needs to be repainted.
2145 On some platforms, such as GTK+, this event is simulated (simply generated just
2146 before the paint event) and may cause flicker. It is therefore recommended that
2147 you set the text background colour explicitly in order to prevent flicker.
2148 The default background colour under GTK+ is grey.
2150 To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table
2153 You must call wxEraseEvent::GetDC and use the returned device context if it is
2154 non-@NULL. If it is @NULL, create your own temporary wxClientDC object.
2157 Use the device context returned by GetDC to draw on, don't create
2158 a wxPaintDC in the event handler.
2160 @beginEventTable{wxEraseEvent}
2161 @event{EVT_ERASE_BACKGROUND(func)}
2162 Process a wxEVT_ERASE_BACKGROUND event.
2168 @see @ref overview_eventhandling
2170 class wxEraseEvent
: public wxEvent
2176 wxEraseEvent(int id
= 0, wxDC
* dc
= NULL
);
2179 Returns the device context associated with the erase event to draw on.
2181 wxDC
* GetDC() const;
2189 A focus event is sent when a window's focus changes. The window losing focus
2190 receives a "kill focus" event while the window gaining it gets a "set focus" one.
2192 Notice that the set focus event happens both when the user gives focus to the
2193 window (whether using the mouse or keyboard) and when it is done from the
2194 program itself using wxWindow::SetFocus.
2196 @beginEventTable{wxFocusEvent}
2197 @event{EVT_SET_FOCUS(func)}
2198 Process a wxEVT_SET_FOCUS event.
2199 @event{EVT_KILL_FOCUS(func)}
2200 Process a wxEVT_KILL_FOCUS event.
2206 @see @ref overview_eventhandling
2208 class wxFocusEvent
: public wxEvent
2214 wxFocusEvent(wxEventType eventType
= wxEVT_NULL
, int id
= 0);
2217 Returns the window associated with this event, that is the window which had the
2218 focus before for the @c wxEVT_SET_FOCUS event and the window which is
2219 going to receive focus for the @c wxEVT_KILL_FOCUS one.
2221 Warning: the window pointer may be @NULL!
2223 wxWindow
*GetWindow() const;
2229 @class wxChildFocusEvent
2231 A child focus event is sent to a (parent-)window when one of its child windows
2232 gains focus, so that the window could restore the focus back to its corresponding
2233 child if it loses it now and regains later.
2235 Notice that child window is the direct child of the window receiving event.
2236 Use wxWindow::FindFocus() to retreive the window which is actually getting focus.
2238 @beginEventTable{wxChildFocusEvent}
2239 @event{EVT_CHILD_FOCUS(func)}
2240 Process a wxEVT_CHILD_FOCUS event.
2246 @see @ref overview_eventhandling
2248 class wxChildFocusEvent
: public wxCommandEvent
2255 The direct child which is (or which contains the window which is) receiving
2258 wxChildFocusEvent(wxWindow
* win
= NULL
);
2261 Returns the direct child which receives the focus, or a (grand-)parent of the
2262 control receiving the focus.
2264 To get the actually focused control use wxWindow::FindFocus.
2266 wxWindow
*GetWindow() const;
2272 @class wxMouseCaptureLostEvent
2274 An mouse capture lost event is sent to a window that obtained mouse capture,
2275 which was subsequently loss due to "external" event, for example when a dialog
2276 box is shown or if another application captures the mouse.
2278 If this happens, this event is sent to all windows that are on capture stack
2279 (i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is
2280 not sent if the capture changes because of a call to CaptureMouse or
2283 This event is currently emitted under Windows only.
2285 @beginEventTable{wxMouseCaptureLostEvent}
2286 @event{EVT_MOUSE_CAPTURE_LOST(func)}
2287 Process a wxEVT_MOUSE_CAPTURE_LOST event.
2295 @see wxMouseCaptureChangedEvent, @ref overview_eventhandling,
2296 wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
2298 class wxMouseCaptureLostEvent
: public wxEvent
2304 wxMouseCaptureLostEvent(wxWindowID windowId
= 0);
2310 @class wxNotifyEvent
2312 This class is not used by the event handlers by itself, but is a base class
2313 for other event classes (such as wxBookCtrlEvent).
2315 It (or an object of a derived class) is sent when the controls state is being
2316 changed and allows the program to wxNotifyEvent::Veto() this change if it wants
2317 to prevent it from happening.
2322 @see wxBookCtrlEvent
2324 class wxNotifyEvent
: public wxCommandEvent
2328 Constructor (used internally by wxWidgets only).
2330 wxNotifyEvent(wxEventType eventType
= wxEVT_NULL
, int id
= 0);
2333 This is the opposite of Veto(): it explicitly allows the event to be processed.
2334 For most events it is not necessary to call this method as the events are allowed
2335 anyhow but some are forbidden by default (this will be mentioned in the corresponding
2341 Returns @true if the change is allowed (Veto() hasn't been called) or @false
2342 otherwise (if it was).
2344 bool IsAllowed() const;
2347 Prevents the change announced by this event from happening.
2349 It is in general a good idea to notify the user about the reasons for vetoing
2350 the change because otherwise the applications behaviour (which just refuses to
2351 do what the user wants) might be quite surprising.
2359 enum wxHelpEventOrigin
2361 wxHE_ORIGIN_UNKNOWN
= -1,
2362 wxHE_ORIGIN_KEYBOARD
,
2364 /** event generated by wxContextHelp or from the [?] button on
2365 the title bar (Windows). */
2366 wxHE_ORIGIN_HELPBUTTON
2372 A help event is sent when the user has requested context-sensitive help.
2373 This can either be caused by the application requesting context-sensitive help mode
2374 via wxContextHelp, or (on MS Windows) by the system generating a WM_HELP message when
2375 the user pressed F1 or clicked on the query button in a dialog caption.
2377 A help event is sent to the window that the user clicked on, and is propagated
2378 up the window hierarchy until the event is processed or there are no more event
2381 The application should call wxEvent::GetId to check the identity of the
2382 clicked-on window, and then either show some suitable help or call wxEvent::Skip()
2383 if the identifier is unrecognised.
2385 Calling Skip is important because it allows wxWidgets to generate further
2386 events for ancestors of the clicked-on window. Otherwise it would be impossible to
2387 show help for container windows, since processing would stop after the first window
2390 @beginEventTable{wxHelpEvent}
2391 @event{EVT_HELP(id, func)}
2392 Process a wxEVT_HELP event.
2393 @event{EVT_HELP_RANGE(id1, id2, func)}
2394 Process a wxEVT_HELP event for a range of ids.
2400 @see wxContextHelp, wxDialog, @ref overview_eventhandling
2402 class wxHelpEvent
: public wxCommandEvent
2406 Indicates how a wxHelpEvent was generated.
2410 Origin_Unknown
, /**< unrecognized event source. */
2411 Origin_Keyboard
, /**< event generated from F1 key press. */
2413 /** event generated by wxContextHelp or from the [?] button on
2414 the title bar (Windows). */
2421 wxHelpEvent(wxEventType type
= wxEVT_NULL
,
2422 wxWindowID winid
= 0,
2423 const wxPoint
& pt
= wxDefaultPosition
,
2424 wxHelpEvent::Origin origin
= Origin_Unknown
);
2427 Returns the origin of the help event which is one of the ::wxHelpEventOrigin
2430 The application may handle events generated using the keyboard or mouse
2431 differently, e.g. by using wxGetMousePosition() for the mouse events.
2435 wxHelpEvent::Origin
GetOrigin() const;
2438 Returns the left-click position of the mouse, in screen coordinates.
2439 This allows the application to position the help appropriately.
2441 const wxPoint
& GetPosition() const;
2444 Set the help event origin, only used internally by wxWidgets normally.
2448 void SetOrigin(wxHelpEvent::Origin origin
);
2451 Sets the left-click position of the mouse, in screen coordinates.
2453 void SetPosition(const wxPoint
& pt
);
2459 @class wxScrollEvent
2461 A scroll event holds information about events sent from stand-alone
2462 scrollbars (see wxScrollBar) and sliders (see wxSlider).
2464 Note that scrolled windows send the wxScrollWinEvent which does not derive from
2465 wxCommandEvent, but from wxEvent directly - don't confuse these two kinds of
2466 events and use the event table macros mentioned below only for the scrollbar-like
2469 @section scrollevent_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
2471 The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb
2472 using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed
2473 by an EVT_SCROLL_CHANGED event).
2475 The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb
2476 position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE
2477 event does not happen).
2479 In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving has finished
2480 independently of the way it had started. Please see the widgets sample ("Slider" page)
2481 to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
2484 Note that unless specifying a scroll control identifier, you will need to test for scrollbar
2485 orientation with wxScrollEvent::GetOrientation, since horizontal and vertical scroll events
2486 are processed using the same event handler.
2488 @beginEventTable{wxScrollEvent}
2489 You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting
2490 scroll events from controls, or EVT_SCROLL... macros without window IDs for
2491 intercepting scroll events from the receiving window -- except for this, the
2492 macros behave exactly the same.
2493 @event{EVT_SCROLL(func)}
2494 Process all scroll events.
2495 @event{EVT_SCROLL_TOP(func)}
2496 Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
2497 @event{EVT_SCROLL_BOTTOM(func)}
2498 Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
2499 @event{EVT_SCROLL_LINEUP(func)}
2500 Process wxEVT_SCROLL_LINEUP line up events.
2501 @event{EVT_SCROLL_LINEDOWN(func)}
2502 Process wxEVT_SCROLL_LINEDOWN line down events.
2503 @event{EVT_SCROLL_PAGEUP(func)}
2504 Process wxEVT_SCROLL_PAGEUP page up events.
2505 @event{EVT_SCROLL_PAGEDOWN(func)}
2506 Process wxEVT_SCROLL_PAGEDOWN page down events.
2507 @event{EVT_SCROLL_THUMBTRACK(func)}
2508 Process wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the
2509 user drags the thumbtrack).
2510 @event{EVT_SCROLL_THUMBRELEASE(func)}
2511 Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
2512 @event{EVT_SCROLL_CHANGED(func)}
2513 Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
2514 @event{EVT_COMMAND_SCROLL(id, func)}
2515 Process all scroll events.
2516 @event{EVT_COMMAND_SCROLL_TOP(id, func)}
2517 Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
2518 @event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
2519 Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
2520 @event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
2521 Process wxEVT_SCROLL_LINEUP line up events.
2522 @event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
2523 Process wxEVT_SCROLL_LINEDOWN line down events.
2524 @event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
2525 Process wxEVT_SCROLL_PAGEUP page up events.
2526 @event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
2527 Process wxEVT_SCROLL_PAGEDOWN page down events.
2528 @event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
2529 Process wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent
2530 as the user drags the thumbtrack).
2531 @event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
2532 Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
2533 @event{EVT_COMMAND_SCROLL_CHANGED(func)}
2534 Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
2540 @see wxScrollBar, wxSlider, wxSpinButton, wxScrollWinEvent, @ref overview_eventhandling
2542 class wxScrollEvent
: public wxCommandEvent
2548 wxScrollEvent(wxEventType commandType
= wxEVT_NULL
, int id
= 0, int pos
= 0,
2549 int orientation
= 0);
2552 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
2555 int GetOrientation() const;
2558 Returns the position of the scrollbar.
2560 int GetPosition() const;
2564 See wxIdleEvent::SetMode() for more info.
2568 /** Send idle events to all windows */
2571 /** Send idle events to windows that have the wxWS_EX_PROCESS_IDLE flag specified */
2572 wxIDLE_PROCESS_SPECIFIED
2579 This class is used for idle events, which are generated when the system becomes
2580 idle. Note that, unless you do something specifically, the idle events are not
2581 sent if the system remains idle once it has become it, e.g. only a single idle
2582 event will be generated until something else resulting in more normal events
2583 happens and only then is the next idle event sent again.
2585 If you need to ensure a continuous stream of idle events, you can either use
2586 wxIdleEvent::RequestMore method in your handler or call wxWakeUpIdle() periodically
2587 (for example from a timer event handler), but note that both of these approaches
2588 (and especially the first one) increase the system load and so should be avoided
2591 By default, idle events are sent to all windows (and also wxApp, as usual).
2592 If this is causing a significant overhead in your application, you can call
2593 wxIdleEvent::SetMode with the value wxIDLE_PROCESS_SPECIFIED, and set the
2594 wxWS_EX_PROCESS_IDLE extra window style for every window which should receive
2597 @beginEventTable{wxIdleEvent}
2598 @event{EVT_IDLE(func)}
2599 Process a wxEVT_IDLE event.
2605 @see @ref overview_eventhandling, wxUpdateUIEvent, wxWindow::OnInternalIdle
2607 class wxIdleEvent
: public wxEvent
2616 Returns @true if it is appropriate to send idle events to this window.
2618 This function looks at the mode used (see wxIdleEvent::SetMode),
2619 and the wxWS_EX_PROCESS_IDLE style in @a window to determine whether idle
2620 events should be sent to this window now.
2622 By default this will always return @true because the update mode is initially
2623 wxIDLE_PROCESS_ALL. You can change the mode to only send idle events to
2624 windows with the wxWS_EX_PROCESS_IDLE extra window style set.
2628 static bool CanSend(wxWindow
* window
);
2631 Static function returning a value specifying how wxWidgets will send idle
2632 events: to all windows, or only to those which specify that they
2633 will process the events.
2637 static wxIdleMode
GetMode();
2640 Returns @true if the OnIdle function processing this event requested more
2645 bool MoreRequested() const;
2648 Tells wxWidgets that more processing is required.
2650 This function can be called by an OnIdle handler for a window or window event
2651 handler to indicate that wxApp::OnIdle should forward the OnIdle event once
2652 more to the application windows.
2654 If no window calls this function during OnIdle, then the application will
2655 remain in a passive event loop (not calling OnIdle) until a new event is
2656 posted to the application by the windowing system.
2658 @see MoreRequested()
2660 void RequestMore(bool needMore
= true);
2663 Static function for specifying how wxWidgets will send idle events: to
2664 all windows, or only to those which specify that they will process the events.
2667 Can be one of the ::wxIdleMode values.
2668 The default is wxIDLE_PROCESS_ALL.
2670 static void SetMode(wxIdleMode mode
);
2676 @class wxInitDialogEvent
2678 A wxInitDialogEvent is sent as a dialog or panel is being initialised.
2679 Handlers for this event can transfer data to the window.
2681 The default handler calls wxWindow::TransferDataToWindow.
2683 @beginEventTable{wxInitDialogEvent}
2684 @event{EVT_INIT_DIALOG(func)}
2685 Process a wxEVT_INIT_DIALOG event.
2691 @see @ref overview_eventhandling
2693 class wxInitDialogEvent
: public wxEvent
2699 wxInitDialogEvent(int id
= 0);
2705 @class wxWindowDestroyEvent
2707 This event is sent from the wxWindow destructor wxWindow::~wxWindow() when a
2708 window is destroyed.
2710 When a class derived from wxWindow is destroyed its destructor will have
2711 already run by the time this event is sent. Therefore this event will not
2712 usually be received at all.
2714 To receive this event wxEvtHandler::Connect() must be used (using an event
2715 table macro will not work). Since it is received after the destructor has run,
2716 an object should not handle its own wxWindowDestroyEvent, but it can be used
2717 to get notification of the destruction of another window.
2722 @see @ref overview_eventhandling, wxWindowCreateEvent
2724 class wxWindowDestroyEvent
: public wxCommandEvent
2730 wxWindowDestroyEvent(wxWindow
* win
= NULL
);
2735 The possible flag values for a wxNavigationKeyEvent.
2737 enum wxNavigationKeyEventFlags
2739 wxNKEF_IS_BACKWARD
= 0x0000,
2740 wxNKEF_IS_FORWARD
= 0x0001,
2741 wxNKEF_WINCHANGE
= 0x0002,
2742 wxNKEF_FROMTAB
= 0x0004
2747 @class wxNavigationKeyEvent
2749 This event class contains information about navigation events,
2750 generated by navigation keys such as tab and page down.
2752 This event is mainly used by wxWidgets implementations.
2753 A wxNavigationKeyEvent handler is automatically provided by wxWidgets
2754 when you make a class into a control container with the macro
2755 WX_DECLARE_CONTROL_CONTAINER.
2757 @beginEventTable{wxNavigationKeyEvent}
2758 @event{EVT_NAVIGATION_KEY(func)}
2759 Process a navigation key event.
2765 @see wxWindow::Navigate, wxWindow::NavigateIn
2767 class wxNavigationKeyEvent
: public wxEvent
2770 wxNavigationKeyEvent();
2771 wxNavigationKeyEvent(const wxNavigationKeyEvent
& event
);
2774 Returns the child that has the focus, or @NULL.
2776 wxWindow
* GetCurrentFocus() const;
2779 Returns @true if the navigation was in the forward direction.
2781 bool GetDirection() const;
2784 Returns @true if the navigation event was from a tab key.
2785 This is required for proper navigation over radio buttons.
2787 bool IsFromTab() const;
2790 Returns @true if the navigation event represents a window change
2791 (for example, from Ctrl-Page Down in a notebook).
2793 bool IsWindowChange() const;
2796 Sets the current focus window member.
2798 void SetCurrentFocus(wxWindow
* currentFocus
);
2801 Sets the direction to forward if @a direction is @true, or backward
2804 void SetDirection(bool direction
);
2807 Sets the flags for this event.
2808 The @a flags can be a combination of the ::wxNavigationKeyEventFlags values.
2810 void SetFlags(long flags
);
2813 Marks the navigation event as from a tab key.
2815 void SetFromTab(bool fromTab
);
2818 Marks the event as a window change event.
2820 void SetWindowChange(bool windowChange
);
2826 @class wxMouseCaptureChangedEvent
2828 An mouse capture changed event is sent to a window that loses its
2829 mouse capture. This is called even if wxWindow::ReleaseCapture
2830 was called by the application code. Handling this event allows
2831 an application to cater for unexpected capture releases which
2832 might otherwise confuse mouse handling code.
2836 @beginEventTable{wxMouseCaptureChangedEvent}
2837 @event{EVT_MOUSE_CAPTURE_CHANGED(func)}
2838 Process a wxEVT_MOUSE_CAPTURE_CHANGED event.
2844 @see wxMouseCaptureLostEvent, @ref overview_eventhandling,
2845 wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
2847 class wxMouseCaptureChangedEvent
: public wxEvent
2853 wxMouseCaptureChangedEvent(wxWindowID windowId
= 0,
2854 wxWindow
* gainedCapture
= NULL
);
2857 Returns the window that gained the capture, or @NULL if it was a
2858 non-wxWidgets window.
2860 wxWindow
* GetCapturedWindow() const;
2868 This event class contains information about window and session close events.
2870 The handler function for EVT_CLOSE is called when the user has tried to close a
2871 a frame or dialog box using the window manager (X) or system menu (Windows).
2872 It can also be invoked by the application itself programmatically, for example by
2873 calling the wxWindow::Close function.
2875 You should check whether the application is forcing the deletion of the window
2876 using wxCloseEvent::CanVeto. If this is @false, you @e must destroy the window
2877 using wxWindow::Destroy.
2879 If the return value is @true, it is up to you whether you respond by destroying
2882 If you don't destroy the window, you should call wxCloseEvent::Veto to
2883 let the calling code know that you did not destroy the window.
2884 This allows the wxWindow::Close function to return @true or @false depending
2885 on whether the close instruction was honoured or not.
2887 Example of a wxCloseEvent handler:
2890 void MyFrame::OnClose(wxCloseEvent& event)
2892 if ( event.CanVeto() && m_bFileNotSaved )
2894 if ( wxMessageBox("The file has not been saved... continue closing?",
2896 wxICON_QUESTION | wxYES_NO) != wxYES )
2903 Destroy(); // you may also do: event.Skip();
2904 // since the default event handler does call Destroy(), too
2908 The EVT_END_SESSION event is slightly different as it is sent by the system
2909 when the user session is ending (e.g. because of log out or shutdown) and
2910 so all windows are being forcefully closed. At least under MSW, after the
2911 handler for this event is executed the program is simply killed by the
2912 system. Because of this, the default handler for this event provided by
2913 wxWidgets calls all the usual cleanup code (including wxApp::OnExit()) so
2914 that it could still be executed and exit()s the process itself, without
2915 waiting for being killed. If this behaviour is for some reason undesirable,
2916 make sure that you define a handler for this event in your wxApp-derived
2917 class and do not call @c event.Skip() in it (but be aware that the system
2918 will still kill your application).
2920 @beginEventTable{wxCloseEvent}
2921 @event{EVT_CLOSE(func)}
2922 Process a close event, supplying the member function.
2923 This event applies to wxFrame and wxDialog classes.
2924 @event{EVT_QUERY_END_SESSION(func)}
2925 Process a query end session event, supplying the member function.
2926 This event can be handled in wxApp-derived class only.
2927 @event{EVT_END_SESSION(func)}
2928 Process an end session event, supplying the member function.
2929 This event can be handled in wxApp-derived class only.
2935 @see wxWindow::Close, @ref overview_windowdeletion
2937 class wxCloseEvent
: public wxEvent
2943 wxCloseEvent(wxEventType commandEventType
= wxEVT_NULL
, int id
= 0);
2946 Returns @true if you can veto a system shutdown or a window close event.
2947 Vetoing a window close event is not possible if the calling code wishes to
2948 force the application to exit, and so this function must be called to check this.
2950 bool CanVeto() const;
2953 Returns @true if the user is just logging off or @false if the system is
2954 shutting down. This method can only be called for end session and query end
2955 session events, it doesn't make sense for close window event.
2957 bool GetLoggingOff() const;
2960 Sets the 'can veto' flag.
2962 void SetCanVeto(bool canVeto
);
2965 Sets the 'logging off' flag.
2967 void SetLoggingOff(bool loggingOff
);
2970 Call this from your event handler to veto a system shutdown or to signal
2971 to the calling application that a window close did not happen.
2973 You can only veto a shutdown if CanVeto() returns @true.
2975 void Veto(bool veto
= true);
2983 This class is used for a variety of menu-related events. Note that
2984 these do not include menu command events, which are
2985 handled using wxCommandEvent objects.
2987 The default handler for wxEVT_MENU_HIGHLIGHT displays help
2988 text in the first field of the status bar.
2990 @beginEventTable{wxMenuEvent}
2991 @event{EVT_MENU_OPEN(func)}
2992 A menu is about to be opened. On Windows, this is only sent once for each
2993 navigation of the menubar (up until all menus have closed).
2994 @event{EVT_MENU_CLOSE(func)}
2995 A menu has been just closed.
2996 @event{EVT_MENU_HIGHLIGHT(id, func)}
2997 The menu item with the specified id has been highlighted: used to show
2998 help prompts in the status bar by wxFrame
2999 @event{EVT_MENU_HIGHLIGHT_ALL(func)}
3000 A menu item has been highlighted, i.e. the currently selected menu item has changed.
3006 @see wxCommandEvent, @ref overview_eventhandling
3008 class wxMenuEvent
: public wxEvent
3014 wxMenuEvent(wxEventType id
= wxEVT_NULL
, int id
= 0, wxMenu
* menu
= NULL
);
3017 Returns the menu which is being opened or closed. This method should only be
3018 used with the @c OPEN and @c CLOSE events and even for them the
3019 returned pointer may be @NULL in some ports.
3021 wxMenu
* GetMenu() const;
3024 Returns the menu identifier associated with the event.
3025 This method should be only used with the @c HIGHLIGHT events.
3027 int GetMenuId() const;
3030 Returns @true if the menu which is being opened or closed is a popup menu,
3031 @false if it is a normal one.
3033 This method should only be used with the @c OPEN and @c CLOSE events.
3035 bool IsPopup() const;
3041 An event being sent when the window is shown or hidden.
3043 Currently only wxMSW, wxGTK and wxOS2 generate such events.
3045 @onlyfor{wxmsw,wxgtk,wxos2}
3047 @beginEventTable{wxShowEvent}
3048 @event{EVT_SHOW(func)}
3049 Process a wxEVT_SHOW event.
3055 @see @ref overview_eventhandling, wxWindow::Show,
3059 class wxShowEvent
: public wxEvent
3065 wxShowEvent(int winid
= 0, bool show
= false);
3068 Set whether the windows was shown or hidden.
3070 void SetShow(bool show
);
3073 Return @true if the window has been shown, @false if it has been
3076 bool IsShown() const;
3079 @deprecated This function is deprecated in favour of IsShown().
3081 bool GetShow() const;
3087 @class wxIconizeEvent
3089 An event being sent when the frame is iconized (minimized) or restored.
3091 Currently only wxMSW and wxGTK generate such events.
3093 @onlyfor{wxmsw,wxgtk}
3095 @beginEventTable{wxIconizeEvent}
3096 @event{EVT_ICONIZE(func)}
3097 Process a wxEVT_ICONIZE event.
3103 @see @ref overview_eventhandling, wxTopLevelWindow::Iconize,
3104 wxTopLevelWindow::IsIconized
3106 class wxIconizeEvent
: public wxEvent
3112 wxIconizeEvent(int id
= 0, bool iconized
= true);
3115 Returns @true if the frame has been iconized, @false if it has been
3118 bool IsIconized() const;
3121 @deprecated This function is deprecated in favour of IsIconized().
3123 bool Iconized() const;
3131 A move event holds information about move change events.
3133 @beginEventTable{wxMoveEvent}
3134 @event{EVT_MOVE(func)}
3135 Process a wxEVT_MOVE event, which is generated when a window is moved.
3136 @event{EVT_MOVE_START(func)}
3137 Process a wxEVT_MOVE_START event, which is generated when the user starts
3138 to move or size a window. wxMSW only.
3139 @event{EVT_MOVE_END(func)}
3140 Process a wxEVT_MOVE_END event, which is generated when the user stops
3141 moving or sizing a window. wxMSW only.
3147 @see wxPoint, @ref overview_eventhandling
3149 class wxMoveEvent
: public wxEvent
3155 wxMoveEvent(const wxPoint
& pt
, int id
= 0);
3158 Returns the position of the window generating the move change event.
3160 wxPoint
GetPosition() const;
3167 A size event holds information about size change events.
3169 The EVT_SIZE handler function will be called when the window has been resized.
3171 You may wish to use this for frames to resize their child windows as appropriate.
3173 Note that the size passed is of the whole window: call wxWindow::GetClientSize
3174 for the area which may be used by the application.
3176 When a window is resized, usually only a small part of the window is damaged
3177 and you may only need to repaint that area. However, if your drawing depends on the
3178 size of the window, you may need to clear the DC explicitly and repaint the whole window.
3179 In which case, you may need to call wxWindow::Refresh to invalidate the entire window.
3181 @beginEventTable{wxSizeEvent}
3182 @event{EVT_SIZE(func)}
3183 Process a wxEVT_SIZE event.
3189 @see wxSize, @ref overview_eventhandling
3191 class wxSizeEvent
: public wxEvent
3197 wxSizeEvent(const wxSize
& sz
, int id
= 0);
3200 Returns the entire size of the window generating the size change event.
3202 wxSize
GetSize() const;
3208 @class wxSetCursorEvent
3210 A wxSetCursorEvent is generated when the mouse cursor is about to be set as a
3211 result of mouse motion.
3213 This event gives the application the chance to perform specific mouse cursor
3214 processing based on the current position of the mouse within the window.
3215 Use wxSetCursorEvent::SetCursor to specify the cursor you want to be displayed.
3217 @beginEventTable{wxSetCursorEvent}
3218 @event{EVT_SET_CURSOR(func)}
3219 Process a wxEVT_SET_CURSOR event.
3225 @see ::wxSetCursor, wxWindow::wxSetCursor
3227 class wxSetCursorEvent
: public wxEvent
3231 Constructor, used by the library itself internally to initialize the event
3234 wxSetCursorEvent(wxCoord x
= 0, wxCoord y
= 0);
3237 Returns a reference to the cursor specified by this event.
3239 const wxCursor
& GetCursor() const;
3242 Returns the X coordinate of the mouse in client coordinates.
3244 wxCoord
GetX() const;
3247 Returns the Y coordinate of the mouse in client coordinates.
3249 wxCoord
GetY() const;
3252 Returns @true if the cursor specified by this event is a valid cursor.
3254 @remarks You cannot specify wxNullCursor with this event, as it is not
3255 considered a valid cursor.
3257 bool HasCursor() const;
3260 Sets the cursor associated with this event.
3262 void SetCursor(const wxCursor
& cursor
);
3267 // ============================================================================
3268 // Global functions/macros
3269 // ============================================================================
3271 /** @ingroup group_funcmacro_events */
3275 Each wxEvent-derived class has an @e event-type associated.
3276 See the macro DEFINE_EVENT_TYPE() for more info.
3278 @see @ref overview_eventhandling_custom
3280 typedef int wxEventType
;
3283 Initializes a new event type using wxNewEventType().
3285 #define DEFINE_EVENT_TYPE(name) const wxEventType name = wxNewEventType();
3288 Generates a new unique event type.
3290 wxEventType
wxNewEventType();
3293 Use this macro inside a class declaration to declare a @e static event table
3296 In the implementation file you'll need to use the BEGIN_EVENT_TABLE()
3297 and the END_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro
3300 @see @ref overview_eventhandling_eventtables
3302 #define DECLARE_EVENT_TABLE()
3305 Use this macro in a source file to start listing @e static event handlers
3306 for a specific class.
3308 Use END_EVENT_TABLE() to terminate the event-declaration block.
3310 @see @ref overview_eventhandling_eventtables
3312 #define BEGIN_EVENT_TABLE(theClass, baseClass)
3315 Use this macro in a source file to end listing @e static event handlers
3316 for a specific class.
3318 Use BEGIN_EVENT_TABLE() to start the event-declaration block.
3320 @see @ref overview_eventhandling_eventtables
3322 #define END_EVENT_TABLE()
3325 In a GUI application, this function posts @a event to the specified @e dest
3326 object using wxEvtHandler::AddPendingEvent().
3328 Otherwise, it dispatches @a event immediately using
3329 wxEvtHandler::ProcessEvent(). See the respective documentation for details
3330 (and caveats). Because of limitation of wxEvtHandler::AddPendingEvent()
3331 this function is not thread-safe for event objects having wxString fields,
3332 use wxQueueEvent() instead.
3336 void wxPostEvent(wxEvtHandler
* dest
, const wxEvent
& event
);
3339 Queue an event for processing on the given object.
3341 This is a wrapper around wxEvtHandler::QueueEvent(), see its documentation
3347 The object to queue the event on, can't be @c NULL.
3349 The heap-allocated and non-@c NULL event to queue, the function takes
3352 void wxQueueEvent(wxEvtHandler
* dest
, wxEvent
*event
);