****************************
wx.grid.GridRangeSelectEvent
****************************

Inheritance diagram for `wx.grid.GridRangeSelectEvent`:

|

.. inheritance-diagram:: wx.grid.GridRangeSelectEvent

|

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

Event fired when a user select a range of cells in `wx.grid.Grid <../grid/wx.grid.Grid.html>`_.

Derived From
^^^^^^^^^^^^^

* `wx.NotifyEvent <wx.NotifyEvent.html>`_ 
* `wx.CommandEvent <wx.CommandEvent.html>`_ 
* `wx.Event <wx.Event.html>`_ 
* `wx.Object <../Widgets/wx.Object.html>`_ 


Event Handling
^^^^^^^^^^^^^^

The event handler for the following functions takes a `wx.grid.GridRangeSelectEvent` parameter. The ``..._CMD_...`` variants also take a window identifier.

==================================================  ==================================================  
Event Name                                          Description
==================================================  ==================================================  
wx.grid.EVT_GRID_RANGE_SELECT(func)                 The user selected a group of contiguous cells. Processes a ``wx.grid.wxEVT_GRID_RANGE_SELECT``.
wx.grid.EVT_GRID_CMD_RANGE_SELECT(func)             The user selected a group of contiguous cells; variant taking a window identifier. Processes a ``wx.grid.wxEVT_GRID_RANGE_SELECT``.
==================================================  ==================================================  

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

* `__init__ <#__init__>`_ 
* `AltDown <#AltDown>`_ 
* `CmdDown <#CmdDown>`_ 
* `ControlDown <#ControlDown>`_ 
* `GetBottomRightCoords <#GetBottomRightCoords>`_ 
* `GetBottomRow <#GetBottomRow>`_ 
* `GetLeftCol <#GetLeftCol>`_ 
* `GetRightCol <#GetRightCol>`_ 
* `GetTopLeftCoords <#GetTopLeftCoords>`_ 
* `GetTopRow <#GetTopRow>`_ 
* `MetaDown <#MetaDown>`_ 
* `Selecting <#Selecting>`_ 
* `ShiftDown <#ShiftDown>`_ 

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

* `BottomRightCoords <#BottomRightCoords>`_ 
* `BottomRow <#BottomRow>`_ 
* `LeftCol <#LeftCol>`_ 
* `RightCol <#RightCol>`_ 
* `TopLeftCoords <#TopLeftCoords>`_ 
* `TopRow <#TopRow>`_ 

Class API
=========

Methods
^^^^^^^


.. method:: __init__(id, type, obj, topLeft, bottomRight, sel=True, control=False, shift=False, alt=False, meta=False)

   Constructor.

   **Parameters:**

   * `id` (int)
   * `type` (eventtype)
   * `obj` (`wx.grid.Grid <../grid/wx.grid.Grid.html>`_)
   * `topLeft` (`wx.grid.GridCellCoords`)
   * `bottomRight` (`wx.grid.GridCellCoords`)
   * `sel` (bool)
   * `control` (bool)
   * `shift` (bool)
   * `alt` (bool)
   * `meta` (bool)

   |

   **Returns:**

   `wx.grid.GridRangeSelectEvent <wx.grid.GridRangeSelectEvent.html>`_ 

--------

.. method:: AltDown()

   Returns ``True`` if the ``Alt`` key was down at the time of the event.

   |  

   **Returns:**

   `bool` 

--------

.. method:: CmdDown()

   `No docstrings available for this method.` 

--------


.. method:: ControlDown()

   Returns ``True`` if the ``Control`` key was down at the time of the event.

   |  

   **Returns:**

   `bool` 

--------

.. method:: GetBottomRightCoords()

   Top left corner of the rectangular area that was (de)selected.

   |  

   **Returns:**

   `wx.grid.GridCellCoords` 

--------

.. method:: GetBottomRow()

   Bottom row of the rectangular area that was (de)selected.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetLeftCol()

   Left column of the rectangular area that was (de)selected.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetRightCol()

   Right column of the rectangular area that was (de)selected.

   |  

   **Returns:**

   `int` 

--------

.. method:: GetTopLeftCoords()

   Top left corner of the rectangular area that was (de)selected.

   |  

   **Returns:**

   `wx.grid.GridCellCoords` 

--------

.. method:: GetTopRow()

   Top row of the rectangular area that was (de)selected.

   |  

   **Returns:**

   `int` 

--------

.. method:: MetaDown()

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

   |  

   **Returns:**

   `bool` 

--------

.. method:: Selecting()

   Returns ``True`` if the area was selected, ``False`` otherwise.

   |  

   **Returns:**

   `bool` 

--------

.. method:: ShiftDown()

   Returns ``True`` if the ``Shift`` key was down at the time of the event.

   |  

   **Returns:**

   `bool` 

--------

Properties
^^^^^^^^^^


.. attribute:: BottomRightCoords

   See `GetBottomRightCoords <#GetBottomRightCoords>`_

.. attribute:: BottomRow

   See `GetBottomRow <#GetBottomRow>`_

.. attribute:: LeftCol

   See `GetLeftCol <#GetLeftCol>`_

.. attribute:: RightCol

   See `GetRightCol <#GetRightCol>`_

.. attribute:: TopLeftCoords

   See `GetTopLeftCoords <#GetTopLeftCoords>`_

.. attribute:: TopRow

   See `GetTopRow <#GetTopRow>`_