]> git.saurik.com Git - wxWidgets.git/blame_incremental - interface/wx/event.h
Add wxTranslations::GetBestTranslation().
[wxWidgets.git] / interface / wx / event.h
... / ...
CommitLineData
1/////////////////////////////////////////////////////////////////////////////
2// Name: event.h
3// Purpose: interface of wxEvtHandler, wxEventBlocker and many
4// wxEvent-derived classes
5// Author: wxWidgets team
6// RCS-ID: $Id$
7// Licence: wxWindows licence
8/////////////////////////////////////////////////////////////////////////////
9
10/**
11 The predefined constants for the number of times we propagate event
12 upwards window child-parent chain.
13*/
14enum wxEventPropagation
15{
16 /// don't propagate it at all
17 wxEVENT_PROPAGATE_NONE = 0,
18
19 /// propagate it until it is processed
20 wxEVENT_PROPAGATE_MAX = INT_MAX
21};
22
23/**
24 The different categories for a wxEvent; see wxEvent::GetEventCategory.
25
26 @note They are used as OR-combinable flags by wxEventLoopBase::YieldFor.
27*/
28enum wxEventCategory
29{
30 /**
31 This is the category for those events which are generated to update
32 the appearance of the GUI but which (usually) do not comport data
33 processing, i.e. which do not provide input or output data
34 (e.g. size events, scroll events, etc).
35 They are events NOT directly generated by the user's input devices.
36 */
37 wxEVT_CATEGORY_UI = 1,
38
39 /**
40 This category groups those events which are generated directly from the
41 user through input devices like mouse and keyboard and usually result in
42 data to be processed from the application
43 (e.g. mouse clicks, key presses, etc).
44 */
45 wxEVT_CATEGORY_USER_INPUT = 2,
46
47 /// This category is for wxSocketEvent
48 wxEVT_CATEGORY_SOCKET = 4,
49
50 /// This category is for wxTimerEvent
51 wxEVT_CATEGORY_TIMER = 8,
52
53 /**
54 This category is for any event used to send notifications from the
55 secondary threads to the main one or in general for notifications among
56 different threads (which may or may not be user-generated).
57 See e.g. wxThreadEvent.
58 */
59 wxEVT_CATEGORY_THREAD = 16,
60
61 /**
62 This mask is used in wxEventLoopBase::YieldFor to specify that all event
63 categories should be processed.
64 */
65 wxEVT_CATEGORY_ALL =
66 wxEVT_CATEGORY_UI|wxEVT_CATEGORY_USER_INPUT|wxEVT_CATEGORY_SOCKET| \
67 wxEVT_CATEGORY_TIMER|wxEVT_CATEGORY_THREAD
68};
69
70/**
71 @class wxEvent
72
73 An event is a structure holding information about an event passed to a
74 callback or member function.
75
76 wxEvent used to be a multipurpose event object, and is an abstract base class
77 for other event classes (see below).
78
79 For more information about events, see the @ref overview_events overview.
80
81 @beginWxPerlOnly
82 In wxPerl custom event classes should be derived from
83 @c Wx::PlEvent and @c Wx::PlCommandEvent.
84 @endWxPerlOnly
85
86 @library{wxbase}
87 @category{events}
88
89 @see wxCommandEvent, wxMouseEvent
90*/
91class wxEvent : public wxObject
92{
93public:
94 /**
95 Constructor.
96
97 Notice that events are usually created by wxWidgets itself and creating
98 e.g. a wxPaintEvent in your code and sending it to e.g. a wxTextCtrl
99 will not usually affect it at all as native controls have no specific
100 knowledge about wxWidgets events. However you may construct objects of
101 specific types and pass them to wxEvtHandler::ProcessEvent() if you
102 want to create your own custom control and want to process its events
103 in the same manner as the standard ones.
104
105 Also please notice that the order of parameters in this constructor is
106 different from almost all the derived classes which specify the event
107 type as the first argument.
108
109 @param id
110 The identifier of the object (window, timer, ...) which generated
111 this event.
112 @param eventType
113 The unique type of event, e.g. @c wxEVT_PAINT, @c wxEVT_SIZE or
114 @c wxEVT_COMMAND_BUTTON_CLICKED.
115 */
116 wxEvent(int id = 0, wxEventType eventType = wxEVT_NULL);
117
118 /**
119 Returns a copy of the event.
120
121 Any event that is posted to the wxWidgets event system for later action
122 (via wxEvtHandler::AddPendingEvent, wxEvtHandler::QueueEvent or wxPostEvent())
123 must implement this method.
124
125 All wxWidgets events fully implement this method, but any derived events
126 implemented by the user should also implement this method just in case they
127 (or some event derived from them) are ever posted.
128
129 All wxWidgets events implement a copy constructor, so the easiest way of
130 implementing the Clone function is to implement a copy constructor for
131 a new event (call it MyEvent) and then define the Clone function like this:
132
133 @code
134 wxEvent *Clone() const { return new MyEvent(*this); }
135 @endcode
136 */
137 virtual wxEvent* Clone() const = 0;
138
139 /**
140 Returns the object (usually a window) associated with the event, if any.
141 */
142 wxObject* GetEventObject() const;
143
144 /**
145 Returns the identifier of the given event type, such as @c wxEVT_COMMAND_BUTTON_CLICKED.
146 */
147 wxEventType GetEventType() const;
148
149 /**
150 Returns a generic category for this event.
151 wxEvent implementation returns @c wxEVT_CATEGORY_UI by default.
152
153 This function is used to selectively process events in wxEventLoopBase::YieldFor.
154 */
155 virtual wxEventCategory GetEventCategory() const;
156
157 /**
158 Returns the identifier associated with this event, such as a button command id.
159 */
160 int GetId() const;
161
162 /**
163 Returns @true if the event handler should be skipped, @false otherwise.
164 */
165 bool GetSkipped() const;
166
167 /**
168 Gets the timestamp for the event. The timestamp is the time in milliseconds
169 since some fixed moment (not necessarily the standard Unix Epoch, so only
170 differences between the timestamps and not their absolute values usually make sense).
171
172 @warning
173 wxWidgets returns a non-NULL timestamp only for mouse and key events
174 (see wxMouseEvent and wxKeyEvent).
175 */
176 long GetTimestamp() const;
177
178 /**
179 Returns @true if the event is or is derived from wxCommandEvent else it returns @false.
180
181 @note exists only for optimization purposes.
182 */
183 bool IsCommandEvent() const;
184
185 /**
186 Sets the propagation level to the given value (for example returned from an
187 earlier call to wxEvent::StopPropagation).
188 */
189 void ResumePropagation(int propagationLevel);
190
191 /**
192 Sets the originating object.
193 */
194 void SetEventObject(wxObject* object);
195
196 /**
197 Sets the event type.
198 */
199 void SetEventType(wxEventType type);
200
201 /**
202 Sets the identifier associated with this event, such as a button command id.
203 */
204 void SetId(int id);
205
206 /**
207 Sets the timestamp for the event.
208 */
209 void SetTimestamp(long timeStamp = 0);
210
211 /**
212 Test if this event should be propagated or not, i.e. if the propagation level
213 is currently greater than 0.
214 */
215 bool ShouldPropagate() const;
216
217 /**
218 This method can be used inside an event handler to control whether further
219 event handlers bound to this event will be called after the current one returns.
220
221 Without Skip() (or equivalently if Skip(@false) is used), the event will not
222 be processed any more. If Skip(@true) is called, the event processing system
223 continues searching for a further handler function for this event, even though
224 it has been processed already in the current handler.
225
226 In general, it is recommended to skip all non-command events to allow the
227 default handling to take place. The command events are, however, normally not
228 skipped as usually a single command such as a button click or menu item
229 selection must only be processed by one handler.
230 */
231 void Skip(bool skip = true);
232
233 /**
234 Stop the event from propagating to its parent window.
235
236 Returns the old propagation level value which may be later passed to
237 ResumePropagation() to allow propagating the event again.
238 */
239 int StopPropagation();
240
241protected:
242 /**
243 Indicates how many levels the event can propagate.
244
245 This member is protected and should typically only be set in the constructors
246 of the derived classes. It may be temporarily changed by StopPropagation()
247 and ResumePropagation() and tested with ShouldPropagate().
248
249 The initial value is set to either @c wxEVENT_PROPAGATE_NONE (by default)
250 meaning that the event shouldn't be propagated at all or to
251 @c wxEVENT_PROPAGATE_MAX (for command events) meaning that it should be
252 propagated as much as necessary.
253
254 Any positive number means that the event should be propagated but no more than
255 the given number of times. E.g. the propagation level may be set to 1 to
256 propagate the event to its parent only, but not to its grandparent.
257 */
258 int m_propagationLevel;
259};
260
261/**
262 @class wxEventBlocker
263
264 This class is a special event handler which allows to discard
265 any event (or a set of event types) directed to a specific window.
266
267 Example:
268
269 @code
270 void MyWindow::DoSomething()
271 {
272 {
273 // block all events directed to this window while
274 // we do the 1000 FunctionWhichSendsEvents() calls
275 wxEventBlocker blocker(this);
276
277 for ( int i = 0; i 1000; i++ )
278 FunctionWhichSendsEvents(i);
279
280 } // ~wxEventBlocker called, old event handler is restored
281
282 // the event generated by this call will be processed:
283 FunctionWhichSendsEvents(0)
284 }
285 @endcode
286
287 @library{wxcore}
288 @category{events}
289
290 @see @ref overview_events_processing, wxEvtHandler
291*/
292class wxEventBlocker : public wxEvtHandler
293{
294public:
295 /**
296 Constructs the blocker for the given window and for the given event type.
297
298 If @a type is @c wxEVT_ANY, then all events for that window are blocked.
299 You can call Block() after creation to add other event types to the list
300 of events to block.
301
302 Note that the @a win window @b must remain alive until the
303 wxEventBlocker object destruction.
304 */
305 wxEventBlocker(wxWindow* win, wxEventType type = -1);
306
307 /**
308 Destructor. The blocker will remove itself from the chain of event handlers for
309 the window provided in the constructor, thus restoring normal processing of events.
310 */
311 virtual ~wxEventBlocker();
312
313 /**
314 Adds to the list of event types which should be blocked the given @a eventType.
315 */
316 void Block(wxEventType eventType);
317};
318
319
320
321/**
322 Helper class to temporarily change an event to not propagate.
323*/
324class wxPropagationDisabler
325{
326public:
327 wxPropagationDisabler(wxEvent& event);
328 ~wxPropagationDisabler();
329};
330
331
332/**
333 Helper class to temporarily lower propagation level.
334*/
335class wxPropagateOnce
336{
337public:
338 wxPropagateOnce(wxEvent& event);
339 ~wxPropagateOnce();
340};
341
342
343
344/**
345 @class wxEvtHandler
346
347 A class that can handle events from the windowing system.
348 wxWindow is (and therefore all window classes are) derived from this class.
349
350 When events are received, wxEvtHandler invokes the method listed in the
351 event table using itself as the object. When using multiple inheritance
352 <b>it is imperative that the wxEvtHandler(-derived) class is the first
353 class inherited</b> such that the @c this pointer for the overall object
354 will be identical to the @c this pointer of the wxEvtHandler portion.
355
356 @library{wxbase}
357 @category{events}
358
359 @see @ref overview_events_processing, wxEventBlocker, wxEventLoopBase
360*/
361class wxEvtHandler : public wxObject, public wxTrackable
362{
363public:
364 /**
365 Constructor.
366 */
367 wxEvtHandler();
368
369 /**
370 Destructor.
371
372 If the handler is part of a chain, the destructor will unlink itself
373 (see Unlink()).
374 */
375 virtual ~wxEvtHandler();
376
377
378 /**
379 @name Event queuing and processing
380 */
381 //@{
382
383 /**
384 Queue event for a later processing.
385
386 This method is similar to ProcessEvent() but while the latter is
387 synchronous, i.e. the event is processed immediately, before the
388 function returns, this one is asynchronous and returns immediately
389 while the event will be processed at some later time (usually during
390 the next event loop iteration).
391
392 Another important difference is that this method takes ownership of the
393 @a event parameter, i.e. it will delete it itself. This implies that
394 the event should be allocated on the heap and that the pointer can't be
395 used any more after the function returns (as it can be deleted at any
396 moment).
397
398 QueueEvent() can be used for inter-thread communication from the worker
399 threads to the main thread, it is safe in the sense that it uses
400 locking internally and avoids the problem mentioned in AddPendingEvent()
401 documentation by ensuring that the @a event object is not used by the
402 calling thread any more. Care should still be taken to avoid that some
403 fields of this object are used by it, notably any wxString members of
404 the event object must not be shallow copies of another wxString object
405 as this would result in them still using the same string buffer behind
406 the scenes. For example:
407 @code
408 void FunctionInAWorkerThread(const wxString& str)
409 {
410 wxCommandEvent* evt = new wxCommandEvent;
411
412 // NOT evt->SetString(str) as this would be a shallow copy
413 evt->SetString(str.c_str()); // make a deep copy
414
415 wxTheApp->QueueEvent( evt );
416 }
417 @endcode
418
419 Note that you can use wxThreadEvent instead of wxCommandEvent
420 to avoid this problem:
421 @code
422 void FunctionInAWorkerThread(const wxString& str)
423 {
424 wxThreadEvent evt;
425 evt->SetString(str);
426
427 // wxThreadEvent::Clone() makes sure that the internal wxString
428 // member is not shared by other wxString instances:
429 wxTheApp->QueueEvent( evt.Clone() );
430 }
431 @endcode
432
433 Finally notice that this method automatically wakes up the event loop
434 if it is currently idle by calling ::wxWakeUpIdle() so there is no need
435 to do it manually when using it.
436
437 @since 2.9.0
438
439 @param event
440 A heap-allocated event to be queued, QueueEvent() takes ownership
441 of it. This parameter shouldn't be @c NULL.
442 */
443 virtual void QueueEvent(wxEvent *event);
444
445 /**
446 Post an event to be processed later.
447
448 This function is similar to QueueEvent() but can't be used to post
449 events from worker threads for the event objects with wxString fields
450 (i.e. in practice most of them) because of an unsafe use of the same
451 wxString object which happens because the wxString field in the
452 original @a event object and its copy made internally by this function
453 share the same string buffer internally. Use QueueEvent() to avoid
454 this.
455
456 A copy of @a event is made by the function, so the original can be deleted
457 as soon as function returns (it is common that the original is created
458 on the stack). This requires that the wxEvent::Clone() method be
459 implemented by event so that it can be duplicated and stored until it
460 gets processed.
461
462 @param event
463 Event to add to the pending events queue.
464 */
465 virtual void AddPendingEvent(const wxEvent& event);
466
467 /**
468 Processes an event, searching event tables and calling zero or more suitable
469 event handler function(s).
470
471 Normally, your application would not call this function: it is called in the
472 wxWidgets implementation to dispatch incoming user interface events to the
473 framework (and application).
474
475 However, you might need to call it if implementing new functionality
476 (such as a new control) where you define new event types, as opposed to
477 allowing the user to override virtual functions.
478
479 Notice that you don't usually need to override ProcessEvent() to
480 customize the event handling, overriding the specially provided
481 TryBefore() and TryAfter() functions is usually enough. For example,
482 wxMDIParentFrame may override TryBefore() to ensure that the menu
483 events are processed in the active child frame before being processed
484 in the parent frame itself.
485
486 The normal order of event table searching is as follows:
487 -# wxApp::FilterEvent() is called. If it returns anything but @c -1
488 (default) the processing stops here.
489 -# TryBefore() is called (this is where wxValidator are taken into
490 account for wxWindow objects). If this returns @true, the function exits.
491 -# If the object is disabled (via a call to wxEvtHandler::SetEvtHandlerEnabled)
492 the function skips to step (7).
493 -# Dynamic event table of the handlers bound using Bind<>() is
494 searched. If a handler is found, it is executed and the function
495 returns @true unless the handler used wxEvent::Skip() to indicate
496 that it didn't handle the event in which case the search continues.
497 -# Static events table of the handlers bound using event table
498 macros is searched for this event handler. If this fails, the base
499 class event table is tried, and so on until no more tables
500 exist or an appropriate function was found. If a handler is found,
501 the same logic as in the previous step applies.
502 -# The search is applied down the entire chain of event handlers (usually the
503 chain has a length of one). This chain can be formed using wxEvtHandler::SetNextHandler():
504 @image html overview_events_chain.png
505 (referring to the image, if @c A->ProcessEvent is called and it doesn't handle
506 the event, @c B->ProcessEvent will be called and so on...).
507 Note that in the case of wxWindow you can build a stack of event handlers
508 (see wxWindow::PushEventHandler() for more info).
509 If any of the handlers of the chain return @true, the function exits.
510 -# TryAfter() is called: for the wxWindow object this may propagate the
511 event to the window parent (recursively). If the event is still not
512 processed, ProcessEvent() on wxTheApp object is called as the last
513 step.
514
515 Notice that steps (2)-(6) are performed in ProcessEventLocally()
516 which is called by this function.
517
518 @param event
519 Event to process.
520 @return
521 @true if a suitable event handler function was found and executed,
522 and the function did not call wxEvent::Skip.
523
524 @see SearchEventTable()
525 */
526 virtual bool ProcessEvent(wxEvent& event);
527
528 /**
529 Try to process the event in this handler and all those chained to it.
530
531 As explained in ProcessEvent() documentation, the event handlers may be
532 chained in a doubly-linked list. This function tries to process the
533 event in this handler (including performing any pre-processing done in
534 TryBefore(), e.g. applying validators) and all those following it in
535 the chain until the event is processed or the chain is exhausted.
536
537 This function is called from ProcessEvent() and, in turn, calls
538 TryBefore() and TryAfter(). It is not virtual and so cannot be
539 overridden but can, and should, be called to forward an event to
540 another handler instead of ProcessEvent() which would result in a
541 duplicate call to TryAfter(), e.g. resulting in all unprocessed events
542 being sent to the application object multiple times.
543
544 @since 2.9.1
545
546 @param event
547 Event to process.
548 @return
549 @true if this handler of one of those chained to it processed the
550 event.
551 */
552 bool ProcessEventLocally(wxEvent& event);
553
554 /**
555 Processes an event by calling ProcessEvent() and handles any exceptions
556 that occur in the process.
557 If an exception is thrown in event handler, wxApp::OnExceptionInMainLoop is called.
558
559 @param event
560 Event to process.
561
562 @return @true if the event was processed, @false if no handler was found
563 or an exception was thrown.
564
565 @see wxWindow::HandleWindowEvent
566 */
567 bool SafelyProcessEvent(wxEvent& event);
568
569 /**
570 Processes the pending events previously queued using QueueEvent() or
571 AddPendingEvent(); you must call this function only if you are sure
572 there are pending events for this handler, otherwise a @c wxCHECK
573 will fail.
574
575 The real processing still happens in ProcessEvent() which is called by this
576 function.
577
578 Note that this function needs a valid application object (see
579 wxAppConsole::GetInstance()) because wxApp holds the list of the event
580 handlers with pending events and this function manipulates that list.
581 */
582 void ProcessPendingEvents();
583
584 /**
585 Deletes all events queued on this event handler using QueueEvent() or
586 AddPendingEvent().
587
588 Use with care because the events which are deleted are (obviously) not
589 processed and this may have unwanted consequences (e.g. user actions events
590 will be lost).
591 */
592 void DeletePendingEvents();
593
594 /**
595 Searches the event table, executing an event handler function if an appropriate
596 one is found.
597
598 @param table
599 Event table to be searched.
600 @param event
601 Event to be matched against an event table entry.
602
603 @return @true if a suitable event handler function was found and
604 executed, and the function did not call wxEvent::Skip.
605
606 @remarks This function looks through the object's event table and tries
607 to find an entry that will match the event.
608 An entry will match if:
609 @li The event type matches, and
610 @li the identifier or identifier range matches, or the event table
611 entry's identifier is zero.
612
613 If a suitable function is called but calls wxEvent::Skip, this
614 function will fail, and searching will continue.
615
616 @todo this function in the header is listed as an "implementation only" function;
617 are we sure we want to document it?
618
619 @see ProcessEvent()
620 */
621 virtual bool SearchEventTable(wxEventTable& table,
622 wxEvent& event);
623
624 //@}
625
626
627 /**
628 @name Connecting and disconnecting
629 */
630 //@{
631
632 /**
633 Connects the given function dynamically with the event handler, id and
634 event type.
635
636 Notice that Bind() provides a more flexible and safer way to do the
637 same thing as Connect(), please use it in any new code -- while
638 Connect() is not formally deprecated due to its existing widespread
639 usage, it has no advantages compared to Bind().
640
641 This is an alternative to the use of static event tables. It is more
642 flexible as it allows to connect events generated by some object to an
643 event handler defined in a different object of a different class (which
644 is impossible to do directly with the event tables -- the events can be
645 only handled in another object if they are propagated upwards to it).
646 Do make sure to specify the correct @a eventSink when connecting to an
647 event of a different object.
648
649 See @ref overview_events_bind for more detailed explanation
650 of this function and the @ref page_samples_event sample for usage
651 examples.
652
653 This specific overload allows you to connect an event handler to a @e range
654 of @e source IDs.
655 Do not confuse @e source IDs with event @e types: source IDs identify the
656 event generator objects (typically wxMenuItem or wxWindow objects) while the
657 event @e type identify which type of events should be handled by the
658 given @e function (an event generator object may generate many different
659 types of events!).
660
661 @param id
662 The first ID of the identifier range to be associated with the event
663 handler function.
664 @param lastId
665 The last ID of the identifier range to be associated with the event
666 handler function.
667 @param eventType
668 The event type to be associated with this event handler.
669 @param function
670 The event handler function. Note that this function should
671 be explicitly converted to the correct type which can be done using a macro
672 called @c wxFooEventHandler for the handler for any @c wxFooEvent.
673 @param userData
674 Data to be associated with the event table entry.
675 @param eventSink
676 Object whose member function should be called. It must be specified
677 when connecting an event generated by one object to a member
678 function of a different object. If it is omitted, @c this is used.
679
680 @beginWxPerlOnly
681 In wxPerl this function takes 4 arguments: @a id, @a lastid,
682 @a type, @a method; if @a method is undef, the handler is
683 disconnected.}
684 @endWxPerlOnly
685
686 @see Bind<>()
687 */
688 void Connect(int id, int lastId, wxEventType eventType,
689 wxObjectEventFunction function,
690 wxObject* userData = NULL,
691 wxEvtHandler* eventSink = NULL);
692
693 /**
694 See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
695 overload for more info.
696
697 This overload can be used to attach an event handler to a single source ID:
698
699 Example:
700 @code
701 frame->Connect( wxID_EXIT,
702 wxEVT_COMMAND_MENU_SELECTED,
703 wxCommandEventHandler(MyFrame::OnQuit) );
704 @endcode
705
706 @beginWxPerlOnly
707 Not supported by wxPerl.
708 @endWxPerlOnly
709 */
710 void Connect(int id, wxEventType eventType,
711 wxObjectEventFunction function,
712 wxObject* userData = NULL,
713 wxEvtHandler* eventSink = NULL);
714
715 /**
716 See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
717 overload for more info.
718
719 This overload will connect the given event handler so that regardless of the
720 ID of the event source, the handler will be called.
721
722 @beginWxPerlOnly
723 Not supported by wxPerl.
724 @endWxPerlOnly
725 */
726 void Connect(wxEventType eventType,
727 wxObjectEventFunction function,
728 wxObject* userData = NULL,
729 wxEvtHandler* eventSink = NULL);
730
731 /**
732 Disconnects the given function dynamically from the event handler, using the
733 specified parameters as search criteria and returning @true if a matching
734 function has been found and removed.
735
736 This method can only disconnect functions which have been added using the
737 Connect() method. There is no way to disconnect functions connected using
738 the (static) event tables.
739
740 @param eventType
741 The event type associated with this event handler.
742 @param function
743 The event handler function.
744 @param userData
745 Data associated with the event table entry.
746 @param eventSink
747 Object whose member function should be called.
748
749 @beginWxPerlOnly
750 Not supported by wxPerl.
751 @endWxPerlOnly
752 */
753 bool Disconnect(wxEventType eventType,
754 wxObjectEventFunction function,
755 wxObject* userData = NULL,
756 wxEvtHandler* eventSink = NULL);
757
758 /**
759 See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
760 overload for more info.
761
762 This overload takes the additional @a id parameter.
763
764 @beginWxPerlOnly
765 Not supported by wxPerl.
766 @endWxPerlOnly
767 */
768 bool Disconnect(int id = wxID_ANY,
769 wxEventType eventType = wxEVT_NULL,
770 wxObjectEventFunction function = NULL,
771 wxObject* userData = NULL,
772 wxEvtHandler* eventSink = NULL);
773
774 /**
775 See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
776 overload for more info.
777
778 This overload takes an additional range of source IDs.
779
780 @beginWxPerlOnly
781 In wxPerl this function takes 3 arguments: @a id,
782 @a lastid, @a type.
783 @endWxPerlOnly
784 */
785 bool Disconnect(int id, int lastId,
786 wxEventType eventType,
787 wxObjectEventFunction function = NULL,
788 wxObject* userData = NULL,
789 wxEvtHandler* eventSink = NULL);
790 //@}
791
792
793 /**
794 @name Binding and Unbinding
795 */
796 //@{
797
798 /**
799 Binds the given function, functor or method dynamically with the event.
800
801 This offers basically the same functionality as Connect(), but it is
802 more flexible as it also allows you to use ordinary functions and
803 arbitrary functors as event handlers. It is also less restrictive then
804 Connect() because you can use an arbitrary method as an event handler,
805 whereas Connect() requires a wxEvtHandler derived handler.
806
807 See @ref overview_events_bind for more detailed explanation
808 of this function and the @ref page_samples_event sample for usage
809 examples.
810
811 @param eventType
812 The event type to be associated with this event handler.
813 @param functor
814 The event handler functor. This can be an ordinary function but also
815 an arbitrary functor like boost::function<>.
816 @param id
817 The first ID of the identifier range to be associated with the event
818 handler.
819 @param lastId
820 The last ID of the identifier range to be associated with the event
821 handler.
822 @param userData
823 Data to be associated with the event table entry.
824
825 @see @ref overview_cpp_rtti_disabled
826
827 @since 2.9.0
828 */
829 template <typename EventTag, typename Functor>
830 void Bind(const EventTag& eventType,
831 Functor functor,
832 int id = wxID_ANY,
833 int lastId = wxID_ANY,
834 wxObject *userData = NULL);
835
836 /**
837 See the Bind<>(const EventTag&, Functor, int, int, wxObject*) overload for
838 more info.
839
840 This overload will bind the given method as the event handler.
841
842 @param eventType
843 The event type to be associated with this event handler.
844 @param method
845 The event handler method. This can be an arbitrary method (doesn't need
846 to be from a wxEvtHandler derived class).
847 @param handler
848 Object whose method should be called. It must always be specified
849 so it can be checked at compile time whether the given method is an
850 actual member of the given handler.
851 @param id
852 The first ID of the identifier range to be associated with the event
853 handler.
854 @param lastId
855 The last ID of the identifier range to be associated with the event
856 handler.
857 @param userData
858 Data to be associated with the event table entry.
859
860 @see @ref overview_cpp_rtti_disabled
861
862 @since 2.9.0
863 */
864 template <typename EventTag, typename Class, typename EventArg, typename EventHandler>
865 void Bind(const EventTag &eventType,
866 void (Class::*method)(EventArg &),
867 EventHandler *handler,
868 int id = wxID_ANY,
869 int lastId = wxID_ANY,
870 wxObject *userData = NULL);
871 /**
872 Unbinds the given function, functor or method dynamically from the
873 event handler, using the specified parameters as search criteria and
874 returning @true if a matching function has been found and removed.
875
876 This method can only unbind functions, functors or methods which have
877 been added using the Bind<>() method. There is no way to unbind
878 functions bound using the (static) event tables.
879
880 @param eventType
881 The event type associated with this event handler.
882 @param functor
883 The event handler functor. This can be an ordinary function but also
884 an arbitrary functor like boost::function<>.
885 @param id
886 The first ID of the identifier range associated with the event
887 handler.
888 @param lastId
889 The last ID of the identifier range associated with the event
890 handler.
891 @param userData
892 Data associated with the event table entry.
893
894 @see @ref overview_cpp_rtti_disabled
895
896 @since 2.9.0
897 */
898 template <typename EventTag, typename Functor>
899 bool Unbind(const EventTag& eventType,
900 Functor functor,
901 int id = wxID_ANY,
902 int lastId = wxID_ANY,
903 wxObject *userData = NULL);
904
905 /**
906 See the Unbind<>(const EventTag&, Functor, int, int, wxObject*)
907 overload for more info.
908
909 This overload unbinds the given method from the event..
910
911 @param eventType
912 The event type associated with this event handler.
913 @param method
914 The event handler method associated with this event.
915 @param handler
916 Object whose method was called.
917 @param id
918 The first ID of the identifier range associated with the event
919 handler.
920 @param lastId
921 The last ID of the identifier range associated with the event
922 handler.
923 @param userData
924 Data associated with the event table entry.
925
926 @see @ref overview_cpp_rtti_disabled
927
928 @since 2.9.0
929 */
930 template <typename EventTag, typename Class, typename EventArg, typename EventHandler>
931 bool Unbind(const EventTag &eventType,
932 void (Class::*method)(EventArg&),
933 EventHandler *handler,
934 int id = wxID_ANY,
935 int lastId = wxID_ANY,
936 wxObject *userData = NULL );
937 //@}
938 /**
939 @name User-supplied data
940 */
941 //@{
942
943 /**
944 Returns user-supplied client data.
945
946 @remarks Normally, any extra data the programmer wishes to associate with
947 the object should be made available by deriving a new class with
948 new data members.
949
950 @see SetClientData()
951 */
952 void* GetClientData() const;
953
954 /**
955 Returns a pointer to the user-supplied client data object.
956
957 @see SetClientObject(), wxClientData
958 */
959 wxClientData* GetClientObject() const;
960
961 /**
962 Sets user-supplied client data.
963
964 @param data
965 Data to be associated with the event handler.
966
967 @remarks Normally, any extra data the programmer wishes to associate
968 with the object should be made available by deriving a new
969 class with new data members. You must not call this method
970 and SetClientObject on the same class - only one of them.
971
972 @see GetClientData()
973 */
974 void SetClientData(void* data);
975
976 /**
977 Set the client data object. Any previous object will be deleted.
978
979 @see GetClientObject(), wxClientData
980 */
981 void SetClientObject(wxClientData* data);
982
983 //@}
984
985
986 /**
987 @name Event handler chaining
988
989 wxEvtHandler can be arranged in a double-linked list of handlers
990 which is automatically iterated by ProcessEvent() if needed.
991 */
992 //@{
993
994 /**
995 Returns @true if the event handler is enabled, @false otherwise.
996
997 @see SetEvtHandlerEnabled()
998 */
999 bool GetEvtHandlerEnabled() const;
1000
1001 /**
1002 Returns the pointer to the next handler in the chain.
1003
1004 @see SetNextHandler(), GetPreviousHandler(), SetPreviousHandler(),
1005 wxWindow::PushEventHandler, wxWindow::PopEventHandler
1006 */
1007 wxEvtHandler* GetNextHandler() const;
1008
1009 /**
1010 Returns the pointer to the previous handler in the chain.
1011
1012 @see SetPreviousHandler(), GetNextHandler(), SetNextHandler(),
1013 wxWindow::PushEventHandler, wxWindow::PopEventHandler
1014 */
1015 wxEvtHandler* GetPreviousHandler() const;
1016
1017 /**
1018 Enables or disables the event handler.
1019
1020 @param enabled
1021 @true if the event handler is to be enabled, @false if it is to be disabled.
1022
1023 @remarks You can use this function to avoid having to remove the event
1024 handler from the chain, for example when implementing a
1025 dialog editor and changing from edit to test mode.
1026
1027 @see GetEvtHandlerEnabled()
1028 */
1029 void SetEvtHandlerEnabled(bool enabled);
1030
1031 /**
1032 Sets the pointer to the next handler.
1033
1034 @remarks
1035 See ProcessEvent() for more info about how the chains of event handlers
1036 are internally used.
1037 Also remember that wxEvtHandler uses double-linked lists and thus if you
1038 use this function, you should also call SetPreviousHandler() on the
1039 argument passed to this function:
1040 @code
1041 handlerA->SetNextHandler(handlerB);
1042 handlerB->SetPreviousHandler(handlerA);
1043 @endcode
1044
1045 @param handler
1046 The event handler to be set as the next handler.
1047 Cannot be @NULL.
1048
1049 @see @ref overview_events_processing
1050 */
1051 virtual void SetNextHandler(wxEvtHandler* handler);
1052
1053 /**
1054 Sets the pointer to the previous handler.
1055 All remarks about SetNextHandler() apply to this function as well.
1056
1057 @param handler
1058 The event handler to be set as the previous handler.
1059 Cannot be @NULL.
1060
1061 @see @ref overview_events_processing
1062 */
1063 virtual void SetPreviousHandler(wxEvtHandler* handler);
1064
1065 /**
1066 Unlinks this event handler from the chain it's part of (if any);
1067 then links the "previous" event handler to the "next" one
1068 (so that the chain won't be interrupted).
1069
1070 E.g. if before calling Unlink() you have the following chain:
1071 @image html evthandler_unlink_before.png
1072 then after calling @c B->Unlink() you'll have:
1073 @image html evthandler_unlink_after.png
1074
1075 @since 2.9.0
1076 */
1077 void Unlink();
1078
1079 /**
1080 Returns @true if the next and the previous handler pointers of this
1081 event handler instance are @NULL.
1082
1083 @since 2.9.0
1084
1085 @see SetPreviousHandler(), SetNextHandler()
1086 */
1087 bool IsUnlinked() const;
1088
1089 //@}
1090
1091 /**
1092 @name Global event filters.
1093
1094 Methods for working with the global list of event filters.
1095
1096 Event filters can be defined to pre-process all the events that happen
1097 in an application, see wxEventFilter documentation for more information.
1098 */
1099 //@{
1100
1101 /**
1102 Add an event filter whose FilterEvent() method will be called for each
1103 and every event processed by wxWidgets.
1104
1105 The filters are called in LIFO order and wxApp is registered as an
1106 event filter by default. The pointer must remain valid until it's
1107 removed with RemoveFilter() and is not deleted by wxEvtHandler.
1108
1109 @since 2.9.3
1110 */
1111 static void AddFilter(wxEventFilter* filter);
1112
1113 /**
1114 Remove a filter previously installed with AddFilter().
1115
1116 It's an error to remove a filter that hadn't been previously added or
1117 was already removed.
1118
1119 @since 2.9.3
1120 */
1121 static void RemoveFilter(wxEventFilter* filter);
1122
1123 //@}
1124
1125protected:
1126 /**
1127 Method called by ProcessEvent() before examining this object event
1128 tables.
1129
1130 This method can be overridden to hook into the event processing logic
1131 as early as possible. You should usually call the base class version
1132 when overriding this method, even if wxEvtHandler itself does nothing
1133 here, some derived classes do use this method, e.g. wxWindow implements
1134 support for wxValidator in it.
1135
1136 Example:
1137 @code
1138 class MyClass : public BaseClass // inheriting from wxEvtHandler
1139 {
1140 ...
1141 protected:
1142 virtual bool TryBefore(wxEvent& event)
1143 {
1144 if ( MyPreProcess(event) )
1145 return true;
1146
1147 return BaseClass::TryBefore(event);
1148 }
1149 };
1150 @endcode
1151
1152 @see ProcessEvent()
1153 */
1154 virtual bool TryBefore(wxEvent& event);
1155
1156 /**
1157 Method called by ProcessEvent() as last resort.
1158
1159 This method can be overridden to implement post-processing for the
1160 events which were not processed anywhere else.
1161
1162 The base class version handles forwarding the unprocessed events to
1163 wxApp at wxEvtHandler level and propagating them upwards the window
1164 child-parent chain at wxWindow level and so should usually be called
1165 when overriding this method:
1166 @code
1167 class MyClass : public BaseClass // inheriting from wxEvtHandler
1168 {
1169 ...
1170 protected:
1171 virtual bool TryAfter(wxEvent& event)
1172 {
1173 if ( BaseClass::TryAfter(event) )
1174 return true;
1175
1176 return MyPostProcess(event);
1177 }
1178 };
1179 @endcode
1180
1181 @see ProcessEvent()
1182 */
1183 virtual bool TryAfter(wxEvent& event);
1184};
1185
1186
1187/**
1188 Flags for categories of keys.
1189
1190 These values are used by wxKeyEvent::IsKeyInCategory(). They may be
1191 combined via the bitwise operators |, &, and ~.
1192
1193 @since 2.9.1
1194*/
1195enum wxKeyCategoryFlags
1196{
1197 /// arrow keys, on and off numeric keypads
1198 WXK_CATEGORY_ARROW,
1199
1200 /// page up and page down keys, on and off numeric keypads
1201 WXK_CATEGORY_PAGING,
1202
1203 /// home and end keys, on and off numeric keypads
1204 WXK_CATEGORY_JUMP,
1205
1206 /// tab key, on and off numeric keypads
1207 WXK_CATEGORY_TAB,
1208
1209 /// backspace and delete keys, on and off numeric keypads
1210 WXK_CATEGORY_CUT,
1211
1212 /// union of WXK_CATEGORY_ARROW, WXK_CATEGORY_PAGING, and WXK_CATEGORY_JUMP categories
1213 WXK_CATEGORY_NAVIGATION
1214};
1215
1216
1217/**
1218 @class wxKeyEvent
1219
1220 This event class contains information about key press and release events.
1221
1222 The main information carried by this event is the key being pressed or
1223 released. It can be accessed using either GetKeyCode() function or
1224 GetUnicodeKey(). For the printable characters, the latter should be used as
1225 it works for any keys, including non-Latin-1 characters that can be entered
1226 when using national keyboard layouts. GetKeyCode() should be used to handle
1227 special characters (such as cursor arrows keys or @c HOME or @c INS and so
1228 on) which correspond to ::wxKeyCode enum elements above the @c WXK_START
1229 constant. While GetKeyCode() also returns the character code for Latin-1
1230 keys for compatibility, it doesn't work for Unicode characters in general
1231 and will return @c WXK_NONE for any non-Latin-1 ones. For this reason, it's
1232 recommended to always use GetUnicodeKey() and only fall back to GetKeyCode()
1233 if GetUnicodeKey() returned @c WXK_NONE meaning that the event corresponds
1234 to a non-printable special keys.
1235
1236 While both of these functions can be used with the events of @c
1237 wxEVT_KEY_DOWN, @c wxEVT_KEY_UP and @c wxEVT_CHAR types, the values
1238 returned by them are different for the first two events and the last one.
1239 For the latter, the key returned corresponds to the character that would
1240 appear in e.g. a text zone if the user pressed the key in it. As such, its
1241 value depends on the current state of the Shift key and, for the letters,
1242 on the state of Caps Lock modifier. For example, if @c A key is pressed
1243 without Shift being held down, wxKeyEvent of type @c wxEVT_CHAR generated
1244 for this key press will return (from either GetKeyCode() or GetUnicodeKey()
1245 as their meanings coincide for ASCII characters) key code of 97
1246 corresponding the ASCII value of @c a. And if the same key is pressed but
1247 with Shift being held (or Caps Lock being active), then the key could would
1248 be 65, i.e. ASCII value of capital @c A.
1249
1250 However for the key down and up events the returned key code will instead
1251 be @c A independently of the state of the modifier keys i.e. it depends
1252 only on physical key being pressed and is not translated to its logical
1253 representation using the current keyboard state. Such untranslated key
1254 codes are defined as follows:
1255 - For the letters they correspond to the @e upper case value of the
1256 letter.
1257 - For the other alphanumeric keys (e.g. @c 7 or @c +), the untranslated
1258 key code corresponds to the character produced by the key when it is
1259 pressed without Shift. E.g. in standard US keyboard layout the
1260 untranslated key code for the key @c =/+ in the upper right corner of
1261 the keyboard is 61 which is the ASCII value of @c =.
1262 - For the rest of the keys (i.e. special non-printable keys) it is the
1263 same as the normal key code as no translation is used anyhow.
1264
1265 Notice that the first rule applies to all Unicode letters, not just the
1266 usual Latin-1 ones. However for non-Latin-1 letters only GetUnicodeKey()
1267 can be used to retrieve the key code as GetKeyCode() just returns @c
1268 WXK_NONE in this case.
1269
1270 To summarize: you should handle @c wxEVT_CHAR if you need the translated
1271 key and @c wxEVT_KEY_DOWN if you only need the value of the key itself,
1272 independent of the current keyboard state.
1273
1274 @note Not all key down events may be generated by the user. As an example,
1275 @c wxEVT_KEY_DOWN with @c = key code can be generated using the
1276 standard US keyboard layout but not using the German one because the @c
1277 = key corresponds to Shift-0 key combination in this layout and the key
1278 code for it is @c 0, not @c =. Because of this you should avoid
1279 requiring your users to type key events that might be impossible to
1280 enter on their keyboard.
1281
1282
1283 Another difference between key and char events is that another kind of
1284 translation is done for the latter ones when the Control key is pressed:
1285 char events for ASCII letters in this case carry codes corresponding to the
1286 ASCII value of Ctrl-Latter, i.e. 1 for Ctrl-A, 2 for Ctrl-B and so on until
1287 26 for Ctrl-Z. This is convenient for terminal-like applications and can be
1288 completely ignored by all the other ones (if you need to handle Ctrl-A it
1289 is probably a better idea to use the key event rather than the char one).
1290 Notice that currently no translation is done for the presses of @c [, @c
1291 \\, @c ], @c ^ and @c _ keys which might be mapped to ASCII values from 27
1292 to 31.
1293 Since version 2.9.2, the enum values @c WXK_CONTROL_A - @c WXK_CONTROL_Z
1294 can be used instead of the non-descriptive constant values 1-26.
1295
1296 Finally, modifier keys only generate key events but no char events at all.
1297 The modifiers keys are @c WXK_SHIFT, @c WXK_CONTROL, @c WXK_ALT and various
1298 @c WXK_WINDOWS_XXX from ::wxKeyCode enum.
1299
1300 Modifier keys events are special in one additional aspect: usually the
1301 keyboard state associated with a key press is well defined, e.g.
1302 wxKeyboardState::ShiftDown() returns @c true only if the Shift key was held
1303 pressed when the key that generated this event itself was pressed. There is
1304 an ambiguity for the key press events for Shift key itself however. By
1305 convention, it is considered to be already pressed when it is pressed and
1306 already released when it is released. In other words, @c wxEVT_KEY_DOWN
1307 event for the Shift key itself will have @c wxMOD_SHIFT in GetModifiers()
1308 and ShiftDown() will return true while the @c wxEVT_KEY_UP event for Shift
1309 itself will not have @c wxMOD_SHIFT in its modifiers and ShiftDown() will
1310 return false.
1311
1312
1313 @b Tip: You may discover the key codes and modifiers generated by all the
1314 keys on your system interactively by running the @ref
1315 page_samples_keyboard wxWidgets sample and pressing some keys in it.
1316
1317 @note If a key down (@c EVT_KEY_DOWN) event is caught and the event handler
1318 does not call @c event.Skip() then the corresponding char event
1319 (@c EVT_CHAR) will not happen. This is by design and enables the
1320 programs that handle both types of events to avoid processing the
1321 same key twice. As a consequence, if you do not want to suppress the
1322 @c wxEVT_CHAR events for the keys you handle, always call @c
1323 event.Skip() in your @c wxEVT_KEY_DOWN handler. Not doing may also
1324 prevent accelerators defined using this key from working.
1325
1326 @note If a key is maintained in a pressed state, you will typically get a
1327 lot of (automatically generated) key down events but only one key up
1328 one at the end when the key is released so it is wrong to assume that
1329 there is one up event corresponding to each down one.
1330
1331 @note For Windows programmers: The key and char events in wxWidgets are
1332 similar to but slightly different from Windows @c WM_KEYDOWN and
1333 @c WM_CHAR events. In particular, Alt-x combination will generate a
1334 char event in wxWidgets (unless it is used as an accelerator) and
1335 almost all keys, including ones without ASCII equivalents, generate
1336 char events too.
1337
1338
1339 @beginEventTable{wxKeyEvent}
1340 @event{EVT_KEY_DOWN(func)}
1341 Process a @c wxEVT_KEY_DOWN event (any key has been pressed). If this
1342 event is handled and not skipped, @c wxEVT_CHAR will not be generated
1343 at all for this key press (but @c wxEVT_KEY_UP will be).
1344 @event{EVT_KEY_UP(func)}
1345 Process a @c wxEVT_KEY_UP event (any key has been released).
1346 @event{EVT_CHAR(func)}
1347 Process a @c wxEVT_CHAR event.
1348 @event{EVT_CHAR_HOOK(func)}
1349 Process a @c wxEVT_CHAR_HOOK event. Unlike all the other key events,
1350 this event is propagated upwards the window hierarchy which allows
1351 intercepting it in the parent window of the focused window to which it
1352 is sent initially (if there is no focused window, this event is sent to
1353 the wxApp global object). It is also generated before any other key
1354 events and so gives the parent window an opportunity to modify the
1355 keyboard handling of its children, e.g. it is used internally by
1356 wxWidgets in some ports to intercept pressing Esc key in any child of a
1357 dialog to close the dialog itself when it's pressed. By default, if
1358 this event is handled, i.e. the handler doesn't call wxEvent::Skip(),
1359 neither @c wxEVT_KEY_DOWN nor @c wxEVT_CHAR events will be generated
1360 (although @c wxEVT_KEY_UP still will be), i.e. it replaces the normal
1361 key events. However by calling the special DoAllowNextEvent() method
1362 you can handle @c wxEVT_CHAR_HOOK and still allow normal events
1363 generation. This is something that is rarely useful but can be required
1364 if you need to prevent a parent @c wxEVT_CHAR_HOOK handler from running
1365 without suppressing the normal key events. Finally notice that this
1366 event is not generated when the mouse is captured as it is considered
1367 that the window which has the capture should receive all the keyboard
1368 events too without allowing its parent wxTopLevelWindow to interfere
1369 with their processing.
1370 @endEventTable
1371
1372 @see wxKeyboardState
1373
1374 @library{wxcore}
1375 @category{events}
1376*/
1377class wxKeyEvent : public wxEvent,
1378 public wxKeyboardState
1379{
1380public:
1381 /**
1382 Constructor.
1383 Currently, the only valid event types are @c wxEVT_CHAR and @c wxEVT_CHAR_HOOK.
1384 */
1385 wxKeyEvent(wxEventType keyEventType = wxEVT_NULL);
1386
1387 /**
1388 Returns the key code of the key that generated this event.
1389
1390 ASCII symbols return normal ASCII values, while events from special
1391 keys such as "left cursor arrow" (@c WXK_LEFT) return values outside of
1392 the ASCII range. See ::wxKeyCode for a full list of the virtual key
1393 codes.
1394
1395 Note that this method returns a meaningful value only for special
1396 non-alphanumeric keys or if the user entered a character that can be
1397 represented in current locale's default charset. Otherwise, e.g. if the
1398 user enters a Japanese character in a program not using Japanese
1399 locale, this method returns @c WXK_NONE and GetUnicodeKey() should be
1400 used to obtain the corresponding Unicode character.
1401
1402 Using GetUnicodeKey() is in general the right thing to do if you are
1403 interested in the characters typed by the user, GetKeyCode() should be
1404 only used for special keys (for which GetUnicodeKey() returns @c
1405 WXK_NONE). To handle both kinds of keys you might write:
1406 @code
1407 void MyHandler::OnChar(wxKeyEvent& event)
1408 {
1409 wxChar uc = event.GetUnicodeKey();
1410 if ( uc != WXK_NONE )
1411 {
1412 // It's a "normal" character. Notice that this includes
1413 // control characters in 1..31 range, e.g. WXK_RETURN or
1414 // WXK_BACK.
1415 if ( wxIsprint(uc) )
1416 {
1417 wxLogMessage("You pressed '%c'", uc);
1418 }
1419 else
1420 {
1421 // It's a control character
1422 ...
1423 }
1424 }
1425 else // No Unicode equivalent.
1426 {
1427 // It's a special key, deal with all the known ones:
1428 switch ( GetKeyCode() )
1429 {
1430 case WXK_LEFT:
1431 case WXK_RIGHT:
1432 ... move cursor ...
1433 break;
1434
1435 case WXK_F1:
1436 ... give help ...
1437 break;
1438 }
1439 }
1440 }
1441 @endcode
1442 */
1443 int GetKeyCode() const;
1444
1445 /**
1446 Returns true if the key is in the given key category.
1447
1448 @param category
1449 A bitwise combination of named ::wxKeyCategoryFlags constants.
1450
1451 @since 2.9.1
1452 */
1453 bool IsKeyInCategory(int category) const;
1454
1455 //@{
1456 /**
1457 Obtains the position (in client coordinates) at which the key was pressed.
1458
1459 Notice that this position is simply the current mouse pointer position
1460 and has no special relationship to the key event itself.
1461 */
1462 wxPoint GetPosition() const;
1463 void GetPosition(long* x, long* y) const;
1464 //@}
1465
1466 /**
1467 Returns the raw key code for this event.
1468
1469 The flags are platform-dependent and should only be used if the
1470 functionality provided by other wxKeyEvent methods is insufficient.
1471
1472 Under MSW, the raw key code is the value of @c wParam parameter of the
1473 corresponding message.
1474
1475 Under GTK, the raw key code is the @c keyval field of the corresponding
1476 GDK event.
1477
1478 Under OS X, the raw key code is the @c keyCode field of the
1479 corresponding NSEvent.
1480
1481 @note Currently the raw key codes are not supported by all ports, use
1482 @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
1483 */
1484 wxUint32 GetRawKeyCode() const;
1485
1486 /**
1487 Returns the low level key flags for this event.
1488
1489 The flags are platform-dependent and should only be used if the
1490 functionality provided by other wxKeyEvent methods is insufficient.
1491
1492 Under MSW, the raw flags are just the value of @c lParam parameter of
1493 the corresponding message.
1494
1495 Under GTK, the raw flags contain the @c hardware_keycode field of the
1496 corresponding GDK event.
1497
1498 Under OS X, the raw flags contain the modifiers state.
1499
1500 @note Currently the raw key flags are not supported by all ports, use
1501 @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
1502 */
1503 wxUint32 GetRawKeyFlags() const;
1504
1505 /**
1506 Returns the Unicode character corresponding to this key event.
1507
1508 If the key pressed doesn't have any character value (e.g. a cursor key)
1509 this method will return @c WXK_NONE. In this case you should use
1510 GetKeyCode() to retrieve the value of the key.
1511
1512 This function is only available in Unicode build, i.e. when
1513 @c wxUSE_UNICODE is 1.
1514 */
1515 wxChar GetUnicodeKey() const;
1516
1517 /**
1518 Returns the X position (in client coordinates) of the event.
1519
1520 @see GetPosition()
1521 */
1522 wxCoord GetX() const;
1523
1524 /**
1525 Returns the Y position (in client coordinates) of the event.
1526
1527 @see GetPosition()
1528 */
1529 wxCoord GetY() const;
1530
1531 /**
1532 Allow normal key events generation.
1533
1534 Can be called from @c wxEVT_CHAR_HOOK handler to indicate that the
1535 generation of normal events should @em not be suppressed, as it happens
1536 by default when this event is handled.
1537
1538 The intended use of this method is to allow some window object to
1539 prevent @c wxEVT_CHAR_HOOK handler in its parent window from running by
1540 defining its own handler for this event. Without calling this method,
1541 this would result in not generating @c wxEVT_KEY_DOWN nor @c wxEVT_CHAR
1542 events at all but by calling it you can ensure that these events would
1543 still be generated, even if @c wxEVT_CHAR_HOOK event was handled.
1544
1545 @since 2.9.3
1546 */
1547 void DoAllowNextEvent();
1548
1549 /**
1550 Returns @true if DoAllowNextEvent() had been called, @false by default.
1551
1552 This method is used by wxWidgets itself to determine whether the normal
1553 key events should be generated after @c wxEVT_CHAR_HOOK processing.
1554
1555 @since 2.9.3
1556 */
1557 bool IsNextEventAllowed() const;
1558};
1559
1560
1561
1562enum
1563{
1564 wxJOYSTICK1,
1565 wxJOYSTICK2
1566};
1567
1568// Which button is down?
1569enum
1570{
1571 wxJOY_BUTTON_ANY = -1,
1572 wxJOY_BUTTON1 = 1,
1573 wxJOY_BUTTON2 = 2,
1574 wxJOY_BUTTON3 = 4,
1575 wxJOY_BUTTON4 = 8
1576};
1577
1578
1579/**
1580 @class wxJoystickEvent
1581
1582 This event class contains information about joystick events, particularly
1583 events received by windows.
1584
1585 @beginEventTable{wxJoystickEvent}
1586 @event{EVT_JOY_BUTTON_DOWN(func)}
1587 Process a @c wxEVT_JOY_BUTTON_DOWN event.
1588 @event{EVT_JOY_BUTTON_UP(func)}
1589 Process a @c wxEVT_JOY_BUTTON_UP event.
1590 @event{EVT_JOY_MOVE(func)}
1591 Process a @c wxEVT_JOY_MOVE event.
1592 @event{EVT_JOY_ZMOVE(func)}
1593 Process a @c wxEVT_JOY_ZMOVE event.
1594 @event{EVT_JOYSTICK_EVENTS(func)}
1595 Processes all joystick events.
1596 @endEventTable
1597
1598 @library{wxcore}
1599 @category{events}
1600
1601 @see wxJoystick
1602*/
1603class wxJoystickEvent : public wxEvent
1604{
1605public:
1606 /**
1607 Constructor.
1608 */
1609 wxJoystickEvent(wxEventType eventType = wxEVT_NULL, int state = 0,
1610 int joystick = wxJOYSTICK1,
1611 int change = 0);
1612
1613 /**
1614 Returns @true if the event was a down event from the specified button
1615 (or any button).
1616
1617 @param button
1618 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1619 indicate any button down event.
1620 */
1621 bool ButtonDown(int button = wxJOY_BUTTON_ANY) const;
1622
1623 /**
1624 Returns @true if the specified button (or any button) was in a down state.
1625
1626 @param button
1627 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1628 indicate any button down event.
1629 */
1630 bool ButtonIsDown(int button = wxJOY_BUTTON_ANY) const;
1631
1632 /**
1633 Returns @true if the event was an up event from the specified button
1634 (or any button).
1635
1636 @param button
1637 Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
1638 indicate any button down event.
1639 */
1640 bool ButtonUp(int button = wxJOY_BUTTON_ANY) const;
1641
1642 /**
1643 Returns the identifier of the button changing state.
1644
1645 This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
1646 */
1647 int GetButtonChange() const;
1648
1649 /**
1650 Returns the down state of the buttons.
1651
1652 This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
1653 */
1654 int GetButtonState() const;
1655
1656 /**
1657 Returns the identifier of the joystick generating the event - one of
1658 wxJOYSTICK1 and wxJOYSTICK2.
1659 */
1660 int GetJoystick() const;
1661
1662 /**
1663 Returns the x, y position of the joystick event.
1664
1665 These coordinates are valid for all the events except wxEVT_JOY_ZMOVE.
1666 */
1667 wxPoint GetPosition() const;
1668
1669 /**
1670 Returns the z position of the joystick event.
1671
1672 This method can only be used for wxEVT_JOY_ZMOVE events.
1673 */
1674 int GetZPosition() const;
1675
1676 /**
1677 Returns @true if this was a button up or down event
1678 (@e not 'is any button down?').
1679 */
1680 bool IsButton() const;
1681
1682 /**
1683 Returns @true if this was an x, y move event.
1684 */
1685 bool IsMove() const;
1686
1687 /**
1688 Returns @true if this was a z move event.
1689 */
1690 bool IsZMove() const;
1691};
1692
1693
1694
1695/**
1696 @class wxScrollWinEvent
1697
1698 A scroll event holds information about events sent from scrolling windows.
1699
1700 Note that you can use the EVT_SCROLLWIN* macros for intercepting scroll window events
1701 from the receiving window.
1702
1703 @beginEventTable{wxScrollWinEvent}
1704 @event{EVT_SCROLLWIN(func)}
1705 Process all scroll events.
1706 @event{EVT_SCROLLWIN_TOP(func)}
1707 Process @c wxEVT_SCROLLWIN_TOP scroll-to-top events.
1708 @event{EVT_SCROLLWIN_BOTTOM(func)}
1709 Process @c wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
1710 @event{EVT_SCROLLWIN_LINEUP(func)}
1711 Process @c wxEVT_SCROLLWIN_LINEUP line up events.
1712 @event{EVT_SCROLLWIN_LINEDOWN(func)}
1713 Process @c wxEVT_SCROLLWIN_LINEDOWN line down events.
1714 @event{EVT_SCROLLWIN_PAGEUP(func)}
1715 Process @c wxEVT_SCROLLWIN_PAGEUP page up events.
1716 @event{EVT_SCROLLWIN_PAGEDOWN(func)}
1717 Process @c wxEVT_SCROLLWIN_PAGEDOWN page down events.
1718 @event{EVT_SCROLLWIN_THUMBTRACK(func)}
1719 Process @c wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
1720 (frequent events sent as the user drags the thumbtrack).
1721 @event{EVT_SCROLLWIN_THUMBRELEASE(func)}
1722 Process @c wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
1723 @endEventTable
1724
1725
1726 @library{wxcore}
1727 @category{events}
1728
1729 @see wxScrollEvent, @ref overview_events
1730*/
1731class wxScrollWinEvent : public wxEvent
1732{
1733public:
1734 /**
1735 Constructor.
1736 */
1737 wxScrollWinEvent(wxEventType commandType = wxEVT_NULL, int pos = 0,
1738 int orientation = 0);
1739
1740 /**
1741 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
1742 scrollbar.
1743
1744 @todo wxHORIZONTAL and wxVERTICAL should go in their own enum
1745 */
1746 int GetOrientation() const;
1747
1748 /**
1749 Returns the position of the scrollbar for the thumb track and release events.
1750
1751 Note that this field can't be used for the other events, you need to query
1752 the window itself for the current position in that case.
1753 */
1754 int GetPosition() const;
1755
1756 void SetOrientation(int orient);
1757 void SetPosition(int pos);
1758};
1759
1760
1761
1762/**
1763 @class wxSysColourChangedEvent
1764
1765 This class is used for system colour change events, which are generated
1766 when the user changes the colour settings using the control panel.
1767 This is only appropriate under Windows.
1768
1769 @remarks
1770 The default event handler for this event propagates the event to child windows,
1771 since Windows only sends the events to top-level windows.
1772 If intercepting this event for a top-level window, remember to call the base
1773 class handler, or to pass the event on to the window's children explicitly.
1774
1775 @beginEventTable{wxSysColourChangedEvent}
1776 @event{EVT_SYS_COLOUR_CHANGED(func)}
1777 Process a @c wxEVT_SYS_COLOUR_CHANGED event.
1778 @endEventTable
1779
1780 @library{wxcore}
1781 @category{events}
1782
1783 @see @ref overview_events
1784*/
1785class wxSysColourChangedEvent : public wxEvent
1786{
1787public:
1788 /**
1789 Constructor.
1790 */
1791 wxSysColourChangedEvent();
1792};
1793
1794
1795
1796/**
1797 @class wxWindowCreateEvent
1798
1799 This event is sent just after the actual window associated with a wxWindow
1800 object has been created.
1801
1802 Since it is derived from wxCommandEvent, the event propagates up
1803 the window hierarchy.
1804
1805 @beginEventTable{wxWindowCreateEvent}
1806 @event{EVT_WINDOW_CREATE(func)}
1807 Process a @c wxEVT_CREATE event.
1808 @endEventTable
1809
1810 @library{wxcore}
1811 @category{events}
1812
1813 @see @ref overview_events, wxWindowDestroyEvent
1814*/
1815class wxWindowCreateEvent : public wxCommandEvent
1816{
1817public:
1818 /**
1819 Constructor.
1820 */
1821 wxWindowCreateEvent(wxWindow* win = NULL);
1822
1823 /// Return the window being created.
1824 wxWindow *GetWindow() const;
1825};
1826
1827
1828
1829/**
1830 @class wxPaintEvent
1831
1832 A paint event is sent when a window's contents needs to be repainted.
1833
1834 The handler of this event must create a wxPaintDC object and use it for
1835 painting the window contents. For example:
1836 @code
1837 void MyWindow::OnPaint(wxPaintEvent& event)
1838 {
1839 wxPaintDC dc(this);
1840
1841 DrawMyDocument(dc);
1842 }
1843 @endcode
1844
1845 Notice that you must @e not create other kinds of wxDC (e.g. wxClientDC or
1846 wxWindowDC) in EVT_PAINT handlers and also don't create wxPaintDC outside
1847 of this event handlers.
1848
1849
1850 You can optimize painting by retrieving the rectangles that have been damaged
1851 and only repainting these. The rectangles are in terms of the client area,
1852 and are unscrolled, so you will need to do some calculations using the current
1853 view position to obtain logical, scrolled units.
1854 Here is an example of using the wxRegionIterator class:
1855 @code
1856 // Called when window needs to be repainted.
1857 void MyWindow::OnPaint(wxPaintEvent& event)
1858 {
1859 wxPaintDC dc(this);
1860
1861 // Find Out where the window is scrolled to
1862 int vbX,vbY; // Top left corner of client
1863 GetViewStart(&vbX,&vbY);
1864
1865 int vX,vY,vW,vH; // Dimensions of client area in pixels
1866 wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
1867
1868 while (upd)
1869 {
1870 vX = upd.GetX();
1871 vY = upd.GetY();
1872 vW = upd.GetW();
1873 vH = upd.GetH();
1874
1875 // Alternatively we can do this:
1876 // wxRect rect(upd.GetRect());
1877
1878 // Repaint this rectangle
1879 ...some code...
1880
1881 upd ++ ;
1882 }
1883 }
1884 @endcode
1885
1886 @remarks
1887 Please notice that in general it is impossible to change the drawing of a
1888 standard control (such as wxButton) and so you shouldn't attempt to handle
1889 paint events for them as even if it might work on some platforms, this is
1890 inherently not portable and won't work everywhere.
1891
1892
1893 @beginEventTable{wxPaintEvent}
1894 @event{EVT_PAINT(func)}
1895 Process a @c wxEVT_PAINT event.
1896 @endEventTable
1897
1898 @library{wxcore}
1899 @category{events}
1900
1901 @see @ref overview_events
1902*/
1903class wxPaintEvent : public wxEvent
1904{
1905public:
1906 /**
1907 Constructor.
1908 */
1909 wxPaintEvent(int id = 0);
1910};
1911
1912
1913
1914/**
1915 @class wxMaximizeEvent
1916
1917 An event being sent when a top level window is maximized. Notice that it is
1918 not sent when the window is restored to its original size after it had been
1919 maximized, only a normal wxSizeEvent is generated in this case.
1920
1921 Currently this event is only generated in wxMSW, wxGTK, wxOSX/Cocoa and wxOS2
1922 ports so portable programs should only rely on receiving @c wxEVT_SIZE and
1923 not necessarily this event when the window is maximized.
1924
1925 @beginEventTable{wxMaximizeEvent}
1926 @event{EVT_MAXIMIZE(func)}
1927 Process a @c wxEVT_MAXIMIZE event.
1928 @endEventTable
1929
1930 @library{wxcore}
1931 @category{events}
1932
1933 @see @ref overview_events, wxTopLevelWindow::Maximize,
1934 wxTopLevelWindow::IsMaximized
1935*/
1936class wxMaximizeEvent : public wxEvent
1937{
1938public:
1939 /**
1940 Constructor. Only used by wxWidgets internally.
1941 */
1942 wxMaximizeEvent(int id = 0);
1943};
1944
1945/**
1946 The possibles modes to pass to wxUpdateUIEvent::SetMode().
1947*/
1948enum wxUpdateUIMode
1949{
1950 /** Send UI update events to all windows. */
1951 wxUPDATE_UI_PROCESS_ALL,
1952
1953 /** Send UI update events to windows that have
1954 the wxWS_EX_PROCESS_UI_UPDATES flag specified. */
1955 wxUPDATE_UI_PROCESS_SPECIFIED
1956};
1957
1958
1959/**
1960 @class wxUpdateUIEvent
1961
1962 This class is used for pseudo-events which are called by wxWidgets
1963 to give an application the chance to update various user interface elements.
1964
1965 Without update UI events, an application has to work hard to check/uncheck,
1966 enable/disable, show/hide, and set the text for elements such as menu items
1967 and toolbar buttons. The code for doing this has to be mixed up with the code
1968 that is invoked when an action is invoked for a menu item or button.
1969
1970 With update UI events, you define an event handler to look at the state of the
1971 application and change UI elements accordingly. wxWidgets will call your member
1972 functions in idle time, so you don't have to worry where to call this code.
1973
1974 In addition to being a clearer and more declarative method, it also means you don't
1975 have to worry whether you're updating a toolbar or menubar identifier. The same
1976 handler can update a menu item and toolbar button, if the identifier is the same.
1977 Instead of directly manipulating the menu or button, you call functions in the event
1978 object, such as wxUpdateUIEvent::Check. wxWidgets will determine whether such a
1979 call has been made, and which UI element to update.
1980
1981 These events will work for popup menus as well as menubars. Just before a menu is
1982 popped up, wxMenu::UpdateUI is called to process any UI events for the window that
1983 owns the menu.
1984
1985 If you find that the overhead of UI update processing is affecting your application,
1986 you can do one or both of the following:
1987 @li Call wxUpdateUIEvent::SetMode with a value of wxUPDATE_UI_PROCESS_SPECIFIED,
1988 and set the extra style wxWS_EX_PROCESS_UI_UPDATES for every window that should
1989 receive update events. No other windows will receive update events.
1990 @li Call wxUpdateUIEvent::SetUpdateInterval with a millisecond value to set the delay
1991 between updates. You may need to call wxWindow::UpdateWindowUI at critical points,
1992 for example when a dialog is about to be shown, in case the user sees a slight
1993 delay before windows are updated.
1994
1995 Note that although events are sent in idle time, defining a wxIdleEvent handler
1996 for a window does not affect this because the events are sent from wxWindow::OnInternalIdle
1997 which is always called in idle time.
1998
1999 wxWidgets tries to optimize update events on some platforms.
2000 On Windows and GTK+, events for menubar items are only sent when the menu is about
2001 to be shown, and not in idle time.
2002
2003
2004 @beginEventTable{wxUpdateUIEvent}
2005 @event{EVT_UPDATE_UI(id, func)}
2006 Process a @c wxEVT_UPDATE_UI event for the command with the given id.
2007 @event{EVT_UPDATE_UI_RANGE(id1, id2, func)}
2008 Process a @c wxEVT_UPDATE_UI event for any command with id included in the given range.
2009 @endEventTable
2010
2011 @library{wxcore}
2012 @category{events}
2013
2014 @see @ref overview_events
2015*/
2016class wxUpdateUIEvent : public wxCommandEvent
2017{
2018public:
2019 /**
2020 Constructor.
2021 */
2022 wxUpdateUIEvent(wxWindowID commandId = 0);
2023
2024 /**
2025 Returns @true if it is appropriate to update (send UI update events to)
2026 this window.
2027
2028 This function looks at the mode used (see wxUpdateUIEvent::SetMode),
2029 the wxWS_EX_PROCESS_UI_UPDATES flag in @a window, the time update events
2030 were last sent in idle time, and the update interval, to determine whether
2031 events should be sent to this window now. By default this will always
2032 return @true because the update mode is initially wxUPDATE_UI_PROCESS_ALL
2033 and the interval is set to 0; so update events will be sent as often as
2034 possible. You can reduce the frequency that events are sent by changing the
2035 mode and/or setting an update interval.
2036
2037 @see ResetUpdateTime(), SetUpdateInterval(), SetMode()
2038 */
2039 static bool CanUpdate(wxWindow* window);
2040
2041 /**
2042 Check or uncheck the UI element.
2043 */
2044 void Check(bool check);
2045
2046 /**
2047 Enable or disable the UI element.
2048 */
2049 void Enable(bool enable);
2050
2051 /**
2052 Returns @true if the UI element should be checked.
2053 */
2054 bool GetChecked() const;
2055
2056 /**
2057 Returns @true if the UI element should be enabled.
2058 */
2059 bool GetEnabled() const;
2060
2061 /**
2062 Static function returning a value specifying how wxWidgets will send update
2063 events: to all windows, or only to those which specify that they will process
2064 the events.
2065
2066 @see SetMode()
2067 */
2068 static wxUpdateUIMode GetMode();
2069
2070 /**
2071 Returns @true if the application has called Check().
2072 For wxWidgets internal use only.
2073 */
2074 bool GetSetChecked() const;
2075
2076 /**
2077 Returns @true if the application has called Enable().
2078 For wxWidgets internal use only.
2079 */
2080 bool GetSetEnabled() const;
2081
2082 /**
2083 Returns @true if the application has called Show().
2084 For wxWidgets internal use only.
2085 */
2086 bool GetSetShown() const;
2087
2088 /**
2089 Returns @true if the application has called SetText().
2090 For wxWidgets internal use only.
2091 */
2092 bool GetSetText() const;
2093
2094 /**
2095 Returns @true if the UI element should be shown.
2096 */
2097 bool GetShown() const;
2098
2099 /**
2100 Returns the text that should be set for the UI element.
2101 */
2102 wxString GetText() const;
2103
2104 /**
2105 Returns the current interval between updates in milliseconds.
2106 The value -1 disables updates, 0 updates as frequently as possible.
2107
2108 @see SetUpdateInterval().
2109 */
2110 static long GetUpdateInterval();
2111
2112 /**
2113 Used internally to reset the last-updated time to the current time.
2114
2115 It is assumed that update events are normally sent in idle time, so this
2116 is called at the end of idle processing.
2117
2118 @see CanUpdate(), SetUpdateInterval(), SetMode()
2119 */
2120 static void ResetUpdateTime();
2121
2122 /**
2123 Specify how wxWidgets will send update events: to all windows, or only to
2124 those which specify that they will process the events.
2125
2126 @param mode
2127 this parameter may be one of the ::wxUpdateUIMode enumeration values.
2128 The default mode is wxUPDATE_UI_PROCESS_ALL.
2129 */
2130 static void SetMode(wxUpdateUIMode mode);
2131
2132 /**
2133 Sets the text for this UI element.
2134 */
2135 void SetText(const wxString& text);
2136
2137 /**
2138 Sets the interval between updates in milliseconds.
2139
2140 Set to -1 to disable updates, or to 0 to update as frequently as possible.
2141 The default is 0.
2142
2143 Use this to reduce the overhead of UI update events if your application
2144 has a lot of windows. If you set the value to -1 or greater than 0,
2145 you may also need to call wxWindow::UpdateWindowUI at appropriate points
2146 in your application, such as when a dialog is about to be shown.
2147 */
2148 static void SetUpdateInterval(long updateInterval);
2149
2150 /**
2151 Show or hide the UI element.
2152 */
2153 void Show(bool show);
2154};
2155
2156
2157
2158/**
2159 @class wxClipboardTextEvent
2160
2161 This class represents the events generated by a control (typically a
2162 wxTextCtrl but other windows can generate these events as well) when its
2163 content gets copied or cut to, or pasted from the clipboard.
2164
2165 There are three types of corresponding events @c wxEVT_COMMAND_TEXT_COPY,
2166 @c wxEVT_COMMAND_TEXT_CUT and @c wxEVT_COMMAND_TEXT_PASTE.
2167
2168 If any of these events is processed (without being skipped) by an event
2169 handler, the corresponding operation doesn't take place which allows to
2170 prevent the text from being copied from or pasted to a control. It is also
2171 possible to examine the clipboard contents in the PASTE event handler and
2172 transform it in some way before inserting in a control -- for example,
2173 changing its case or removing invalid characters.
2174
2175 Finally notice that a CUT event is always preceded by the COPY event which
2176 makes it possible to only process the latter if it doesn't matter if the
2177 text was copied or cut.
2178
2179 @note
2180 These events are currently only generated by wxTextCtrl in wxGTK and wxOSX
2181 but are also generated by wxComboBox without wxCB_READONLY style in wxMSW.
2182
2183 @beginEventTable{wxClipboardTextEvent}
2184 @event{EVT_TEXT_COPY(id, func)}
2185 Some or all of the controls content was copied to the clipboard.
2186 @event{EVT_TEXT_CUT(id, func)}
2187 Some or all of the controls content was cut (i.e. copied and
2188 deleted).
2189 @event{EVT_TEXT_PASTE(id, func)}
2190 Clipboard content was pasted into the control.
2191 @endEventTable
2192
2193
2194 @library{wxcore}
2195 @category{events}
2196
2197 @see wxClipboard
2198*/
2199class wxClipboardTextEvent : public wxCommandEvent
2200{
2201public:
2202 /**
2203 Constructor.
2204 */
2205 wxClipboardTextEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
2206};
2207
2208/**
2209 Possible axis values for mouse wheel scroll events.
2210
2211 @since 2.9.4
2212 */
2213enum wxMouseWheelAxis
2214{
2215 wxMOUSE_WHEEL_VERTICAL, ///< Vertical scroll event.
2216 wxMOUSE_WHEEL_HORIZONTAL ///< Horizontal scroll event.
2217};
2218
2219
2220/**
2221 @class wxMouseEvent
2222
2223 This event class contains information about the events generated by the mouse:
2224 they include mouse buttons press and release events and mouse move events.
2225
2226 All mouse events involving the buttons use @c wxMOUSE_BTN_LEFT for the
2227 left mouse button, @c wxMOUSE_BTN_MIDDLE for the middle one and
2228 @c wxMOUSE_BTN_RIGHT for the right one. And if the system supports more
2229 buttons, the @c wxMOUSE_BTN_AUX1 and @c wxMOUSE_BTN_AUX2 events
2230 can also be generated. Note that not all mice have even a middle button so a
2231 portable application should avoid relying on the events from it (but the right
2232 button click can be emulated using the left mouse button with the control key
2233 under Mac platforms with a single button mouse).
2234
2235 For the @c wxEVT_ENTER_WINDOW and @c wxEVT_LEAVE_WINDOW events
2236 purposes, the mouse is considered to be inside the window if it is in the
2237 window client area and not inside one of its children. In other words, the
2238 parent window receives @c wxEVT_LEAVE_WINDOW event not only when the
2239 mouse leaves the window entirely but also when it enters one of its children.
2240
2241 The position associated with a mouse event is expressed in the window
2242 coordinates of the window which generated the event, you can use
2243 wxWindow::ClientToScreen() to convert it to screen coordinates and possibly
2244 call wxWindow::ScreenToClient() next to convert it to window coordinates of
2245 another window.
2246
2247 @note Note that under Windows CE mouse enter and leave events are not natively
2248 supported by the system but are generated by wxWidgets itself. This has several
2249 drawbacks: the LEAVE_WINDOW event might be received some time after the mouse
2250 left the window and the state variables for it may have changed during this time.
2251
2252 @note Note the difference between methods like wxMouseEvent::LeftDown and
2253 the inherited wxMouseState::LeftIsDown: the former returns @true when
2254 the event corresponds to the left mouse button click while the latter
2255 returns @true if the left mouse button is currently being pressed.
2256 For example, when the user is dragging the mouse you can use
2257 wxMouseEvent::LeftIsDown to test whether the left mouse button is
2258 (still) depressed. Also, by convention, if wxMouseEvent::LeftDown
2259 returns @true, wxMouseEvent::LeftIsDown will also return @true in
2260 wxWidgets whatever the underlying GUI behaviour is (which is
2261 platform-dependent). The same applies, of course, to other mouse
2262 buttons as well.
2263
2264
2265 @beginEventTable{wxMouseEvent}
2266 @event{EVT_LEFT_DOWN(func)}
2267 Process a @c wxEVT_LEFT_DOWN event. The handler of this event should normally
2268 call event.Skip() to allow the default processing to take place as otherwise
2269 the window under mouse wouldn't get the focus.
2270 @event{EVT_LEFT_UP(func)}
2271 Process a @c wxEVT_LEFT_UP event.
2272 @event{EVT_LEFT_DCLICK(func)}
2273 Process a @c wxEVT_LEFT_DCLICK event.
2274 @event{EVT_MIDDLE_DOWN(func)}
2275 Process a @c wxEVT_MIDDLE_DOWN event.
2276 @event{EVT_MIDDLE_UP(func)}
2277 Process a @c wxEVT_MIDDLE_UP event.
2278 @event{EVT_MIDDLE_DCLICK(func)}
2279 Process a @c wxEVT_MIDDLE_DCLICK event.
2280 @event{EVT_RIGHT_DOWN(func)}
2281 Process a @c wxEVT_RIGHT_DOWN event.
2282 @event{EVT_RIGHT_UP(func)}
2283 Process a @c wxEVT_RIGHT_UP event.
2284 @event{EVT_RIGHT_DCLICK(func)}
2285 Process a @c wxEVT_RIGHT_DCLICK event.
2286 @event{EVT_MOUSE_AUX1_DOWN(func)}
2287 Process a @c wxEVT_AUX1_DOWN event.
2288 @event{EVT_MOUSE_AUX1_UP(func)}
2289 Process a @c wxEVT_AUX1_UP event.
2290 @event{EVT_MOUSE_AUX1_DCLICK(func)}
2291 Process a @c wxEVT_AUX1_DCLICK event.
2292 @event{EVT_MOUSE_AUX2_DOWN(func)}
2293 Process a @c wxEVT_AUX2_DOWN event.
2294 @event{EVT_MOUSE_AUX2_UP(func)}
2295 Process a @c wxEVT_AUX2_UP event.
2296 @event{EVT_MOUSE_AUX2_DCLICK(func)}
2297 Process a @c wxEVT_AUX2_DCLICK event.
2298 @event{EVT_MOTION(func)}
2299 Process a @c wxEVT_MOTION event.
2300 @event{EVT_ENTER_WINDOW(func)}
2301 Process a @c wxEVT_ENTER_WINDOW event.
2302 @event{EVT_LEAVE_WINDOW(func)}
2303 Process a @c wxEVT_LEAVE_WINDOW event.
2304 @event{EVT_MOUSEWHEEL(func)}
2305 Process a @c wxEVT_MOUSEWHEEL event.
2306 @event{EVT_MOUSE_EVENTS(func)}
2307 Process all mouse events.
2308 @endEventTable
2309
2310 @library{wxcore}
2311 @category{events}
2312
2313 @see wxKeyEvent
2314*/
2315class wxMouseEvent : public wxEvent,
2316 public wxMouseState
2317{
2318public:
2319 /**
2320 Constructor. Valid event types are:
2321
2322 @li @c wxEVT_ENTER_WINDOW
2323 @li @c wxEVT_LEAVE_WINDOW
2324 @li @c wxEVT_LEFT_DOWN
2325 @li @c wxEVT_LEFT_UP
2326 @li @c wxEVT_LEFT_DCLICK
2327 @li @c wxEVT_MIDDLE_DOWN
2328 @li @c wxEVT_MIDDLE_UP
2329 @li @c wxEVT_MIDDLE_DCLICK
2330 @li @c wxEVT_RIGHT_DOWN
2331 @li @c wxEVT_RIGHT_UP
2332 @li @c wxEVT_RIGHT_DCLICK
2333 @li @c wxEVT_AUX1_DOWN
2334 @li @c wxEVT_AUX1_UP
2335 @li @c wxEVT_AUX1_DCLICK
2336 @li @c wxEVT_AUX2_DOWN
2337 @li @c wxEVT_AUX2_UP
2338 @li @c wxEVT_AUX2_DCLICK
2339 @li @c wxEVT_MOTION
2340 @li @c wxEVT_MOUSEWHEEL
2341 */
2342 wxMouseEvent(wxEventType mouseEventType = wxEVT_NULL);
2343
2344 /**
2345 Returns @true if the event was a first extra button double click.
2346 */
2347 bool Aux1DClick() const;
2348
2349 /**
2350 Returns @true if the first extra button mouse button changed to down.
2351 */
2352 bool Aux1Down() const;
2353
2354 /**
2355 Returns @true if the first extra button mouse button changed to up.
2356 */
2357 bool Aux1Up() const;
2358
2359 /**
2360 Returns @true if the event was a second extra button double click.
2361 */
2362 bool Aux2DClick() const;
2363
2364 /**
2365 Returns @true if the second extra button mouse button changed to down.
2366 */
2367 bool Aux2Down() const;
2368
2369 /**
2370 Returns @true if the second extra button mouse button changed to up.
2371 */
2372 bool Aux2Up() const;
2373
2374 /**
2375 Returns @true if the event was generated by the specified button.
2376
2377 @see wxMouseState::ButtoinIsDown()
2378 */
2379 bool Button(wxMouseButton but) const;
2380
2381 /**
2382 If the argument is omitted, this returns @true if the event was a mouse
2383 double click event. Otherwise the argument specifies which double click event
2384 was generated (see Button() for the possible values).
2385 */
2386 bool ButtonDClick(wxMouseButton but = wxMOUSE_BTN_ANY) const;
2387
2388 /**
2389 If the argument is omitted, this returns @true if the event was a mouse
2390 button down event. Otherwise the argument specifies which button-down event
2391 was generated (see Button() for the possible values).
2392 */
2393 bool ButtonDown(wxMouseButton but = wxMOUSE_BTN_ANY) const;
2394
2395 /**
2396 If the argument is omitted, this returns @true if the event was a mouse
2397 button up event. Otherwise the argument specifies which button-up event
2398 was generated (see Button() for the possible values).
2399 */
2400 bool ButtonUp(wxMouseButton but = wxMOUSE_BTN_ANY) const;
2401
2402 /**
2403 Returns @true if this was a dragging event (motion while a button is depressed).
2404
2405 @see Moving()
2406 */
2407 bool Dragging() const;
2408
2409 /**
2410 Returns @true if the mouse was entering the window.
2411
2412 @see Leaving()
2413 */
2414 bool Entering() const;
2415
2416 /**
2417 Returns the mouse button which generated this event or @c wxMOUSE_BTN_NONE
2418 if no button is involved (for mouse move, enter or leave event, for example).
2419 Otherwise @c wxMOUSE_BTN_LEFT is returned for the left button down, up and
2420 double click events, @c wxMOUSE_BTN_MIDDLE and @c wxMOUSE_BTN_RIGHT
2421 for the same events for the middle and the right buttons respectively.
2422 */
2423 int GetButton() const;
2424
2425 /**
2426 Returns the number of mouse clicks for this event: 1 for a simple click, 2
2427 for a double-click, 3 for a triple-click and so on.
2428
2429 Currently this function is implemented only in wxMac and returns -1 for the
2430 other platforms (you can still distinguish simple clicks from double-clicks as
2431 they generate different kinds of events however).
2432
2433 @since 2.9.0
2434 */
2435 int GetClickCount() const;
2436
2437 /**
2438 Returns the configured number of lines (or whatever) to be scrolled per
2439 wheel action. Defaults to three.
2440 */
2441 int GetLinesPerAction() const;
2442
2443 /**
2444 Returns the logical mouse position in pixels (i.e. translated according to the
2445 translation set for the DC, which usually indicates that the window has been
2446 scrolled).
2447 */
2448 wxPoint GetLogicalPosition(const wxDC& dc) const;
2449
2450 /**
2451 Get wheel delta, normally 120.
2452
2453 This is the threshold for action to be taken, and one such action
2454 (for example, scrolling one increment) should occur for each delta.
2455 */
2456 int GetWheelDelta() const;
2457
2458 /**
2459 Get wheel rotation, positive or negative indicates direction of rotation.
2460
2461 Current devices all send an event when rotation is at least +/-WheelDelta, but
2462 finer resolution devices can be created in the future.
2463
2464 Because of this you shouldn't assume that one event is equal to 1 line, but you
2465 should be able to either do partial line scrolling or wait until several
2466 events accumulate before scrolling.
2467 */
2468 int GetWheelRotation() const;
2469
2470 /**
2471 Gets the axis the wheel operation concerns.
2472
2473 Usually the mouse wheel is used to scroll vertically so @c
2474 wxMOUSE_WHEEL_VERTICAL is returned but some mice (and most trackpads)
2475 also allow to use the wheel to scroll horizontally in which case
2476 @c wxMOUSE_WHEEL_HORIZONTAL is returned.
2477
2478 Notice that before wxWidgets 2.9.4 this method returned @c int.
2479 */
2480 wxMouseWheelAxis GetWheelAxis() const;
2481
2482 /**
2483 Returns @true if the event was a mouse button event (not necessarily a button
2484 down event - that may be tested using ButtonDown()).
2485 */
2486 bool IsButton() const;
2487
2488 /**
2489 Returns @true if the system has been setup to do page scrolling with
2490 the mouse wheel instead of line scrolling.
2491 */
2492 bool IsPageScroll() const;
2493
2494 /**
2495 Returns @true if the mouse was leaving the window.
2496
2497 @see Entering().
2498 */
2499 bool Leaving() const;
2500
2501 /**
2502 Returns @true if the event was a left double click.
2503 */
2504 bool LeftDClick() const;
2505
2506 /**
2507 Returns @true if the left mouse button changed to down.
2508 */
2509 bool LeftDown() const;
2510
2511 /**
2512 Returns @true if the left mouse button changed to up.
2513 */
2514 bool LeftUp() const;
2515
2516 /**
2517 Returns @true if the Meta key was down at the time of the event.
2518 */
2519 bool MetaDown() const;
2520
2521 /**
2522 Returns @true if the event was a middle double click.
2523 */
2524 bool MiddleDClick() const;
2525
2526 /**
2527 Returns @true if the middle mouse button changed to down.
2528 */
2529 bool MiddleDown() const;
2530
2531 /**
2532 Returns @true if the middle mouse button changed to up.
2533 */
2534 bool MiddleUp() const;
2535
2536 /**
2537 Returns @true if this was a motion event and no mouse buttons were pressed.
2538 If any mouse button is held pressed, then this method returns @false and
2539 Dragging() returns @true.
2540 */
2541 bool Moving() const;
2542
2543 /**
2544 Returns @true if the event was a right double click.
2545 */
2546 bool RightDClick() const;
2547
2548 /**
2549 Returns @true if the right mouse button changed to down.
2550 */
2551 bool RightDown() const;
2552
2553 /**
2554 Returns @true if the right mouse button changed to up.
2555 */
2556 bool RightUp() const;
2557};
2558
2559
2560
2561/**
2562 @class wxDropFilesEvent
2563
2564 This class is used for drop files events, that is, when files have been dropped
2565 onto the window. This functionality is currently only available under Windows.
2566
2567 The window must have previously been enabled for dropping by calling
2568 wxWindow::DragAcceptFiles().
2569
2570 Important note: this is a separate implementation to the more general drag and drop
2571 implementation documented in the @ref overview_dnd. It uses the older, Windows
2572 message-based approach of dropping files.
2573
2574 @beginEventTable{wxDropFilesEvent}
2575 @event{EVT_DROP_FILES(func)}
2576 Process a @c wxEVT_DROP_FILES event.
2577 @endEventTable
2578
2579 @onlyfor{wxmsw}
2580
2581 @library{wxcore}
2582 @category{events}
2583
2584 @see @ref overview_events
2585*/
2586class wxDropFilesEvent : public wxEvent
2587{
2588public:
2589 /**
2590 Constructor.
2591 */
2592 wxDropFilesEvent(wxEventType id = 0, int noFiles = 0,
2593 wxString* files = NULL);
2594
2595 /**
2596 Returns an array of filenames.
2597 */
2598 wxString* GetFiles() const;
2599
2600 /**
2601 Returns the number of files dropped.
2602 */
2603 int GetNumberOfFiles() const;
2604
2605 /**
2606 Returns the position at which the files were dropped.
2607 Returns an array of filenames.
2608 */
2609 wxPoint GetPosition() const;
2610};
2611
2612
2613
2614/**
2615 @class wxCommandEvent
2616
2617 This event class contains information about command events, which originate
2618 from a variety of simple controls.
2619
2620 Note that wxCommandEvents and wxCommandEvent-derived event classes by default
2621 and unlike other wxEvent-derived classes propagate upward from the source
2622 window (the window which emits the event) up to the first parent which processes
2623 the event. Be sure to read @ref overview_events_propagation.
2624
2625 More complex controls, such as wxTreeCtrl, have separate command event classes.
2626
2627 @beginEventTable{wxCommandEvent}
2628 @event{EVT_COMMAND(id, event, func)}
2629 Process a command, supplying the window identifier, command event identifier,
2630 and member function.
2631 @event{EVT_COMMAND_RANGE(id1, id2, event, func)}
2632 Process a command for a range of window identifiers, supplying the minimum and
2633 maximum window identifiers, command event identifier, and member function.
2634 @event{EVT_BUTTON(id, func)}
2635 Process a @c wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wxButton control.
2636 @event{EVT_CHECKBOX(id, func)}
2637 Process a @c wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wxCheckBox control.
2638 @event{EVT_CHOICE(id, func)}
2639 Process a @c wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wxChoice control.
2640 @event{EVT_COMBOBOX(id, func)}
2641 Process a @c wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wxComboBox control.
2642 @event{EVT_LISTBOX(id, func)}
2643 Process a @c wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.
2644 @event{EVT_LISTBOX_DCLICK(id, func)}
2645 Process a @c wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.
2646 @event{EVT_CHECKLISTBOX(id, func)}
2647 Process a @c wxEVT_COMMAND_CHECKLISTBOX_TOGGLED command, which is generated by a wxCheckListBox control.
2648 @event{EVT_MENU(id, func)}
2649 Process a @c wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
2650 @event{EVT_MENU_RANGE(id1, id2, func)}
2651 Process a @c wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.
2652 @event{EVT_CONTEXT_MENU(func)}
2653 Process the event generated when the user has requested a popup menu to appear by
2654 pressing a special keyboard key (under Windows) or by right clicking the mouse.
2655 @event{EVT_RADIOBOX(id, func)}
2656 Process a @c wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wxRadioBox control.
2657 @event{EVT_RADIOBUTTON(id, func)}
2658 Process a @c wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wxRadioButton control.
2659 @event{EVT_SCROLLBAR(id, func)}
2660 Process a @c wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a wxScrollBar
2661 control. This is provided for compatibility only; more specific scrollbar event macros
2662 should be used instead (see wxScrollEvent).
2663 @event{EVT_SLIDER(id, func)}
2664 Process a @c wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wxSlider control.
2665 @event{EVT_TEXT(id, func)}
2666 Process a @c wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wxTextCtrl control.
2667 @event{EVT_TEXT_ENTER(id, func)}
2668 Process a @c wxEVT_COMMAND_TEXT_ENTER command, which is generated by a wxTextCtrl control.
2669 Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it
2670 to generate such events.
2671 @event{EVT_TEXT_MAXLEN(id, func)}
2672 Process a @c wxEVT_COMMAND_TEXT_MAXLEN command, which is generated by a wxTextCtrl control
2673 when the user tries to enter more characters into it than the limit previously set
2674 with SetMaxLength().
2675 @event{EVT_TOGGLEBUTTON(id, func)}
2676 Process a @c wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event.
2677 @event{EVT_TOOL(id, func)}
2678 Process a @c wxEVT_COMMAND_TOOL_CLICKED event (a synonym for @c wxEVT_COMMAND_MENU_SELECTED).
2679 Pass the id of the tool.
2680 @event{EVT_TOOL_RANGE(id1, id2, func)}
2681 Process a @c wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools.
2682 @event{EVT_TOOL_RCLICKED(id, func)}
2683 Process a @c wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool. (Not available on wxOSX.)
2684 @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}
2685 Process a @c wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools. (Not available on wxOSX.)
2686 @event{EVT_TOOL_ENTER(id, func)}
2687 Process a @c wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself.
2688 The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor
2689 has moved off a tool. (Not available on wxOSX.)
2690 @event{EVT_COMMAND_LEFT_CLICK(id, func)}
2691 Process a @c wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (wxMSW only).
2692 @event{EVT_COMMAND_LEFT_DCLICK(id, func)}
2693 Process a @c wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (wxMSW only).
2694 @event{EVT_COMMAND_RIGHT_CLICK(id, func)}
2695 Process a @c wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (wxMSW only).
2696 @event{EVT_COMMAND_SET_FOCUS(id, func)}
2697 Process a @c wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (wxMSW only).
2698 @event{EVT_COMMAND_KILL_FOCUS(id, func)}
2699 Process a @c wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (wxMSW only).
2700 @event{EVT_COMMAND_ENTER(id, func)}
2701 Process a @c wxEVT_COMMAND_ENTER command, which is generated by a control.
2702 @endEventTable
2703
2704 @library{wxcore}
2705 @category{events}
2706*/
2707class wxCommandEvent : public wxEvent
2708{
2709public:
2710 /**
2711 Constructor.
2712 */
2713 wxCommandEvent(wxEventType commandEventType = wxEVT_NULL, int id = 0);
2714
2715 /**
2716 Returns client data pointer for a listbox or choice selection event
2717 (not valid for a deselection).
2718 */
2719 void* GetClientData() const;
2720
2721 /**
2722 Returns client object pointer for a listbox or choice selection event
2723 (not valid for a deselection).
2724 */
2725 wxClientData* GetClientObject() const;
2726
2727 /**
2728 Returns extra information dependent on the event objects type.
2729
2730 If the event comes from a listbox selection, it is a boolean
2731 determining whether the event was a selection (@true) or a
2732 deselection (@false). A listbox deselection only occurs for
2733 multiple-selection boxes, and in this case the index and string values
2734 are indeterminate and the listbox must be examined by the application.
2735 */
2736 long GetExtraLong() const;
2737
2738 /**
2739 Returns the integer identifier corresponding to a listbox, choice or
2740 radiobox selection (only if the event was a selection, not a deselection),
2741 or a boolean value representing the value of a checkbox.
2742
2743 For a menu item, this method returns -1 if the item is not checkable or
2744 a boolean value (true or false) for checkable items indicating the new
2745 state of the item.
2746 */
2747 int GetInt() const;
2748
2749 /**
2750 Returns item index for a listbox or choice selection event (not valid for
2751 a deselection).
2752 */
2753 int GetSelection() const;
2754
2755 /**
2756 Returns item string for a listbox or choice selection event. If one
2757 or several items have been deselected, returns the index of the first
2758 deselected item. If some items have been selected and others deselected
2759 at the same time, it will return the index of the first selected item.
2760 */
2761 wxString GetString() const;
2762
2763 /**
2764 This method can be used with checkbox and menu events: for the checkboxes, the
2765 method returns @true for a selection event and @false for a deselection one.
2766 For the menu events, this method indicates if the menu item just has become
2767 checked or unchecked (and thus only makes sense for checkable menu items).
2768
2769 Notice that this method cannot be used with wxCheckListBox currently.
2770 */
2771 bool IsChecked() const;
2772
2773 /**
2774 For a listbox or similar event, returns @true if it is a selection, @false
2775 if it is a deselection. If some items have been selected and others deselected
2776 at the same time, it will return @true.
2777 */
2778 bool IsSelection() const;
2779
2780 /**
2781 Sets the client data for this event.
2782 */
2783 void SetClientData(void* clientData);
2784
2785 /**
2786 Sets the client object for this event. The client object is not owned by the
2787 event object and the event object will not delete the client object in its destructor.
2788
2789 The client object must be owned and deleted by another object (e.g. a control)
2790 that has longer life time than the event object.
2791 */
2792 void SetClientObject(wxClientData* clientObject);
2793
2794 /**
2795 Sets the @b m_extraLong member.
2796 */
2797 void SetExtraLong(long extraLong);
2798
2799 /**
2800 Sets the @b m_commandInt member.
2801 */
2802 void SetInt(int intCommand);
2803
2804 /**
2805 Sets the @b m_commandString member.
2806 */
2807 void SetString(const wxString& string);
2808};
2809
2810
2811
2812/**
2813 @class wxActivateEvent
2814
2815 An activate event is sent when a window or application is being activated
2816 or deactivated.
2817
2818 @beginEventTable{wxActivateEvent}
2819 @event{EVT_ACTIVATE(func)}
2820 Process a @c wxEVT_ACTIVATE event.
2821 @event{EVT_ACTIVATE_APP(func)}
2822 Process a @c wxEVT_ACTIVATE_APP event.
2823 This event is received by the wxApp-derived instance only.
2824 @event{EVT_HIBERNATE(func)}
2825 Process a hibernate event, supplying the member function. This event applies
2826 to wxApp only, and only on Windows SmartPhone and PocketPC.
2827 It is generated when the system is low on memory; the application should free
2828 up as much memory as possible, and restore full working state when it receives
2829 a @c wxEVT_ACTIVATE or @c wxEVT_ACTIVATE_APP event.
2830 @endEventTable
2831
2832 @library{wxcore}
2833 @category{events}
2834
2835 @see @ref overview_events, wxApp::IsActive
2836*/
2837class wxActivateEvent : public wxEvent
2838{
2839public:
2840 /**
2841 Constructor.
2842 */
2843 wxActivateEvent(wxEventType eventType = wxEVT_NULL, bool active = true,
2844 int id = 0);
2845
2846 /**
2847 Returns @true if the application or window is being activated, @false otherwise.
2848 */
2849 bool GetActive() const;
2850};
2851
2852
2853
2854/**
2855 @class wxContextMenuEvent
2856
2857 This class is used for context menu events, sent to give
2858 the application a chance to show a context (popup) menu for a wxWindow.
2859
2860 Note that if wxContextMenuEvent::GetPosition returns wxDefaultPosition, this
2861 means that the event originated from a keyboard context button event, and you
2862 should compute a suitable position yourself, for example by calling wxGetMousePosition().
2863
2864 When a keyboard context menu button is pressed on Windows, a right-click event
2865 with default position is sent first, and if this event is not processed, the
2866 context menu event is sent. So if you process mouse events and you find your
2867 context menu event handler is not being called, you could call wxEvent::Skip()
2868 for mouse right-down events.
2869
2870 @beginEventTable{wxContextMenuEvent}
2871 @event{EVT_CONTEXT_MENU(func)}
2872 A right click (or other context menu command depending on platform) has been detected.
2873 @endEventTable
2874
2875
2876 @library{wxcore}
2877 @category{events}
2878
2879 @see wxCommandEvent, @ref overview_events
2880*/
2881class wxContextMenuEvent : public wxCommandEvent
2882{
2883public:
2884 /**
2885 Constructor.
2886 */
2887 wxContextMenuEvent(wxEventType type = wxEVT_NULL, int id = 0,
2888 const wxPoint& pos = wxDefaultPosition);
2889
2890 /**
2891 Returns the position in screen coordinates at which the menu should be shown.
2892 Use wxWindow::ScreenToClient to convert to client coordinates.
2893
2894 You can also omit a position from wxWindow::PopupMenu in order to use
2895 the current mouse pointer position.
2896
2897 If the event originated from a keyboard event, the value returned from this
2898 function will be wxDefaultPosition.
2899 */
2900 const wxPoint& GetPosition() const;
2901
2902 /**
2903 Sets the position at which the menu should be shown.
2904 */
2905 void SetPosition(const wxPoint& point);
2906};
2907
2908
2909
2910/**
2911 @class wxEraseEvent
2912
2913 An erase event is sent when a window's background needs to be repainted.
2914
2915 On some platforms, such as GTK+, this event is simulated (simply generated just
2916 before the paint event) and may cause flicker. It is therefore recommended that
2917 you set the text background colour explicitly in order to prevent flicker.
2918 The default background colour under GTK+ is grey.
2919
2920 To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table
2921 definition.
2922
2923 You must use the device context returned by GetDC() to draw on, don't create
2924 a wxPaintDC in the event handler.
2925
2926 @beginEventTable{wxEraseEvent}
2927 @event{EVT_ERASE_BACKGROUND(func)}
2928 Process a @c wxEVT_ERASE_BACKGROUND event.
2929 @endEventTable
2930
2931 @library{wxcore}
2932 @category{events}
2933
2934 @see @ref overview_events
2935*/
2936class wxEraseEvent : public wxEvent
2937{
2938public:
2939 /**
2940 Constructor.
2941 */
2942 wxEraseEvent(int id = 0, wxDC* dc = NULL);
2943
2944 /**
2945 Returns the device context associated with the erase event to draw on.
2946
2947 The returned pointer is never @NULL.
2948 */
2949 wxDC* GetDC() const;
2950};
2951
2952
2953
2954/**
2955 @class wxFocusEvent
2956
2957 A focus event is sent when a window's focus changes. The window losing focus
2958 receives a "kill focus" event while the window gaining it gets a "set focus" one.
2959
2960 Notice that the set focus event happens both when the user gives focus to the
2961 window (whether using the mouse or keyboard) and when it is done from the
2962 program itself using wxWindow::SetFocus.
2963
2964 The focus event handlers should almost invariably call wxEvent::Skip() on
2965 their event argument to allow the default handling to take place. Failure
2966 to do this may result in incorrect behaviour of the native controls. Also
2967 note that wxEVT_KILL_FOCUS handler must not call wxWindow::SetFocus() as
2968 this, again, is not supported by all native controls. If you need to do
2969 this, consider using the @ref sec_delayed_action described in wxIdleEvent
2970 documentation.
2971
2972 @beginEventTable{wxFocusEvent}
2973 @event{EVT_SET_FOCUS(func)}
2974 Process a @c wxEVT_SET_FOCUS event.
2975 @event{EVT_KILL_FOCUS(func)}
2976 Process a @c wxEVT_KILL_FOCUS event.
2977 @endEventTable
2978
2979 @library{wxcore}
2980 @category{events}
2981
2982 @see @ref overview_events
2983*/
2984class wxFocusEvent : public wxEvent
2985{
2986public:
2987 /**
2988 Constructor.
2989 */
2990 wxFocusEvent(wxEventType eventType = wxEVT_NULL, int id = 0);
2991
2992 /**
2993 Returns the window associated with this event, that is the window which had the
2994 focus before for the @c wxEVT_SET_FOCUS event and the window which is
2995 going to receive focus for the @c wxEVT_KILL_FOCUS one.
2996
2997 Warning: the window pointer may be @NULL!
2998 */
2999 wxWindow *GetWindow() const;
3000
3001 void SetWindow(wxWindow *win);
3002};
3003
3004
3005
3006/**
3007 @class wxChildFocusEvent
3008
3009 A child focus event is sent to a (parent-)window when one of its child windows
3010 gains focus, so that the window could restore the focus back to its corresponding
3011 child if it loses it now and regains later.
3012
3013 Notice that child window is the direct child of the window receiving event.
3014 Use wxWindow::FindFocus() to retrieve the window which is actually getting focus.
3015
3016 @beginEventTable{wxChildFocusEvent}
3017 @event{EVT_CHILD_FOCUS(func)}
3018 Process a @c wxEVT_CHILD_FOCUS event.
3019 @endEventTable
3020
3021 @library{wxcore}
3022 @category{events}
3023
3024 @see @ref overview_events
3025*/
3026class wxChildFocusEvent : public wxCommandEvent
3027{
3028public:
3029 /**
3030 Constructor.
3031
3032 @param win
3033 The direct child which is (or which contains the window which is) receiving
3034 the focus.
3035 */
3036 wxChildFocusEvent(wxWindow* win = NULL);
3037
3038 /**
3039 Returns the direct child which receives the focus, or a (grand-)parent of the
3040 control receiving the focus.
3041
3042 To get the actually focused control use wxWindow::FindFocus.
3043 */
3044 wxWindow *GetWindow() const;
3045};
3046
3047
3048
3049/**
3050 @class wxMouseCaptureLostEvent
3051
3052 A mouse capture lost event is sent to a window that had obtained mouse capture,
3053 which was subsequently lost due to an "external" event (for example, when a dialog
3054 box is shown or if another application captures the mouse).
3055
3056 If this happens, this event is sent to all windows that are on the capture stack
3057 (i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is
3058 not sent if the capture changes because of a call to CaptureMouse or
3059 ReleaseMouse.
3060
3061 This event is currently emitted under Windows only.
3062
3063 @beginEventTable{wxMouseCaptureLostEvent}
3064 @event{EVT_MOUSE_CAPTURE_LOST(func)}
3065 Process a @c wxEVT_MOUSE_CAPTURE_LOST event.
3066 @endEventTable
3067
3068 @onlyfor{wxmsw}
3069
3070 @library{wxcore}
3071 @category{events}
3072
3073 @see wxMouseCaptureChangedEvent, @ref overview_events,
3074 wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
3075*/
3076class wxMouseCaptureLostEvent : public wxEvent
3077{
3078public:
3079 /**
3080 Constructor.
3081 */
3082 wxMouseCaptureLostEvent(wxWindowID windowId = 0);
3083};
3084
3085
3086
3087class wxDisplayChangedEvent : public wxEvent
3088{
3089public:
3090 wxDisplayChangedEvent();
3091};
3092
3093
3094class wxPaletteChangedEvent : public wxEvent
3095{
3096public:
3097 wxPaletteChangedEvent(wxWindowID winid = 0);
3098
3099 void SetChangedWindow(wxWindow* win);
3100 wxWindow* GetChangedWindow() const;
3101};
3102
3103
3104class wxQueryNewPaletteEvent : public wxEvent
3105{
3106public:
3107 wxQueryNewPaletteEvent(wxWindowID winid = 0);
3108
3109 void SetPaletteRealized(bool realized);
3110 bool GetPaletteRealized();
3111};
3112
3113
3114
3115
3116/**
3117 @class wxNotifyEvent
3118
3119 This class is not used by the event handlers by itself, but is a base class
3120 for other event classes (such as wxBookCtrlEvent).
3121
3122 It (or an object of a derived class) is sent when the controls state is being
3123 changed and allows the program to wxNotifyEvent::Veto() this change if it wants
3124 to prevent it from happening.
3125
3126 @library{wxcore}
3127 @category{events}
3128
3129 @see wxBookCtrlEvent
3130*/
3131class wxNotifyEvent : public wxCommandEvent
3132{
3133public:
3134 /**
3135 Constructor (used internally by wxWidgets only).
3136 */
3137 wxNotifyEvent(wxEventType eventType = wxEVT_NULL, int id = 0);
3138
3139 /**
3140 This is the opposite of Veto(): it explicitly allows the event to be processed.
3141 For most events it is not necessary to call this method as the events are allowed
3142 anyhow but some are forbidden by default (this will be mentioned in the corresponding
3143 event description).
3144 */
3145 void Allow();
3146
3147 /**
3148 Returns @true if the change is allowed (Veto() hasn't been called) or @false
3149 otherwise (if it was).
3150 */
3151 bool IsAllowed() const;
3152
3153 /**
3154 Prevents the change announced by this event from happening.
3155
3156 It is in general a good idea to notify the user about the reasons for vetoing
3157 the change because otherwise the applications behaviour (which just refuses to
3158 do what the user wants) might be quite surprising.
3159 */
3160 void Veto();
3161};
3162
3163
3164/**
3165 @class wxThreadEvent
3166
3167 This class adds some simple functionality to wxEvent to facilitate
3168 inter-thread communication.
3169
3170 This event is not natively emitted by any control/class: it is just
3171 a helper class for the user.
3172 Its most important feature is the GetEventCategory() implementation which
3173 allows thread events @b NOT to be processed by wxEventLoopBase::YieldFor calls
3174 (unless the @c wxEVT_CATEGORY_THREAD is specified - which is never in wx code).
3175
3176 @library{wxcore}
3177 @category{events,threading}
3178
3179 @see @ref overview_thread, wxEventLoopBase::YieldFor
3180
3181 @since 2.9.0
3182*/
3183class wxThreadEvent : public wxEvent
3184{
3185public:
3186 /**
3187 Constructor.
3188 */
3189 wxThreadEvent(wxEventType eventType = wxEVT_THREAD, int id = wxID_ANY);
3190
3191 /**
3192 Clones this event making sure that all internal members which use
3193 COW (only @c m_commandString for now; see @ref overview_refcount)
3194 are unshared (see wxObject::UnShare).
3195 */
3196 virtual wxEvent *Clone() const;
3197
3198 /**
3199 Returns @c wxEVT_CATEGORY_THREAD.
3200
3201 This is important to avoid unwanted processing of thread events
3202 when calling wxEventLoopBase::YieldFor().
3203 */
3204 virtual wxEventCategory GetEventCategory() const;
3205
3206 /**
3207 Sets custom data payload.
3208
3209 The @a payload argument may be of any type that wxAny can handle
3210 (i.e. pretty much anything). Note that T's copy constructor must be
3211 thread-safe, i.e. create a copy that doesn't share anything with
3212 the original (see Clone()).
3213
3214 @note This method is not available with Visual C++ 6.
3215
3216 @since 2.9.1
3217
3218 @see GetPayload(), wxAny
3219 */
3220 template<typename T>
3221 void SetPayload(const T& payload);
3222
3223 /**
3224 Get custom data payload.
3225
3226 Correct type is checked in debug builds.
3227
3228 @note This method is not available with Visual C++ 6.
3229
3230 @since 2.9.1
3231
3232 @see SetPayload(), wxAny
3233 */
3234 template<typename T>
3235 T GetPayload() const;
3236
3237 /**
3238 Returns extra information integer value.
3239 */
3240 long GetExtraLong() const;
3241
3242 /**
3243 Returns stored integer value.
3244 */
3245 int GetInt() const;
3246
3247 /**
3248 Returns stored string value.
3249 */
3250 wxString GetString() const;
3251
3252
3253 /**
3254 Sets the extra information value.
3255 */
3256 void SetExtraLong(long extraLong);
3257
3258 /**
3259 Sets the integer value.
3260 */
3261 void SetInt(int intCommand);
3262
3263 /**
3264 Sets the string value.
3265 */
3266 void SetString(const wxString& string);
3267};
3268
3269
3270/**
3271 @class wxHelpEvent
3272
3273 A help event is sent when the user has requested context-sensitive help.
3274 This can either be caused by the application requesting context-sensitive help mode
3275 via wxContextHelp, or (on MS Windows) by the system generating a WM_HELP message when
3276 the user pressed F1 or clicked on the query button in a dialog caption.
3277
3278 A help event is sent to the window that the user clicked on, and is propagated
3279 up the window hierarchy until the event is processed or there are no more event
3280 handlers.
3281
3282 The application should call wxEvent::GetId to check the identity of the
3283 clicked-on window, and then either show some suitable help or call wxEvent::Skip()
3284 if the identifier is unrecognised.
3285
3286 Calling Skip is important because it allows wxWidgets to generate further
3287 events for ancestors of the clicked-on window. Otherwise it would be impossible to
3288 show help for container windows, since processing would stop after the first window
3289 found.
3290
3291 @beginEventTable{wxHelpEvent}
3292 @event{EVT_HELP(id, func)}
3293 Process a @c wxEVT_HELP event.
3294 @event{EVT_HELP_RANGE(id1, id2, func)}
3295 Process a @c wxEVT_HELP event for a range of ids.
3296 @endEventTable
3297
3298 @library{wxcore}
3299 @category{events}
3300
3301 @see wxContextHelp, wxDialog, @ref overview_events
3302*/
3303class wxHelpEvent : public wxCommandEvent
3304{
3305public:
3306 /**
3307 Indicates how a wxHelpEvent was generated.
3308 */
3309 enum Origin
3310 {
3311 Origin_Unknown, /**< unrecognized event source. */
3312 Origin_Keyboard, /**< event generated from F1 key press. */
3313
3314 /** event generated by wxContextHelp or from the [?] button on
3315 the title bar (Windows). */
3316 Origin_HelpButton
3317 };
3318
3319 /**
3320 Constructor.
3321 */
3322 wxHelpEvent(wxEventType type = wxEVT_NULL,
3323 wxWindowID winid = 0,
3324 const wxPoint& pt = wxDefaultPosition,
3325 wxHelpEvent::Origin origin = Origin_Unknown);
3326
3327 /**
3328 Returns the origin of the help event which is one of the ::wxHelpEventOrigin
3329 values.
3330
3331 The application may handle events generated using the keyboard or mouse
3332 differently, e.g. by using wxGetMousePosition() for the mouse events.
3333
3334 @see SetOrigin()
3335 */
3336 wxHelpEvent::Origin GetOrigin() const;
3337
3338 /**
3339 Returns the left-click position of the mouse, in screen coordinates.
3340 This allows the application to position the help appropriately.
3341 */
3342 const wxPoint& GetPosition() const;
3343
3344 /**
3345 Set the help event origin, only used internally by wxWidgets normally.
3346
3347 @see GetOrigin()
3348 */
3349 void SetOrigin(wxHelpEvent::Origin origin);
3350
3351 /**
3352 Sets the left-click position of the mouse, in screen coordinates.
3353 */
3354 void SetPosition(const wxPoint& pt);
3355};
3356
3357
3358
3359/**
3360 @class wxScrollEvent
3361
3362 A scroll event holds information about events sent from stand-alone
3363 scrollbars (see wxScrollBar) and sliders (see wxSlider).
3364
3365 Note that scrolled windows send the wxScrollWinEvent which does not derive from
3366 wxCommandEvent, but from wxEvent directly - don't confuse these two kinds of
3367 events and use the event table macros mentioned below only for the scrollbar-like
3368 controls.
3369
3370 @section scrollevent_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
3371
3372 The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb
3373 using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed
3374 by an EVT_SCROLL_CHANGED event).
3375
3376 The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb
3377 position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE
3378 event does not happen).
3379
3380 In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving has finished
3381 independently of the way it had started. Please see the widgets sample ("Slider" page)
3382 to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
3383
3384 @remarks
3385 Note that unless specifying a scroll control identifier, you will need to test for scrollbar
3386 orientation with wxScrollEvent::GetOrientation, since horizontal and vertical scroll events
3387 are processed using the same event handler.
3388
3389 @beginEventTable{wxScrollEvent}
3390 You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting
3391 scroll events from controls, or EVT_SCROLL... macros without window IDs for
3392 intercepting scroll events from the receiving window -- except for this, the
3393 macros behave exactly the same.
3394 @event{EVT_SCROLL(func)}
3395 Process all scroll events.
3396 @event{EVT_SCROLL_TOP(func)}
3397 Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
3398 @event{EVT_SCROLL_BOTTOM(func)}
3399 Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
3400 @event{EVT_SCROLL_LINEUP(func)}
3401 Process @c wxEVT_SCROLL_LINEUP line up events.
3402 @event{EVT_SCROLL_LINEDOWN(func)}
3403 Process @c wxEVT_SCROLL_LINEDOWN line down events.
3404 @event{EVT_SCROLL_PAGEUP(func)}
3405 Process @c wxEVT_SCROLL_PAGEUP page up events.
3406 @event{EVT_SCROLL_PAGEDOWN(func)}
3407 Process @c wxEVT_SCROLL_PAGEDOWN page down events.
3408 @event{EVT_SCROLL_THUMBTRACK(func)}
3409 Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the
3410 user drags the thumbtrack).
3411 @event{EVT_SCROLL_THUMBRELEASE(func)}
3412 Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
3413 @event{EVT_SCROLL_CHANGED(func)}
3414 Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
3415 @event{EVT_COMMAND_SCROLL(id, func)}
3416 Process all scroll events.
3417 @event{EVT_COMMAND_SCROLL_TOP(id, func)}
3418 Process @c wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
3419 @event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
3420 Process @c wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
3421 @event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
3422 Process @c wxEVT_SCROLL_LINEUP line up events.
3423 @event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
3424 Process @c wxEVT_SCROLL_LINEDOWN line down events.
3425 @event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
3426 Process @c wxEVT_SCROLL_PAGEUP page up events.
3427 @event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
3428 Process @c wxEVT_SCROLL_PAGEDOWN page down events.
3429 @event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
3430 Process @c wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent
3431 as the user drags the thumbtrack).
3432 @event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
3433 Process @c wxEVT_SCROLL_THUMBRELEASE thumb release events.
3434 @event{EVT_COMMAND_SCROLL_CHANGED(func)}
3435 Process @c wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
3436 @endEventTable
3437
3438 @library{wxcore}
3439 @category{events}
3440
3441 @see wxScrollBar, wxSlider, wxSpinButton, wxScrollWinEvent, @ref overview_events
3442*/
3443class wxScrollEvent : public wxCommandEvent
3444{
3445public:
3446 /**
3447 Constructor.
3448 */
3449 wxScrollEvent(wxEventType commandType = wxEVT_NULL, int id = 0, int pos = 0,
3450 int orientation = 0);
3451
3452 /**
3453 Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
3454 scrollbar.
3455 */
3456 int GetOrientation() const;
3457
3458 /**
3459 Returns the position of the scrollbar.
3460 */
3461 int GetPosition() const;
3462
3463
3464 void SetOrientation(int orient);
3465 void SetPosition(int pos);
3466};
3467
3468/**
3469 See wxIdleEvent::SetMode() for more info.
3470*/
3471enum wxIdleMode
3472{
3473 /** Send idle events to all windows */
3474 wxIDLE_PROCESS_ALL,
3475
3476 /** Send idle events to windows that have the wxWS_EX_PROCESS_IDLE flag specified */
3477 wxIDLE_PROCESS_SPECIFIED
3478};
3479
3480
3481/**
3482 @class wxIdleEvent
3483
3484 This class is used for idle events, which are generated when the system becomes
3485 idle. Note that, unless you do something specifically, the idle events are not
3486 sent if the system remains idle once it has become it, e.g. only a single idle
3487 event will be generated until something else resulting in more normal events
3488 happens and only then is the next idle event sent again.
3489
3490 If you need to ensure a continuous stream of idle events, you can either use
3491 wxIdleEvent::RequestMore method in your handler or call wxWakeUpIdle() periodically
3492 (for example from a timer event handler), but note that both of these approaches
3493 (and especially the first one) increase the system load and so should be avoided
3494 if possible.
3495
3496 By default, idle events are sent to all windows, including even the hidden
3497 ones because they may be shown if some condition is met from their @c
3498 wxEVT_IDLE (or related @c wxEVT_UPDATE_UI) handler. The children of hidden
3499 windows do not receive idle events however as they can't change their state
3500 in any way noticeable by the user. Finally, the global wxApp object also
3501 receives these events, as usual, so it can be used for any global idle time
3502 processing.
3503
3504 If sending idle events to all windows is causing a significant overhead in
3505 your application, you can call wxIdleEvent::SetMode with the value
3506 wxIDLE_PROCESS_SPECIFIED, and set the wxWS_EX_PROCESS_IDLE extra window
3507 style for every window which should receive idle events, all the other ones
3508 will not receive them in this case.
3509
3510 @beginEventTable{wxIdleEvent}
3511 @event{EVT_IDLE(func)}
3512 Process a @c wxEVT_IDLE event.
3513 @endEventTable
3514
3515 @library{wxbase}
3516 @category{events}
3517
3518 @section sec_delayed_action Delayed Action Mechanism
3519
3520 wxIdleEvent can be used to perform some action "at slightly later time".
3521 This can be necessary in several circumstances when, for whatever reason,
3522 something can't be done in the current event handler. For example, if a
3523 mouse event handler is called with the mouse button pressed, the mouse can
3524 be currently captured and some operations with it -- notably capturing it
3525 again -- might be impossible or lead to undesirable results. If you still
3526 want to capture it, you can do it from @c wxEVT_IDLE handler when it is
3527 called the next time instead of doing it immediately.
3528
3529 This can be achieved in two different ways: when using static event tables,
3530 you will need a flag indicating to the (always connected) idle event
3531 handler whether the desired action should be performed. The originally
3532 called handler would then set it to indicate that it should indeed be done
3533 and the idle handler itself would reset it to prevent it from doing the
3534 same action again.
3535
3536 Using dynamically connected event handlers things are even simpler as the
3537 original event handler can simply wxEvtHandler::Connect() or
3538 wxEvtHandler::Bind() the idle event handler which would only be executed
3539 then and could wxEvtHandler::Disconnect() or wxEvtHandler::Unbind() itself.
3540
3541
3542 @see @ref overview_events, wxUpdateUIEvent, wxWindow::OnInternalIdle
3543*/
3544class wxIdleEvent : public wxEvent
3545{
3546public:
3547 /**
3548 Constructor.
3549 */
3550 wxIdleEvent();
3551
3552 /**
3553 Static function returning a value specifying how wxWidgets will send idle
3554 events: to all windows, or only to those which specify that they
3555 will process the events.
3556
3557 @see SetMode().
3558 */
3559 static wxIdleMode GetMode();
3560
3561 /**
3562 Returns @true if the OnIdle function processing this event requested more
3563 processing time.
3564
3565 @see RequestMore()
3566 */
3567 bool MoreRequested() const;
3568
3569 /**
3570 Tells wxWidgets that more processing is required.
3571
3572 This function can be called by an OnIdle handler for a window or window event
3573 handler to indicate that wxApp::OnIdle should forward the OnIdle event once
3574 more to the application windows.
3575
3576 If no window calls this function during OnIdle, then the application will
3577 remain in a passive event loop (not calling OnIdle) until a new event is
3578 posted to the application by the windowing system.
3579
3580 @see MoreRequested()
3581 */
3582 void RequestMore(bool needMore = true);
3583
3584 /**
3585 Static function for specifying how wxWidgets will send idle events: to
3586 all windows, or only to those which specify that they will process the events.
3587
3588 @param mode
3589 Can be one of the ::wxIdleMode values.
3590 The default is wxIDLE_PROCESS_ALL.
3591 */
3592 static void SetMode(wxIdleMode mode);
3593};
3594
3595
3596
3597/**
3598 @class wxInitDialogEvent
3599
3600 A wxInitDialogEvent is sent as a dialog or panel is being initialised.
3601 Handlers for this event can transfer data to the window.
3602
3603 The default handler calls wxWindow::TransferDataToWindow.
3604
3605 @beginEventTable{wxInitDialogEvent}
3606 @event{EVT_INIT_DIALOG(func)}
3607 Process a @c wxEVT_INIT_DIALOG event.
3608 @endEventTable
3609
3610 @library{wxcore}
3611 @category{events}
3612
3613 @see @ref overview_events
3614*/
3615class wxInitDialogEvent : public wxEvent
3616{
3617public:
3618 /**
3619 Constructor.
3620 */
3621 wxInitDialogEvent(int id = 0);
3622};
3623
3624
3625
3626/**
3627 @class wxWindowDestroyEvent
3628
3629 This event is sent as early as possible during the window destruction
3630 process.
3631
3632 For the top level windows, as early as possible means that this is done by
3633 wxFrame or wxDialog destructor, i.e. after the destructor of the derived
3634 class was executed and so any methods specific to the derived class can't
3635 be called any more from this event handler. If you need to do this, you
3636 must call wxWindow::SendDestroyEvent() from your derived class destructor.
3637
3638 For the child windows, this event is generated just before deleting the
3639 window from wxWindow::Destroy() (which is also called when the parent
3640 window is deleted) or from the window destructor if operator @c delete was
3641 used directly (which is not recommended for this very reason).
3642
3643 It is usually pointless to handle this event in the window itself but it ca
3644 be very useful to receive notifications about the window destruction in the
3645 parent window or in any other object interested in this window.
3646
3647 @library{wxcore}
3648 @category{events}
3649
3650 @see @ref overview_events, wxWindowCreateEvent
3651*/
3652class wxWindowDestroyEvent : public wxCommandEvent
3653{
3654public:
3655 /**
3656 Constructor.
3657 */
3658 wxWindowDestroyEvent(wxWindow* win = NULL);
3659
3660 /// Return the window being destroyed.
3661 wxWindow *GetWindow() const;
3662};
3663
3664
3665/**
3666 @class wxNavigationKeyEvent
3667
3668 This event class contains information about navigation events,
3669 generated by navigation keys such as tab and page down.
3670
3671 This event is mainly used by wxWidgets implementations.
3672 A wxNavigationKeyEvent handler is automatically provided by wxWidgets
3673 when you enable keyboard navigation inside a window by inheriting it from
3674 wxNavigationEnabled<>.
3675
3676 @beginEventTable{wxNavigationKeyEvent}
3677 @event{EVT_NAVIGATION_KEY(func)}
3678 Process a navigation key event.
3679 @endEventTable
3680
3681 @library{wxcore}
3682 @category{events}
3683
3684 @see wxWindow::Navigate, wxWindow::NavigateIn
3685*/
3686class wxNavigationKeyEvent : public wxEvent
3687{
3688public:
3689 /**
3690 Flags which can be used with wxNavigationKeyEvent.
3691 */
3692 enum wxNavigationKeyEventFlags
3693 {
3694 IsBackward = 0x0000,
3695 IsForward = 0x0001,
3696 WinChange = 0x0002,
3697 FromTab = 0x0004
3698 };
3699
3700 wxNavigationKeyEvent();
3701 wxNavigationKeyEvent(const wxNavigationKeyEvent& event);
3702
3703 /**
3704 Returns the child that has the focus, or @NULL.
3705 */
3706 wxWindow* GetCurrentFocus() const;
3707
3708 /**
3709 Returns @true if the navigation was in the forward direction.
3710 */
3711 bool GetDirection() const;
3712
3713 /**
3714 Returns @true if the navigation event was from a tab key.
3715 This is required for proper navigation over radio buttons.
3716 */
3717 bool IsFromTab() const;
3718
3719 /**
3720 Returns @true if the navigation event represents a window change
3721 (for example, from Ctrl-Page Down in a notebook).
3722 */
3723 bool IsWindowChange() const;
3724
3725 /**
3726 Sets the current focus window member.
3727 */
3728 void SetCurrentFocus(wxWindow* currentFocus);
3729
3730 /**
3731 Sets the direction to forward if @a direction is @true, or backward
3732 if @false.
3733 */
3734 void SetDirection(bool direction);
3735
3736 /**
3737 Sets the flags for this event.
3738 The @a flags can be a combination of the ::wxNavigationKeyEventFlags values.
3739 */
3740 void SetFlags(long flags);
3741
3742 /**
3743 Marks the navigation event as from a tab key.
3744 */
3745 void SetFromTab(bool fromTab);
3746
3747 /**
3748 Marks the event as a window change event.
3749 */
3750 void SetWindowChange(bool windowChange);
3751};
3752
3753
3754
3755/**
3756 @class wxMouseCaptureChangedEvent
3757
3758 An mouse capture changed event is sent to a window that loses its
3759 mouse capture. This is called even if wxWindow::ReleaseMouse
3760 was called by the application code. Handling this event allows
3761 an application to cater for unexpected capture releases which
3762 might otherwise confuse mouse handling code.
3763
3764 @onlyfor{wxmsw}
3765
3766 @beginEventTable{wxMouseCaptureChangedEvent}
3767 @event{EVT_MOUSE_CAPTURE_CHANGED(func)}
3768 Process a @c wxEVT_MOUSE_CAPTURE_CHANGED event.
3769 @endEventTable
3770
3771 @library{wxcore}
3772 @category{events}
3773
3774 @see wxMouseCaptureLostEvent, @ref overview_events,
3775 wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
3776*/
3777class wxMouseCaptureChangedEvent : public wxEvent
3778{
3779public:
3780 /**
3781 Constructor.
3782 */
3783 wxMouseCaptureChangedEvent(wxWindowID windowId = 0,
3784 wxWindow* gainedCapture = NULL);
3785
3786 /**
3787 Returns the window that gained the capture, or @NULL if it was a
3788 non-wxWidgets window.
3789 */
3790 wxWindow* GetCapturedWindow() const;
3791};
3792
3793
3794
3795/**
3796 @class wxCloseEvent
3797
3798 This event class contains information about window and session close events.
3799
3800 The handler function for EVT_CLOSE is called when the user has tried to close a
3801 a frame or dialog box using the window manager (X) or system menu (Windows).
3802 It can also be invoked by the application itself programmatically, for example by
3803 calling the wxWindow::Close function.
3804
3805 You should check whether the application is forcing the deletion of the window
3806 using wxCloseEvent::CanVeto. If this is @false, you @e must destroy the window
3807 using wxWindow::Destroy.
3808
3809 If the return value is @true, it is up to you whether you respond by destroying
3810 the window.
3811
3812 If you don't destroy the window, you should call wxCloseEvent::Veto to
3813 let the calling code know that you did not destroy the window.
3814 This allows the wxWindow::Close function to return @true or @false depending
3815 on whether the close instruction was honoured or not.
3816
3817 Example of a wxCloseEvent handler:
3818
3819 @code
3820 void MyFrame::OnClose(wxCloseEvent& event)
3821 {
3822 if ( event.CanVeto() && m_bFileNotSaved )
3823 {
3824 if ( wxMessageBox("The file has not been saved... continue closing?",
3825 "Please confirm",
3826 wxICON_QUESTION | wxYES_NO) != wxYES )
3827 {
3828 event.Veto();
3829 return;
3830 }
3831 }
3832
3833 Destroy(); // you may also do: event.Skip();
3834 // since the default event handler does call Destroy(), too
3835 }
3836 @endcode
3837
3838 The EVT_END_SESSION event is slightly different as it is sent by the system
3839 when the user session is ending (e.g. because of log out or shutdown) and
3840 so all windows are being forcefully closed. At least under MSW, after the
3841 handler for this event is executed the program is simply killed by the
3842 system. Because of this, the default handler for this event provided by
3843 wxWidgets calls all the usual cleanup code (including wxApp::OnExit()) so
3844 that it could still be executed and exit()s the process itself, without
3845 waiting for being killed. If this behaviour is for some reason undesirable,
3846 make sure that you define a handler for this event in your wxApp-derived
3847 class and do not call @c event.Skip() in it (but be aware that the system
3848 will still kill your application).
3849
3850 @beginEventTable{wxCloseEvent}
3851 @event{EVT_CLOSE(func)}
3852 Process a @c wxEVT_CLOSE_WINDOW command event, supplying the member function.
3853 This event applies to wxFrame and wxDialog classes.
3854 @event{EVT_QUERY_END_SESSION(func)}
3855 Process a @c wxEVT_QUERY_END_SESSION session event, supplying the member function.
3856 This event can be handled in wxApp-derived class only.
3857 @event{EVT_END_SESSION(func)}
3858 Process a @c wxEVT_END_SESSION session event, supplying the member function.
3859 This event can be handled in wxApp-derived class only.
3860 @endEventTable
3861
3862 @library{wxcore}
3863 @category{events}
3864
3865 @see wxWindow::Close, @ref overview_windowdeletion
3866*/
3867class wxCloseEvent : public wxEvent
3868{
3869public:
3870 /**
3871 Constructor.
3872 */
3873 wxCloseEvent(wxEventType commandEventType = wxEVT_NULL, int id = 0);
3874
3875 /**
3876 Returns @true if you can veto a system shutdown or a window close event.
3877 Vetoing a window close event is not possible if the calling code wishes to
3878 force the application to exit, and so this function must be called to check this.
3879 */
3880 bool CanVeto() const;
3881
3882 /**
3883 Returns @true if the user is just logging off or @false if the system is
3884 shutting down. This method can only be called for end session and query end
3885 session events, it doesn't make sense for close window event.
3886 */
3887 bool GetLoggingOff() const;
3888
3889 /**
3890 Sets the 'can veto' flag.
3891 */
3892 void SetCanVeto(bool canVeto);
3893
3894 /**
3895 Sets the 'logging off' flag.
3896 */
3897 void SetLoggingOff(bool loggingOff);
3898
3899 /**
3900 Call this from your event handler to veto a system shutdown or to signal
3901 to the calling application that a window close did not happen.
3902
3903 You can only veto a shutdown if CanVeto() returns @true.
3904 */
3905 void Veto(bool veto = true);
3906};
3907
3908
3909
3910/**
3911 @class wxMenuEvent
3912
3913 This class is used for a variety of menu-related events. Note that
3914 these do not include menu command events, which are
3915 handled using wxCommandEvent objects.
3916
3917 The default handler for @c wxEVT_MENU_HIGHLIGHT displays help
3918 text in the first field of the status bar.
3919
3920 @beginEventTable{wxMenuEvent}
3921 @event{EVT_MENU_OPEN(func)}
3922 A menu is about to be opened. On Windows, this is only sent once for each
3923 navigation of the menubar (up until all menus have closed).
3924 @event{EVT_MENU_CLOSE(func)}
3925 A menu has been just closed.
3926 @event{EVT_MENU_HIGHLIGHT(id, func)}
3927 The menu item with the specified id has been highlighted: used to show
3928 help prompts in the status bar by wxFrame
3929 @event{EVT_MENU_HIGHLIGHT_ALL(func)}
3930 A menu item has been highlighted, i.e. the currently selected menu item has changed.
3931 @endEventTable
3932
3933 @library{wxcore}
3934 @category{events}
3935
3936 @see wxCommandEvent, @ref overview_events
3937*/
3938class wxMenuEvent : public wxEvent
3939{
3940public:
3941 /**
3942 Constructor.
3943 */
3944 wxMenuEvent(wxEventType type = wxEVT_NULL, int id = 0, wxMenu* menu = NULL);
3945
3946 /**
3947 Returns the menu which is being opened or closed.
3948
3949 This method can only be used with the @c OPEN and @c CLOSE events.
3950
3951 The returned value is never @NULL in the ports implementing this
3952 function, which currently includes all the major ones.
3953 */
3954 wxMenu* GetMenu() const;
3955
3956 /**
3957 Returns the menu identifier associated with the event.
3958 This method should be only used with the @c HIGHLIGHT events.
3959 */
3960 int GetMenuId() const;
3961
3962 /**
3963 Returns @true if the menu which is being opened or closed is a popup menu,
3964 @false if it is a normal one.
3965
3966 This method should only be used with the @c OPEN and @c CLOSE events.
3967 */
3968 bool IsPopup() const;
3969};
3970
3971/**
3972 @class wxShowEvent
3973
3974 An event being sent when the window is shown or hidden.
3975 The event is triggered by calls to wxWindow::Show(), and any user
3976 action showing a previously hidden window or vice versa (if allowed by
3977 the current platform and/or window manager).
3978 Notice that the event is not triggered when the application is iconized
3979 (minimized) or restored under wxMSW.
3980
3981 @onlyfor{wxmsw,wxgtk,wxos2}
3982
3983 @beginEventTable{wxShowEvent}
3984 @event{EVT_SHOW(func)}
3985 Process a @c wxEVT_SHOW event.
3986 @endEventTable
3987
3988 @library{wxcore}
3989 @category{events}
3990
3991 @see @ref overview_events, wxWindow::Show,
3992 wxWindow::IsShown
3993*/
3994
3995class wxShowEvent : public wxEvent
3996{
3997public:
3998 /**
3999 Constructor.
4000 */
4001 wxShowEvent(int winid = 0, bool show = false);
4002
4003 /**
4004 Set whether the windows was shown or hidden.
4005 */
4006 void SetShow(bool show);
4007
4008 /**
4009 Return @true if the window has been shown, @false if it has been
4010 hidden.
4011 */
4012 bool IsShown() const;
4013
4014 /**
4015 @deprecated This function is deprecated in favour of IsShown().
4016 */
4017 bool GetShow() const;
4018};
4019
4020
4021
4022/**
4023 @class wxIconizeEvent
4024
4025 An event being sent when the frame is iconized (minimized) or restored.
4026
4027 Currently only wxMSW and wxGTK generate such events.
4028
4029 @onlyfor{wxmsw,wxgtk}
4030
4031 @beginEventTable{wxIconizeEvent}
4032 @event{EVT_ICONIZE(func)}
4033 Process a @c wxEVT_ICONIZE event.
4034 @endEventTable
4035
4036 @library{wxcore}
4037 @category{events}
4038
4039 @see @ref overview_events, wxTopLevelWindow::Iconize,
4040 wxTopLevelWindow::IsIconized
4041*/
4042class wxIconizeEvent : public wxEvent
4043{
4044public:
4045 /**
4046 Constructor.
4047 */
4048 wxIconizeEvent(int id = 0, bool iconized = true);
4049
4050 /**
4051 Returns @true if the frame has been iconized, @false if it has been
4052 restored.
4053 */
4054 bool IsIconized() const;
4055
4056 /**
4057 @deprecated This function is deprecated in favour of IsIconized().
4058 */
4059 bool Iconized() const;
4060};
4061
4062
4063
4064/**
4065 @class wxMoveEvent
4066
4067 A move event holds information about wxTopLevelWindow move change events.
4068
4069 These events are currently only generated by wxMSW port.
4070
4071 @beginEventTable{wxMoveEvent}
4072 @event{EVT_MOVE(func)}
4073 Process a @c wxEVT_MOVE event, which is generated when a window is moved.
4074 @event{EVT_MOVE_START(func)}
4075 Process a @c wxEVT_MOVE_START event, which is generated when the user starts
4076 to move or size a window. wxMSW only.
4077 @event{EVT_MOVING(func)}
4078 Process a @c wxEVT_MOVING event, which is generated while the user is
4079 moving the window. wxMSW only.
4080 @event{EVT_MOVE_END(func)}
4081 Process a @c wxEVT_MOVE_END event, which is generated when the user stops
4082 moving or sizing a window. wxMSW only.
4083 @endEventTable
4084
4085 @library{wxcore}
4086 @category{events}
4087
4088 @see wxPoint, @ref overview_events
4089*/
4090class wxMoveEvent : public wxEvent
4091{
4092public:
4093 /**
4094 Constructor.
4095 */
4096 wxMoveEvent(const wxPoint& pt, int id = 0);
4097
4098 /**
4099 Returns the position of the window generating the move change event.
4100 */
4101 wxPoint GetPosition() const;
4102
4103 wxRect GetRect() const;
4104 void SetRect(const wxRect& rect);
4105 void SetPosition(const wxPoint& pos);
4106};
4107
4108
4109/**
4110 @class wxSizeEvent
4111
4112 A size event holds information about size change events of wxWindow.
4113
4114 The EVT_SIZE handler function will be called when the window has been resized.
4115
4116 You may wish to use this for frames to resize their child windows as appropriate.
4117
4118 Note that the size passed is of the whole window: call wxWindow::GetClientSize()
4119 for the area which may be used by the application.
4120
4121 When a window is resized, usually only a small part of the window is damaged
4122 and you may only need to repaint that area. However, if your drawing depends on the
4123 size of the window, you may need to clear the DC explicitly and repaint the whole window.
4124 In which case, you may need to call wxWindow::Refresh to invalidate the entire window.
4125
4126 @b Important : Sizers ( see @ref overview_sizer ) rely on size events to function
4127 correctly. Therefore, in a sizer-based layout, do not forget to call Skip on all
4128 size events you catch (and don't catch size events at all when you don't need to).
4129
4130 @beginEventTable{wxSizeEvent}
4131 @event{EVT_SIZE(func)}
4132 Process a @c wxEVT_SIZE event.
4133 @endEventTable
4134
4135 @library{wxcore}
4136 @category{events}
4137
4138 @see wxSize, @ref overview_events
4139*/
4140class wxSizeEvent : public wxEvent
4141{
4142public:
4143 /**
4144 Constructor.
4145 */
4146 wxSizeEvent(const wxSize& sz, int id = 0);
4147
4148 /**
4149 Returns the entire size of the window generating the size change event.
4150
4151 This is the new total size of the window, i.e. the same size as would
4152 be returned by wxWindow::GetSize() if it were called now. Use
4153 wxWindow::GetClientSize() if you catch this event in a top level window
4154 such as wxFrame to find the size available for the window contents.
4155 */
4156 wxSize GetSize() const;
4157 void SetSize(wxSize size);
4158
4159 wxRect GetRect() const;
4160 void SetRect(wxRect rect);
4161};
4162
4163
4164
4165/**
4166 @class wxSetCursorEvent
4167
4168 A wxSetCursorEvent is generated from wxWindow when the mouse cursor is about
4169 to be set as a result of mouse motion.
4170
4171 This event gives the application the chance to perform specific mouse cursor
4172 processing based on the current position of the mouse within the window.
4173 Use wxSetCursorEvent::SetCursor to specify the cursor you want to be displayed.
4174
4175 @beginEventTable{wxSetCursorEvent}
4176 @event{EVT_SET_CURSOR(func)}
4177 Process a @c wxEVT_SET_CURSOR event.
4178 @endEventTable
4179
4180 @library{wxcore}
4181 @category{events}
4182
4183 @see ::wxSetCursor, wxWindow::wxSetCursor
4184*/
4185class wxSetCursorEvent : public wxEvent
4186{
4187public:
4188 /**
4189 Constructor, used by the library itself internally to initialize the event
4190 object.
4191 */
4192 wxSetCursorEvent(wxCoord x = 0, wxCoord y = 0);
4193
4194 /**
4195 Returns a reference to the cursor specified by this event.
4196 */
4197 const wxCursor& GetCursor() const;
4198
4199 /**
4200 Returns the X coordinate of the mouse in client coordinates.
4201 */
4202 wxCoord GetX() const;
4203
4204 /**
4205 Returns the Y coordinate of the mouse in client coordinates.
4206 */
4207 wxCoord GetY() const;
4208
4209 /**
4210 Returns @true if the cursor specified by this event is a valid cursor.
4211
4212 @remarks You cannot specify wxNullCursor with this event, as it is not
4213 considered a valid cursor.
4214 */
4215 bool HasCursor() const;
4216
4217 /**
4218 Sets the cursor associated with this event.
4219 */
4220 void SetCursor(const wxCursor& cursor);
4221};
4222
4223
4224
4225// ============================================================================
4226// Global functions/macros
4227// ============================================================================
4228
4229/** @addtogroup group_funcmacro_events */
4230//@{
4231
4232/**
4233 A value uniquely identifying the type of the event.
4234
4235 The values of this type should only be created using wxNewEventType().
4236
4237 See the macro DEFINE_EVENT_TYPE() for more info.
4238
4239 @see @ref overview_events_introduction
4240*/
4241typedef int wxEventType;
4242
4243/**
4244 A special event type usually used to indicate that some wxEvent has yet
4245 no type assigned.
4246*/
4247wxEventType wxEVT_NULL;
4248
4249wxEventType wxEVT_ANY;
4250
4251/**
4252 Generates a new unique event type.
4253
4254 Usually this function is only used by wxDEFINE_EVENT() and not called
4255 directly.
4256*/
4257wxEventType wxNewEventType();
4258
4259/**
4260 Define a new event type associated with the specified event class.
4261
4262 This macro defines a new unique event type @a name associated with the
4263 event class @a cls.
4264
4265 For example:
4266 @code
4267 wxDEFINE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
4268
4269 class MyCustomEvent : public wxEvent { ... };
4270 wxDEFINE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
4271 @endcode
4272
4273 @see wxDECLARE_EVENT(), @ref overview_events_custom
4274 */
4275#define wxDEFINE_EVENT(name, cls) \
4276 const wxEventTypeTag< cls > name(wxNewEventType())
4277
4278/**
4279 Declares a custom event type.
4280
4281 This macro declares a variable called @a name which must be defined
4282 elsewhere using wxDEFINE_EVENT().
4283
4284 The class @a cls must be the wxEvent-derived class associated with the
4285 events of this type and its full declaration must be visible from the point
4286 of use of this macro.
4287
4288 For example:
4289 @code
4290 wxDECLARE_EVENT(MY_COMMAND_EVENT, wxCommandEvent);
4291
4292 class MyCustomEvent : public wxEvent { ... };
4293 wxDECLARE_EVENT(MY_CUSTOM_EVENT, MyCustomEvent);
4294 @endcode
4295 */
4296#define wxDECLARE_EVENT(name, cls) \
4297 wxDECLARE_EXPORTED_EVENT(wxEMPTY_PARAMETER_VALUE, name, cls)
4298
4299/**
4300 Variant of wxDECLARE_EVENT() used for event types defined inside a shared
4301 library.
4302
4303 This is mostly used by wxWidgets internally, e.g.
4304 @code
4305 wxDECLARE_EXPORTED_EVENT(WXDLLIMPEXP_CORE, wxEVT_COMMAND_BUTTON_CLICKED, wxCommandEvent)
4306 @endcode
4307 */
4308#define wxDECLARE_EXPORTED_EVENT( expdecl, name, cls ) \
4309 extern const expdecl wxEventTypeTag< cls > name;
4310
4311/**
4312 Helper macro for definition of custom event table macros.
4313
4314 This macro must only be used if wxEVENTS_COMPATIBILITY_2_8 is 1, otherwise
4315 it is better and more clear to just use the address of the function
4316 directly as this is all this macro does in this case. However it needs to
4317 explicitly cast @a func to @a functype, which is the type of wxEvtHandler
4318 member function taking the custom event argument when
4319 wxEVENTS_COMPATIBILITY_2_8 is 0.
4320
4321 See wx__DECLARE_EVT0 for an example of use.
4322
4323 @see @ref overview_events_custom_ownclass
4324 */
4325#define wxEVENT_HANDLER_CAST(functype, func) (&func)
4326
4327/**
4328 This macro is used to define event table macros for handling custom
4329 events.
4330
4331 Example of use:
4332 @code
4333 class MyEvent : public wxEvent { ... };
4334
4335 // note that this is not necessary unless using old compilers: for the
4336 // reasonably new ones just use &func instead of MyEventHandler(func)
4337 typedef void (wxEvtHandler::*MyEventFunction)(MyEvent&);
4338 #define MyEventHandler(func) wxEVENT_HANDLER_CAST(MyEventFunction, func)
4339
4340 wxDEFINE_EVENT(MY_EVENT_TYPE, MyEvent);
4341
4342 #define EVT_MY(id, func) \
4343 wx__DECLARE_EVT1(MY_EVENT_TYPE, id, MyEventHandler(func))
4344
4345 ...
4346
4347 wxBEGIN_EVENT_TABLE(MyFrame, wxFrame)
4348 EVT_MY(wxID_ANY, MyFrame::OnMyEvent)
4349 wxEND_EVENT_TABLE()
4350 @endcode
4351
4352 @param evt
4353 The event type to handle.
4354 @param id
4355 The identifier of events to handle.
4356 @param fn
4357 The event handler method.
4358 */
4359#define wx__DECLARE_EVT1(evt, id, fn) \
4360 wx__DECLARE_EVT2(evt, id, wxID_ANY, fn)
4361
4362/**
4363 Generalized version of the wx__DECLARE_EVT1() macro taking a range of
4364 IDs instead of a single one.
4365 Argument @a id1 is the first identifier of the range, @a id2 is the
4366 second identifier of the range.
4367*/
4368#define wx__DECLARE_EVT2(evt, id1, id2, fn) \
4369 DECLARE_EVENT_TABLE_ENTRY(evt, id1, id2, fn, NULL),
4370
4371/**
4372 Simplified version of the wx__DECLARE_EVT1() macro, to be used when the
4373 event type must be handled regardless of the ID associated with the
4374 specific event instances.
4375*/
4376#define wx__DECLARE_EVT0(evt, fn) \
4377 wx__DECLARE_EVT1(evt, wxID_ANY, fn)
4378
4379/**
4380 Use this macro inside a class declaration to declare a @e static event table
4381 for that class.
4382
4383 In the implementation file you'll need to use the wxBEGIN_EVENT_TABLE()
4384 and the wxEND_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro
4385 to capture events.
4386
4387 Note that this macro requires a final semicolon.
4388
4389 @see @ref overview_events_eventtables
4390*/
4391#define wxDECLARE_EVENT_TABLE()
4392
4393/**
4394 Use this macro in a source file to start listing @e static event handlers
4395 for a specific class.
4396
4397 Use wxEND_EVENT_TABLE() to terminate the event-declaration block.
4398
4399 @see @ref overview_events_eventtables
4400*/
4401#define wxBEGIN_EVENT_TABLE(theClass, baseClass)
4402
4403/**
4404 Use this macro in a source file to end listing @e static event handlers
4405 for a specific class.
4406
4407 Use wxBEGIN_EVENT_TABLE() to start the event-declaration block.
4408
4409 @see @ref overview_events_eventtables
4410*/
4411#define wxEND_EVENT_TABLE()
4412
4413/**
4414 In a GUI application, this function posts @a event to the specified @e dest
4415 object using wxEvtHandler::AddPendingEvent().
4416
4417 Otherwise, it dispatches @a event immediately using
4418 wxEvtHandler::ProcessEvent(). See the respective documentation for details
4419 (and caveats). Because of limitation of wxEvtHandler::AddPendingEvent()
4420 this function is not thread-safe for event objects having wxString fields,
4421 use wxQueueEvent() instead.
4422
4423 @header{wx/event.h}
4424*/
4425void wxPostEvent(wxEvtHandler* dest, const wxEvent& event);
4426
4427/**
4428 Queue an event for processing on the given object.
4429
4430 This is a wrapper around wxEvtHandler::QueueEvent(), see its documentation
4431 for more details.
4432
4433 @header{wx/event.h}
4434
4435 @param dest
4436 The object to queue the event on, can't be @c NULL.
4437 @param event
4438 The heap-allocated and non-@c NULL event to queue, the function takes
4439 ownership of it.
4440 */
4441void wxQueueEvent(wxEvtHandler* dest, wxEvent *event);
4442
4443
4444
4445wxEventType wxEVT_COMMAND_BUTTON_CLICKED;
4446wxEventType wxEVT_COMMAND_CHECKBOX_CLICKED;
4447wxEventType wxEVT_COMMAND_CHOICE_SELECTED;
4448wxEventType wxEVT_COMMAND_LISTBOX_SELECTED;
4449wxEventType wxEVT_COMMAND_LISTBOX_DOUBLECLICKED;
4450wxEventType wxEVT_COMMAND_CHECKLISTBOX_TOGGLED;
4451wxEventType wxEVT_COMMAND_MENU_SELECTED;
4452wxEventType wxEVT_COMMAND_SLIDER_UPDATED;
4453wxEventType wxEVT_COMMAND_RADIOBOX_SELECTED;
4454wxEventType wxEVT_COMMAND_RADIOBUTTON_SELECTED;
4455wxEventType wxEVT_COMMAND_SCROLLBAR_UPDATED;
4456wxEventType wxEVT_COMMAND_VLBOX_SELECTED;
4457wxEventType wxEVT_COMMAND_COMBOBOX_SELECTED;
4458wxEventType wxEVT_COMMAND_TOOL_RCLICKED;
4459wxEventType wxEVT_COMMAND_TOOL_DROPDOWN_CLICKED;
4460wxEventType wxEVT_COMMAND_TOOL_ENTER;
4461wxEventType wxEVT_COMMAND_COMBOBOX_DROPDOWN;
4462wxEventType wxEVT_COMMAND_COMBOBOX_CLOSEUP;
4463wxEventType wxEVT_THREAD;
4464wxEventType wxEVT_LEFT_DOWN;
4465wxEventType wxEVT_LEFT_UP;
4466wxEventType wxEVT_MIDDLE_DOWN;
4467wxEventType wxEVT_MIDDLE_UP;
4468wxEventType wxEVT_RIGHT_DOWN;
4469wxEventType wxEVT_RIGHT_UP;
4470wxEventType wxEVT_MOTION;
4471wxEventType wxEVT_ENTER_WINDOW;
4472wxEventType wxEVT_LEAVE_WINDOW;
4473wxEventType wxEVT_LEFT_DCLICK;
4474wxEventType wxEVT_MIDDLE_DCLICK;
4475wxEventType wxEVT_RIGHT_DCLICK;
4476wxEventType wxEVT_SET_FOCUS;
4477wxEventType wxEVT_KILL_FOCUS;
4478wxEventType wxEVT_CHILD_FOCUS;
4479wxEventType wxEVT_MOUSEWHEEL;
4480wxEventType wxEVT_AUX1_DOWN;
4481wxEventType wxEVT_AUX1_UP;
4482wxEventType wxEVT_AUX1_DCLICK;
4483wxEventType wxEVT_AUX2_DOWN;
4484wxEventType wxEVT_AUX2_UP;
4485wxEventType wxEVT_AUX2_DCLICK;
4486wxEventType wxEVT_CHAR;
4487wxEventType wxEVT_CHAR_HOOK;
4488wxEventType wxEVT_NAVIGATION_KEY;
4489wxEventType wxEVT_KEY_DOWN;
4490wxEventType wxEVT_KEY_UP;
4491wxEventType wxEVT_HOTKEY;
4492wxEventType wxEVT_SET_CURSOR;
4493wxEventType wxEVT_SCROLL_TOP;
4494wxEventType wxEVT_SCROLL_BOTTOM;
4495wxEventType wxEVT_SCROLL_LINEUP;
4496wxEventType wxEVT_SCROLL_LINEDOWN;
4497wxEventType wxEVT_SCROLL_PAGEUP;
4498wxEventType wxEVT_SCROLL_PAGEDOWN;
4499wxEventType wxEVT_SCROLL_THUMBTRACK;
4500wxEventType wxEVT_SCROLL_THUMBRELEASE;
4501wxEventType wxEVT_SCROLL_CHANGED;
4502wxEventType wxEVT_SPIN_UP;
4503wxEventType wxEVT_SPIN_DOWN;
4504wxEventType wxEVT_SPIN;
4505wxEventType wxEVT_SCROLLWIN_TOP;
4506wxEventType wxEVT_SCROLLWIN_BOTTOM;
4507wxEventType wxEVT_SCROLLWIN_LINEUP;
4508wxEventType wxEVT_SCROLLWIN_LINEDOWN;
4509wxEventType wxEVT_SCROLLWIN_PAGEUP;
4510wxEventType wxEVT_SCROLLWIN_PAGEDOWN;
4511wxEventType wxEVT_SCROLLWIN_THUMBTRACK;
4512wxEventType wxEVT_SCROLLWIN_THUMBRELEASE;
4513wxEventType wxEVT_SIZE;
4514wxEventType wxEVT_MOVE;
4515wxEventType wxEVT_CLOSE_WINDOW;
4516wxEventType wxEVT_END_SESSION;
4517wxEventType wxEVT_QUERY_END_SESSION;
4518wxEventType wxEVT_ACTIVATE_APP;
4519wxEventType wxEVT_ACTIVATE;
4520wxEventType wxEVT_CREATE;
4521wxEventType wxEVT_DESTROY;
4522wxEventType wxEVT_SHOW;
4523wxEventType wxEVT_ICONIZE;
4524wxEventType wxEVT_MAXIMIZE;
4525wxEventType wxEVT_MOUSE_CAPTURE_CHANGED;
4526wxEventType wxEVT_MOUSE_CAPTURE_LOST;
4527wxEventType wxEVT_PAINT;
4528wxEventType wxEVT_ERASE_BACKGROUND;
4529wxEventType wxEVT_NC_PAINT;
4530wxEventType wxEVT_MENU_OPEN;
4531wxEventType wxEVT_MENU_CLOSE;
4532wxEventType wxEVT_MENU_HIGHLIGHT;
4533wxEventType wxEVT_CONTEXT_MENU;
4534wxEventType wxEVT_SYS_COLOUR_CHANGED;
4535wxEventType wxEVT_DISPLAY_CHANGED;
4536wxEventType wxEVT_QUERY_NEW_PALETTE;
4537wxEventType wxEVT_PALETTE_CHANGED;
4538wxEventType wxEVT_JOY_BUTTON_DOWN;
4539wxEventType wxEVT_JOY_BUTTON_UP;
4540wxEventType wxEVT_JOY_MOVE;
4541wxEventType wxEVT_JOY_ZMOVE;
4542wxEventType wxEVT_DROP_FILES;
4543wxEventType wxEVT_INIT_DIALOG;
4544wxEventType wxEVT_IDLE;
4545wxEventType wxEVT_UPDATE_UI;
4546wxEventType wxEVT_SIZING;
4547wxEventType wxEVT_MOVING;
4548wxEventType wxEVT_MOVE_START;
4549wxEventType wxEVT_MOVE_END;
4550wxEventType wxEVT_HIBERNATE;
4551wxEventType wxEVT_COMMAND_TEXT_COPY;
4552wxEventType wxEVT_COMMAND_TEXT_CUT;
4553wxEventType wxEVT_COMMAND_TEXT_PASTE;
4554wxEventType wxEVT_COMMAND_LEFT_CLICK;
4555wxEventType wxEVT_COMMAND_LEFT_DCLICK;
4556wxEventType wxEVT_COMMAND_RIGHT_CLICK;
4557wxEventType wxEVT_COMMAND_RIGHT_DCLICK;
4558wxEventType wxEVT_COMMAND_SET_FOCUS;
4559wxEventType wxEVT_COMMAND_KILL_FOCUS;
4560wxEventType wxEVT_COMMAND_ENTER;
4561wxEventType wxEVT_HELP;
4562wxEventType wxEVT_DETAILED_HELP;
4563wxEventType wxEVT_COMMAND_TEXT_UPDATED;
4564wxEventType wxEVT_COMMAND_TEXT_ENTER;
4565wxEventType wxEVT_COMMAND_TOOL_CLICKED;
4566wxEventType wxEVT_WINDOW_MODAL_DIALOG_CLOSED;
4567
4568
4569
4570//@}
4571