wxMouseEvent Class Reference

#include </home/zeitlin/src/wx/github/interface/wx/event.h>

Inheritance diagram for wxMouseEvent:

---

Detailed Description

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 wxMOUSE_BTN_LEFT for the left mouse button, wxMOUSE_BTN_MIDDLE for the middle one and wxMOUSE_BTN_RIGHT for the right one. And if the system supports more buttons, the wxMOUSE_BTN_AUX1 and 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 wxEVT_ENTER_WINDOW and 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 wxEVT_LEAVE_WINDOW event not only when the mouse leaves the window entirely but also when it enters one of its children.

The position associated with a mouse event is expressed in the window coordinates of the window which generated the event, you can use wxWindow::ClientToScreen() to convert it to screen coordinates and possibly call wxWindow::ScreenToClient() next to convert it to window coordinates of another window.

注:

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 the difference between methods like wxMouseEvent::LeftDown and the inherited wxMouseState::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.

Events using this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxMouseEvent& event)

Event macros:

• 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.
• EVT_LEFT_UP(func):
  Process a wxEVT_LEFT_UP event.
• EVT_LEFT_DCLICK(func):
  Process a wxEVT_LEFT_DCLICK event.
• EVT_MIDDLE_DOWN(func):
  Process a wxEVT_MIDDLE_DOWN event.
• EVT_MIDDLE_UP(func):
  Process a wxEVT_MIDDLE_UP event.
• EVT_MIDDLE_DCLICK(func):
  Process a wxEVT_MIDDLE_DCLICK event.
• EVT_RIGHT_DOWN(func):
  Process a wxEVT_RIGHT_DOWN event.
• EVT_RIGHT_UP(func):
  Process a wxEVT_RIGHT_UP event.
• EVT_RIGHT_DCLICK(func):
  Process a wxEVT_RIGHT_DCLICK event.
• EVT_MOUSE_AUX1_DOWN(func):
  Process a wxEVT_AUX1_DOWN event.
• EVT_MOUSE_AUX1_UP(func):
  Process a wxEVT_AUX1_UP event.
• EVT_MOUSE_AUX1_DCLICK(func):
  Process a wxEVT_AUX1_DCLICK event.
• EVT_MOUSE_AUX2_DOWN(func):
  Process a wxEVT_AUX2_DOWN event.
• EVT_MOUSE_AUX2_UP(func):
  Process a wxEVT_AUX2_UP event.
• EVT_MOUSE_AUX2_DCLICK(func):
  Process a wxEVT_AUX2_DCLICK event.
• EVT_MOTION(func):
  Process a wxEVT_MOTION event.
• EVT_ENTER_WINDOW(func):
  Process a wxEVT_ENTER_WINDOW event.
• EVT_LEAVE_WINDOW(func):
  Process a wxEVT_LEAVE_WINDOW event.
• EVT_MOUSEWHEEL(func):
  Process a wxEVT_MOUSEWHEEL event.
• EVT_MOUSE_EVENTS(func):
  Process all mouse events.

Library:  wxCore

Category:  Events

参照:

wxKeyEvent

Public Member Functions
	wxMouseEvent (wxEventType mouseEventType=wxEVT_NULL)
	Constructor.
bool	Aux1DClick () const
	Returns true if the event was a first extra button double click.
bool	Aux1Down () const
	Returns true if the first extra button mouse button changed to down.
bool	Aux1Up () const
	Returns true if the first extra button mouse button changed to up.
bool	Aux2DClick () const
	Returns true if the event was a second extra button double click.
bool	Aux2Down () const
	Returns true if the second extra button mouse button changed to down.
bool	Aux2Up () const
	Returns true if the second extra button mouse button changed to up.
bool	Button (wxMouseButton but) const
	Returns true if the event was generated by the specified button.
bool	ButtonDClick (wxMouseButton but=wxMOUSE_BTN_ANY) const
	If the argument is omitted, this returns true if the event was a mouse double click event.
bool	ButtonDown (wxMouseButton but=wxMOUSE_BTN_ANY) const
	If the argument is omitted, this returns true if the event was a mouse button down event.
bool	ButtonUp (wxMouseButton but=wxMOUSE_BTN_ANY) const
	If the argument is omitted, this returns true if the event was a mouse button up event.
bool	Dragging () const
	Returns true if this was a dragging event (motion while a button is depressed).
bool	Entering () const
	Returns true if the mouse was entering the window.
int	GetButton () const
	Returns the mouse button which generated this event or wxMOUSE_BTN_NONE if no button is involved (for mouse move, enter or leave event, for example).
int	GetClickCount () 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.
int	GetLinesPerAction () const
	Returns the configured number of lines (or whatever) to be scrolled per wheel action.
wxPoint	GetLogicalPosition (const wxDC &dc) const
	Returns the logical mouse position in pixels (i.e.
int	GetWheelDelta () const
	Get wheel delta, normally 120.
int	GetWheelRotation () const
	Get wheel rotation, positive or negative indicates direction of rotation.
wxMouseWheelAxis	GetWheelAxis () const
	Gets the axis the wheel operation concerns.
bool	IsButton () const
	Returns true if the event was a mouse button event (not necessarily a button down event - that may be tested using ButtonDown()).
bool	IsPageScroll () const
	Returns true if the system has been setup to do page scrolling with the mouse wheel instead of line scrolling.
bool	Leaving () const
	Returns true if the mouse was leaving the window.
bool	LeftDClick () const
	Returns true if the event was a left double click.
bool	LeftDown () const
	Returns true if the left mouse button changed to down.
bool	LeftUp () const
	Returns true if the left mouse button changed to up.
bool	MetaDown () const
	Returns true if the Meta key was down at the time of the event.
bool	MiddleDClick () const
	Returns true if the event was a middle double click.
bool	MiddleDown () const
	Returns true if the middle mouse button changed to down.
bool	MiddleUp () const
	Returns true if the middle mouse button changed to up.
bool	Moving () const
	Returns true if this was a motion event and no mouse buttons were pressed.
bool	RightDClick () const
	Returns true if the event was a right double click.
bool	RightDown () const
	Returns true if the right mouse button changed to down.
bool	RightUp () const
	Returns true if the right mouse button changed to up.

List of all members.

---

Constructor & Destructor Documentation

wxMouseEvent::wxMouseEvent

(

wxEventType

mouseEventType = wxEVT_NULL

)

Constructor.

Valid event types are:

• wxEVT_ENTER_WINDOW
• wxEVT_LEAVE_WINDOW
• wxEVT_LEFT_DOWN
• wxEVT_LEFT_UP
• wxEVT_LEFT_DCLICK
• wxEVT_MIDDLE_DOWN
• wxEVT_MIDDLE_UP
• wxEVT_MIDDLE_DCLICK
• wxEVT_RIGHT_DOWN
• wxEVT_RIGHT_UP
• wxEVT_RIGHT_DCLICK
• wxEVT_AUX1_DOWN
• wxEVT_AUX1_UP
• wxEVT_AUX1_DCLICK
• wxEVT_AUX2_DOWN
• wxEVT_AUX2_UP
• wxEVT_AUX2_DCLICK
• wxEVT_MOTION
• wxEVT_MOUSEWHEEL

---

Member Function Documentation

bool wxMouseEvent::Aux1DClick

(

)

const

Returns true if the event was a first extra button double click.

bool wxMouseEvent::Aux1Down

(

)

const

Returns true if the first extra button mouse button changed to down.

bool wxMouseEvent::Aux1Up

(

)

const

Returns true if the first extra button mouse button changed to up.

bool wxMouseEvent::Aux2DClick

(

)

const

Returns true if the event was a second extra button double click.

bool wxMouseEvent::Aux2Down

(

)

const

Returns true if the second extra button mouse button changed to down.

bool wxMouseEvent::Aux2Up

(

)

const

Returns true if the second extra button mouse button changed to up.

bool wxMouseEvent::Button

(

wxMouseButton

but

)

const

Returns true if the event was generated by the specified button.

参照:

wxMouseState::ButtoinIsDown()

bool wxMouseEvent::ButtonDClick

(

wxMouseButton

but = wxMOUSE_BTN_ANY

)

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 wxMouseEvent::ButtonDown

(

wxMouseButton

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 wxMouseEvent::ButtonUp

(

wxMouseButton

but = 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 wxMouseEvent::Dragging

(

)

const

Returns true if this was a dragging event (motion while a button is depressed).

参照:

Moving()

bool wxMouseEvent::Entering

(

)

const

Returns true if the mouse was entering the window.

参照:

Leaving()

int wxMouseEvent::GetButton

(

)

const

Returns the mouse button which generated this event or wxMOUSE_BTN_NONE if no button is involved (for mouse move, enter or leave event, for example).

Otherwise wxMOUSE_BTN_LEFT is returned for the left button down, up and double click events, wxMOUSE_BTN_MIDDLE and wxMOUSE_BTN_RIGHT for the same events for the middle and the right buttons respectively.

int wxMouseEvent::GetClickCount

(

)

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 wxMouseEvent::GetLinesPerAction

(

)

const

Returns the configured number of lines (or whatever) to be scrolled per wheel action.

Defaults to three.

wxPoint wxMouseEvent::GetLogicalPosition

(

const wxDC &

dc

)

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).

wxMouseWheelAxis wxMouseEvent::GetWheelAxis

(

)

const

Gets the axis the wheel operation concerns.

Usually the mouse wheel is used to scroll vertically so wxMOUSE_WHEEL_VERTICAL is returned but some mice (and most trackpads) also allow to use the wheel to scroll horizontally in which case wxMOUSE_WHEEL_HORIZONTAL is returned.

Notice that before wxWidgets 2.9.4 this method returned int.

int wxMouseEvent::GetWheelDelta

(

)

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 wxMouseEvent::GetWheelRotation

(

)

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.

bool wxMouseEvent::IsButton

(

)

const

Returns true if the event was a mouse button event (not necessarily a button down event - that may be tested using ButtonDown()).

bool wxMouseEvent::IsPageScroll

(

)

const

Returns true if the system has been setup to do page scrolling with the mouse wheel instead of line scrolling.

bool wxMouseEvent::Leaving

(

)

const

Returns true if the mouse was leaving the window.

参照:

Entering().

bool wxMouseEvent::LeftDClick

(

)

const

Returns true if the event was a left double click.

bool wxMouseEvent::LeftDown

(

)

const

Returns true if the left mouse button changed to down.

bool wxMouseEvent::LeftUp

(

)

const

Returns true if the left mouse button changed to up.

bool wxMouseEvent::MetaDown

(

)

const

Returns true if the Meta key was down at the time of the event.

Reimplemented from wxKeyboardState.

bool wxMouseEvent::MiddleDClick

(

)

const

Returns true if the event was a middle double click.

bool wxMouseEvent::MiddleDown

(

)

const

Returns true if the middle mouse button changed to down.

bool wxMouseEvent::MiddleUp

(

)

const

Returns true if the middle mouse button changed to up.

bool wxMouseEvent::Moving

(

)

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 wxMouseEvent::RightDClick

(

)

const

Returns true if the event was a right double click.

bool wxMouseEvent::RightDown

(

)

const

Returns true if the right mouse button changed to down.

bool wxMouseEvent::RightUp

(

)

const

Returns true if the right mouse button changed to up.