wxMouseState Class Reference
[Miscellaneous]

#include <wx/mousestate.h>

Inheritance diagram for wxMouseState:

Inheritance graph
[legend]

Detailed Description

Represents the mouse state.

This class is used as a base class by wxMouseEvent and so its methods may be used to obtain information about the mouse state for the mouse events. It also inherits from wxKeyboardState and so carries information about the keyboard state and not only the mouse one.

This class is implemented entirely inline in <wx/mousestate.h> and thus has no linking requirements.

Library:  None; this class implementation is entirely header-based.

Category:  Miscellaneous

See also:
wxGetMouseState(), wxMouseEvent

Public Member Functions

 wxMouseState ()
 Default constructor.
wxCoord GetX () const
 Returns X coordinate of the physical mouse event position.
wxCoord GetY () const
 Returns Y coordinate of the physical mouse event position.
wxPoint GetPosition () const
 Returns the physical mouse position.
bool LeftDown () const
 Returns true if the left mouse button changed to down.
bool MiddleDown () const
 Returns true if the middle mouse button changed to down.
bool RightDown () const
 Returns true if the right mouse button changed to down.
bool Aux1Down () const
 Returns true if the first extra button mouse button changed to down.
bool Aux2Down () const
 Returns true if the second extra button mouse button changed to down.

List of all members.


Constructor & Destructor Documentation

wxMouseState::wxMouseState (  ) 

Default constructor.


Member Function Documentation

bool wxMouseState::Aux1Down (  )  const

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

Reimplemented in wxMouseEvent.

bool wxMouseState::Aux2Down (  )  const

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

Reimplemented in wxMouseEvent.

wxPoint wxMouseState::GetPosition (  )  const

Returns the physical mouse position.

Reimplemented in wxMouseEvent.

wxCoord wxMouseState::GetX (  )  const

Returns X coordinate of the physical mouse event position.

Reimplemented in wxMouseEvent.

wxCoord wxMouseState::GetY (  )  const

Returns Y coordinate of the physical mouse event position.

Reimplemented in wxMouseEvent.

bool wxMouseState::LeftDown (  )  const

Returns true if the left mouse button changed to down.

Reimplemented in wxMouseEvent.

bool wxMouseState::MiddleDown (  )  const

Returns true if the middle mouse button changed to down.

Reimplemented in wxMouseEvent.

bool wxMouseState::RightDown (  )  const

Returns true if the right mouse button changed to down.

Reimplemented in wxMouseEvent.



wxWidgets logo

[ top ]