X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/0e0977894a66f5b3227d2864becaeae86a5e93c8..7344108e8a129a3f9b4df5ab0f98a1713db03b89:/interface/wx/mousestate.h diff --git a/interface/wx/mousestate.h b/interface/wx/mousestate.h index 0632791564..62ff0e39ac 100644 --- a/interface/wx/mousestate.h +++ b/interface/wx/mousestate.h @@ -4,9 +4,37 @@ // Author: wxWidgets team // Created: 2008-09-19 // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// +/// Symbolic names for the mouse buttons. +enum wxMouseButton +{ + /// Any mouse button, means to check for any button being pressed for + /// example. + wxMOUSE_BTN_ANY = -1, + + /// None of the mouse buttons. + wxMOUSE_BTN_NONE = 0, + + /// Left mouse button. + wxMOUSE_BTN_LEFT = 1, + + /// Middle mouse button. + wxMOUSE_BTN_MIDDLE = 2, + + /// Right mouse button. + wxMOUSE_BTN_RIGHT = 3, + + /// First additional mouse button. + wxMOUSE_BTN_AUX1 = 4, + + /// Second additional mouse button. + wxMOUSE_BTN_AUX2 = 5, + + wxMOUSE_BTN_MAX +}; + /** @class wxMouseState @@ -21,7 +49,8 @@ This class is implemented entirely inline in @ and thus has no linking requirements. - @category{misc} + @nolibrary + @category{events} @see wxGetMouseState(), wxMouseEvent */ @@ -37,35 +66,58 @@ public: 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 the physical mouse position. */ + //@{ wxPoint GetPosition() const; + void GetPosition(int *x, int *y) const; + //@} /** - Returns @true if the left mouse button changed to down. + Returns @true if the left mouse button is currently down. */ - bool LeftDown() const; + bool LeftIsDown() const; + /** - Returns @true if the middle mouse button changed to down. + Returns @true if the middle mouse button is currently down. */ - bool MiddleDown() const; + bool MiddleIsDown() const; + /** - Returns @true if the right mouse button changed to down. + Returns @true if the right mouse button is currently down. */ - bool RightDown() const; + bool RightIsDown() const; + /** - Returns @true if the first extra button mouse button changed to down. + Returns @true if the first extra button mouse button is currently down. */ - bool Aux1Down() const; + bool Aux1IsDown() const; + /** - Returns @true if the second extra button mouse button changed to down. + Returns @true if the second extra button mouse button is currently down. */ - bool Aux2Down() const; + bool Aux2IsDown() const; + + + void SetX(wxCoord x); + void SetY(wxCoord y); + void SetPosition(wxPoint pos); + + void SetLeftDown(bool down); + void SetMiddleDown(bool down); + void SetRightDown(bool down); + void SetAux1Down(bool down); + void SetAux2Down(bool down); + + void SetState(const wxMouseState& state); + };