/////////////////////////////////////////////////////////////////////////////
// Name: event.h
-// Purpose: documentation for wxKeyEvent class
+// Purpose: interface of wxEventHandler, wxEventBlocker and many
+// wxEvent-derived classes
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
+
+
/**
- @class wxKeyEvent
+ @class wxEvent
@wxheader{event.h}
-
- This event class contains information about keypress (character) events.
-
- Notice that there are three different kinds of keyboard events in wxWidgets:
- key down and up events and char events. The difference between the first two
- is clear - the first corresponds to a key press and the second to a key
- release - otherwise they are identical. Just note that if the key is
- maintained in a pressed state you will typically get a lot of (automatically
- generated) down events but only one up so it is wrong to assume that there is
- one up event corresponding to each down one.
-
- Both key events provide untranslated key codes while the char event carries
- the translated one. The untranslated code for alphanumeric keys is always
- an upper case value. For the other keys it is one of @c WXK_XXX values
- from the @ref overview_keycodes "keycodes table". The translated key is, in
- general, the character the user expects to appear as the result of the key
- combination when typing the text into a text entry zone, for example.
-
- A few examples to clarify this (all assume that CAPS LOCK is unpressed
- and the standard US keyboard): when the @c 'A' key is pressed, the key down
- event key code is equal to @c ASCII A == 65. But the char event key code
- is @c ASCII a == 97. On the other hand, if you press both SHIFT and
- @c 'A' keys simultaneously , the key code in key down event will still be
- just @c 'A' while the char event key code parameter will now be @c 'A'
- as well.
-
- Although in this simple case it is clear that the correct key code could be
- found in the key down event handler by checking the value returned by
- wxKeyEvent::ShiftDown, in general you should use
- @c EVT_CHAR for this as for non-alphanumeric keys the translation is
- keyboard-layout dependent and can only be done properly by the system itself.
-
- Another kind of translation is done when the control key is pressed: for
- example, for CTRL-A key press the key down event still carries the
- same key code @c 'a' as usual but the char event will have key code of
- 1, the ASCII value of this key combination.
-
- You may discover how the other keys on your system behave interactively by
- running the text wxWidgets sample and pressing some keys
- in any of the text controls shown in it.
-
- @b Note: If a key down (@c EVT_KEY_DOWN) event is caught and
- the event handler does not call @c event.Skip() then the corresponding
- char event (@c EVT_CHAR) will not happen. This is by design and
- enables the programs that handle both types of events to be a bit
- simpler.
-
- @b Note for Windows programmers: The key and char events in wxWidgets are
- similar to but slightly different from Windows @c WM_KEYDOWN and
- @c WM_CHAR events. In particular, Alt-x combination will generate a char
- event in wxWidgets (unless it is used as an accelerator).
-
- @b Tip: be sure to call @c event.Skip() for events that you don't process in
- key event function, otherwise menu shortcuts may cease to work under Windows.
-
- @library{wxcore}
+
+ An event is a structure holding information about an event passed to a
+ callback or member function.
+
+ wxEvent used to be a multipurpose event object, and is an abstract base class
+ for other event classes (see below).
+
+ For more information about events, see the @ref overview_eventhandling overview.
+
+ @beginWxPerlOnly
+ In wxPerl custom event classes should be derived from
+ @c Wx::PlEvent and @c Wx::PlCommandEvent.
+ @endWxPerlOnly
+
+ @library{wxbase}
@category{events}
+
+ @see wxCommandEvent, wxMouseEvent
*/
-class wxKeyEvent : public wxEvent
+class wxEvent : public wxObject
{
public:
/**
- Constructor. Currently, the only valid event types are wxEVT_CHAR and
- wxEVT_CHAR_HOOK.
+ Constructor. Should not need to be used directly by an application.
*/
- wxKeyEvent(WXTYPE keyEventType);
+ wxEvent(int id = 0, wxEventType eventType = wxEVT_NULL);
/**
- Returns @true if the Alt key was down at the time of the key event.
-
- Notice that GetModifiers() is easier to use
- correctly than this function so you should consider using it in new code.
+ Returns a copy of the event.
+
+ Any event that is posted to the wxWidgets event system for later action
+ (via wxEvtHandler::AddPendingEvent or wxPostEvent()) must implement
+ this method.
+
+ All wxWidgets events fully implement this method, but any derived events
+ implemented by the user should also implement this method just in case they
+ (or some event derived from them) are ever posted.
+
+ All wxWidgets events implement a copy constructor, so the easiest way of
+ implementing the Clone function is to implement a copy constructor for
+ a new event (call it MyEvent) and then define the Clone function like this:
+
+ @code
+ wxEvent *Clone() const { return new MyEvent(*this); }
+ @endcode
*/
- bool AltDown();
+ virtual wxEvent* Clone() const = 0;
/**
- CMD is a pseudo key which is the same as Control for PC and Unix
- platforms but the special APPLE (a.k.a as COMMAND) key under
- Macs: it makes often sense to use it instead of, say, ControlDown() because Cmd
- key is used for the same thing under Mac as Ctrl elsewhere (but Ctrl still
- exists, just not used for this purpose under Mac). So for non-Mac platforms
- this is the same as ControlDown() and under
- Mac this is the same as MetaDown().
+ Returns the object (usually a window) associated with the event, if any.
*/
- bool CmdDown();
+ wxObject* GetEventObject() const;
/**
- Returns @true if the control key was down at the time of the key event.
-
- Notice that GetModifiers() is easier to use
- correctly than this function so you should consider using it in new code.
+ Returns the identifier of the given event type, such as @c wxEVT_COMMAND_BUTTON_CLICKED.
*/
- bool ControlDown();
+ wxEventType GetEventType() const;
/**
- Returns the virtual key code. ASCII events return normal ASCII values,
- while non-ASCII events return values such as @b WXK_LEFT for the
- left cursor key. See Keycodes for a full list of
- the virtual key codes.
-
- Note that in Unicode build, the returned value is meaningful only if the
- user entered a character that can be represented in current locale's default
- charset. You can obtain the corresponding Unicode character using
- GetUnicodeKey().
+ Returns the identifier associated with this event, such as a button command id.
*/
- int GetKeyCode();
+ int GetId() const;
/**
- Return the bitmask of modifier keys which were pressed when this event
- happened. See @ref overview_keymodifiers "key modifier constants" for the full
- list
- of modifiers.
-
- Notice that this function is easier to use correctly than, for example,
- ControlDown() because when using the latter you
- also have to remember to test that none of the other modifiers is pressed:
- and forgetting to do it can result in serious program bugs (e.g. program not
- working with European keyboard layout where ALTGR key which is seen by
- the program as combination of CTRL and ALT is used). On the
- other hand, you can simply write
- with this function.
+ Returns @true if the event handler should be skipped, @false otherwise.
*/
- int GetModifiers();
+ bool GetSkipped() const;
- //@{
/**
- Obtains the position (in client coordinates) at which the key was pressed.
+ Gets the timestamp for the event. The timestamp is the time in milliseconds
+ since some fixed moment (not necessarily the standard Unix Epoch, so only
+ differences between the timestamps and not their absolute values usually make sense).
*/
- wxPoint GetPosition();
- void GetPosition(long * x, long * y);
- //@}
+ long GetTimestamp() const;
/**
- Returns the raw key code for this event. This is a platform-dependent scan code
- which should only be used in advanced applications.
-
- @b NB: Currently the raw key codes are not supported by all ports, use
- @c #ifdef wxHAS_RAW_KEY_CODES to determine if this feature is available.
+ Returns @true if the event is or is derived from wxCommandEvent else it returns @false.
+
+ @note exists only for optimization purposes.
*/
- wxUint32 GetRawKeyCode();
+ bool IsCommandEvent() const;
/**
- Returns the low level key flags for this event. The flags are
- platform-dependent and should only be used in advanced applications.
-
- @b NB: Currently the raw key flags are not supported by all ports, use
- @c #ifdef wxHAS_RAW_KEY_CODES to determine if this feature is available.
+ Sets the propagation level to the given value (for example returned from an
+ earlier call to wxEvent::StopPropagation).
*/
- wxUint32 GetRawKeyFlags();
+ void ResumePropagation(int propagationLevel);
/**
- Returns the Unicode character corresponding to this key event.
-
- This function is only available in Unicode build, i.e. when
- @c wxUSE_UNICODE is 1.
+ Sets the originating object.
*/
- wxChar GetUnicodeKey();
+ void SetEventObject(wxObject* object);
/**
- Returns the X position (in client coordinates) of the event.
+ Sets the event type.
*/
-#define long GetX() /* implementation is private */
+ void SetEventType(wxEventType type);
/**
- Returns the Y (in client coordinates) position of the event.
+ Sets the identifier associated with this event, such as a button command id.
*/
-#define long GetY() /* implementation is private */
+ void SetId(int id);
/**
- Returns @true if either CTRL or ALT keys was down
- at the time of the key event. Note that this function does not take into
- account neither SHIFT nor META key states (the reason for ignoring
- the latter is that it is common for NUMLOCK key to be configured as
- META under X but the key presses even while NUMLOCK is on should
- be still processed normally).
+ Sets the timestamp for the event.
*/
- bool HasModifiers();
+ void SetTimestamp(long = 0);
/**
- Returns @true if the Meta key was down at the time of the key event.
-
- Notice that GetModifiers() is easier to use
- correctly than this function so you should consider using it in new code.
+ Test if this event should be propagated or not, i.e. if the propagation level
+ is currently greater than 0.
*/
- bool MetaDown();
+ bool ShouldPropagate() const;
/**
- Returns @true if the shift key was down at the time of the key event.
-
- Notice that GetModifiers() is easier to use
- correctly than this function so you should consider using it in new code.
+ This method can be used inside an event handler to control whether further
+ event handlers bound to this event will be called after the current one returns.
+
+ Without Skip() (or equivalently if Skip(@false) is used), the event will not
+ be processed any more. If Skip(@true) is called, the event processing system
+ continues searching for a further handler function for this event, even though
+ it has been processed already in the current handler.
+
+ In general, it is recommended to skip all non-command events to allow the
+ default handling to take place. The command events are, however, normally not
+ skipped as usually a single command such as a button click or menu item
+ selection must only be processed by one handler.
*/
- bool ShiftDown();
+ void Skip(bool skip = true);
/**
- bool m_altDown
-
- @b Deprecated: Please use GetModifiers()
- instead!
-
- @true if the Alt key is pressed down.
- */
+ Stop the event from propagating to its parent window.
+ Returns the old propagation level value which may be later passed to
+ ResumePropagation() to allow propagating the event again.
+ */
+ int StopPropagation();
+protected:
/**
- bool m_controlDown
-
- @b Deprecated: Please use GetModifiers()
- instead!
-
- @true if control is pressed down.
- */
+ Indicates how many levels the event can propagate.
+ This member is protected and should typically only be set in the constructors
+ of the derived classes. It may be temporarily changed by StopPropagation()
+ and ResumePropagation() and tested with ShouldPropagate().
- /**
- long m_keyCode
-
- @b Deprecated: Please use GetKeyCode()
- instead!
-
- Virtual keycode. See Keycodes for a list of identifiers.
+ The initial value is set to either @c wxEVENT_PROPAGATE_NONE (by default)
+ meaning that the event shouldn't be propagated at all or to
+ @c wxEVENT_PROPAGATE_MAX (for command events) meaning that it should be
+ propagated as much as necessary.
+
+ Any positive number means that the event should be propagated but no more than
+ the given number of times. E.g. the propagation level may be set to 1 to
+ propagate the event to its parent only, but not to its grandparent.
*/
+ int m_propagationLevel;
+};
+
+/**
+ @class wxEventBlocker
+ @wxheader{event.h}
+
+ This class is a special event handler which allows to discard
+ any event (or a set of event types) directed to a specific window.
+ Example:
- /**
- bool m_metaDown
-
- @b Deprecated: Please use GetModifiers()
- instead!
-
- @true if the Meta key is pressed down.
- */
+ @code
+ void MyWindow::DoSomething()
+ {
+ {
+ // block all events directed to this window while
+ // we do the 1000 FunctionWhichSendsEvents() calls
+ wxEventBlocker blocker(this);
+ for ( int i = 0; i 1000; i++ )
+ FunctionWhichSendsEvents(i);
- /**
- bool m_shiftDown
-
- @b Deprecated: Please use GetModifiers()
- instead!
-
- @true if shift is pressed down.
- */
+ } // ~wxEventBlocker called, old event handler is restored
+ // the event generated by this call will be processed:
+ FunctionWhichSendsEvents(0)
+ }
+ @endcode
+
+ @library{wxcore}
+ @category{events}
+ @see @ref overview_eventhandling, wxEvtHandler
+*/
+class wxEventBlocker : public wxEvtHandler
+{
+public:
/**
- int m_x
-
- @b Deprecated: Please use GetX() instead!
-
- X position of the event.
+ Constructs the blocker for the given window and for the given event type.
+
+ If @a type is @c wxEVT_ANY, then all events for that window are blocked.
+ You can call Block() after creation to add other event types to the list
+ of events to block.
+
+ Note that the @a win window @b must remain alive until the
+ wxEventBlocker object destruction.
*/
+ wxEventBlocker(wxWindow* win, wxEventType = wxEVT_ANY);
+ /**
+ Destructor. The blocker will remove itself from the chain of event handlers for
+ the window provided in the constructor, thus restoring normal processing of events.
+ */
+ virtual ~wxEventBlocker();
/**
- int m_y
-
- @b Deprecated: Please use GetY() instead!
-
- Y position of the event.
+ Adds to the list of event types which should be blocked the given @a eventType.
*/
+ void Block(wxEventType eventType);
};
+
/**
- @class wxJoystickEvent
+ @class wxEvtHandler
@wxheader{event.h}
-
- This event class contains information about mouse events, particularly
- events received by windows.
-
- @library{wxcore}
+
+ A class that can handle events from the windowing system.
+ wxWindow (and therefore all window classes) are derived from this class.
+
+ When events are received, wxEvtHandler invokes the method listed in the
+ event table using itself as the object. When using multiple inheritance
+ it is imperative that the wxEvtHandler(-derived) class be the first
+ class inherited such that the "this" pointer for the overall object
+ will be identical to the "this" pointer for the wxEvtHandler portion.
+
+ @library{wxbase}
@category{events}
-
- @seealso
- wxJoystick
+
+ @see @ref overview_eventhandling
*/
-class wxJoystickEvent : public wxEvent
+class wxEvtHandler : public wxObject
{
public:
/**
Constructor.
*/
- wxJoystickEvent(WXTYPE eventType = 0, int state = 0,
- int joystick = wxJOYSTICK1,
- int change = 0);
+ wxEvtHandler();
/**
- Returns @true if the event was a down event from the specified button (or any
- button).
-
- @param button
- Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
- indicate any button down event.
+ Destructor.
+
+ If the handler is part of a chain, the destructor will unlink itself and
+ restore the previous and next handlers so that they point to each other.
*/
- bool ButtonDown(int button = wxJOY_BUTTON_ANY);
+ virtual ~wxEvtHandler();
/**
- Returns @true if the specified button (or any button) was in a down state.
-
- @param button
- Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
- indicate any button down event.
- */
- bool ButtonIsDown(int button = wxJOY_BUTTON_ANY);
+ Queue event for a later processing.
+
+ This method is similar to ProcessEvent() but while the latter is
+ synchronous, i.e. the event is processed immediately, before the
+ function returns, this one is asynchronous and returns immediately
+ while the event will be processed at some later time (usually during
+ the next event loop iteration).
+
+ Another important difference is that this method takes ownership of the
+ @a event parameter, i.e. it will delete it itself. This implies that
+ the event should be allocated on the heap and that the pointer can't be
+ used any more after the function returns (as it can be deleted at any
+ moment).
+
+ QueueEvent() can be used for inter-thread communication from the worker
+ threads to the main thread, it is safe in the sense that it uses
+ locking internally and avoids the problem mentioned in AddPendingEvent()
+ documentation by ensuring that the @a event object is not used by the
+ calling thread any more. Care should still be taken to avoid that some
+ fields of this object are used by it, notably any wxString members of
+ the event object must not be shallow copies of another wxString object
+ as this would result in them still using the same string buffer behind
+ the scenes. For example
+ @code
+ void FunctionInAWorkerThread(const wxString& str)
+ {
+ wxCommandEvent* evt = new wxCommandEvent;
+
+ // NOT evt->SetString(str) as this would be a shallow copy
+ evt->SetString(str.c_str()); // make a deep copy
+
+ wxTheApp->QueueEvent( evt );
+ }
+ @endcode
+
+ Finally notice that this method automatically wakes up the event loop
+ if it is currently idle by calling ::wxWakeUpIdle() so there is no need
+ to do it manually when using it.
+
+ @since 2.9.0
+
+ @param event
+ A heap-allocated event to be queued, QueueEvent() takes ownership
+ of it. This parameter shouldn't be @c NULL.
+ */
+ virtual void QueueEvent(wxEvent *event);
/**
- Returns @true if the event was an up event from the specified button (or any
- button).
-
- @param button
- Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
- indicate any button down event.
+ Post an event to be processed later.
+
+ This function is similar to QueueEvent() but can't be used to post
+ events from worker threads for the event objects with wxString fields
+ (i.e. in practice most of them) because of an unsafe use of the same
+ wxString object which happens because the wxString field in the
+ original @a event object and its copy made internally by this function
+ share the same string buffer internally. Use QueueEvent() to avoid
+ this.
+
+ A copy of event is made by the function, so the original can be deleted
+ as soon as function returns (it is common that the original is created
+ on the stack). This requires that the wxEvent::Clone() method be
+ implemented by event so that it can be duplicated and stored until it
+ gets processed.
+
+ @param event
+ Event to add to the pending events queue.
*/
- bool ButtonUp(int button = wxJOY_BUTTON_ANY);
+ virtual void AddPendingEvent(const wxEvent& event);
/**
- Returns the identifier of the button changing state. This is a wxJOY_BUTTONn
- identifier, where
- n is one of 1, 2, 3, 4.
+ Connects the given function dynamically with the event handler, id and event type.
+ This is an alternative to the use of static event tables.
+
+ See the @ref page_samples_event sample for usage.
+
+ This specific overload allows you to connect an event handler to a @e range
+ of @e source IDs.
+ Do not confuse @e source IDs with event @e types: source IDs identify the
+ event generator objects (typically wxMenuItem or wxWindow objects) while the
+ event @e type identify which type of events should be handled by the
+ given @e function (an event generator object may generate many different
+ types of events!).
+
+ @param id
+ The first ID of the identifier range to be associated with the event
+ handler function.
+ @param lastId
+ The last ID of the identifier range to be associated with the event
+ handler function.
+ @param eventType
+ The event type to be associated with this event handler.
+ @param function
+ The event handler function. Note that this function should
+ be explicitly converted to the correct type which can be done using a macro
+ called @c wxFooEventHandler for the handler for any @c wxFooEvent.
+ @param userData
+ Data to be associated with the event table entry.
+ @param eventSink
+ Object whose member function should be called.
+ If this is @NULL, @c *this will be used.
*/
- int GetButtonChange();
+ void Connect(int id, int lastId, wxEventType eventType,
+ wxObjectEventFunction function,
+ wxObject* userData = NULL,
+ wxEvtHandler* eventSink = NULL);
/**
- Returns the down state of the buttons. This is a bitlist of wxJOY_BUTTONn
- identifiers, where
- n is one of 1, 2, 3, 4.
+ See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
+ overload for more info.
+
+ This overload can be used to attach an event handler to a single source ID:
+
+ Example:
+ @code
+ frame->Connect( wxID_EXIT,
+ wxEVT_COMMAND_MENU_SELECTED,
+ wxCommandEventHandler(MyFrame::OnQuit) );
+ @endcode
*/
- int GetButtonState();
+ void Connect(int id, wxEventType eventType,
+ wxObjectEventFunction function,
+ wxObject* userData = NULL,
+ wxEvtHandler* eventSink = NULL);
/**
- Returns the identifier of the joystick generating the event - one of
- wxJOYSTICK1 and wxJOYSTICK2.
+ See the Connect(int, int, wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
+ overload for more info.
+
+ This overload will connect the given event handler so that regardless of the
+ ID of the event source, the handler will be called.
*/
- int GetJoystick();
+ void Connect(wxEventType eventType,
+ wxObjectEventFunction function,
+ wxObject* userData = NULL,
+ wxEvtHandler* eventSink = NULL);
/**
- Returns the x, y position of the joystick event.
+ Disconnects the given function dynamically from the event handler, using the
+ specified parameters as search criteria and returning @true if a matching
+ function has been found and removed.
+
+ This method can only disconnect functions which have been added using the
+ Connect() method. There is no way to disconnect functions connected using
+ the (static) event tables.
+
+ @param eventType
+ The event type associated with this event handler.
+ @param function
+ The event handler function.
+ @param userData
+ Data associated with the event table entry.
+ @param eventSink
+ Object whose member function should be called.
*/
- wxPoint GetPosition();
+ bool Disconnect(wxEventType eventType = wxEVT_NULL,
+ wxObjectEventFunction function = NULL,
+ wxObject* userData = NULL,
+ wxEvtHandler* eventSink = NULL);
/**
- Returns the z position of the joystick event.
+ See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
+ overload for more info.
+
+ This overload takes the additional @a id parameter.
*/
- int GetZPosition();
+ bool Disconnect(int id = wxID_ANY,
+ wxEventType eventType = wxEVT_NULL,
+ wxObjectEventFunction function = NULL,
+ wxObject* userData = NULL,
+ wxEvtHandler* eventSink = NULL);
/**
- Returns @true if this was a button up or down event (@e not 'is any button
- down?').
+ See the Disconnect(wxEventType, wxObjectEventFunction, wxObject*, wxEvtHandler*)
+ overload for more info.
+
+ This overload takes an additional range of source IDs.
*/
- bool IsButton();
+ bool Disconnect(int id, int lastId = wxID_ANY,
+ wxEventType eventType = wxEVT_NULL,
+ wxObjectEventFunction function = NULL,
+ wxObject* userData = NULL,
+ wxEvtHandler* eventSink = NULL);
/**
- Returns @true if this was an x, y move event.
+ Returns user-supplied client data.
+
+ @remarks Normally, any extra data the programmer wishes to associate with
+ the object should be made available by deriving a new class with
+ new data members.
+
+ @see SetClientData()
*/
- bool IsMove();
+ void* GetClientData() const;
/**
- Returns @true if this was a z move event.
- */
- bool IsZMove();
-};
+ Returns a pointer to the user-supplied client data object.
+ @see SetClientObject(), wxClientData
+ */
+ wxClientData* GetClientObject() const;
-/**
- @class wxScrollWinEvent
- @wxheader{event.h}
-
- A scroll event holds information about events sent from scrolling windows.
-
- @library{wxcore}
- @category{events}
-
- @seealso
- wxScrollEvent, @ref overview_eventhandlingoverview "Event handling overview"
-*/
-class wxScrollWinEvent : public wxEvent
-{
-public:
/**
- Constructor.
+ Returns @true if the event handler is enabled, @false otherwise.
+
+ @see SetEvtHandlerEnabled()
*/
- wxScrollWinEvent(WXTYPE commandType = 0, int pos = 0,
- int orientation = 0);
+ bool GetEvtHandlerEnabled() const;
/**
- Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
- scrollbar.
+ Returns the pointer to the next handler in the chain.
+
+ @see SetNextHandler(), GetPreviousHandler(), SetPreviousHandler(),
+ wxWindow::PushEventHandler, wxWindow::PopEventHandler
*/
- int GetOrientation();
+ wxEvtHandler* GetNextHandler() const;
/**
- Returns the position of the scrollbar for the thumb track and release events.
- Note that this field can't be used for the other events, you need to query
- the window itself for the current position in that case.
+ Returns the pointer to the previous handler in the chain.
+
+ @see SetPreviousHandler(), GetNextHandler(), SetNextHandler(),
+ wxWindow::PushEventHandler, wxWindow::PopEventHandler
*/
- int GetPosition();
-};
+ wxEvtHandler* GetPreviousHandler() const;
+
+ /**
+ Processes an event, searching event tables and calling zero or more suitable
+ event handler function(s).
+ Normally, your application would not call this function: it is called in the
+ wxWidgets implementation to dispatch incoming user interface events to the
+ framework (and application).
+
+ However, you might need to call it if implementing new functionality
+ (such as a new control) where you define new event types, as opposed to
+ allowing the user to override virtual functions.
+
+ An instance where you might actually override the ProcessEvent function is where
+ you want to direct event processing to event handlers not normally noticed by
+ wxWidgets. For example, in the document/view architecture, documents and views
+ are potential event handlers. When an event reaches a frame, ProcessEvent will
+ need to be called on the associated document and view in case event handler functions
+ are associated with these objects. The property classes library (wxProperty) also
+ overrides ProcessEvent for similar reasons.
+
+ The normal order of event table searching is as follows:
+ -# If the object is disabled (via a call to wxEvtHandler::SetEvtHandlerEnabled)
+ the function skips to step (6).
+ -# If the object is a wxWindow, ProcessEvent() is recursively called on the
+ window's wxValidator. If this returns @true, the function exits.
+ -# SearchEventTable() is called for this event handler. If this fails, the base
+ class table is tried, and so on until no more tables exist or an appropriate
+ function was found, in which case the function exits.
+ -# The search is applied down the entire chain of event handlers (usually the
+ chain has a length of one). If this succeeds, the function exits.
+ -# If the object is a wxWindow and the event is a wxCommandEvent, ProcessEvent()
+ is recursively applied to the parent window's event handler.
+ If this returns true, the function exits.
+ -# Finally, ProcessEvent() is called on the wxApp object.
+
+ @param event
+ Event to process.
+
+ @return @true if a suitable event handler function was found and
+ executed, and the function did not call wxEvent::Skip.
+
+ @see SearchEventTable()
+ */
+ virtual bool ProcessEvent(wxEvent& event);
-/**
- @class wxSysColourChangedEvent
- @wxheader{event.h}
-
- This class is used for system colour change events, which are generated
- when the user changes the colour settings using the control panel.
- This is only appropriate under Windows.
-
- @library{wxcore}
- @category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview"
-*/
-class wxSysColourChangedEvent : public wxEvent
-{
-public:
/**
- Constructor.
+ Processes an event by calling ProcessEvent() and handles any exceptions
+ that occur in the process.
+ If an exception is thrown in event handler, wxApp::OnExceptionInMainLoop is called.
+
+ @param event
+ Event to process.
+
+ @return @true if the event was processed, @false if no handler was found
+ or an exception was thrown.
+
+ @see wxWindow::HandleWindowEvent
*/
- wxSysColourChangedEvent();
-};
+ bool SafelyProcessEvent(wxEvent& event);
+ /**
+ Searches the event table, executing an event handler function if an appropriate
+ one is found.
+
+ @param table
+ Event table to be searched.
+ @param event
+ Event to be matched against an event table entry.
+
+ @return @true if a suitable event handler function was found and
+ executed, and the function did not call wxEvent::Skip.
+
+ @remarks This function looks through the object's event table and tries
+ to find an entry that will match the event.
+ An entry will match if:
+ @li The event type matches, and
+ @li the identifier or identifier range matches, or the event table
+ entry's identifier is zero.
+ If a suitable function is called but calls wxEvent::Skip, this
+ function will fail, and searching will continue.
+
+ @see ProcessEvent()
+ */
+ virtual bool SearchEventTable(wxEventTable& table,
+ wxEvent& event);
-/**
- @class wxWindowCreateEvent
- @wxheader{event.h}
-
- This event is sent just after the actual window associated with a wxWindow
- object
- has been created. Since it is derived from wxCommandEvent, the event propagates
- up
- the window hierarchy.
-
- @library{wxcore}
- @category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview",
- wxWindowDestroyEvent
-*/
-class wxWindowCreateEvent : public wxCommandEvent
-{
-public:
/**
- Constructor.
+ Sets user-supplied client data.
+
+ @param data
+ Data to be associated with the event handler.
+
+ @remarks Normally, any extra data the programmer wishes to associate
+ with the object should be made available by deriving a new
+ class with new data members. You must not call this method
+ and SetClientObject on the same class - only one of them.
+
+ @see GetClientData()
*/
- wxWindowCreateEvent(wxWindow* win = @NULL);
-};
+ void SetClientData(void* data);
+ /**
+ Set the client data object. Any previous object will be deleted.
+
+ @see GetClientObject(), wxClientData
+ */
+ void SetClientObject(wxClientData* data);
-/**
- @class wxPaintEvent
- @wxheader{event.h}
-
- A paint event is sent when a window's contents needs to be repainted.
-
- Please notice that in general it is impossible to change the drawing of a
- standard control (such as wxButton) and so you shouldn't
- attempt to handle paint events for them as even if it might work on some
- platforms, this is inherently not portable and won't work everywhere.
-
- @library{wxcore}
- @category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview"
-*/
-class wxPaintEvent : public wxEvent
-{
-public:
/**
- Constructor.
+ Enables or disables the event handler.
+
+ @param enabled
+ @true if the event handler is to be enabled, @false if it is to be disabled.
+
+ @remarks You can use this function to avoid having to remove the event
+ handler from the chain, for example when implementing a
+ dialog editor and changing from edit to test mode.
+
+ @see GetEvtHandlerEnabled()
*/
- wxPaintEvent(int id = 0);
-};
+ void SetEvtHandlerEnabled(bool enabled);
+ /**
+ Sets the pointer to the next handler.
+
+ @param handler
+ Event handler to be set as the next handler.
+
+ @see GetNextHandler(), SetPreviousHandler(), GetPreviousHandler(),
+ wxWindow::PushEventHandler, wxWindow::PopEventHandler
+ */
+ void SetNextHandler(wxEvtHandler* handler);
-/**
- @class wxMaximizeEvent
- @wxheader{event.h}
-
- An event being sent when a top level window is maximized. Notice that it is
- not sent when the window is restored to its original size after it had been
- maximized, only a normal wxSizeEvent is generated in
- this case.
-
- @library{wxcore}
- @category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview",
- wxTopLevelWindow::Maximize, wxTopLevelWindow::IsMaximized
-*/
-class wxMaximizeEvent : public wxEvent
-{
-public:
/**
- Constructor. Only used by wxWidgets internally.
+ Sets the pointer to the previous handler.
+
+ @param handler
+ Event handler to be set as the previous handler.
*/
- wxMaximizeEvent(int id = 0);
+ void SetPreviousHandler(wxEvtHandler* handler);
};
/**
- @class wxUpdateUIEvent
+ @class wxKeyEvent
@wxheader{event.h}
-
- This class is used for pseudo-events which are called by wxWidgets
- to give an application the chance to update various user interface elements.
-
+
+ This event class contains information about keypress (character) events.
+
+ Notice that there are three different kinds of keyboard events in wxWidgets:
+ key down and up events and char events. The difference between the first two
+ is clear - the first corresponds to a key press and the second to a key
+ release - otherwise they are identical. Just note that if the key is
+ maintained in a pressed state you will typically get a lot of (automatically
+ generated) down events but only one up so it is wrong to assume that there is
+ one up event corresponding to each down one.
+
+ Both key events provide untranslated key codes while the char event carries
+ the translated one. The untranslated code for alphanumeric keys is always
+ an upper case value. For the other keys it is one of @c WXK_XXX values
+ from the @ref page_keycodes.
+ The translated key is, in general, the character the user expects to appear
+ as the result of the key combination when typing the text into a text entry
+ zone, for example.
+
+ A few examples to clarify this (all assume that CAPS LOCK is unpressed
+ and the standard US keyboard): when the @c 'A' key is pressed, the key down
+ event key code is equal to @c ASCII A == 65. But the char event key code
+ is @c ASCII a == 97. On the other hand, if you press both SHIFT and
+ @c 'A' keys simultaneously , the key code in key down event will still be
+ just @c 'A' while the char event key code parameter will now be @c 'A'
+ as well.
+
+ Although in this simple case it is clear that the correct key code could be
+ found in the key down event handler by checking the value returned by
+ wxKeyEvent::ShiftDown(), in general you should use @c EVT_CHAR for this as
+ for non-alphanumeric keys the translation is keyboard-layout dependent and
+ can only be done properly by the system itself.
+
+ Another kind of translation is done when the control key is pressed: for
+ example, for CTRL-A key press the key down event still carries the
+ same key code @c 'a' as usual but the char event will have key code of 1,
+ the ASCII value of this key combination.
+
+ You may discover how the other keys on your system behave interactively by
+ running the @ref page_samples_text wxWidgets sample and pressing some keys
+ in any of the text controls shown in it.
+
+ @b Tip: be sure to call @c event.Skip() for events that you don't process in
+ key event function, otherwise menu shortcuts may cease to work under Windows.
+
+ @note If a key down (@c EVT_KEY_DOWN) event is caught and the event handler
+ does not call @c event.Skip() then the corresponding char event
+ (@c EVT_CHAR) will not happen.
+ This is by design and enables the programs that handle both types of
+ events to be a bit simpler.
+
+ @note For Windows programmers: The key and char events in wxWidgets are
+ similar to but slightly different from Windows @c WM_KEYDOWN and
+ @c WM_CHAR events. In particular, Alt-x combination will generate a
+ char event in wxWidgets (unless it is used as an accelerator).
+
+
+ @beginEventTable{wxKeyEvent}
+ @event{EVT_KEY_DOWN(func)}
+ Process a wxEVT_KEY_DOWN event (any key has been pressed).
+ @event{EVT_KEY_UP(func)}
+ Process a wxEVT_KEY_UP event (any key has been released).
+ @event{EVT_CHAR(func)}
+ Process a wxEVT_CHAR event.
+ @endEventTable
+
@library{wxcore}
@category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview"
*/
-class wxUpdateUIEvent : public wxCommandEvent
+class wxKeyEvent : public wxEvent
{
public:
/**
Constructor.
+ Currently, the only valid event types are @c wxEVT_CHAR and @c wxEVT_CHAR_HOOK.
*/
- wxUpdateUIEvent(wxWindowID commandId = 0);
+ wxKeyEvent(wxEventType keyEventType = wxEVT_NULL);
/**
- Returns @true if it is appropriate to update (send UI update events to)
- this window.
-
- This function looks at the mode used (see wxUpdateUIEvent::SetMode),
- the wxWS_EX_PROCESS_UI_UPDATES flag in @e window,
- the time update events were last sent in idle time, and
- the update interval, to determine whether events should be sent to
- this window now. By default this will always return @true because
- the update mode is initially wxUPDATE_UI_PROCESS_ALL and
- the interval is set to 0; so update events will be sent as
- often as possible. You can reduce the frequency that events
- are sent by changing the mode and/or setting an update interval.
-
- @sa ResetUpdateTime(), SetUpdateInterval(),
- SetMode()
- */
- static bool CanUpdate(wxWindow* window);
+ Returns @true if the Alt key was down at the time of the key event.
- /**
- Check or uncheck the UI element.
+ Notice that GetModifiers() is easier to use correctly than this function
+ so you should consider using it in new code.
*/
- void Check(bool check);
+ bool AltDown() const;
/**
- Enable or disable the UI element.
+ CMD is a pseudo key which is the same as Control for PC and Unix
+ platforms but the special APPLE (a.k.a as COMMAND) key under Macs:
+ it makes often sense to use it instead of, say, ControlDown() because Cmd
+ key is used for the same thing under Mac as Ctrl elsewhere (but Ctrl still
+ exists, just not used for this purpose under Mac). So for non-Mac platforms
+ this is the same as ControlDown() and under Mac this is the same as MetaDown().
*/
- void Enable(bool enable);
+ bool CmdDown() const;
/**
- Returns @true if the UI element should be checked.
- */
- bool GetChecked();
+ Returns @true if the control key was down at the time of the key event.
- /**
- Returns @true if the UI element should be enabled.
+ Notice that GetModifiers() is easier to use correctly than this function
+ so you should consider using it in new code.
*/
- bool GetEnabled();
+ bool ControlDown() const;
/**
- Static function returning a value specifying how wxWidgets
- will send update events: to all windows, or only to those which specify that
- they
- will process the events.
-
- See SetMode().
- */
- static wxUpdateUIMode GetMode();
+ Returns the virtual key code. ASCII events return normal ASCII values,
+ while non-ASCII events return values such as @b WXK_LEFT for the left cursor
+ key. See @ref page_keycodes for a full list of the virtual key codes.
- /**
- Returns @true if the application has called Check(). For wxWidgets internal use
- only.
+ Note that in Unicode build, the returned value is meaningful only if the
+ user entered a character that can be represented in current locale's default
+ charset. You can obtain the corresponding Unicode character using GetUnicodeKey().
*/
- bool GetSetChecked();
+ int GetKeyCode() const;
/**
- Returns @true if the application has called Enable(). For wxWidgets internal use
- only.
- */
- bool GetSetEnabled();
+ Return the bitmask of modifier keys which were pressed when this event
+ happened. See @ref page_keymodifiers for the full list of modifiers.
- /**
- Returns @true if the application has called Show(). For wxWidgets internal use
- only.
+ Notice that this function is easier to use correctly than, for example,
+ ControlDown() because when using the latter you also have to remember to
+ test that none of the other modifiers is pressed:
+
+ @code
+ if ( ControlDown() && !AltDown() && !ShiftDown() && !MetaDown() )
+ ... handle Ctrl-XXX ...
+ @endcode
+
+ and forgetting to do it can result in serious program bugs (e.g. program
+ not working with European keyboard layout where ALTGR key which is seen by
+ the program as combination of CTRL and ALT is used). On the other hand,
+ you can simply write:
+
+ @code
+ if ( GetModifiers() == wxMOD_CONTROL )
+ ... handle Ctrl-XXX ...
+ @endcode
+
+ with this function.
*/
- bool GetSetShown();
+ int GetModifiers() const;
+ //@{
/**
- Returns @true if the application has called SetText(). For wxWidgets internal
- use only.
+ Obtains the position (in client coordinates) at which the key was pressed.
*/
- bool GetSetText();
+ wxPoint GetPosition() const;
+ void GetPosition(long* x, long* y) const;
+ //@}
/**
- Returns @true if the UI element should be shown.
+ Returns the raw key code for this event. This is a platform-dependent scan code
+ which should only be used in advanced applications.
+
+ @note Currently the raw key codes are not supported by all ports, use
+ @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
*/
- bool GetShown();
+ wxUint32 GetRawKeyCode() const;
/**
- Returns the text that should be set for the UI element.
+ Returns the low level key flags for this event. The flags are
+ platform-dependent and should only be used in advanced applications.
+
+ @note Currently the raw key flags are not supported by all ports, use
+ @ifdef_ wxHAS_RAW_KEY_CODES to determine if this feature is available.
*/
- wxString GetText();
+ wxUint32 GetRawKeyFlags() const;
/**
- Returns the current interval between updates in milliseconds.
- -1 disables updates, 0 updates as frequently as possible.
-
- See SetUpdateInterval().
+ Returns the Unicode character corresponding to this key event.
+
+ This function is only available in Unicode build, i.e. when
+ @c wxUSE_UNICODE is 1.
*/
- static long GetUpdateInterval();
+ wxChar GetUnicodeKey() const;
/**
- Used internally to reset the last-updated time to the
- current time. It is assumed that update events are
- normally sent in idle time, so this is called at the end of
- idle processing.
-
- @sa CanUpdate(), SetUpdateInterval(),
- SetMode()
+ Returns the X position (in client coordinates) of the event.
*/
- static void ResetUpdateTime();
+ wxCoord GetX() const;
/**
- Specify how wxWidgets will send update events: to
- all windows, or only to those which specify that they
- will process the events.
-
- @e mode may be one of the following values.
- The default is wxUPDATE_UI_PROCESS_ALL.
+ Returns the Y position (in client coordinates) of the event.
*/
- static void SetMode(wxUpdateUIMode mode);
+ wxCoord GetY() const;
/**
- Sets the text for this UI element.
+ Returns @true if either CTRL or ALT keys was down at the time of the
+ key event.
+
+ Note that this function does not take into account neither SHIFT nor
+ META key states (the reason for ignoring the latter is that it is
+ common for NUMLOCK key to be configured as META under X but the key
+ presses even while NUMLOCK is on should be still processed normally).
*/
- void SetText(const wxString& text);
+ bool HasModifiers() const;
/**
- Sets the interval between updates in milliseconds.
- Set to -1 to disable updates, or to 0 to update as frequently as possible.
- The default is 0.
-
- Use this to reduce the overhead of UI update events if your application
- has a lot of windows. If you set the value to -1 or greater than 0,
- you may also need to call wxWindow::UpdateWindowUI
- at appropriate points in your application, such as when a dialog
- is about to be shown.
+ Returns @true if the Meta key was down at the time of the key event.
+
+ Notice that GetModifiers() is easier to use correctly than this function
+ so you should consider using it in new code.
*/
- static void SetUpdateInterval(long updateInterval);
+ bool MetaDown() const;
/**
- Show or hide the UI element.
+ Returns @true if the shift key was down at the time of the key event.
+
+ Notice that GetModifiers() is easier to use correctly than this function
+ so you should consider using it in new code.
*/
- void Show(bool show);
+ bool ShiftDown() const;
};
+
/**
- @class wxClipboardTextEvent
+ @class wxJoystickEvent
@wxheader{event.h}
-
- This class represents the events generated by a control (typically a
- wxTextCtrl but other windows can generate these events as
- well) when its content gets copied or cut to, or pasted from the clipboard.
- There are three types of corresponding events wxEVT_COMMAND_TEXT_COPY,
- wxEVT_COMMAND_TEXT_CUT and wxEVT_COMMAND_TEXT_PASTE.
-
- If any of these events is processed (without being skipped) by an event
- handler, the corresponding operation doesn't take place which allows to prevent
- the text from being copied from or pasted to a control. It is also possible to
- examine the clipboard contents in the PASTE event handler and transform it in
- some way before inserting in a control -- for example, changing its case or
- removing invalid characters.
-
- Finally notice that a CUT event is always preceded by the COPY event which
- makes it possible to only process the latter if it doesn't matter if the text
- was copied or cut.
-
- @library{wxcore}
- @category{events}
-
- @seealso
- wxClipboard
-*/
-class wxClipboardTextEvent : public wxCommandEvent
-{
-public:
- /**
-
- */
- wxClipboardTextEvent(wxEventType commandType = wxEVT_@NULL,
- int id = 0);
-};
+ This event class contains information about joystick events, particularly
+ events received by windows.
+
+ @beginEventTable{wxJoystickEvent}
+ @style{EVT_JOY_BUTTON_DOWN(func)}
+ Process a wxEVT_JOY_BUTTON_DOWN event.
+ @style{EVT_JOY_BUTTON_UP(func)}
+ Process a wxEVT_JOY_BUTTON_UP event.
+ @style{EVT_JOY_MOVE(func)}
+ Process a wxEVT_JOY_MOVE event.
+ @style{EVT_JOY_ZMOVE(func)}
+ Process a wxEVT_JOY_ZMOVE event.
+ @style{EVT_JOYSTICK_EVENTS(func)}
+ Processes all joystick events.
+ @endEventTable
-/**
- @class wxMouseEvent
- @wxheader{event.h}
-
- This event class contains information about the events generated by the mouse:
- they include mouse buttons press and release events and mouse move events.
-
- All mouse events involving the buttons use @c wxMOUSE_BTN_LEFT for the
- left mouse button, @c wxMOUSE_BTN_MIDDLE for the middle one and
- @c wxMOUSE_BTN_RIGHT for the right one. And if the system supports more
- buttons, the @c wxMOUSE_BTN_AUX1 and @c wxMOUSE_BTN_AUX2 events
- can also be generated. Note that not all mice have even a middle button so a
- portable application should avoid relying on the events from it (but the right
- button click can be emulated using the left mouse button with the control key
- under Mac platforms with a single button mouse).
-
- For the @c wxEVT_ENTER_WINDOW and @c wxEVT_LEAVE_WINDOW events
- purposes, the mouse is considered to be inside the window if it is in the
- window client area and not inside one of its children. In other words, the
- parent window receives @c wxEVT_LEAVE_WINDOW event not only when the
- mouse leaves the window entirely but also when it enters one of its children.
-
- @b NB: Note that under Windows CE mouse enter and leave events are not natively
- supported
- by the system but are generated by wxWidgets itself. This has several
- drawbacks: the LEAVE_WINDOW event might be received some time after the mouse
- left the window and the state variables for it may have changed during this
- time.
-
- @b NB: Note the difference between methods like
- wxMouseEvent::LeftDown and
- wxMouseEvent::LeftIsDown: the former returns @true
- when the event corresponds to the left mouse button click while the latter
- returns @true if the left mouse button is currently being pressed. For
- example, when the user is dragging the mouse you can use
- wxMouseEvent::LeftIsDown to test
- whether the left mouse button is (still) depressed. Also, by convention, if
- wxMouseEvent::LeftDown returns @true,
- wxMouseEvent::LeftIsDown will also return @true in
- wxWidgets whatever the underlying GUI behaviour is (which is
- platform-dependent). The same applies, of course, to other mouse buttons as
- well.
-
@library{wxcore}
@category{events}
-
- @seealso
- wxKeyEvent::CmdDown
+
+ @see wxJoystick
*/
-class wxMouseEvent : public wxEvent
+class wxJoystickEvent : public wxEvent
{
public:
/**
- Constructor. Valid event types are:
-
- @b wxEVT_ENTER_WINDOW
- @b wxEVT_LEAVE_WINDOW
- @b wxEVT_LEFT_DOWN
- @b wxEVT_LEFT_UP
- @b wxEVT_LEFT_DCLICK
- @b wxEVT_MIDDLE_DOWN
- @b wxEVT_MIDDLE_UP
- @b wxEVT_MIDDLE_DCLICK
- @b wxEVT_RIGHT_DOWN
- @b wxEVT_RIGHT_UP
- @b wxEVT_RIGHT_DCLICK
- @b wxEVT_MOUSE_AUX1_DOWN
- @b wxEVT_MOUSE_AUX1_UP
- @b wxEVT_MOUSE_AUX1_DCLICK
- @b wxEVT_MOUSE_AUX2_DOWN
- @b wxEVT_MOUSE_AUX2_UP
- @b wxEVT_MOUSE_AUX2_DCLICK
- @b wxEVT_MOTION
- @b wxEVT_MOUSEWHEEL
- */
- wxMouseEvent(WXTYPE mouseEventType = 0);
-
- /**
- Returns @true if the Alt key was down at the time of the event.
+ Constructor.
*/
- bool AltDown();
+ wxJoystickEvent(wxEventType eventType = wxEVT_NULL, int state = 0,
+ int joystick = wxJOYSTICK1,
+ int change = 0);
/**
- Returns @true if the event was a first extra button double click.
- */
- bool Aux1DClick();
+ Returns @true if the event was a down event from the specified button
+ (or any button).
- /**
- Returns @true if the first extra button mouse button changed to down.
+ @param button
+ Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
+ indicate any button down event.
*/
- bool Aux1Down();
+ bool ButtonDown(int button = wxJOY_BUTTON_ANY) const;
/**
- Returns @true if the first extra button mouse button is currently down,
- independent
- of the current event type.
+ Returns @true if the specified button (or any button) was in a down state.
+
+ @param button
+ Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
+ indicate any button down event.
*/
- bool Aux1IsDown();
+ bool ButtonIsDown(int button = wxJOY_BUTTON_ANY) const;
/**
- Returns @true if the first extra button mouse button changed to up.
+ Returns @true if the event was an up event from the specified button
+ (or any button).
+
+ @param button
+ Can be @c wxJOY_BUTTONn where @c n is 1, 2, 3 or 4; or @c wxJOY_BUTTON_ANY to
+ indicate any button down event.
*/
- bool Aux1Up();
+ bool ButtonUp(int button = wxJOY_BUTTON_ANY) const;
/**
- Returns @true if the event was a second extra button double click.
+ Returns the identifier of the button changing state.
+
+ This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
*/
- bool Aux2DClick();
+ int GetButtonChange() const;
/**
- Returns @true if the second extra button mouse button changed to down.
+ Returns the down state of the buttons.
+
+ This is a @c wxJOY_BUTTONn identifier, where @c n is one of 1, 2, 3, 4.
*/
- bool Aux2Down();
+ int GetButtonState() const;
/**
- Returns @true if the second extra button mouse button is currently down,
- independent
- of the current event type.
+ Returns the identifier of the joystick generating the event - one of
+ wxJOYSTICK1 and wxJOYSTICK2.
*/
- bool Aux2IsDown();
+ int GetJoystick() const;
/**
- Returns @true if the second extra button mouse button changed to up.
+ Returns the x, y position of the joystick event.
*/
- bool Aux2Up();
-
- /**
- Returns @true if the identified mouse button is changing state. Valid
- values of @e button are:
-
- @c wxMOUSE_BTN_LEFT
-
-
- check if left button was pressed
-
- @c wxMOUSE_BTN_MIDDLE
-
-
- check if middle button was pressed
-
- @c wxMOUSE_BTN_RIGHT
-
-
- check if right button was pressed
-
- @c wxMOUSE_BTN_AUX1
-
-
- check if the first extra button was pressed
-
- @c wxMOUSE_BTN_AUX2
-
-
- check if the second extra button was pressed
-
- @c wxMOUSE_BTN_ANY
-
-
- check if any button was pressed
- */
- bool Button(int button);
+ wxPoint GetPosition() const;
/**
- If the argument is omitted, this returns @true if the event was a mouse
- double click event. Otherwise the argument specifies which double click event
- was generated (see Button() for the possible
- values).
+ Returns the z position of the joystick event.
*/
- bool ButtonDClick(int but = wxMOUSE_BTN_ANY);
+ int GetZPosition() const;
/**
- If the argument is omitted, this returns @true if the event was a mouse
- button down event. Otherwise the argument specifies which button-down event
- was generated (see Button() for the possible
- values).
+ Returns @true if this was a button up or down event
+ (@e not 'is any button down?').
*/
- bool ButtonDown(int but = -1);
+ bool IsButton() const;
/**
- If the argument is omitted, this returns @true if the event was a mouse
- button up event. Otherwise the argument specifies which button-up event
- was generated (see Button() for the possible
- values).
+ Returns @true if this was an x, y move event.
*/
- bool ButtonUp(int but = -1);
+ bool IsMove() const;
/**
- Same as MetaDown() under Mac, same as
- ControlDown() elsewhere.
-
- @sa wxKeyEvent::CmdDown
+ Returns @true if this was a z move event.
*/
- bool CmdDown();
+ bool IsZMove() const;
+};
- /**
- Returns @true if the control key was down at the time of the event.
- */
- bool ControlDown();
- /**
- Returns @true if this was a dragging event (motion while a button is depressed).
-
- @sa Moving()
- */
- bool Dragging();
- /**
- Returns @true if the mouse was entering the window.
-
- See also Leaving().
- */
- bool Entering();
+/**
+ @class wxScrollWinEvent
+ @wxheader{event.h}
- /**
- Returns the mouse button which generated this event or @c wxMOUSE_BTN_NONE
- if no button is involved (for mouse move, enter or leave event, for example).
- Otherwise @c wxMOUSE_BTN_LEFT is returned for the left button down, up and
- double click events, @c wxMOUSE_BTN_MIDDLE and @c wxMOUSE_BTN_RIGHT
- for the same events for the middle and the right buttons respectively.
- */
- int GetButton();
+ A scroll event holds information about events sent from scrolling windows.
- /**
- Returns the number of mouse clicks for this event: 1 for a simple click, 2
- for a double-click, 3 for a triple-click and so on.
-
- Currently this function is implemented only in wxMac and returns -1 for the
- other platforms (you can still distinguish simple clicks from double-clicks as
- they generate different kinds of events however).
-
- This function is new since wxWidgets version 2.9.0
- */
- int GetClickCount();
- /**
- Returns the configured number of lines (or whatever) to be scrolled per
- wheel action. Defaults to three.
- */
- int GetLinesPerAction();
+ @beginEventTable{wxScrollWinEvent}
+ You can use the EVT_SCROLLWIN* macros for intercepting scroll window events
+ from the receiving window.
+ @event{EVT_SCROLLWIN(func)}
+ Process all scroll events.
+ @event{EVT_SCROLLWIN_TOP(func)}
+ Process wxEVT_SCROLLWIN_TOP scroll-to-top events.
+ @event{EVT_SCROLLWIN_BOTTOM(func)}
+ Process wxEVT_SCROLLWIN_BOTTOM scroll-to-bottom events.
+ @event{EVT_SCROLLWIN_LINEUP(func)}
+ Process wxEVT_SCROLLWIN_LINEUP line up events.
+ @event{EVT_SCROLLWIN_LINEDOWN(func)}
+ Process wxEVT_SCROLLWIN_LINEDOWN line down events.
+ @event{EVT_SCROLLWIN_PAGEUP(func)}
+ Process wxEVT_SCROLLWIN_PAGEUP page up events.
+ @event{EVT_SCROLLWIN_PAGEDOWN(func)}
+ Process wxEVT_SCROLLWIN_PAGEDOWN page down events.
+ @event{EVT_SCROLLWIN_THUMBTRACK(func)}
+ Process wxEVT_SCROLLWIN_THUMBTRACK thumbtrack events
+ (frequent events sent as the user drags the thumbtrack).
+ @event{EVT_SCROLLWIN_THUMBRELEASE(func)}
+ Process wxEVT_SCROLLWIN_THUMBRELEASE thumb release events.
+ @endEventTable
- /**
- Returns the logical mouse position in pixels (i.e. translated according to the
- translation set for the DC, which usually indicates that the window has been
- scrolled).
- */
- wxPoint GetLogicalPosition(const wxDC& dc);
- //@{
- /**
- Sets *x and *y to the position at which the event occurred.
-
- Returns the physical mouse position in pixels.
-
- Note that if the mouse event has been artificially generated from a special
- keyboard combination (e.g. under Windows when the "menu'' key is pressed), the
- returned position is @c wxDefaultPosition.
- */
- wxPoint GetPosition();
- void GetPosition(wxCoord* x, wxCoord* y);
- void GetPosition(long* x, long* y);
- //@}
+ @library{wxcore}
+ @category{events}
+ @see wxScrollEvent, @ref overview_eventhandling
+*/
+class wxScrollWinEvent : public wxEvent
+{
+public:
/**
- Get wheel delta, normally 120. This is the threshold for action to be
- taken, and one such action (for example, scrolling one increment)
- should occur for each delta.
+ Constructor.
*/
- int GetWheelDelta();
+ wxScrollWinEvent(wxEventType commandType = wxEVT_NULL, int pos = 0,
+ int orientation = 0);
/**
- Get wheel rotation, positive or negative indicates direction of
- rotation. Current devices all send an event when rotation is at least
- +/-WheelDelta, but finer resolution devices can be created in the future.
- Because of this you shouldn't assume that one event is equal to 1 line, but you
- should be able to either do partial line scrolling or wait until several
- events accumulate before scrolling.
- */
- int GetWheelRotation();
+ Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
+ scrollbar.
- /**
- Returns X coordinate of the physical mouse event position.
+ @todo wxHORIZONTAL and wxVERTICAL should go in their own enum
*/
-#define long GetX() /* implementation is private */
+ int GetOrientation() const;
/**
- Returns Y coordinate of the physical mouse event position.
- */
-#define long GetY() /* implementation is private */
+ Returns the position of the scrollbar for the thumb track and release events.
- /**
- Returns @true if the event was a mouse button event (not necessarily a button
- down event -
- that may be tested using @e ButtonDown).
+ Note that this field can't be used for the other events, you need to query
+ the window itself for the current position in that case.
*/
- bool IsButton();
+ int GetPosition() const;
+};
- /**
- Returns @true if the system has been setup to do page scrolling with
- the mouse wheel instead of line scrolling.
- */
- bool IsPageScroll();
- /**
- Returns @true if the mouse was leaving the window.
-
- See also Entering().
- */
- bool Leaving();
- /**
- Returns @true if the event was a left double click.
- */
- bool LeftDClick();
+/**
+ @class wxSysColourChangedEvent
+ @wxheader{event.h}
- /**
- Returns @true if the left mouse button changed to down.
- */
- bool LeftDown();
+ This class is used for system colour change events, which are generated
+ when the user changes the colour settings using the control panel.
+ This is only appropriate under Windows.
- /**
- Returns @true if the left mouse button is currently down, independent
- of the current event type.
-
- Please notice that it is not the same as
- LeftDown() which returns @true if the event was
- generated by the left mouse button being pressed. Rather, it simply describes
- the state of the left mouse button at the time when the event was generated
- (so while it will be @true for a left click event, it can also be @true for
- a right click if it happened while the left mouse button was pressed).
-
- This event is usually used in the mouse event handlers which process "move
- mouse" messages to determine whether the user is (still) dragging the mouse.
- */
- bool LeftIsDown();
+ @remarks
+ The default event handler for this event propagates the event to child windows,
+ since Windows only sends the events to top-level windows.
+ If intercepting this event for a top-level window, remember to call the base
+ class handler, or to pass the event on to the window's children explicitly.
- /**
- Returns @true if the left mouse button changed to up.
- */
- bool LeftUp();
+ @beginEventTable{wxSysColourChangedEvent}
+ @event{EVT_SYS_COLOUR_CHANGED(func)}
+ Process a wxEVT_SYS_COLOUR_CHANGED event.
+ @endEventTable
- /**
- Returns @true if the Meta key was down at the time of the event.
- */
- bool MetaDown();
+ @library{wxcore}
+ @category{events}
+ @see @ref overview_eventhandling
+*/
+class wxSysColourChangedEvent : public wxEvent
+{
+public:
/**
- Returns @true if the event was a middle double click.
+ Constructor.
*/
- bool MiddleDClick();
+ wxSysColourChangedEvent();
+};
- /**
- Returns @true if the middle mouse button changed to down.
- */
- bool MiddleDown();
- /**
- Returns @true if the middle mouse button is currently down, independent
- of the current event type.
- */
- bool MiddleIsDown();
- /**
- Returns @true if the middle mouse button changed to up.
- */
- bool MiddleUp();
+/**
+ @class wxWindowCreateEvent
+ @wxheader{event.h}
- /**
- Returns @true if this was a motion event and no mouse buttons were pressed.
- If any mouse button is held pressed, then this method returns @false and
- Dragging() returns @true.
- */
- bool Moving();
+ This event is sent just after the actual window associated with a wxWindow
+ object has been created.
- /**
- Returns @true if the event was a right double click.
- */
- bool RightDClick();
+ Since it is derived from wxCommandEvent, the event propagates up
+ the window hierarchy.
- /**
- Returns @true if the right mouse button changed to down.
- */
- bool RightDown();
+ @beginEventTable{wxWindowCreateEvent}
+ @event{EVT_WINDOW_CREATE(func)}
+ Process a wxEVT_CREATE event.
+ @endEventTable
- /**
- Returns @true if the right mouse button is currently down, independent
- of the current event type.
- */
- bool RightIsDown();
+ @library{wxcore}
+ @category{events}
+ @see @ref overview_eventhandling, wxWindowDestroyEvent
+*/
+class wxWindowCreateEvent : public wxCommandEvent
+{
+public:
/**
- Returns @true if the right mouse button changed to up.
+ Constructor.
*/
- bool RightUp();
+ wxWindowCreateEvent(wxWindow* win = NULL);
+};
- /**
- Returns @true if the shift key was down at the time of the event.
- */
- bool ShiftDown();
- /**
- bool m_altDown
-
- @true if the Alt key is pressed down.
- */
+/**
+ @class wxPaintEvent
+ @wxheader{event.h}
- /**
- bool m_controlDown
-
- @true if control key is pressed down.
- */
+ A paint event is sent when a window's contents needs to be repainted.
+ Please notice that in general it is impossible to change the drawing of a
+ standard control (such as wxButton) and so you shouldn't attempt to handle
+ paint events for them as even if it might work on some platforms, this is
+ inherently not portable and won't work everywhere.
+
+ @remarks
+ Note that in a paint event handler, the application must always create a
+ wxPaintDC object, even if you do not use it. Otherwise, under MS Windows,
+ refreshing for this and other windows will go wrong.
+ For example:
+ @code
+ void MyWindow::OnPaint(wxPaintEvent& event)
+ {
+ wxPaintDC dc(this);
- /**
- bool m_leftDown
-
- @true if the left mouse button is currently pressed down.
- */
+ DrawMyDocument(dc);
+ }
+ @endcode
+ You can optimize painting by retrieving the rectangles that have been damaged
+ and only repainting these. The rectangles are in terms of the client area,
+ and are unscrolled, so you will need to do some calculations using the current
+ view position to obtain logical, scrolled units.
+ Here is an example of using the wxRegionIterator class:
+ @code
+ // Called when window needs to be repainted.
+ void MyWindow::OnPaint(wxPaintEvent& event)
+ {
+ wxPaintDC dc(this);
+ // Find Out where the window is scrolled to
+ int vbX,vbY; // Top left corner of client
+ GetViewStart(&vbX,&vbY);
- /**
- int m_linesPerAction
-
- The configured number of lines (or whatever) to be scrolled per wheel
- action.
- */
+ int vX,vY,vW,vH; // Dimensions of client area in pixels
+ wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
+ while (upd)
+ {
+ vX = upd.GetX();
+ vY = upd.GetY();
+ vW = upd.GetW();
+ vH = upd.GetH();
- /**
- bool m_metaDown
-
- @true if the Meta key is pressed down.
- */
+ // Alternatively we can do this:
+ // wxRect rect(upd.GetRect());
+ // Repaint this rectangle
+ ...some code...
- /**
- bool m_middleDown
-
- @true if the middle mouse button is currently pressed down.
- */
+ upd ++ ;
+ }
+ }
+ @endcode
- /**
- bool m_rightDown
-
- @true if the right mouse button is currently pressed down.
- */
+ @beginEventTable{wxPaintEvent}
+ @event{EVT_PAINT(func)}
+ Process a wxEVT_PAINT event.
+ @endEventTable
+ @library{wxcore}
+ @category{events}
+ @see @ref overview_eventhandling
+*/
+class wxPaintEvent : public wxEvent
+{
+public:
/**
- bool m_shiftDown
-
- @true if shift is pressed down.
+ Constructor.
*/
+ wxPaintEvent(int id = 0);
+};
- /**
- int m_wheelDelta
-
- The wheel delta, normally 120.
- */
+/**
+ @class wxMaximizeEvent
+ @wxheader{event.h}
+
+ An event being sent when a top level window is maximized. Notice that it is
+ not sent when the window is restored to its original size after it had been
+ maximized, only a normal wxSizeEvent is generated in this case.
- /**
- int m_wheelRotation
-
- The distance the mouse wheel is rotated.
- */
+ @beginEventTable{wxMaximizeEvent}
+ @event{EVT_MAXIMIZE(func)}
+ Process a wxEVT_MAXIMIZE event.
+ @endEventTable
+ @library{wxcore}
+ @category{events}
+ @see @ref overview_eventhandling, wxTopLevelWindow::Maximize,
+ wxTopLevelWindow::IsMaximized
+*/
+class wxMaximizeEvent : public wxEvent
+{
+public:
/**
- long m_x
-
- X-coordinate of the event.
+ Constructor. Only used by wxWidgets internally.
*/
+ wxMaximizeEvent(int id = 0);
+};
+/**
+ The possibles modes to pass to wxUpdateUIEvent::SetMode().
+*/
+enum wxUpdateUIMode
+{
+ /** Send UI update events to all windows. */
+ wxUPDATE_UI_PROCESS_ALL,
- /**
- long m_y
-
- Y-coordinate of the event.
- */
+ /** Send UI update events to windows that have
+ the wxWS_EX_PROCESS_UI_UPDATES flag specified. */
+ wxUPDATE_UI_PROCESS_SPECIFIED
};
/**
- @class wxDropFilesEvent
+ @class wxUpdateUIEvent
@wxheader{event.h}
-
- This class is used for drop files events, that is, when files have been dropped
- onto the window. This functionality is currently only available under Windows.
- The window must have previously been enabled for dropping by calling
- wxWindow::DragAcceptFiles.
-
- Important note: this is a separate implementation to the more general
- drag and drop implementation documented here. It uses the
- older, Windows message-based approach of dropping files.
-
+
+ This class is used for pseudo-events which are called by wxWidgets
+ to give an application the chance to update various user interface elements.
+
+ Without update UI events, an application has to work hard to check/uncheck,
+ enable/disable, show/hide, and set the text for elements such as menu items
+ and toolbar buttons. The code for doing this has to be mixed up with the code
+ that is invoked when an action is invoked for a menu item or button.
+
+ With update UI events, you define an event handler to look at the state of the
+ application and change UI elements accordingly. wxWidgets will call your member
+ functions in idle time, so you don't have to worry where to call this code.
+
+ In addition to being a clearer and more declarative method, it also means you don't
+ have to worry whether you're updating a toolbar or menubar identifier. The same
+ handler can update a menu item and toolbar button, if the identifier is the same.
+ Instead of directly manipulating the menu or button, you call functions in the event
+ object, such as wxUpdateUIEvent::Check. wxWidgets will determine whether such a
+ call has been made, and which UI element to update.
+
+ These events will work for popup menus as well as menubars. Just before a menu is
+ popped up, wxMenu::UpdateUI is called to process any UI events for the window that
+ owns the menu.
+
+ If you find that the overhead of UI update processing is affecting your application,
+ you can do one or both of the following:
+ @li Call wxUpdateUIEvent::SetMode with a value of wxUPDATE_UI_PROCESS_SPECIFIED,
+ and set the extra style wxWS_EX_PROCESS_UI_UPDATES for every window that should
+ receive update events. No other windows will receive update events.
+ @li Call wxUpdateUIEvent::SetUpdateInterval with a millisecond value to set the delay
+ between updates. You may need to call wxWindow::UpdateWindowUI at critical points,
+ for example when a dialog is about to be shown, in case the user sees a slight
+ delay before windows are updated.
+
+ Note that although events are sent in idle time, defining a wxIdleEvent handler
+ for a window does not affect this because the events are sent from wxWindow::OnInternalIdle
+ which is always called in idle time.
+
+ wxWidgets tries to optimize update events on some platforms.
+ On Windows and GTK+, events for menubar items are only sent when the menu is about
+ to be shown, and not in idle time.
+
+
+ @beginEventTable{wxUpdateUIEvent}
+ @event{EVT_UPDATE_UI(id, func)}
+ Process a wxEVT_UPDATE_UI event for the command with the given id.
+ @event{EVT_UPDATE_UI_RANGE(id1, id2, func)}
+ Process a wxEVT_UPDATE_UI event for any command with id included in the given range.
+ @endEventTable
+
@library{wxcore}
@category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+
+ @see @ref overview_eventhandling
*/
-class wxDropFilesEvent : public wxEvent
+class wxUpdateUIEvent : public wxCommandEvent
{
public:
/**
Constructor.
*/
- wxDropFilesEvent(WXTYPE id = 0, int noFiles = 0,
- wxString* files = @NULL);
+ wxUpdateUIEvent(wxWindowID commandId = 0);
/**
- Returns an array of filenames.
+ Returns @true if it is appropriate to update (send UI update events to)
+ this window.
+
+ This function looks at the mode used (see wxUpdateUIEvent::SetMode),
+ the wxWS_EX_PROCESS_UI_UPDATES flag in @a window, the time update events
+ were last sent in idle time, and the update interval, to determine whether
+ events should be sent to this window now. By default this will always
+ return @true because the update mode is initially wxUPDATE_UI_PROCESS_ALL
+ and the interval is set to 0; so update events will be sent as often as
+ possible. You can reduce the frequency that events are sent by changing the
+ mode and/or setting an update interval.
+
+ @see ResetUpdateTime(), SetUpdateInterval(), SetMode()
*/
- wxString* GetFiles();
+ static bool CanUpdate(wxWindow* window);
/**
- Returns the number of files dropped.
+ Check or uncheck the UI element.
*/
- int GetNumberOfFiles();
+ void Check(bool check);
/**
- Returns the position at which the files were dropped.
-
- Returns an array of filenames.
+ Enable or disable the UI element.
*/
- wxPoint GetPosition();
+ void Enable(bool enable);
/**
- wxString* m_files
-
- An array of filenames.
+ Returns @true if the UI element should be checked.
*/
-
+ bool GetChecked() const;
/**
- int m_noFiles
-
- The number of files dropped.
+ Returns @true if the UI element should be enabled.
*/
-
+ bool GetEnabled() const;
/**
- wxPoint m_pos
-
- The point at which the drop took place.
- */
-};
+ Static function returning a value specifying how wxWidgets will send update
+ events: to all windows, or only to those which specify that they will process
+ the events.
+ @see SetMode()
+ */
+ static wxUpdateUIMode GetMode();
-/**
- @class wxCommandEvent
- @wxheader{event.h}
-
- This event class contains information about command events, which originate
- from a variety of
- simple controls. More complex controls, such as wxTreeCtrl, have separate
- command event classes.
-
- @library{wxcore}
- @category{events}
-*/
-class wxCommandEvent : public wxEvent
-{
-public:
/**
- Constructor.
+ Returns @true if the application has called Check().
+ For wxWidgets internal use only.
*/
- wxCommandEvent(WXTYPE commandEventType = 0, int id = 0);
+ bool GetSetChecked() const;
/**
- Deprecated, use IsChecked() instead.
+ Returns @true if the application has called Enable().
+ For wxWidgets internal use only.
*/
- bool Checked();
+ bool GetSetEnabled() const;
/**
- Returns client data pointer for a listbox or choice selection event
- (not valid for a deselection).
+ Returns @true if the application has called Show().
+ For wxWidgets internal use only.
*/
- void* GetClientData();
+ bool GetSetShown() const;
/**
- Returns client object pointer for a listbox or choice selection event
- (not valid for a deselection).
+ Returns @true if the application has called SetText().
+ For wxWidgets internal use only.
*/
- wxClientData * GetClientObject();
+ bool GetSetText() const;
/**
- Returns extra information dependant on the event objects type.
+ Returns @true if the UI element should be shown.
+ */
+ bool GetShown() const;
+
+ /**
+ Returns the text that should be set for the UI element.
+ */
+ wxString GetText() const;
+
+ /**
+ Returns the current interval between updates in milliseconds.
+ The value -1 disables updates, 0 updates as frequently as possible.
+
+ @see SetUpdateInterval().
+ */
+ static long GetUpdateInterval();
+
+ /**
+ Used internally to reset the last-updated time to the current time.
+
+ It is assumed that update events are normally sent in idle time, so this
+ is called at the end of idle processing.
+
+ @see CanUpdate(), SetUpdateInterval(), SetMode()
+ */
+ static void ResetUpdateTime();
+
+ /**
+ Specify how wxWidgets will send update events: to all windows, or only to
+ those which specify that they will process the events.
+
+ @param mode
+ this parameter may be one of the ::wxUpdateUIMode enumeration values.
+ The default mode is wxUPDATE_UI_PROCESS_ALL.
+ */
+ static void SetMode(wxUpdateUIMode mode);
+
+ /**
+ Sets the text for this UI element.
+ */
+ void SetText(const wxString& text);
+
+ /**
+ Sets the interval between updates in milliseconds.
+
+ Set to -1 to disable updates, or to 0 to update as frequently as possible.
+ The default is 0.
+
+ Use this to reduce the overhead of UI update events if your application
+ has a lot of windows. If you set the value to -1 or greater than 0,
+ you may also need to call wxWindow::UpdateWindowUI at appropriate points
+ in your application, such as when a dialog is about to be shown.
+ */
+ static void SetUpdateInterval(long updateInterval);
+
+ /**
+ Show or hide the UI element.
+ */
+ void Show(bool show);
+};
+
+
+
+/**
+ @class wxClipboardTextEvent
+ @wxheader{event.h}
+
+ This class represents the events generated by a control (typically a
+ wxTextCtrl but other windows can generate these events as well) when its
+ content gets copied or cut to, or pasted from the clipboard.
+
+ There are three types of corresponding events wxEVT_COMMAND_TEXT_COPY,
+ wxEVT_COMMAND_TEXT_CUT and wxEVT_COMMAND_TEXT_PASTE.
+
+ If any of these events is processed (without being skipped) by an event
+ handler, the corresponding operation doesn't take place which allows to
+ prevent the text from being copied from or pasted to a control. It is also
+ possible to examine the clipboard contents in the PASTE event handler and
+ transform it in some way before inserting in a control -- for example,
+ changing its case or removing invalid characters.
+
+ Finally notice that a CUT event is always preceded by the COPY event which
+ makes it possible to only process the latter if it doesn't matter if the
+ text was copied or cut.
+
+ @note
+ These events are currently only generated by wxTextCtrl under GTK+.
+ They are generated by all controls under Windows.
+
+ @beginEventTable{wxClipboardTextEvent}
+ @event{EVT_TEXT_COPY(id, func)}
+ Some or all of the controls content was copied to the clipboard.
+ @event{EVT_TEXT_CUT(id, func)}
+ Some or all of the controls content was cut (i.e. copied and
+ deleted).
+ @event{EVT_TEXT_PASTE(id, func)}
+ Clipboard content was pasted into the control.
+ @endEventTable
+
+
+ @library{wxcore}
+ @category{events}
+
+ @see wxClipboard
+*/
+class wxClipboardTextEvent : public wxCommandEvent
+{
+public:
+ /**
+ Constructor.
+ */
+ wxClipboardTextEvent(wxEventType commandType = wxEVT_NULL, int id = 0);
+};
+
+
+
+/**
+ @class wxMouseEvent
+ @wxheader{event.h}
+
+ This event class contains information about the events generated by the mouse:
+ they include mouse buttons press and release events and mouse move events.
+
+ All mouse events involving the buttons use @c wxMOUSE_BTN_LEFT for the
+ left mouse button, @c wxMOUSE_BTN_MIDDLE for the middle one and
+ @c wxMOUSE_BTN_RIGHT for the right one. And if the system supports more
+ buttons, the @c wxMOUSE_BTN_AUX1 and @c wxMOUSE_BTN_AUX2 events
+ can also be generated. Note that not all mice have even a middle button so a
+ portable application should avoid relying on the events from it (but the right
+ button click can be emulated using the left mouse button with the control key
+ under Mac platforms with a single button mouse).
+
+ For the @c wxEVT_ENTER_WINDOW and @c wxEVT_LEAVE_WINDOW events
+ purposes, the mouse is considered to be inside the window if it is in the
+ window client area and not inside one of its children. In other words, the
+ parent window receives @c wxEVT_LEAVE_WINDOW event not only when the
+ mouse leaves the window entirely but also when it enters one of its children.
+
+ @note Note that under Windows CE mouse enter and leave events are not natively
+ supported by the system but are generated by wxWidgets itself. This has several
+ drawbacks: the LEAVE_WINDOW event might be received some time after the mouse
+ left the window and the state variables for it may have changed during this time.
+
+ @note Note the difference between methods like wxMouseEvent::LeftDown and
+ wxMouseEvent::LeftIsDown: the former returns @true when the event corresponds
+ to the left mouse button click while the latter returns @true if the left
+ mouse button is currently being pressed. For example, when the user is dragging
+ the mouse you can use wxMouseEvent::LeftIsDown to test whether the left mouse
+ button is (still) depressed. Also, by convention, if wxMouseEvent::LeftDown
+ returns @true, wxMouseEvent::LeftIsDown will also return @true in wxWidgets
+ whatever the underlying GUI behaviour is (which is platform-dependent).
+ The same applies, of course, to other mouse buttons as well.
+
+
+ @beginEventTable{wxMouseEvent}
+ @event{EVT_LEFT_DOWN(func)}
+ Process a wxEVT_LEFT_DOWN event. The handler of this event should normally
+ call event.Skip() to allow the default processing to take place as otherwise
+ the window under mouse wouldn't get the focus.
+ @event{EVT_LEFT_UP(func)}
+ Process a wxEVT_LEFT_UP event.
+ @event{EVT_LEFT_DCLICK(func)}
+ Process a wxEVT_LEFT_DCLICK event.
+ @event{EVT_MIDDLE_DOWN(func)}
+ Process a wxEVT_MIDDLE_DOWN event.
+ @event{EVT_MIDDLE_UP(func)}
+ Process a wxEVT_MIDDLE_UP event.
+ @event{EVT_MIDDLE_DCLICK(func)}
+ Process a wxEVT_MIDDLE_DCLICK event.
+ @event{EVT_RIGHT_DOWN(func)}
+ Process a wxEVT_RIGHT_DOWN event.
+ @event{EVT_RIGHT_UP(func)}
+ Process a wxEVT_RIGHT_UP event.
+ @event{EVT_RIGHT_DCLICK(func)}
+ Process a wxEVT_RIGHT_DCLICK event.
+ @event{EVT_MOUSE_AUX1_DOWN(func)}
+ Process a wxEVT_MOUSE_AUX1_DOWN event.
+ @event{EVT_MOUSE_AUX1_UP(func)}
+ Process a wxEVT_MOUSE_AUX1_UP event.
+ @event{EVT_MOUSE_AUX1_DCLICK(func)}
+ Process a wxEVT_MOUSE_AUX1_DCLICK event.
+ @event{EVT_MOUSE_AUX2_DOWN(func)}
+ Process a wxEVT_MOUSE_AUX2_DOWN event.
+ @event{EVT_MOUSE_AUX2_UP(func)}
+ Process a wxEVT_MOUSE_AUX2_UP event.
+ @event{EVT_MOUSE_AUX2_DCLICK(func)}
+ Process a wxEVT_MOUSE_AUX2_DCLICK event.
+ @event{EVT_MOTION(func)}
+ Process a wxEVT_MOTION event.
+ @event{EVT_ENTER_WINDOW(func)}
+ Process a wxEVT_ENTER_WINDOW event.
+ @event{EVT_LEAVE_WINDOW(func)}
+ Process a wxEVT_LEAVE_WINDOW event.
+ @event{EVT_MOUSEWHEEL(func)}
+ Process a wxEVT_MOUSEWHEEL event.
+ @event{EVT_MOUSE_EVENTS(func)}
+ Process all mouse events.
+ @endEventTable
+
+ @library{wxcore}
+ @category{events}
+
+ @see wxKeyEvent::CmdDown
+*/
+class wxMouseEvent : public wxEvent
+{
+public:
+ /**
+ Constructor. Valid event types are:
+
+ @li wxEVT_ENTER_WINDOW
+ @li wxEVT_LEAVE_WINDOW
+ @li wxEVT_LEFT_DOWN
+ @li wxEVT_LEFT_UP
+ @li wxEVT_LEFT_DCLICK
+ @li wxEVT_MIDDLE_DOWN
+ @li wxEVT_MIDDLE_UP
+ @li wxEVT_MIDDLE_DCLICK
+ @li wxEVT_RIGHT_DOWN
+ @li wxEVT_RIGHT_UP
+ @li wxEVT_RIGHT_DCLICK
+ @li wxEVT_MOUSE_AUX1_DOWN
+ @li wxEVT_MOUSE_AUX1_UP
+ @li wxEVT_MOUSE_AUX1_DCLICK
+ @li wxEVT_MOUSE_AUX2_DOWN
+ @li wxEVT_MOUSE_AUX2_UP
+ @li wxEVT_MOUSE_AUX2_DCLICK
+ @li wxEVT_MOTION
+ @li wxEVT_MOUSEWHEEL
+ */
+ wxMouseEvent(wxEventType mouseEventType = wxEVT_NULL);
+
+ /**
+ Returns @true if the Alt key was down at the time of the event.
+ */
+ bool AltDown() const;
+
+ /**
+ Returns @true if the event was a first extra button double click.
+ */
+ bool Aux1DClick() const;
+
+ /**
+ Returns @true if the first extra button mouse button changed to down.
+ */
+ bool Aux1Down() const;
+
+ /**
+ Returns @true if the first extra button mouse button is currently down,
+ independent of the current event type.
+ */
+ bool Aux1IsDown() const;
+
+ /**
+ Returns @true if the first extra button mouse button changed to up.
+ */
+ bool Aux1Up() const;
+
+ /**
+ Returns @true if the event was a second extra button double click.
+ */
+ bool Aux2DClick() const;
+
+ /**
+ Returns @true if the second extra button mouse button changed to down.
+ */
+ bool Aux2Down() const;
+
+ /**
+ Returns @true if the second extra button mouse button is currently down,
+ independent of the current event type.
+ */
+ bool Aux2IsDown() const;
+
+ /**
+ Returns @true if the second extra button mouse button changed to up.
+ */
+ bool Aux2Up() const;
+
+ /**
+ Returns @true if the identified mouse button is changing state.
+ Valid values of @a button are:
+
+ @li @c wxMOUSE_BTN_LEFT: check if left button was pressed
+ @li @c wxMOUSE_BTN_MIDDLE: check if middle button was pressed
+ @li @c wxMOUSE_BTN_RIGHT: check if right button was pressed
+ @li @c wxMOUSE_BTN_AUX1: check if the first extra button was pressed
+ @li @c wxMOUSE_BTN_AUX2: check if the second extra button was pressed
+ @li @c wxMOUSE_BTN_ANY: check if any button was pressed
+
+ @todo introduce wxMouseButton enum
+ */
+ bool Button(int button) const;
+
+ /**
+ If the argument is omitted, this returns @true if the event was a mouse
+ double click event. Otherwise the argument specifies which double click event
+ was generated (see Button() for the possible values).
+ */
+ bool ButtonDClick(int but = wxMOUSE_BTN_ANY) const;
+
+ /**
+ If the argument is omitted, this returns @true if the event was a mouse
+ button down event. Otherwise the argument specifies which button-down event
+ was generated (see Button() for the possible values).
+ */
+ bool ButtonDown(int = wxMOUSE_BTN_ANY) const;
+
+ /**
+ If the argument is omitted, this returns @true if the event was a mouse
+ button up event. Otherwise the argument specifies which button-up event
+ was generated (see Button() for the possible values).
+ */
+ bool ButtonUp(int = wxMOUSE_BTN_ANY) const;
+
+ /**
+ Same as MetaDown() under Mac, same as ControlDown() elsewhere.
+
+ @see wxKeyEvent::CmdDown
+ */
+ bool CmdDown() const;
+
+ /**
+ Returns @true if the control key was down at the time of the event.
+ */
+ bool ControlDown() const;
+
+ /**
+ Returns @true if this was a dragging event (motion while a button is depressed).
+
+ @see Moving()
+ */
+ bool Dragging() const;
+
+ /**
+ Returns @true if the mouse was entering the window.
+
+ @see Leaving()
+ */
+ bool Entering() const;
+
+ /**
+ Returns the mouse button which generated this event or @c wxMOUSE_BTN_NONE
+ if no button is involved (for mouse move, enter or leave event, for example).
+ Otherwise @c wxMOUSE_BTN_LEFT is returned for the left button down, up and
+ double click events, @c wxMOUSE_BTN_MIDDLE and @c wxMOUSE_BTN_RIGHT
+ for the same events for the middle and the right buttons respectively.
+ */
+ int GetButton() const;
+
+ /**
+ Returns the number of mouse clicks for this event: 1 for a simple click, 2
+ for a double-click, 3 for a triple-click and so on.
+
+ Currently this function is implemented only in wxMac and returns -1 for the
+ other platforms (you can still distinguish simple clicks from double-clicks as
+ they generate different kinds of events however).
+
+ @since 2.9.0
+ */
+ int GetClickCount() const;
+
+ /**
+ Returns the configured number of lines (or whatever) to be scrolled per
+ wheel action. Defaults to three.
+ */
+ int GetLinesPerAction() const;
+
+ /**
+ Returns the logical mouse position in pixels (i.e. translated according to the
+ translation set for the DC, which usually indicates that the window has been
+ scrolled).
+ */
+ wxPoint GetLogicalPosition(const wxDC& dc) const;
+
+ //@{
+ /**
+ Sets *x and *y to the position at which the event occurred.
+ Returns the physical mouse position in pixels.
+
+ Note that if the mouse event has been artificially generated from a special
+ keyboard combination (e.g. under Windows when the "menu" key is pressed), the
+ returned position is ::wxDefaultPosition.
+ */
+ wxPoint GetPosition() const;
+ void GetPosition(wxCoord* x, wxCoord* y) const;
+ void GetPosition(long* x, long* y) const;
+ //@}
+
+ /**
+ Get wheel delta, normally 120.
+
+ This is the threshold for action to be taken, and one such action
+ (for example, scrolling one increment) should occur for each delta.
+ */
+ int GetWheelDelta() const;
+
+ /**
+ Get wheel rotation, positive or negative indicates direction of rotation.
+
+ Current devices all send an event when rotation is at least +/-WheelDelta, but
+ finer resolution devices can be created in the future.
+
+ Because of this you shouldn't assume that one event is equal to 1 line, but you
+ should be able to either do partial line scrolling or wait until several
+ events accumulate before scrolling.
+ */
+ int GetWheelRotation() const;
+
+ /**
+ Returns X coordinate of the physical mouse event position.
+ */
+ wxCoord GetX() const;
+
+ /**
+ Returns Y coordinate of the physical mouse event position.
+ */
+ wxCoord GetY() const;
+
+ /**
+ Returns @true if the event was a mouse button event (not necessarily a button
+ down event - that may be tested using ButtonDown()).
+ */
+ bool IsButton() const;
+
+ /**
+ Returns @true if the system has been setup to do page scrolling with
+ the mouse wheel instead of line scrolling.
+ */
+ bool IsPageScroll() const;
+
+ /**
+ Returns @true if the mouse was leaving the window.
+
+ @see Entering().
+ */
+ bool Leaving() const;
+
+ /**
+ Returns @true if the event was a left double click.
+ */
+ bool LeftDClick() const;
+
+ /**
+ Returns @true if the left mouse button changed to down.
+ */
+ bool LeftDown() const;
+
+ /**
+ Returns @true if the left mouse button is currently down, independent
+ of the current event type.
+
+ Please notice that it is not the same as LeftDown() which returns @true if the
+ event was generated by the left mouse button being pressed. Rather, it simply
+ describes the state of the left mouse button at the time when the event was
+ generated (so while it will be @true for a left click event, it can also be @true
+ for a right click if it happened while the left mouse button was pressed).
+
+ This event is usually used in the mouse event handlers which process "move
+ mouse" messages to determine whether the user is (still) dragging the mouse.
+ */
+ bool LeftIsDown() const;
+
+ /**
+ Returns @true if the left mouse button changed to up.
+ */
+ bool LeftUp() const;
+
+ /**
+ Returns @true if the Meta key was down at the time of the event.
+ */
+ bool MetaDown() const;
+
+ /**
+ Returns @true if the event was a middle double click.
+ */
+ bool MiddleDClick() const;
+
+ /**
+ Returns @true if the middle mouse button changed to down.
+ */
+ bool MiddleDown() const;
+
+ /**
+ Returns @true if the middle mouse button is currently down, independent
+ of the current event type.
+ */
+ bool MiddleIsDown() const;
+
+ /**
+ Returns @true if the middle mouse button changed to up.
+ */
+ bool MiddleUp() const;
+
+ /**
+ Returns @true if this was a motion event and no mouse buttons were pressed.
+ If any mouse button is held pressed, then this method returns @false and
+ Dragging() returns @true.
+ */
+ bool Moving() const;
+
+ /**
+ Returns @true if the event was a right double click.
+ */
+ bool RightDClick() const;
+
+ /**
+ Returns @true if the right mouse button changed to down.
+ */
+ bool RightDown() const;
+
+ /**
+ Returns @true if the right mouse button is currently down, independent
+ of the current event type.
+ */
+ bool RightIsDown() const;
+
+ /**
+ Returns @true if the right mouse button changed to up.
+ */
+ bool RightUp() const;
+
+ /**
+ Returns @true if the shift key was down at the time of the event.
+ */
+ bool ShiftDown() const;
+};
+
+
+
+/**
+ @class wxDropFilesEvent
+ @wxheader{event.h}
+
+ This class is used for drop files events, that is, when files have been dropped
+ onto the window. This functionality is currently only available under Windows.
+
+ The window must have previously been enabled for dropping by calling
+ wxWindow::DragAcceptFiles().
+
+ Important note: this is a separate implementation to the more general drag and drop
+ implementation documented in the @ref overview_dnd. It uses the older, Windows
+ message-based approach of dropping files.
+
+ @beginEventTable{wxDropFilesEvent}
+ @event{EVT_DROP_FILES(func)}
+ Process a wxEVT_DROP_FILES event.
+ @endEventTable
+
+ @onlyfor{wxmsw}
+
+ @library{wxcore}
+ @category{events}
+
+ @see @ref overview_eventhandling
+*/
+class wxDropFilesEvent : public wxEvent
+{
+public:
+ /**
+ Constructor.
+ */
+ wxDropFilesEvent(wxEventType id = 0, int noFiles = 0,
+ wxString* files = NULL);
+
+ /**
+ Returns an array of filenames.
+ */
+ wxString* GetFiles() const;
+
+ /**
+ Returns the number of files dropped.
+ */
+ int GetNumberOfFiles() const;
+
+ /**
+ Returns the position at which the files were dropped.
+ Returns an array of filenames.
+ */
+ wxPoint GetPosition() const;
+};
+
+
+
+/**
+ @class wxCommandEvent
+ @wxheader{event.h}
+
+ This event class contains information about command events, which originate
+ from a variety of simple controls.
+
+ More complex controls, such as wxTreeCtrl, have separate command event classes.
+
+ @beginEventTable{wxCommandEvent}
+ @event{EVT_COMMAND(id, event, func)}
+ Process a command, supplying the window identifier, command event identifier,
+ and member function.
+ @event{EVT_COMMAND_RANGE(id1, id2, event, func)}
+ Process a command for a range of window identifiers, supplying the minimum and
+ maximum window identifiers, command event identifier, and member function.
+ @event{EVT_BUTTON(id, func)}
+ Process a wxEVT_COMMAND_BUTTON_CLICKED command, which is generated by a wxButton control.
+ @event{EVT_CHECKBOX(id, func)}
+ Process a wxEVT_COMMAND_CHECKBOX_CLICKED command, which is generated by a wxCheckBox control.
+ @event{EVT_CHOICE(id, func)}
+ Process a wxEVT_COMMAND_CHOICE_SELECTED command, which is generated by a wxChoice control.
+ @event{EVT_COMBOBOX(id, func)}
+ Process a wxEVT_COMMAND_COMBOBOX_SELECTED command, which is generated by a wxComboBox control.
+ @event{EVT_LISTBOX(id, func)}
+ Process a wxEVT_COMMAND_LISTBOX_SELECTED command, which is generated by a wxListBox control.
+ @event{EVT_LISTBOX_DCLICK(id, func)}
+ Process a wxEVT_COMMAND_LISTBOX_DOUBLECLICKED command, which is generated by a wxListBox control.
+ @event{EVT_MENU(id, func)}
+ Process a wxEVT_COMMAND_MENU_SELECTED command, which is generated by a menu item.
+ @event{EVT_MENU_RANGE(id1, id2, func)}
+ Process a wxEVT_COMMAND_MENU_RANGE command, which is generated by a range of menu items.
+ @event{EVT_CONTEXT_MENU(func)}
+ Process the event generated when the user has requested a popup menu to appear by
+ pressing a special keyboard key (under Windows) or by right clicking the mouse.
+ @event{EVT_RADIOBOX(id, func)}
+ Process a wxEVT_COMMAND_RADIOBOX_SELECTED command, which is generated by a wxRadioBox control.
+ @event{EVT_RADIOBUTTON(id, func)}
+ Process a wxEVT_COMMAND_RADIOBUTTON_SELECTED command, which is generated by a wxRadioButton control.
+ @event{EVT_SCROLLBAR(id, func)}
+ Process a wxEVT_COMMAND_SCROLLBAR_UPDATED command, which is generated by a wxScrollBar
+ control. This is provided for compatibility only; more specific scrollbar event macros
+ should be used instead (see wxScrollEvent).
+ @event{EVT_SLIDER(id, func)}
+ Process a wxEVT_COMMAND_SLIDER_UPDATED command, which is generated by a wxSlider control.
+ @event{EVT_TEXT(id, func)}
+ Process a wxEVT_COMMAND_TEXT_UPDATED command, which is generated by a wxTextCtrl control.
+ @event{EVT_TEXT_ENTER(id, func)}
+ Process a wxEVT_COMMAND_TEXT_ENTER command, which is generated by a wxTextCtrl control.
+ Note that you must use wxTE_PROCESS_ENTER flag when creating the control if you want it
+ to generate such events.
+ @event{EVT_TEXT_MAXLEN(id, func)}
+ Process a wxEVT_COMMAND_TEXT_MAXLEN command, which is generated by a wxTextCtrl control
+ when the user tries to enter more characters into it than the limit previously set
+ with SetMaxLength().
+ @event{EVT_TOGGLEBUTTON(id, func)}
+ Process a wxEVT_COMMAND_TOGGLEBUTTON_CLICKED event.
+ @event{EVT_TOOL(id, func)}
+ Process a wxEVT_COMMAND_TOOL_CLICKED event (a synonym for wxEVT_COMMAND_MENU_SELECTED).
+ Pass the id of the tool.
+ @event{EVT_TOOL_RANGE(id1, id2, func)}
+ Process a wxEVT_COMMAND_TOOL_CLICKED event for a range of identifiers. Pass the ids of the tools.
+ @event{EVT_TOOL_RCLICKED(id, func)}
+ Process a wxEVT_COMMAND_TOOL_RCLICKED event. Pass the id of the tool.
+ @event{EVT_TOOL_RCLICKED_RANGE(id1, id2, func)}
+ Process a wxEVT_COMMAND_TOOL_RCLICKED event for a range of ids. Pass the ids of the tools.
+ @event{EVT_TOOL_ENTER(id, func)}
+ Process a wxEVT_COMMAND_TOOL_ENTER event. Pass the id of the toolbar itself.
+ The value of wxCommandEvent::GetSelection() is the tool id, or -1 if the mouse cursor
+ has moved off a tool.
+ @event{EVT_COMMAND_LEFT_CLICK(id, func)}
+ Process a wxEVT_COMMAND_LEFT_CLICK command, which is generated by a control (Windows 95 and NT only).
+ @event{EVT_COMMAND_LEFT_DCLICK(id, func)}
+ Process a wxEVT_COMMAND_LEFT_DCLICK command, which is generated by a control (Windows 95 and NT only).
+ @event{EVT_COMMAND_RIGHT_CLICK(id, func)}
+ Process a wxEVT_COMMAND_RIGHT_CLICK command, which is generated by a control (Windows 95 and NT only).
+ @event{EVT_COMMAND_SET_FOCUS(id, func)}
+ Process a wxEVT_COMMAND_SET_FOCUS command, which is generated by a control (Windows 95 and NT only).
+ @event{EVT_COMMAND_KILL_FOCUS(id, func)}
+ Process a wxEVT_COMMAND_KILL_FOCUS command, which is generated by a control (Windows 95 and NT only).
+ @event{EVT_COMMAND_ENTER(id, func)}
+ Process a wxEVT_COMMAND_ENTER command, which is generated by a control.
+ @endEventTable
+
+ @library{wxcore}
+ @category{events}
+*/
+class wxCommandEvent : public wxEvent
+{
+public:
+ /**
+ Constructor.
+ */
+ wxCommandEvent(wxEventType commandEventType = 0, int id = 0);
+
+ /**
+ Returns client data pointer for a listbox or choice selection event
+ (not valid for a deselection).
+ */
+ void* GetClientData() const;
+
+ /**
+ Returns client object pointer for a listbox or choice selection event
+ (not valid for a deselection).
+ */
+ wxClientData* GetClientObject() const;
+
+ /**
+ Returns extra information dependant on the event objects type.
+
If the event comes from a listbox selection, it is a boolean
determining whether the event was a selection (@true) or a
deselection (@false). A listbox deselection only occurs for
multiple-selection boxes, and in this case the index and string values
are indeterminate and the listbox must be examined by the application.
*/
- long GetExtraLong();
+ long GetExtraLong() const;
/**
Returns the integer identifier corresponding to a listbox, choice or
- radiobox selection (only if the event was a selection, not a
- deselection), or a boolean value representing the value of a checkbox.
+ radiobox selection (only if the event was a selection, not a deselection),
+ or a boolean value representing the value of a checkbox.
*/
- int GetInt();
+ int GetInt() const;
/**
Returns item index for a listbox or choice selection event (not valid for
a deselection).
*/
- int GetSelection();
+ int GetSelection() const;
/**
Returns item string for a listbox or choice selection event (not valid for
a deselection).
*/
- wxString GetString();
+ wxString GetString() const;
/**
This method can be used with checkbox and menu events: for the checkboxes, the
- method returns @true for a selection event and @false for a
- deselection one. For the menu events, this method indicates if the menu item
- just has become checked or unchecked (and thus only makes sense for checkable
- menu items).
-
- Notice that this method can not be used with
- wxCheckListBox currently.
+ method returns @true for a selection event and @false for a deselection one.
+ For the menu events, this method indicates if the menu item just has become
+ checked or unchecked (and thus only makes sense for checkable menu items).
+
+ Notice that this method can not be used with wxCheckListBox currently.
*/
- bool IsChecked();
+ bool IsChecked() const;
/**
For a listbox or similar event, returns @true if it is a selection, @false if it
is a deselection.
*/
- bool IsSelection();
+ bool IsSelection() const;
/**
Sets the client data for this event.
/**
Sets the client object for this event. The client object is not owned by the
- event
- object and the event object will not delete the client object in its destructor.
+ event object and the event object will not delete the client object in its destructor.
+
The client object must be owned and deleted by another object (e.g. a control)
that has longer life time than the event object.
*/
};
+
/**
@class wxActivateEvent
@wxheader{event.h}
-
+
An activate event is sent when a window or application is being activated
or deactivated.
-
+
+ @beginEventTable{wxActivateEvent}
+ @event{EVT_ACTIVATE(func)}
+ Process a wxEVT_ACTIVATE event.
+ @event{EVT_ACTIVATE_APP(func)}
+ Process a wxEVT_ACTIVATE_APP event.
+ @event{EVT_HIBERNATE(func)}
+ Process a hibernate event, supplying the member function. This event applies
+ to wxApp only, and only on Windows SmartPhone and PocketPC.
+ It is generated when the system is low on memory; the application should free
+ up as much memory as possible, and restore full working state when it receives
+ a wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP event.
+ @endEventTable
+
+
@library{wxcore}
@category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview", wxApp::IsActive
+
+ @see @ref overview_eventhandling, wxApp::IsActive
*/
class wxActivateEvent : public wxEvent
{
/**
Constructor.
*/
- wxActivateEvent(WXTYPE eventType = 0, bool active = @true,
+ wxActivateEvent(wxEventType eventType = wxEVT_NULL, bool active = true,
int id = 0);
/**
Returns @true if the application or window is being activated, @false otherwise.
*/
- bool GetActive();
+ bool GetActive() const;
};
+
/**
@class wxContextMenuEvent
@wxheader{event.h}
-
+
This class is used for context menu events, sent to give
the application a chance to show a context (popup) menu.
-
+
Note that if wxContextMenuEvent::GetPosition returns wxDefaultPosition, this
- means that the event originated
- from a keyboard context button event, and you should compute a suitable
- position yourself,
- for example by calling wxGetMousePosition.
-
+ means that the event originated from a keyboard context button event, and you
+ should compute a suitable position yourself, for example by calling wxGetMousePosition().
+
When a keyboard context menu button is pressed on Windows, a right-click event
- with default position is sent first,
- and if this event is not processed, the context menu event is sent. So if you
- process mouse events and you find your context menu event handler
- is not being called, you could call wxEvent::Skip for mouse right-down events.
-
+ with default position is sent first, and if this event is not processed, the
+ context menu event is sent. So if you process mouse events and you find your
+ context menu event handler is not being called, you could call wxEvent::Skip()
+ for mouse right-down events.
+
+ @beginEventTable{wxContextMenuEvent}
+ @event{EVT_CONTEXT_MENU(func)}
+ A right click (or other context menu command depending on platform) has been detected.
+ @endEventTable
+
+
@library{wxcore}
@category{events}
-
- @seealso
- @ref overview_wxcommandevent "Command events", @ref
- overview_eventhandlingoverview "Event handling overview"
+
+ @see wxCommandEvent, @ref overview_eventhandling
*/
class wxContextMenuEvent : public wxCommandEvent
{
/**
Constructor.
*/
- wxContextMenuEvent(WXTYPE id = 0, int id = 0,
- const wxPoint& pos=wxDefaultPosition);
+ wxContextMenuEvent(wxEventType id = wxEVT_NULL, int id = 0,
+ const wxPoint& pos = wxDefaultPosition);
/**
Returns the position in screen coordinates at which the menu should be shown.
- Use wxWindow::ScreenToClient to
- convert to client coordinates. You can also omit a position from
- wxWindow::PopupMenu in order to use
+ Use wxWindow::ScreenToClient to convert to client coordinates.
+
+ You can also omit a position from wxWindow::PopupMenu in order to use
the current mouse pointer position.
-
+
If the event originated from a keyboard event, the value returned from this
function will be wxDefaultPosition.
*/
- wxPoint GetPosition();
+ const wxPoint& GetPosition() const;
/**
Sets the position at which the menu should be shown.
};
+
/**
@class wxEraseEvent
@wxheader{event.h}
-
+
An erase event is sent when a window's background needs to be repainted.
-
+
On some platforms, such as GTK+, this event is simulated (simply generated just
- before the
- paint event) and may cause flicker. It is therefore recommended that
+ before the paint event) and may cause flicker. It is therefore recommended that
you set the text background colour explicitly in order to prevent flicker.
The default background colour under GTK+ is grey.
-
+
To intercept this event, use the EVT_ERASE_BACKGROUND macro in an event table
definition.
-
+
You must call wxEraseEvent::GetDC and use the returned device context if it is
- non-@NULL.
- If it is @NULL, create your own temporary wxClientDC object.
-
+ non-@NULL. If it is @NULL, create your own temporary wxClientDC object.
+
+ @remarks
+ Use the device context returned by GetDC to draw on, don't create
+ a wxPaintDC in the event handler.
+
+ @beginEventTable{wxEraseEvent}
+ @event{EVT_ERASE_BACKGROUND(func)}
+ Process a wxEVT_ERASE_BACKGROUND event.
+ @endEventTable
+
@library{wxcore}
@category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+
+ @see @ref overview_eventhandling
*/
class wxEraseEvent : public wxEvent
{
/**
Constructor.
*/
- wxEraseEvent(int id = 0, wxDC* dc = @NULL);
+ wxEraseEvent(int id = 0, wxDC* dc = NULL);
/**
Returns the device context associated with the erase event to draw on.
*/
-#define wxDC* GetDC() /* implementation is private */
+ wxDC* GetDC() const;
};
+
/**
@class wxFocusEvent
@wxheader{event.h}
-
+
A focus event is sent when a window's focus changes. The window losing focus
- receives a "kill focus'' event while the window gaining it gets a "set
- focus'' one.
-
+ receives a "kill focus" event while the window gaining it gets a "set focus" one.
+
Notice that the set focus event happens both when the user gives focus to the
window (whether using the mouse or keyboard) and when it is done from the
program itself using wxWindow::SetFocus.
-
+
+ @beginEventTable{wxFocusEvent}
+ @event{EVT_SET_FOCUS(func)}
+ Process a wxEVT_SET_FOCUS event.
+ @event{EVT_KILL_FOCUS(func)}
+ Process a wxEVT_KILL_FOCUS event.
+ @endEventTable
+
@library{wxcore}
@category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+
+ @see @ref overview_eventhandling
*/
class wxFocusEvent : public wxEvent
{
/**
Constructor.
*/
- wxFocusEvent(WXTYPE eventType = 0, int id = 0);
+ wxFocusEvent(wxEventType eventType = wxEVT_NULL, int id = 0);
/**
Returns the window associated with this event, that is the window which had the
focus before for the @c wxEVT_SET_FOCUS event and the window which is
going to receive focus for the @c wxEVT_KILL_FOCUS one.
-
+
Warning: the window pointer may be @NULL!
*/
+ wxWindow *GetWindow() const;
};
+
/**
@class wxChildFocusEvent
@wxheader{event.h}
-
+
A child focus event is sent to a (parent-)window when one of its child windows
- gains focus,
- so that the window could restore the focus back to its corresponding child
- if it loses it now and regains later.
-
+ gains focus, so that the window could restore the focus back to its corresponding
+ child if it loses it now and regains later.
+
Notice that child window is the direct child of the window receiving event.
- Use wxWindow::FindFocus to retreive the window which is actually getting focus.
-
+ Use wxWindow::FindFocus() to retreive the window which is actually getting focus.
+
+ @beginEventTable{wxChildFocusEvent}
+ @event{EVT_CHILD_FOCUS(func)}
+ Process a wxEVT_CHILD_FOCUS event.
+ @endEventTable
+
@library{wxcore}
@category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+
+ @see @ref overview_eventhandling
*/
class wxChildFocusEvent : public wxCommandEvent
{
public:
/**
Constructor.
-
- @param win
- The direct child which is (or which contains the window which is) receiving the
- focus.
+
+ @param win
+ The direct child which is (or which contains the window which is) receiving
+ the focus.
*/
- wxChildFocusEvent(wxWindow * win = @NULL);
+ wxChildFocusEvent(wxWindow* win = NULL);
/**
Returns the direct child which receives the focus, or a (grand-)parent of the
control receiving the focus.
-
+
To get the actually focused control use wxWindow::FindFocus.
*/
+ wxWindow *GetWindow() const;
};
+
/**
@class wxMouseCaptureLostEvent
@wxheader{event.h}
-
+
An mouse capture lost event is sent to a window that obtained mouse capture,
which was subsequently loss due to "external" event, for example when a dialog
box is shown or if another application captures the mouse.
-
+
If this happens, this event is sent to all windows that are on capture stack
(i.e. called CaptureMouse, but didn't call ReleaseMouse yet). The event is
not sent if the capture changes because of a call to CaptureMouse or
ReleaseMouse.
-
+
This event is currently emitted under Windows only.
-
+
+ @beginEventTable{wxMouseCaptureLostEvent}
+ @event{EVT_MOUSE_CAPTURE_LOST(func)}
+ Process a wxEVT_MOUSE_CAPTURE_LOST event.
+ @endEventTable
+
+ @onlyfor{wxmsw}
+
@library{wxcore}
@category{events}
-
- @seealso
- wxMouseCaptureChangedEvent, @ref overview_eventhandlingoverview "Event handling
- overview", wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
+
+ @see wxMouseCaptureChangedEvent, @ref overview_eventhandling,
+ wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
*/
class wxMouseCaptureLostEvent : public wxEvent
{
};
+
/**
@class wxNotifyEvent
@wxheader{event.h}
-
+
This class is not used by the event handlers by itself, but is a base class
for other event classes (such as wxNotebookEvent).
-
+
It (or an object of a derived class) is sent when the controls state is being
- changed and allows the program to wxNotifyEvent::Veto this
- change if it wants to prevent it from happening.
-
+ changed and allows the program to wxNotifyEvent::Veto() this change if it wants
+ to prevent it from happening.
+
@library{wxcore}
@category{events}
-
- @seealso
- wxNotebookEvent
+
+ @see wxNotebookEvent
*/
class wxNotifyEvent : public wxCommandEvent
{
/**
Constructor (used internally by wxWidgets only).
*/
- wxNotifyEvent(wxEventType eventType = wxEVT_@NULL, int id = 0);
+ wxNotifyEvent(wxEventType eventType = wxEVT_NULL, int id = 0);
/**
- This is the opposite of Veto(): it explicitly
- allows the event to be processed. For most events it is not necessary to call
- this method as the events are allowed anyhow but some are forbidden by default
- (this will be mentioned in the corresponding event description).
+ This is the opposite of Veto(): it explicitly allows the event to be processed.
+ For most events it is not necessary to call this method as the events are allowed
+ anyhow but some are forbidden by default (this will be mentioned in the corresponding
+ event description).
*/
void Allow();
/**
- Returns @true if the change is allowed (Veto()
- hasn't been called) or @false otherwise (if it was).
- */
- bool IsAllowed();
-
- /**
- Prevents the change announced by this event from happening.
-
- It is in general a good idea to notify the user about the reasons for vetoing
- the change because otherwise the applications behaviour (which just refuses to
- do what the user wants) might be quite surprising.
- */
- void Veto();
-};
-
-
-/**
- @class wxHelpEvent
- @wxheader{event.h}
-
- A help event is sent when the user has requested context-sensitive help.
- This can either be caused by the application requesting
- context-sensitive help mode via wxContextHelp, or
- (on MS Windows) by the system generating a WM_HELP message when the user
- pressed F1 or clicked
- on the query button in a dialog caption.
-
- A help event is sent to the window that the user clicked on, and is propagated
- up the
- window hierarchy until the event is processed or there are no more event
- handlers.
- The application should call wxEvent::GetId to check the identity of the
- clicked-on window,
- and then either show some suitable help or call wxEvent::Skip if the identifier
- is unrecognised.
- Calling Skip is important because it allows wxWidgets to generate further
- events for ancestors
- of the clicked-on window. Otherwise it would be impossible to show help for
- container windows,
- since processing would stop after the first window found.
-
- @library{wxcore}
- @category{FIXME}
-
- @seealso
- wxContextHelp, wxDialog, @ref overview_eventhandlingoverview "Event handling
- overview"
-*/
-class wxHelpEvent : public wxCommandEvent
-{
-public:
- /**
- Constructor.
- */
- wxHelpEvent(WXTYPE eventType = 0, wxWindowID id = 0,
- const wxPoint& point);
-
- /**
- Returns the origin of the help event which is one of the following values:
-
-
- @b Origin_Unknown
-
-
- Unrecognized event source.
-
- @b Origin_Keyboard
-
-
- Event generated by @c F1 key press.
-
- @b Origin_HelpButton
-
-
- Event generated by
- wxContextHelp or using the "?" title bur button under
- MS Windows.
-
- The application may handle events generated using the keyboard or mouse
- differently, e.g. by using wxGetMousePosition
- for the mouse events.
-
- @sa SetOrigin()
- */
- wxHelpEvent::Origin GetOrigin();
-
- /**
- Returns the left-click position of the mouse, in screen coordinates. This allows
- the application to position the help appropriately.
- */
- const wxPoint GetPosition();
-
- /**
- Set the help event origin, only used internally by wxWidgets normally.
-
- @sa GetOrigin()
- */
- void SetOrigin(wxHelpEvent::Origin origin);
-
- /**
- Sets the left-click position of the mouse, in screen coordinates.
- */
- void SetPosition(const wxPoint& pt);
-};
-
-
-/**
- @class wxScrollEvent
- @wxheader{event.h}
-
- A scroll event holds information about events sent from stand-alone
- scrollbars and sliders. Note that
- starting from wxWidgets 2.1, scrolled windows send the
- wxScrollWinEvent which does not derive from
- wxCommandEvent, but from wxEvent directly - don't confuse these two kinds of
- events and use the event table macros mentioned below only for the
- scrollbar-like controls.
-
- @library{wxcore}
- @category{events}
-
- @seealso
- wxScrollBar, wxSlider, wxSpinButton, , wxScrollWinEvent, @ref
- overview_eventhandlingoverview "Event handling overview"
-*/
-class wxScrollEvent : public wxCommandEvent
-{
-public:
- /**
- Constructor.
- */
- wxScrollEvent(WXTYPE commandType = 0, int id = 0, int pos = 0,
- int orientation = 0);
-
- /**
- Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
- scrollbar.
- */
- int GetOrientation();
-
- /**
- Returns the position of the scrollbar.
- */
- int GetPosition();
-};
-
-
-/**
- @class wxIdleEvent
- @wxheader{event.h}
-
- This class is used for idle events, which are generated when the system becomes
- idle. Note that, unless you do something specifically, the idle events are not
- sent if the system remains idle once it has become it, e.g. only a single idle
- event will be generated until something else resulting in more normal events
- happens and only then is the next idle event sent again. If you need to ensure
- a continuous stream of idle events, you can either use
- wxIdleEvent::RequestMore method in your handler or call
- wxWakeUpIdle periodically (for example from timer
- event), but note that both of these approaches (and especially the first one)
- increase the system load and so should be avoided if possible.
-
- By default, idle events are sent to all windows (and also
- wxApp, as usual). If this is causing a significant
- overhead in your application, you can call wxIdleEvent::SetMode with
- the value wxIDLE_PROCESS_SPECIFIED, and set the wxWS_EX_PROCESS_IDLE extra
- window style for every window which should receive idle events.
-
- @library{wxbase}
- @category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview", wxUpdateUIEvent,
- wxWindow::OnInternalIdle
-*/
-class wxIdleEvent : public wxEvent
-{
-public:
- /**
- Constructor.
- */
- wxIdleEvent();
-
- /**
- Returns @true if it is appropriate to send idle events to
- this window.
-
- This function looks at the mode used (see wxIdleEvent::SetMode),
- and the wxWS_EX_PROCESS_IDLE style in @e window to determine whether idle
- events should be sent to
- this window now. By default this will always return @true because
- the update mode is initially wxIDLE_PROCESS_ALL. You can change the mode
- to only send idle events to windows with the wxWS_EX_PROCESS_IDLE extra window
- style set.
-
- @sa SetMode()
- */
- static bool CanSend(wxWindow* window);
-
- /**
- Static function returning a value specifying how wxWidgets
- will send idle events: to all windows, or only to those which specify that they
- will process the events.
-
- See SetMode().
- */
- static wxIdleMode GetMode();
-
- /**
- Returns @true if the OnIdle function processing this event requested more
- processing time.
-
- @sa RequestMore()
- */
- bool MoreRequested();
-
- /**
- Tells wxWidgets that more processing is required. This function can be called
- by an OnIdle
- handler for a window or window event handler to indicate that wxApp::OnIdle
- should
- forward the OnIdle event once more to the application windows. If no window
- calls this function
- during OnIdle, then the application will remain in a passive event loop (not
- calling OnIdle) until a
- new event is posted to the application by the windowing system.
-
- @sa MoreRequested()
- */
- void RequestMore(bool needMore = @true);
-
- /**
- Static function for specifying how wxWidgets will send idle events: to
- all windows, or only to those which specify that they
- will process the events.
-
- @e mode can be one of the following values.
- The default is wxIDLE_PROCESS_ALL.
+ Returns @true if the change is allowed (Veto() hasn't been called) or @false
+ otherwise (if it was).
*/
- static void SetMode(wxIdleMode mode);
-};
-
+ bool IsAllowed() const;
-/**
- @class wxInitDialogEvent
- @wxheader{event.h}
-
- A wxInitDialogEvent is sent as a dialog or panel is being initialised.
- Handlers for this event can transfer data to the window.
- The default handler calls wxWindow::TransferDataToWindow.
-
- @library{wxcore}
- @category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview"
-*/
-class wxInitDialogEvent : public wxEvent
-{
-public:
/**
- Constructor.
+ Prevents the change announced by this event from happening.
+
+ It is in general a good idea to notify the user about the reasons for vetoing
+ the change because otherwise the applications behaviour (which just refuses to
+ do what the user wants) might be quite surprising.
*/
- wxInitDialogEvent(int id = 0);
+ void Veto();
};
+
+
/**
- @class wxWindowDestroyEvent
- @wxheader{event.h}
-
- This event is sent from the wxWindow destructor wxWindow::~wxWindow() when a
- window is destroyed.
-
- When a class derived from wxWindow is destroyed its destructor will have
- already run by the time this event is sent. Therefore this event will not
- usually be received at all.
-
- To receive this event wxEvtHandler::Connect
- must be used (using an event table macro will not work). Since it is
- received after the destructor has run, an object should not handle its
- own wxWindowDestroyEvent, but it can be used to get notification of the
- destruction of another window.
-
- @library{wxcore}
- @category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview",
- wxWindowCreateEvent
+ Indicates how a wxHelpEvent was generated.
*/
-class wxWindowDestroyEvent : public wxCommandEvent
+enum wxHelpEventOrigin
{
-public:
- /**
- Constructor.
- */
- wxWindowDestroyEvent(wxWindow* win = @NULL);
-};
+ wxHE_ORIGIN_UNKNOWN = -1, /**< unrecognized event source. */
+ wxHE_ORIGIN_KEYBOARD, /**< event generated from F1 key press. */
+ /** event generated by wxContextHelp or from the [?] button on
+ the title bar (Windows). */
+ wxHE_ORIGIN_HELPBUTTON
+};
/**
- @class wxNavigationKeyEvent
+ @class wxHelpEvent
@wxheader{event.h}
-
- This event class contains information about navigation events,\r
- generated by navigation keys such as tab and page down.\r
-
- This event is mainly used by wxWidgets implementations. A\r
- wxNavigationKeyEvent handler is automatically provided by wxWidgets\r
- when you make a class into a control container with the macro
- WX_DECLARE_CONTROL_CONTAINER.\r
-
+
+ A help event is sent when the user has requested context-sensitive help.
+ This can either be caused by the application requesting context-sensitive help mode
+ via wxContextHelp, or (on MS Windows) by the system generating a WM_HELP message when
+ the user pressed F1 or clicked on the query button in a dialog caption.
+
+ A help event is sent to the window that the user clicked on, and is propagated
+ up the window hierarchy until the event is processed or there are no more event
+ handlers.
+
+ The application should call wxEvent::GetId to check the identity of the
+ clicked-on window, and then either show some suitable help or call wxEvent::Skip()
+ if the identifier is unrecognised.
+
+ Calling Skip is important because it allows wxWidgets to generate further
+ events for ancestors of the clicked-on window. Otherwise it would be impossible to
+ show help for container windows, since processing would stop after the first window
+ found.
+
+ @beginEventTable{wxHelpEvent}
+ @event{EVT_HELP(id, func)}
+ Process a wxEVT_HELP event.
+ @event{EVT_HELP_RANGE(id1, id2, func)}
+ Process a wxEVT_HELP event for a range of ids.
+ @endEventTable
+
@library{wxcore}
@category{events}
-
- @seealso
- wxWindow::Navigate, wxWindow::NavigateIn
+
+ @see wxContextHelp, wxDialog, @ref overview_eventhandling
*/
-class wxNavigationKeyEvent
+class wxHelpEvent : public wxCommandEvent
{
public:
- //@{
/**
Constructor.
*/
- wxNavigationKeyEvent();
- wxNavigationKeyEvent(const wxNavigationKeyEvent& event);
- //@}
-
- /**
- Returns the child that has the focus, or @NULL.
- */
- wxWindow* GetCurrentFocus();
-
- /**
- Returns @true if the navigation was in the forward direction.
- */
- bool GetDirection();
+ wxHelpEvent(wxEventType type = wxEVT_NULL,
+ wxWindowID winid = 0,
+ const wxPoint& pt = wxDefaultPosition,
+ wxHelpEventOrigin origin = wxHE_ORIGIN_UNKNOWN);
/**
- Returns @true if the navigation event was from a tab key. This is required
- for proper navigation over radio buttons.
- */
- bool IsFromTab();
+ Returns the origin of the help event which is one of the ::wxHelpEventOrigin
+ values.
- /**
- Returns @true if the navigation event represents a window change (for
- example, from Ctrl-Page Down\r
- in a notebook).
- */
- bool IsWindowChange();
+ The application may handle events generated using the keyboard or mouse
+ differently, e.g. by using wxGetMousePosition() for the mouse events.
- /**
- Sets the current focus window member.
+ @see SetOrigin()
*/
- void SetCurrentFocus(wxWindow* currentFocus);
+ wxHelpEventOrigin GetOrigin() const;
/**
- Sets the direction to forward if @e direction is @true, or backward if @c
- @false.
+ Returns the left-click position of the mouse, in screen coordinates.
+ This allows the application to position the help appropriately.
*/
- void SetDirection(bool direction);
+ const wxPoint& GetPosition() const;
/**
- Sets the flags.
- */
- void SetFlags(long flags);
+ Set the help event origin, only used internally by wxWidgets normally.
- /**
- Marks the navigation event as from a tab key.
+ @see GetOrigin()
*/
- void SetFromTab(bool fromTab);
+ void SetOrigin(wxHelpEventOrigin);
/**
- Marks the event as a window change event.
+ Sets the left-click position of the mouse, in screen coordinates.
*/
- void SetWindowChange(bool windowChange);
+ void SetPosition(const wxPoint& pt);
};
+
/**
- @class wxMouseCaptureChangedEvent
+ @class wxScrollEvent
@wxheader{event.h}
-
- An mouse capture changed event is sent to a window that loses its
- mouse capture. This is called even if wxWindow::ReleaseCapture
- was called by the application code. Handling this event allows
- an application to cater for unexpected capture releases which
- might otherwise confuse mouse handling code.
-
- This event is implemented under Windows only.
-
+
+ A scroll event holds information about events sent from stand-alone
+ scrollbars (see wxScrollBar) and sliders (see wxSlider).
+
+ Note that scrolled windows send the wxScrollWinEvent which does not derive from
+ wxCommandEvent, but from wxEvent directly - don't confuse these two kinds of
+ events and use the event table macros mentioned below only for the scrollbar-like
+ controls.
+
+ @section wxscrollevent_diff The difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED
+
+ The EVT_SCROLL_THUMBRELEASE event is only emitted when actually dragging the thumb
+ using the mouse and releasing it (This EVT_SCROLL_THUMBRELEASE event is also followed
+ by an EVT_SCROLL_CHANGED event).
+
+ The EVT_SCROLL_CHANGED event also occurs when using the keyboard to change the thumb
+ position, and when clicking next to the thumb (In all these cases the EVT_SCROLL_THUMBRELEASE
+ event does not happen).
+
+ In short, the EVT_SCROLL_CHANGED event is triggered when scrolling/ moving has finished
+ independently of the way it had started. Please see the widgets sample ("Slider" page)
+ to see the difference between EVT_SCROLL_THUMBRELEASE and EVT_SCROLL_CHANGED in action.
+
+ @remarks
+ Note that unless specifying a scroll control identifier, you will need to test for scrollbar
+ orientation with wxScrollEvent::GetOrientation, since horizontal and vertical scroll events
+ are processed using the same event handler.
+
+ @beginEventTable{wxScrollEvent}
+ You can use EVT_COMMAND_SCROLL... macros with window IDs for when intercepting
+ scroll events from controls, or EVT_SCROLL... macros without window IDs for
+ intercepting scroll events from the receiving window -- except for this, the
+ macros behave exactly the same.
+ @event{EVT_SCROLL(func)}
+ Process all scroll events.
+ @event{EVT_SCROLL_TOP(func)}
+ Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
+ @event{EVT_SCROLL_BOTTOM(func)}
+ Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
+ @event{EVT_SCROLL_LINEUP(func)}
+ Process wxEVT_SCROLL_LINEUP line up events.
+ @event{EVT_SCROLL_LINEDOWN(func)}
+ Process wxEVT_SCROLL_LINEDOWN line down events.
+ @event{EVT_SCROLL_PAGEUP(func)}
+ Process wxEVT_SCROLL_PAGEUP page up events.
+ @event{EVT_SCROLL_PAGEDOWN(func)}
+ Process wxEVT_SCROLL_PAGEDOWN page down events.
+ @event{EVT_SCROLL_THUMBTRACK(func)}
+ Process wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent as the
+ user drags the thumbtrack).
+ @event{EVT_SCROLL_THUMBRELEASE(func)}
+ Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
+ @event{EVT_SCROLL_CHANGED(func)}
+ Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
+ @event{EVT_COMMAND_SCROLL(id, func)}
+ Process all scroll events.
+ @event{EVT_COMMAND_SCROLL_TOP(id, func)}
+ Process wxEVT_SCROLL_TOP scroll-to-top events (minimum position).
+ @event{EVT_COMMAND_SCROLL_BOTTOM(id, func)}
+ Process wxEVT_SCROLL_BOTTOM scroll-to-bottom events (maximum position).
+ @event{EVT_COMMAND_SCROLL_LINEUP(id, func)}
+ Process wxEVT_SCROLL_LINEUP line up events.
+ @event{EVT_COMMAND_SCROLL_LINEDOWN(id, func)}
+ Process wxEVT_SCROLL_LINEDOWN line down events.
+ @event{EVT_COMMAND_SCROLL_PAGEUP(id, func)}
+ Process wxEVT_SCROLL_PAGEUP page up events.
+ @event{EVT_COMMAND_SCROLL_PAGEDOWN(id, func)}
+ Process wxEVT_SCROLL_PAGEDOWN page down events.
+ @event{EVT_COMMAND_SCROLL_THUMBTRACK(id, func)}
+ Process wxEVT_SCROLL_THUMBTRACK thumbtrack events (frequent events sent
+ as the user drags the thumbtrack).
+ @event{EVT_COMMAND_SCROLL_THUMBRELEASE(func)}
+ Process wxEVT_SCROLL_THUMBRELEASE thumb release events.
+ @event{EVT_COMMAND_SCROLL_CHANGED(func)}
+ Process wxEVT_SCROLL_CHANGED end of scrolling events (MSW only).
+ @endEventTable
+
@library{wxcore}
@category{events}
-
- @seealso
- wxMouseCaptureLostEvent, @ref overview_eventhandlingoverview "Event handling
- overview", wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
+
+ @see wxScrollBar, wxSlider, wxSpinButton, wxScrollWinEvent, @ref overview_eventhandling
*/
-class wxMouseCaptureChangedEvent : public wxEvent
+class wxScrollEvent : public wxCommandEvent
{
public:
/**
Constructor.
*/
- wxMouseCaptureChangedEvent(wxWindowID windowId = 0,
- wxWindow* gainedCapture = @NULL);
+ wxScrollEvent(wxEventType commandType = wxEVT_NULL, int id = 0, int pos = 0,
+ int orientation = 0);
+
+ /**
+ Returns wxHORIZONTAL or wxVERTICAL, depending on the orientation of the
+ scrollbar.
+ */
+ int GetOrientation() const;
/**
- Returns the window that gained the capture, or @NULL if it was a non-wxWidgets
- window.
+ Returns the position of the scrollbar.
*/
- wxWindow* GetCapturedWindow();
+ int GetPosition() const;
+};
+
+/**
+ See wxIdleEvent::SetMode() for more info.
+*/
+enum wxIdleMode
+{
+ /** Send idle events to all windows */
+ wxIDLE_PROCESS_ALL,
+
+ /** Send idle events to windows that have the wxWS_EX_PROCESS_IDLE flag specified */
+ wxIDLE_PROCESS_SPECIFIED
};
/**
- @class wxCloseEvent
+ @class wxIdleEvent
@wxheader{event.h}
-
- This event class contains information about window and session close events.
-
- The handler function for EVT_CLOSE is called when the user has tried to close a
- a frame
- or dialog box using the window manager (X) or system menu (Windows). It can
- also be invoked by the application itself programmatically, for example by
- calling the wxWindow::Close function.
-
- You should check whether the application is forcing the deletion of the window
- using wxCloseEvent::CanVeto. If this is @false,
- you @e must destroy the window using wxWindow::Destroy.
- If the return value is @true, it is up to you whether you respond by destroying
- the window.
-
- If you don't destroy the window, you should call wxCloseEvent::Veto to
- let the calling code know that you did not destroy the window. This allows the
- wxWindow::Close function
- to return @true or @false depending on whether the close instruction was
- honoured or not.
-
- @library{wxcore}
+
+ This class is used for idle events, which are generated when the system becomes
+ idle. Note that, unless you do something specifically, the idle events are not
+ sent if the system remains idle once it has become it, e.g. only a single idle
+ event will be generated until something else resulting in more normal events
+ happens and only then is the next idle event sent again.
+
+ If you need to ensure a continuous stream of idle events, you can either use
+ wxIdleEvent::RequestMore method in your handler or call wxWakeUpIdle() periodically
+ (for example from a timer event handler), but note that both of these approaches
+ (and especially the first one) increase the system load and so should be avoided
+ if possible.
+
+ By default, idle events are sent to all windows (and also wxApp, as usual).
+ If this is causing a significant overhead in your application, you can call
+ wxIdleEvent::SetMode with the value wxIDLE_PROCESS_SPECIFIED, and set the
+ wxWS_EX_PROCESS_IDLE extra window style for every window which should receive
+ idle events.
+
+ @beginEventTable{wxIdleEvent}
+ @event{EVT_IDLE(func)}
+ Process a wxEVT_IDLE event.
+ @endEventTable
+
+ @library{wxbase}
@category{events}
-
- @seealso
- wxWindow::Close, @ref overview_windowdeletionoverview "Window deletion overview"
+
+ @see @ref overview_eventhandling, wxUpdateUIEvent, wxWindow::OnInternalIdle
*/
-class wxCloseEvent : public wxEvent
+class wxIdleEvent : public wxEvent
{
public:
/**
Constructor.
*/
- wxCloseEvent(WXTYPE commandEventType = 0, int id = 0);
+ wxIdleEvent();
/**
- Returns @true if you can veto a system shutdown or a window close event.
- Vetoing a window close event is not possible if the calling code wishes to
- force the application to exit, and so this function must be called to check
- this.
- */
- bool CanVeto();
+ Returns @true if it is appropriate to send idle events to this window.
- /**
- Returns @true if the user is just logging off or @false if the system is
- shutting down. This method can only be called for end session and query end
- session events, it doesn't make sense for close window event.
+ This function looks at the mode used (see wxIdleEvent::SetMode),
+ and the wxWS_EX_PROCESS_IDLE style in @a window to determine whether idle
+ events should be sent to this window now.
+
+ By default this will always return @true because the update mode is initially
+ wxIDLE_PROCESS_ALL. You can change the mode to only send idle events to
+ windows with the wxWS_EX_PROCESS_IDLE extra window style set.
+
+ @see SetMode()
*/
- bool GetLoggingOff();
+ static bool CanSend(wxWindow* window);
/**
- Sets the 'can veto' flag.
+ Static function returning a value specifying how wxWidgets will send idle
+ events: to all windows, or only to those which specify that they
+ will process the events.
+
+ @see SetMode().
*/
- void SetCanVeto(bool canVeto);
+ static wxIdleMode GetMode();
/**
- Sets the 'force' flag.
+ Returns @true if the OnIdle function processing this event requested more
+ processing time.
+
+ @see RequestMore()
*/
- void SetForce(bool force);
+ bool MoreRequested() const;
/**
- Sets the 'logging off' flag.
+ Tells wxWidgets that more processing is required.
+
+ This function can be called by an OnIdle handler for a window or window event
+ handler to indicate that wxApp::OnIdle should forward the OnIdle event once
+ more to the application windows.
+
+ If no window calls this function during OnIdle, then the application will
+ remain in a passive event loop (not calling OnIdle) until a new event is
+ posted to the application by the windowing system.
+
+ @see MoreRequested()
*/
- void SetLoggingOff(bool loggingOff);
+ void RequestMore(bool needMore = true);
/**
- Call this from your event handler to veto a system shutdown or to signal
- to the calling application that a window close did not happen.
-
- You can only veto a shutdown if CanVeto() returns
- @true.
+ Static function for specifying how wxWidgets will send idle events: to
+ all windows, or only to those which specify that they will process the events.
+
+ @param mode
+ Can be one of the ::wxIdleMode values.
+ The default is wxIDLE_PROCESS_ALL.
*/
- void Veto(bool veto = @true);
+ static void SetMode(wxIdleMode mode);
};
+
/**
- @class wxMenuEvent
+ @class wxInitDialogEvent
@wxheader{event.h}
-
- This class is used for a variety of menu-related events. Note that
- these do not include menu command events, which are
- handled using wxCommandEvent objects.
-
- The default handler for wxEVT_MENU_HIGHLIGHT displays help
- text in the first field of the status bar.
-
+
+ A wxInitDialogEvent is sent as a dialog or panel is being initialised.
+ Handlers for this event can transfer data to the window.
+
+ The default handler calls wxWindow::TransferDataToWindow.
+
+ @beginEventTable{wxInitDialogEvent}
+ @event{EVT_INIT_DIALOG(func)}
+ Process a wxEVT_INIT_DIALOG event.
+ @endEventTable
+
@library{wxcore}
@category{events}
-
- @seealso
- @ref overview_wxcommandevent "Command events", @ref
- overview_eventhandlingoverview "Event handling overview"
+
+ @see @ref overview_eventhandling
*/
-class wxMenuEvent : public wxEvent
+class wxInitDialogEvent : public wxEvent
{
public:
/**
Constructor.
*/
- wxMenuEvent(WXTYPE id = 0, int id = 0, wxMenu* menu = @NULL);
-
- /**
- Returns the menu which is being opened or closed. This method should only be
- used with the @c OPEN and @c CLOSE events and even for them the
- returned pointer may be @NULL in some ports.
- */
- wxMenu * GetMenu();
-
- /**
- Returns the menu identifier associated with the event. This method should be
- only used with the @c HIGHLIGHT events.
- */
- int GetMenuId();
-
- /**
- Returns @true if the menu which is being opened or closed is a popup menu,
- @false if it is a normal one.
-
- This method should only be used with the @c OPEN and @c CLOSE events.
- */
- bool IsPopup();
+ wxInitDialogEvent(int id = 0);
};
+
/**
- @class wxEventBlocker
+ @class wxWindowDestroyEvent
@wxheader{event.h}
-
- This class is a special event handler which allows to discard
- any event (or a set of event types) directed to a specific window.
-
- Example:
-
- @code
- {
- // block all events directed to this window while
- // we do the 1000 FuncWhichSendsEvents() calls
- wxEventBlocker blocker(this);
-
- for ( int i = 0; i 1000; i++ )
- FuncWhichSendsEvents(i);
-
- } // ~wxEventBlocker called, old event handler is restored
-
- // the event generated by this call will be processed
- FuncWhichSendsEvents(0)
- @endcode
-
- @library{wxcore}
- @category{FIXME}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview", wxEvtHandler
-*/
-class wxEventBlocker : public wxEvtHandler
-{
-public:
- /**
- Constructs the blocker for the given window and for the given event type.
- If @e type is @c wxEVT_ANY, then all events for that window are
- blocked. You can call Block() after creation to
- add other event types to the list of events to block.
-
- Note that the @e win window @b must remain alive until the
- wxEventBlocker object destruction.
- */
- wxEventBlocker(wxWindow* win, wxEventType type = wxEVT_ANY);
- /**
- Destructor. The blocker will remove itself from the chain of event handlers for
- the window provided in the constructor, thus restoring normal processing of
- events.
- */
- ~wxEventBlocker();
+ This event is sent from the wxWindow destructor wxWindow::~wxWindow() when a
+ window is destroyed.
- /**
- Adds to the list of event types which should be blocked the given @e eventType.
- */
- void Block(wxEventType eventType);
-};
+ When a class derived from wxWindow is destroyed its destructor will have
+ already run by the time this event is sent. Therefore this event will not
+ usually be received at all.
+ To receive this event wxEvtHandler::Connect() must be used (using an event
+ table macro will not work). Since it is received after the destructor has run,
+ an object should not handle its own wxWindowDestroyEvent, but it can be used
+ to get notification of the destruction of another window.
-/**
- @class wxEvtHandler
- @wxheader{event.h}
-
- A class that can handle events from the windowing system.
- wxWindow (and therefore all window classes) are derived from
- this class.
-
- When events are received, wxEvtHandler invokes the method listed in the
- event table using itself as the object. When using multiple inheritance
- it is imperative that the wxEvtHandler(-derived) class be the first
- class inherited such that the "this" pointer for the overall object
- will be identical to the "this" pointer for the wxEvtHandler portion.
-
- @library{wxbase}
- @category{FIXME}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview"
+ @library{wxcore}
+ @category{events}
+
+ @see @ref overview_eventhandling, wxWindowCreateEvent
*/
-class wxEvtHandler : public wxObject
+class wxWindowDestroyEvent : public wxCommandEvent
{
public:
/**
Constructor.
*/
- wxEvtHandler();
+ wxWindowDestroyEvent(wxWindow* win = NULL);
+};
- /**
- Destructor. If the handler is part of a chain, the destructor will
- unlink itself and restore the previous and next handlers so that they point to
- each other.
- */
- ~wxEvtHandler();
- /**
- This function posts an event to be processed later.
-
- @param event
- Event to add to process queue.
-
- @remarks The difference between sending an event (using the ProcessEvent
- method) and posting it is that in the first case the
- event is processed before the function returns, while
- in the second case, the function returns immediately
- and the event will be processed sometime later
- (usually during the next event loop iteration).
- */
- virtual void AddPendingEvent(const wxEvent& event);
+/**
+ The possible flag values for a wxNavigationKeyEvent.
+*/
+enum wxNavigationKeyEventFlags
+{
+ wxNKEF_IS_BACKWARD = 0x0000,
+ wxNKEF_IS_FORWARD = 0x0001,
+ wxNKEF_WINCHANGE = 0x0002,
+ wxNKEF_FROMTAB = 0x0004
+};
- //@{
- /**
- Connects the given function dynamically with the event handler, id and event
- type. This
- is an alternative to the use of static event tables. See the 'event' or the old
- 'dynamic' sample for usage.
-
- @param id
- The identifier (or first of the identifier range) to be
- associated with the event handler function. For the version not taking this
- argument, it defaults to wxID_ANY.
-
- @param lastId
- The second part of the identifier range to be associated with the event handler
- function.
-
- @param eventType
- The event type to be associated with this event handler.
-
- @param function
- The event handler function. Note that this function should
- be explicitly converted to the correct type which can be done using a macro
- called wxFooEventHandler for the handler for any wxFooEvent.
-
- @param userData
- Data to be associated with the event table entry.
-
- @param eventSink
- Object whose member function should be called. If this is @NULL,
- this will be used.
- */
- void Connect(int id, int lastId, wxEventType eventType,
- wxObjectEventFunction function,
- wxObject* userData = @NULL,
- wxEvtHandler* eventSink = @NULL);
- void Connect(int id, wxEventType eventType,
- wxObjectEventFunction function,
- wxObject* userData = @NULL,
- wxEvtHandler* eventSink = @NULL);
- void Connect(wxEventType eventType,
- wxObjectEventFunction function,
- wxObject* userData = @NULL,
- wxEvtHandler* eventSink = @NULL);
- //@}
- //@{
- /**
- Disconnects the given function dynamically from the event handler, using the
- specified
- parameters as search criteria and returning @true if a matching function has been
- found and removed. This method can only disconnect functions which have been
- added
- using the Connect() method. There is no way
- to disconnect functions connected using the (static) event tables.
-
- @param id
- The identifier (or first of the identifier range) associated with the event
- handler function.
-
- @param lastId
- The second part of the identifier range associated with the event handler
- function.
-
- @param eventType
- The event type associated with this event handler.
-
- @param function
- The event handler function.
-
- @param userData
- Data associated with the event table entry.
-
- @param eventSink
- Object whose member function should be called.
- */
- bool Disconnect(wxEventType eventType = wxEVT_@NULL,
- wxObjectEventFunction function = @NULL,
- wxObject* userData = @NULL,
- wxEvtHandler* eventSink = @NULL);
- bool Disconnect(int id = wxID_ANY,
- wxEventType eventType = wxEVT_@NULL,
- wxObjectEventFunction function = @NULL,
- wxObject* userData = @NULL,
- wxEvtHandler* eventSink = @NULL);
- bool Disconnect(int id, int lastId = wxID_ANY,
- wxEventType eventType = wxEVT_@NULL,
- wxObjectEventFunction function = @NULL,
- wxObject* userData = @NULL,
- wxEvtHandler* eventSink = @NULL);
- //@}
+/**
+ @class wxNavigationKeyEvent
+ @wxheader{event.h}
- /**
- Gets user-supplied client data.
-
- @remarks Normally, any extra data the programmer wishes to associate with
- the object should be made available by deriving a new
- class with new data members.
-
- @sa SetClientData()
- */
- void* GetClientData();
+ This event class contains information about navigation events,
+ generated by navigation keys such as tab and page down.
- /**
- Get a pointer to the user-supplied client data object.
-
- @sa SetClientObject(), wxClientData
- */
- wxClientData* GetClientObject();
+ This event is mainly used by wxWidgets implementations.
+ A wxNavigationKeyEvent handler is automatically provided by wxWidgets
+ when you make a class into a control container with the macro
+ WX_DECLARE_CONTROL_CONTAINER.
- /**
- Returns @true if the event handler is enabled, @false otherwise.
-
- @sa SetEvtHandlerEnabled()
- */
- bool GetEvtHandlerEnabled();
+ @beginEventTable{wxNavigationKeyEvent}
+ @event{EVT_NAVIGATION_KEY(func)}
+ Process a navigation key event.
+ @endEventTable
- /**
- Gets the pointer to the next handler in the chain.
-
- @sa SetNextHandler(), GetPreviousHandler(),
- SetPreviousHandler(), wxWindow::PushEventHandler,
- wxWindow::PopEventHandler
- */
- wxEvtHandler* GetNextHandler();
+ @library{wxcore}
+ @category{events}
+
+ @see wxWindow::Navigate, wxWindow::NavigateIn
+*/
+class wxNavigationKeyEvent : public wxEvent
+{
+public:
+ wxNavigationKeyEvent();
+ wxNavigationKeyEvent(const wxNavigationKeyEvent& event);
/**
- Gets the pointer to the previous handler in the chain.
-
- @sa SetPreviousHandler(), GetNextHandler(),
- SetNextHandler(), wxWindow::PushEventHandler,
- wxWindow::PopEventHandler
+ Returns the child that has the focus, or @NULL.
*/
- wxEvtHandler* GetPreviousHandler();
+ wxWindow* GetCurrentFocus() const;
/**
- Processes an event, searching event tables and calling zero or more suitable
- event handler function(s).
-
- @param event
- Event to process.
-
- @returns @true if a suitable event handler function was found and
- executed, and the function did not call wxEvent::Skip.
-
- @remarks Normally, your application would not call this function: it is
- called in the wxWidgets implementation to dispatch
- incoming user interface events to the framework (and
- application).
-
- @sa SearchEventTable()
+ Returns @true if the navigation was in the forward direction.
*/
- virtual bool ProcessEvent(wxEvent& event);
+ bool GetDirection() const;
/**
- Processes an event by calling ProcessEvent()
- and handles any exceptions that occur in the process. If an exception is
- thrown in event handler, wxApp::OnExceptionInMainLoop
- is called.
-
- @param event
- Event to process.
-
- @returns @true if the event was processed, @false if no handler was found
- or an exception was thrown.
-
- @sa wxWindow::HandleWindowEvent
+ Returns @true if the navigation event was from a tab key.
+ This is required for proper navigation over radio buttons.
*/
- bool SafelyProcessEvent(wxEvent& event);
+ bool IsFromTab() const;
/**
- Searches the event table, executing an event handler function if an appropriate
- one
- is found.
-
- @param table
- Event table to be searched.
-
- @param event
- Event to be matched against an event table entry.
-
- @returns @true if a suitable event handler function was found and
- executed, and the function did not call wxEvent::Skip.
-
- @remarks This function looks through the object's event table and tries
- to find an entry that will match the event.
-
- @sa ProcessEvent()
+ Returns @true if the navigation event represents a window change
+ (for example, from Ctrl-Page Down in a notebook).
*/
- virtual bool SearchEventTable(wxEventTable& table,
- wxEvent& event);
+ bool IsWindowChange() const;
/**
- Sets user-supplied client data.
-
- @param data
- Data to be associated with the event handler.
-
- @remarks Normally, any extra data the programmer wishes to associate with
- the object should be made available by deriving a
- new class with new data members. You must not call
- this method and SetClientObject on the same class -
- only one of them.
-
- @sa GetClientData()
+ Sets the current focus window member.
*/
- void SetClientData(void* data);
+ void SetCurrentFocus(wxWindow* currentFocus);
/**
- Set the client data object. Any previous object will be deleted.
-
- @sa GetClientObject(), wxClientData
+ Sets the direction to forward if @a direction is @true, or backward
+ if @false.
*/
- void SetClientObject(wxClientData* data);
+ void SetDirection(bool direction);
/**
- Enables or disables the event handler.
-
- @param enabled
- @true if the event handler is to be enabled, @false if it is to be disabled.
-
- @remarks You can use this function to avoid having to remove the event
- handler from the chain, for example when implementing
- a dialog editor and changing from edit to test mode.
-
- @sa GetEvtHandlerEnabled()
+ Sets the flags for this event.
+ The @a flags can be a combination of the ::wxNavigationKeyEventFlags values.
*/
- void SetEvtHandlerEnabled(bool enabled);
+ void SetFlags(long flags);
/**
- Sets the pointer to the next handler.
-
- @param handler
- Event handler to be set as the next handler.
-
- @sa GetNextHandler(), SetPreviousHandler(),
- GetPreviousHandler(), wxWindow::PushEventHandler,
- wxWindow::PopEventHandler
+ Marks the navigation event as from a tab key.
*/
- void SetNextHandler(wxEvtHandler* handler);
+ void SetFromTab(bool fromTab);
/**
- Sets the pointer to the previous handler.
-
- @param handler
- Event handler to be set as the previous handler.
+ Marks the event as a window change event.
*/
- void SetPreviousHandler(wxEvtHandler* handler);
+ void SetWindowChange(bool windowChange);
};
+
/**
- @class wxIconizeEvent
+ @class wxMouseCaptureChangedEvent
@wxheader{event.h}
-
- An event being sent when the frame is iconized (minimized) or restored.
-
- Currently only wxMSW and wxGTK generate such events.
-
+
+ An mouse capture changed event is sent to a window that loses its
+ mouse capture. This is called even if wxWindow::ReleaseCapture
+ was called by the application code. Handling this event allows
+ an application to cater for unexpected capture releases which
+ might otherwise confuse mouse handling code.
+
+ @onlyfor{wxmsw}
+
+ @beginEventTable{wxMouseCaptureChangedEvent}
+ @event{EVT_MOUSE_CAPTURE_CHANGED(func)}
+ Process a wxEVT_MOUSE_CAPTURE_CHANGED event.
+ @endEventTable
+
@library{wxcore}
@category{events}
-
- @seealso
- @ref overview_eventhandlingoverview "Event handling overview",
- wxTopLevelWindow::Iconize, wxTopLevelWindow::IsIconized
+
+ @see wxMouseCaptureLostEvent, @ref overview_eventhandling,
+ wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture
*/
-class wxIconizeEvent : public wxEvent
+class wxMouseCaptureChangedEvent : public wxEvent
{
public:
/**
Constructor.
*/
- wxIconizeEvent(int id = 0, bool iconized = @true);
+ wxMouseCaptureChangedEvent(wxWindowID windowId = 0,
+ wxWindow* gainedCapture = NULL);
/**
- Returns @true if the frame has been iconized, @false if it has been
- restored.
+ Returns the window that gained the capture, or @NULL if it was a
+ non-wxWidgets window.
*/
- bool Iconized();
+ wxWindow* GetCapturedWindow() const;
};
+
/**
- @class wxMoveEvent
+ @class wxCloseEvent
@wxheader{event.h}
-
- A move event holds information about move change events.
-
+
+ This event class contains information about window and session close events.
+
+ The handler function for EVT_CLOSE is called when the user has tried to close a
+ a frame or dialog box using the window manager (X) or system menu (Windows).
+ It can also be invoked by the application itself programmatically, for example by
+ calling the wxWindow::Close function.
+
+ You should check whether the application is forcing the deletion of the window
+ using wxCloseEvent::CanVeto. If this is @false, you @e must destroy the window
+ using wxWindow::Destroy.
+
+ If the return value is @true, it is up to you whether you respond by destroying
+ the window.
+
+ If you don't destroy the window, you should call wxCloseEvent::Veto to
+ let the calling code know that you did not destroy the window.
+ This allows the wxWindow::Close function to return @true or @false depending
+ on whether the close instruction was honoured or not.
+
+ The EVT_END_SESSION event is slightly different as it is sent by the system
+ when the user session is ending (e.g. because of log out or shutdown) and
+ so all windows are being forcefully closed. At least under MSW, after the
+ handler for this event is executed the program is simply killed by the
+ system. Because of this, the default handler for this event provided by
+ wxWidgets calls all the usual cleanup code (including wxApp::OnExit()) so
+ that it could still be executed and exit()s the process itself, without
+ waiting for being killed. If this behaviour is for some reason undesirable,
+ make sure that you define a handler for this event in your wxApp-derived
+ class and do not call @c event.Skip() in it (but be aware that the system
+ will still kill your application).
+
+ @beginEventTable{wxCloseEvent}
+ @event{EVT_CLOSE(func)}
+ Process a close event, supplying the member function.
+ This event applies to wxFrame and wxDialog classes.
+ @event{EVT_QUERY_END_SESSION(func)}
+ Process a query end session event, supplying the member function.
+ This event can be handled in wxApp-derived class only.
+ @event{EVT_END_SESSION(func)}
+ Process an end session event, supplying the member function.
+ This event can be handled in wxApp-derived class only.
+ @endEventTable
+
@library{wxcore}
@category{events}
-
- @seealso
- wxPoint, @ref overview_eventhandlingoverview "Event handling overview"
+
+ @see wxWindow::Close, @ref overview_windowdeletion
*/
-class wxMoveEvent : public wxEvent
+class wxCloseEvent : public wxEvent
{
public:
/**
Constructor.
*/
- wxMoveEvent(const wxPoint& pt, int id = 0);
+ wxCloseEvent(wxEventType commandEventType = wxEVT_NULL, int id = 0);
/**
- Returns the position of the window generating the move change event.
+ Returns @true if you can veto a system shutdown or a window close event.
+ Vetoing a window close event is not possible if the calling code wishes to
+ force the application to exit, and so this function must be called to check this.
*/
- wxPoint GetPosition();
-};
+ bool CanVeto() const;
-
-/**
- @class wxEvent
- @wxheader{event.h}
-
- An event is a structure holding information about an event passed to a
- callback or member function. @b wxEvent used to be a multipurpose
- event object, and is an abstract base class for other event classes (see below).
-
- For more information about events, see the @ref overview_eventhandlingoverview
- "Event handling overview".
-
- @b wxPerl note: In wxPerl custom event classes should be derived from
- @c Wx::PlEvent and @c Wx::PlCommandEvent.
-
- @library{wxbase}
- @category{events}
-
- @seealso
- wxCommandEvent, wxMouseEvent
-*/
-class wxEvent : public wxObject
-{
-public:
/**
- Constructor. Should not need to be used directly by an application.
+ Returns @true if the user is just logging off or @false if the system is
+ shutting down. This method can only be called for end session and query end
+ session events, it doesn't make sense for close window event.
*/
- wxEvent(int id = 0, wxEventType eventType = wxEVT_@NULL);
+ bool GetLoggingOff() const;
/**
- Returns a copy of the event.
-
- Any event that is posted to the wxWidgets event system for later action (via
- wxEvtHandler::AddPendingEvent or
- wxPostEvent) must implement this method. All wxWidgets
- events fully implement this method, but any derived events implemented by the
- user should also implement this method just in case they (or some event
- derived from them) are ever posted.
-
- All wxWidgets events implement a copy constructor, so the easiest way of
- implementing the Clone function is to implement a copy constructor for
- a new event (call it MyEvent) and then define the Clone function like this:
+ Sets the 'can veto' flag.
*/
- virtual wxEvent* Clone();
+ void SetCanVeto(bool canVeto);
/**
- Returns the object (usually a window) associated with the
- event, if any.
+ Sets the 'force' flag.
*/
- wxObject* GetEventObject();
+ void SetForce(bool force) const;
/**
- Returns the identifier of the given event type,
- such as @c wxEVT_COMMAND_BUTTON_CLICKED.
+ Sets the 'logging off' flag.
*/
- wxEventType GetEventType();
+ void SetLoggingOff(bool loggingOff);
/**
- Returns the identifier associated with this event, such as a button command id.
- */
- int GetId();
+ Call this from your event handler to veto a system shutdown or to signal
+ to the calling application that a window close did not happen.
- /**
- Returns @true if the event handler should be skipped, @false otherwise.
+ You can only veto a shutdown if CanVeto() returns @true.
*/
- bool GetSkipped();
+ void Veto(bool veto = true);
+};
- /**
- Gets the timestamp for the event. The timestamp is the time in milliseconds
- since some fixed moment (not necessarily the standard Unix Epoch, so
- only differences between the timestamps and not their absolute values usually
- make sense).
- */
- long GetTimestamp();
- /**
- Returns @true if the event is or is derived from
- wxCommandEvent else it returns @false.
- Note: Exists only for optimization purposes.
- */
- bool IsCommandEvent();
- /**
- Sets the propagation level to the given value (for example returned from an
- earlier call to wxEvent::StopPropagation).
- */
- void ResumePropagation(int propagationLevel);
+/**
+ @class wxMenuEvent
+ @wxheader{event.h}
+
+ This class is used for a variety of menu-related events. Note that
+ these do not include menu command events, which are
+ handled using wxCommandEvent objects.
+
+ The default handler for wxEVT_MENU_HIGHLIGHT displays help
+ text in the first field of the status bar.
+
+ @beginEventTable{wxMenuEvent}
+ @event{EVT_MENU_OPEN(func)}
+ A menu is about to be opened. On Windows, this is only sent once for each
+ navigation of the menubar (up until all menus have closed).
+ @event{EVT_MENU_CLOSE(func)}
+ A menu has been just closed.
+ @event{EVT_MENU_HIGHLIGHT(id, func)}
+ The menu item with the specified id has been highlighted: used to show
+ help prompts in the status bar by wxFrame
+ @event{EVT_MENU_HIGHLIGHT_ALL(func)}
+ A menu item has been highlighted, i.e. the currently selected menu item has changed.
+ @endEventTable
+
+ @library{wxcore}
+ @category{events}
+ @see wxCommandEvent, @ref overview_eventhandling
+*/
+class wxMenuEvent : public wxEvent
+{
+public:
/**
- Sets the originating object.
+ Constructor.
*/
- void SetEventObject(wxObject* object);
+ wxMenuEvent(wxEventType id = wxEVT_NULL, int id = 0, wxMenu* menu = NULL);
/**
- Sets the event type.
+ Returns the menu which is being opened or closed. This method should only be
+ used with the @c OPEN and @c CLOSE events and even for them the
+ returned pointer may be @NULL in some ports.
*/
- void SetEventType(wxEventType type);
+ wxMenu* GetMenu() const;
/**
- Sets the identifier associated with this event, such as a button command id.
+ Returns the menu identifier associated with the event.
+ This method should be only used with the @c HIGHLIGHT events.
*/
- void SetId(int id);
+ int GetMenuId() const;
/**
- Sets the timestamp for the event.
+ Returns @true if the menu which is being opened or closed is a popup menu,
+ @false if it is a normal one.
+
+ This method should only be used with the @c OPEN and @c CLOSE events.
*/
- void SetTimestamp(long timeStamp);
+ bool IsPopup() const;
+};
+
+
+/**
+ @class wxIconizeEvent
+ @wxheader{event.h}
+
+ An event being sent when the frame is iconized (minimized) or restored.
+ Currently only wxMSW and wxGTK generate such events.
+
+ @onlyfor{wxmsw,wxgtk}
+
+ @beginEventTable{wxIconizeEvent}
+ @event{EVT_ICONIZE(func)}
+ Process a wxEVT_ICONIZE event.
+ @endEventTable
+
+ @library{wxcore}
+ @category{events}
+
+ @see @ref overview_eventhandling, wxTopLevelWindow::Iconize,
+ wxTopLevelWindow::IsIconized
+*/
+class wxIconizeEvent : public wxEvent
+{
+public:
/**
- Test if this event should be propagated or not, i.e. if the propagation level
- is currently greater than 0.
+ Constructor.
*/
- bool ShouldPropagate();
+ wxIconizeEvent(int id = 0, bool iconized = true);
/**
- This method can be used inside an event handler to control whether further
- event handlers bound to this event will be called after the current one
- returns. Without Skip() (or equivalently if Skip(@false) is used),
- the event will not be processed any more. If Skip(@true) is called, the event
- processing system continues searching for a further handler function for this
- event, even though it has been processed already in the current handler.
-
- In general, it is recommended to skip all non-command events to allow the
- default handling to take place. The command events are, however, normally not
- skipped as usually a single command such as a button click or menu item
- selection must only be processed by one handler.
+ Returns @true if the frame has been iconized, @false if it has been
+ restored.
*/
- void Skip(bool skip = @true);
+ bool Iconized() const;
+};
+
+
+
+/**
+ @class wxMoveEvent
+ @wxheader{event.h}
+
+ A move event holds information about move change events.
+
+ @beginEventTable{wxMoveEvent}
+ @event{EVT_MOVE(func)}
+ Process a wxEVT_MOVE event, which is generated when a window is moved.
+ @event{EVT_MOVE_START(func)}
+ Process a wxEVT_MOVE_START event, which is generated when the user starts
+ to move or size a window. wxMSW only.
+ @event{EVT_MOVE_END(func)}
+ Process a wxEVT_MOVE_END event, which is generated when the user stops
+ moving or sizing a window. wxMSW only.
+ @endEventTable
+
+ @library{wxcore}
+ @category{events}
+ @see wxPoint, @ref overview_eventhandling
+*/
+class wxMoveEvent : public wxEvent
+{
+public:
/**
- Stop the event from propagating to its parent window.
-
- Returns the old propagation level value which may be later passed to
- ResumePropagation() to allow propagating the
- event again.
+ Constructor.
*/
- int StopPropagation();
+ wxMoveEvent(const wxPoint& pt, int id = 0);
/**
- int m_propagationLevel
-
- Indicates how many levels the event can propagate. This member is protected and
- should typically only be set in the constructors of the derived classes. It
- may be temporarily changed by StopPropagation()
- and ResumePropagation() and tested with
- ShouldPropagate().
-
- The initial value is set to either @c wxEVENT_PROPAGATE_NONE (by
- default) meaning that the event shouldn't be propagated at all or to
- @c wxEVENT_PROPAGATE_MAX (for command events) meaning that it should be
- propagated as much as necessary.
-
- Any positive number means that the event should be propagated but no more than
- the given number of times. E.g. the propagation level may be set to 1 to
- propagate the event to its parent only, but not to its grandparent.
+ Returns the position of the window generating the move change event.
*/
+ wxPoint GetPosition() const;
};
/**
@class wxSizeEvent
@wxheader{event.h}
-
+
A size event holds information about size change events.
-
+
The EVT_SIZE handler function will be called when the window has been resized.
-
- You may wish to use this for frames to resize their child windows as
- appropriate.
-
- Note that the size passed is of
- the whole window: call wxWindow::GetClientSize for the area which may be
- used by the application.
-
+
+ You may wish to use this for frames to resize their child windows as appropriate.
+
+ Note that the size passed is of the whole window: call wxWindow::GetClientSize
+ for the area which may be used by the application.
+
When a window is resized, usually only a small part of the window is damaged
- and you
- may only need to repaint that area. However, if your drawing depends on the
- size of the window,
- you may need to clear the DC explicitly and repaint the whole window. In which
- case, you
- may need to call wxWindow::Refresh to invalidate the entire window.
-
+ and you may only need to repaint that area. However, if your drawing depends on the
+ size of the window, you may need to clear the DC explicitly and repaint the whole window.
+ In which case, you may need to call wxWindow::Refresh to invalidate the entire window.
+
+ @beginEventTable{wxSizeEvent}
+ @event{EVT_SIZE(func)}
+ Process a wxEVT_SIZE event.
+ @endEventTable
+
@library{wxcore}
@category{events}
-
- @seealso
- wxSize, @ref overview_eventhandlingoverview "Event handling overview"
+
+ @see wxSize, @ref overview_eventhandling
*/
class wxSizeEvent : public wxEvent
{
/**
Returns the entire size of the window generating the size change event.
*/
- wxSize GetSize();
+ wxSize GetSize() const;
};
+
/**
@class wxSetCursorEvent
@wxheader{event.h}
-
+
A SetCursorEvent is generated when the mouse cursor is about to be set as a
- result of mouse motion. This event gives the application the chance to perform
- specific mouse cursor processing based on the current position of the mouse
- within the window. Use wxSetCursorEvent::SetCursor to
- specify the cursor you want to be displayed.
-
+ result of mouse motion.
+
+ This event gives the application the chance to perform specific mouse cursor
+ processing based on the current position of the mouse within the window.
+ Use wxSetCursorEvent::SetCursor to specify the cursor you want to be displayed.
+
+ @beginEventTable{wxSetCursorEvent}
+ @event{EVT_SET_CURSOR(func)}
+ Process a wxEVT_SET_CURSOR event.
+ @endEventTable
+
@library{wxcore}
- @category{FIXME}
-
- @seealso
- ::wxSetCursor, wxWindow::wxSetCursor
+ @category{events}
+
+ @see ::wxSetCursor, wxWindow::wxSetCursor
*/
class wxSetCursorEvent : public wxEvent
{
/**
Returns a reference to the cursor specified by this event.
*/
- wxCursor GetCursor();
+ const wxCursor& GetCursor() const;
/**
Returns the X coordinate of the mouse in client coordinates.
*/
-#define wxCoord GetX() /* implementation is private */
+ wxCoord GetX() const;
/**
Returns the Y coordinate of the mouse in client coordinates.
*/
-#define wxCoord GetY() /* implementation is private */
+ wxCoord GetY() const;
/**
Returns @true if the cursor specified by this event is a valid cursor.
-
+
@remarks You cannot specify wxNullCursor with this event, as it is not
- considered a valid cursor.
+ considered a valid cursor.
*/
- bool HasCursor();
+ bool HasCursor() const;
/**
Sets the cursor associated with this event.
*/
void SetCursor(const wxCursor& cursor);
};
+
+
+
+// ============================================================================
+// Global functions/macros
+// ============================================================================
+
+/** @ingroup group_funcmacro_misc */
+//@{
+
+/**
+ In a GUI application, this function posts @a event to the specified @e dest
+ object using wxEvtHandler::AddPendingEvent().
+
+ Otherwise, it dispatches @a event immediately using
+ wxEvtHandler::ProcessEvent(). See the respective documentation for details
+ (and caveats). Because of limitation of wxEvtHandler::AddPendingEvent()
+ this function is not thread-safe for event objects having wxString fields,
+ use wxQueueEvent() instead.
+
+ @header{wx/event.h}
+*/
+void wxPostEvent(wxEvtHandler* dest, const wxEvent& event);
+
+/**
+ Queue an event for processing on the given object.
+
+ This is a wrapper around wxEvtHandler::QueueEvent(), see its documentation
+ for more details.
+
+ @header{wx/event.h}
+
+ @param dest
+ The object to queue the event on, can't be @c NULL.
+ @param event
+ The heap-allocated and non-@c NULL event to queue, the function takes
+ ownership of it.
+ */
+void wxQueueEvent(wxEvtHandler* dest, wxEvent *event);
+
+//@}
+
projects / wxWidgets.git / blobdiff