*************
wx.MouseState
*************

Inheritance diagram for `wx.MouseState`:

|

.. inheritance-diagram:: wx.MouseState

|

Description
===========

`wx.MouseState` is used to hold information about mouse button and modifier key states and is what is returned from `wx.GetMouseState <../wxFunctions.html#GetMouseState>`_.


Methods Summary
^^^^^^^^^^^^^^^

* `__init__ <#__init__>`_ 
* `AltDown <#AltDown>`_ 
* `CmdDown <#CmdDown>`_ 
* `ControlDown <#ControlDown>`_ 
* `GetX <#GetX>`_ 
* `GetY <#GetY>`_ 
* `LeftDown <#LeftDown>`_ 
* `MetaDown <#MetaDown>`_ 
* `MiddleDown <#MiddleDown>`_ 
* `RightDown <#RightDown>`_ 
* `SetAltDown <#SetAltDown>`_ 
* `SetControlDown <#SetControlDown>`_ 
* `SetLeftDown <#SetLeftDown>`_ 
* `SetMetaDown <#SetMetaDown>`_ 
* `SetMiddleDown <#SetMiddleDown>`_ 
* `SetRightDown <#SetRightDown>`_ 
* `SetShiftDown <#SetShiftDown>`_ 
* `SetX <#SetX>`_ 
* `SetY <#SetY>`_ 
* `ShiftDown <#ShiftDown>`_ 

Properties Summary
^^^^^^^^^^^^^^^^^^

* `altDown <#altDown>`_ 
* `cmdDown <#cmdDown>`_ 
* `controlDown <#controlDown>`_ 
* `leftDown <#leftDown>`_ 
* `metaDown <#metaDown>`_ 
* `middleDown <#middleDown>`_ 
* `rightDown <#rightDown>`_ 
* `shiftDown <#shiftDown>`_ 
* `x <#x>`_ 
* `y <#y>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__()

   `wx.MouseState` is used to hold information about mouse button and
   modifier key states and is what is returned from `wx.GetMouseState <../wxFunctions.html#GetMouseState>`_.

   |

   **Returns:**

   `wx.MouseState <wx.MouseState.html>`_
 

--------

.. method:: AltDown()

   `No docstrings available for this method.` 

--------


.. method:: CmdDown()

   `No docstrings available for this method.` 

--------


.. method:: ControlDown()

   `No docstrings available for this method.` 

--------


.. method:: GetX()

   `No docstrings available for this method.` 

--------


.. method:: GetY()

   `No docstrings available for this method.` 

--------


.. method:: LeftDown()

   `No docstrings available for this method.` 

--------


.. method:: MetaDown()

   `No docstrings available for this method.` 

--------


.. method:: MiddleDown()

   `No docstrings available for this method.` 

--------


.. method:: RightDown()

   `No docstrings available for this method.` 

--------


.. method:: SetAltDown(down)

   |

   **Parameters:**

   * `down` (bool)


--------

.. method:: SetControlDown(down)

   |

   **Parameters:**

   * `down` (bool)


--------

.. method:: SetLeftDown(down)

   |

   **Parameters:**

   * `down` (bool)


--------

.. method:: SetMetaDown(down)

   |

   **Parameters:**

   * `down` (bool)


--------

.. method:: SetMiddleDown(down)

   |

   **Parameters:**

   * `down` (bool)


--------

.. method:: SetRightDown(down)

   |

   **Parameters:**

   * `down` (bool)


--------

.. method:: SetShiftDown(down)

   |

   **Parameters:**

   * `down` (bool)


--------

.. method:: SetX(x)

   |

   **Parameters:**

   * `x` (int)


--------

.. method:: SetY(y)

   |

   **Parameters:**

   * `y` (int)


--------

.. method:: ShiftDown()

   `No docstrings available for this method.` 

--------


Properties
^^^^^^^^^^


.. attribute:: altDown

   See `AltDown <#AltDown>`_

.. attribute:: cmdDown

   See `CmdDown <#CmdDown>`_

.. attribute:: controlDown

   See `ControlDown <#ControlDown>`_

.. attribute:: leftDown

   See `LeftDown <#LeftDown>`_

.. attribute:: metaDown

   See `MetaDown <#MetaDown>`_

.. attribute:: middleDown

   See `MiddleDown <#MiddleDown>`_

.. attribute:: rightDown

   See `RightDown <#RightDown>`_

.. attribute:: shiftDown

   See `ShiftDown <#ShiftDown>`_

.. attribute:: x

   See `GetX`_ and `SetX`_

.. attribute:: y

   See `GetY`_ and `SetY`_