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