.. wxPython Phoenix documentation
This file was generated by Phoenix's sphinx generator and associated
tools, do not edit by hand.
Copyright: (c) 2011-2018 by Total Control Software
License: wxWindows License
.. include:: headings.inc
.. _wx.grid.GridRangeSelectEvent:
==========================================================================================================================================
|phoenix_title| **wx.grid.GridRangeSelectEvent**
==========================================================================================================================================
.. _GridRangeSelectEvent-events:
|events| Events Emitted by this Class
=====================================
Handlers bound for the following event types will receive a :ref:`wx.grid.GridRangeSelectEvent` parameter.
- EVT_GRID_RANGE_SELECT: The user selected a group of contiguous cells. Processes a ``wxEVT_GRID_RANGE_SELECT`` event type.
- EVT_GRID_CMD_RANGE_SELECT: The user selected a group of contiguous cells; variant taking a window identifier. Processes a ``wxEVT_GRID_RANGE_SELECT`` event type.
|
|class_hierarchy| Class Hierarchy
=================================
.. raw:: html
<div id="toggleBlock" onclick="return toggleVisibility(this)" class="closed" style="cursor:pointer;">
<img id="toggleBlock-trigger" src="_static/images/closed.png"/>
Inheritance diagram for class <strong>GridRangeSelectEvent</strong>:
</div>
<div id="toggleBlock-summary" style="display:block;"></div>
<div id="toggleBlock-content" style="display:none;">
<p class="graphviz">
<center><img src="_static/images/inheritance/wx.grid.GridRangeSelectEvent_inheritance.png" alt="Inheritance diagram of GridRangeSelectEvent" usemap="#dummy" class="inheritance"/></center>
<script type="text/javascript">toggleVisibilityOnLoad(document.getElementById('toggleBlock'))</script>
<map id="dummy" name="dummy"> <area shape="rect" id="node1" href="wx.grid.GridRangeSelectEvent.html" title="=====================================" alt="" coords="5,315,231,344"/> <area shape="rect" id="node2" href="wx.NotifyEvent.html" title="This class is not used by the event handlers by itself, but is a base class for other event classes (such as wx.BookCtrlEvent)." alt="" coords="57,237,179,267"/> <area shape="rect" id="node3" href="wx.CommandEvent.html" title="This event class contains information about command events, which originate from a variety of simple controls." alt="" coords="42,160,194,189"/> <area shape="rect" id="node4" href="wx.Event.html" title="An event is a structure holding information about an event passed to a callback or member function." alt="" coords="77,83,159,112"/> <area shape="rect" id="node5" href="wx.Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="74,5,162,35"/> </map>
</p>
</div>
|
|method_summary| Methods Summary
================================
================================================================================ ================================================================================
:meth:`~wx.grid.GridRangeSelectEvent.__init__` Default constructor.
:meth:`~wx.grid.GridRangeSelectEvent.AltDown` Returns ``True`` if the Alt key was down at the time of the event.
:meth:`~wx.grid.GridRangeSelectEvent.ControlDown` Returns ``True`` if the Control key was down at the time of the event.
:meth:`~wx.grid.GridRangeSelectEvent.GetBottomRightCoords` Top left corner of the rectangular area that was (de)selected.
:meth:`~wx.grid.GridRangeSelectEvent.GetBottomRow` Bottom row of the rectangular area that was (de)selected.
:meth:`~wx.grid.GridRangeSelectEvent.GetLeftCol` Left column of the rectangular area that was (de)selected.
:meth:`~wx.grid.GridRangeSelectEvent.GetRightCol` Right column of the rectangular area that was (de)selected.
:meth:`~wx.grid.GridRangeSelectEvent.GetTopLeftCoords` Top left corner of the rectangular area that was (de)selected.
:meth:`~wx.grid.GridRangeSelectEvent.GetTopRow` Top row of the rectangular area that was (de)selected.
:meth:`~wx.grid.GridRangeSelectEvent.MetaDown` Returns ``True`` if the Meta key was down at the time of the event.
:meth:`~wx.grid.GridRangeSelectEvent.Selecting` Returns ``True`` if the area was selected, ``False`` otherwise.
:meth:`~wx.grid.GridRangeSelectEvent.ShiftDown` Returns ``True`` if the Shift key was down at the time of the event.
================================================================================ ================================================================================
|
|property_summary| Properties Summary
=====================================
================================================================================ ================================================================================
:attr:`~wx.grid.GridRangeSelectEvent.BottomRightCoords` See :meth:`~wx.grid.GridRangeSelectEvent.GetBottomRightCoords`
:attr:`~wx.grid.GridRangeSelectEvent.BottomRow` See :meth:`~wx.grid.GridRangeSelectEvent.GetBottomRow`
:attr:`~wx.grid.GridRangeSelectEvent.LeftCol` See :meth:`~wx.grid.GridRangeSelectEvent.GetLeftCol`
:attr:`~wx.grid.GridRangeSelectEvent.RightCol` See :meth:`~wx.grid.GridRangeSelectEvent.GetRightCol`
:attr:`~wx.grid.GridRangeSelectEvent.TopLeftCoords` See :meth:`~wx.grid.GridRangeSelectEvent.GetTopLeftCoords`
:attr:`~wx.grid.GridRangeSelectEvent.TopRow` See :meth:`~wx.grid.GridRangeSelectEvent.GetTopRow`
================================================================================ ================================================================================
|
|api| Class API
===============
.. class:: wx.grid.GridRangeSelectEvent(NotifyEvent)
**Possible constructors**::
GridRangeSelectEvent()
GridRangeSelectEvent(id, type, obj, topLeft, bottomRight, sel=True,
kbd=KeyboardState())
.. method:: __init__(self, *args, **kw)
|overload| Overloaded Implementations:
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self)`
Default constructor.
:html:`<hr class="overloadsep" /><br />`
**__init__** `(self, id, type, obj, topLeft, bottomRight, sel=True, kbd=KeyboardState())`
Constructor for initializing all event attributes.
:param `id`:
:type `id`: int
:param `type`:
:type `type`: wx.EventType
:param `obj`:
:type `obj`: wx.Object
:param `topLeft`:
:type `topLeft`: wx.grid.GridCellCoords
:param `bottomRight`:
:type `bottomRight`: wx.grid.GridCellCoords
:param `sel`:
:type `sel`: bool
:param `kbd`:
:type `kbd`: wx.KeyboardState
:html:`<hr class="overloadsep" /><br />`
.. method:: AltDown(self)
Returns ``True`` if the Alt key was down at the time of the event.
:rtype: `bool`
.. method:: ControlDown(self)
Returns ``True`` if the Control key was down at the time of the event.
:rtype: `bool`
.. method:: GetBottomRightCoords(self)
Top left corner of the rectangular area that was (de)selected.
:rtype: :ref:`wx.grid.GridCellCoords`
.. method:: GetBottomRow(self)
Bottom row of the rectangular area that was (de)selected.
:rtype: `int`
.. method:: GetLeftCol(self)
Left column of the rectangular area that was (de)selected.
:rtype: `int`
.. method:: GetRightCol(self)
Right column of the rectangular area that was (de)selected.
:rtype: `int`
.. method:: GetTopLeftCoords(self)
Top left corner of the rectangular area that was (de)selected.
:rtype: :ref:`wx.grid.GridCellCoords`
.. method:: GetTopRow(self)
Top row of the rectangular area that was (de)selected.
:rtype: `int`
.. method:: MetaDown(self)
Returns ``True`` if the Meta key was down at the time of the event.
:rtype: `bool`
.. method:: Selecting(self)
Returns ``True`` if the area was selected, ``False`` otherwise.
:rtype: `bool`
.. method:: ShiftDown(self)
Returns ``True`` if the Shift key was down at the time of the event.
:rtype: `bool`
.. attribute:: BottomRightCoords
See :meth:`~wx.grid.GridRangeSelectEvent.GetBottomRightCoords`
.. attribute:: BottomRow
See :meth:`~wx.grid.GridRangeSelectEvent.GetBottomRow`
.. attribute:: LeftCol
See :meth:`~wx.grid.GridRangeSelectEvent.GetLeftCol`
.. attribute:: RightCol
See :meth:`~wx.grid.GridRangeSelectEvent.GetRightCol`
.. attribute:: TopLeftCoords
See :meth:`~wx.grid.GridRangeSelectEvent.GetTopLeftCoords`
.. attribute:: TopRow
See :meth:`~wx.grid.GridRangeSelectEvent.GetTopRow`