wxMouseEvent

Implements methods from the following classes

• wxEvent
• wxMouseState

Methods

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

Static Methods

wxMouseEvent

wxMouseEvent ( integer $mouseEventType=wxEVT_NULL )

Constructor.

Aux1DClick

bool Aux1DClick ( )

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

Aux1Down

bool Aux1Down ( )

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

Aux1Up

bool Aux1Up ( )

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

Aux2DClick

bool Aux2DClick ( )

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

Aux2Down

bool Aux2Down ( )

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

Aux2Up

bool Aux2Up ( )

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

Button

bool Button ( wxMouseButton $but )

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

ButtonDClick

bool ButtonDClick ( wxMouseButton $but=wxMOUSE_BTN_ANY )

If the argument is omitted, this returns true if the event was a mouse double click event.

ButtonDown

bool ButtonDown ( wxMouseButton $but=wxMOUSE_BTN_ANY )

If the argument is omitted, this returns true if the event was a mouse button down event.

ButtonUp

bool ButtonUp ( wxMouseButton $but=wxMOUSE_BTN_ANY )

If the argument is omitted, this returns true if the event was a mouse button up event.

Dragging

bool Dragging ( )

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

Entering

bool Entering ( )

Returns true if the mouse was entering the window.

GetButton

integer GetButton ( )

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

GetClickCount

integer GetClickCount ( )

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.

GetLinesPerAction

integer GetLinesPerAction ( )

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

GetLogicalPosition

wxPoint GetLogicalPosition ( wxDC $dc )

Returns the logical mouse position in pixels (i.e.

GetWheelAxis

wxMouseWheelAxis GetWheelAxis ( )

Gets the axis the wheel operation concerns.

GetWheelDelta

integer GetWheelDelta ( )

Get wheel delta, normally 120.

GetWheelRotation

integer GetWheelRotation ( )

Get wheel rotation, positive or negative indicates direction of rotation.

IsButton

bool IsButton ( )

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

IsPageScroll

bool IsPageScroll ( )

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

Leaving

bool Leaving ( )

Returns true if the mouse was leaving the window.

LeftDClick

bool LeftDClick ( )

Returns true if the event was a left double click.

LeftDown

bool LeftDown ( )

Returns true if the left mouse button changed to down.

LeftUp

bool LeftUp ( )

Returns true if the left mouse button changed to up.

MetaDown

bool MetaDown ( )

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

MiddleDClick

bool MiddleDClick ( )

Returns true if the event was a middle double click.

MiddleDown

bool MiddleDown ( )

Returns true if the middle mouse button changed to down.

MiddleUp

bool MiddleUp ( )

Returns true if the middle mouse button changed to up.

Moving

bool Moving ( )

Returns true if this was a motion event and no mouse buttons were pressed.

RightDClick

bool RightDClick ( )

Returns true if the event was a right double click.

RightDown

bool RightDown ( )

Returns true if the right mouse button changed to down.

RightUp

bool RightUp ( )

Returns true if the right mouse button changed to up.