.. include:: headings.inc

.. currentmodule:: lib.sheet

.. highlight:: python



.. _lib.sheet.CSheet:

==========================================================================================================================================
|phoenix_title|  **CSheet**
==========================================================================================================================================





|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **CSheet**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/lib.sheet.CSheet_inheritance.png" alt="Inheritance diagram of CSheet" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="lib.sheet.CSheet.html" title="sheet.CSheet" alt="" coords="981,33,1101,63"/> <area shape="rect" id="node4" href="Window.html" title="Window  is the base class for all windows and represents any visible object on screen." alt="" coords="407,58,487,89"/> <area shape="rect" id="node8" href="Panel.html" title="A panel is a window on which controls are placed." alt="" coords="536,58,608,89"/> <area shape="rect" id="node5" href="EvtHandler.html" title="A class that can handle events from the windowing system." alt="" coords="252,58,351,89"/> <area shape="rect" id="node16" href="Object.html" title="This is the root class of many of the wxWidgets classes." alt="" coords="125,58,197,89"/> </map> 
   </p>

|


|super_classes| Known Superclasses
==================================

:class:`grid.Grid`

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~lib.sheet.CSheet.__init__`                                               
:meth:`~lib.sheet.CSheet.Clear`                                                  Clear the currently selected cells
:meth:`~lib.sheet.CSheet.Copy`                                                   Copy the currently selected cells to the clipboard
:meth:`~lib.sheet.CSheet.OnCellChange`                                           
:meth:`~lib.sheet.CSheet.OnColSize`                                              
:meth:`~lib.sheet.CSheet.OnGridSelectCell`                                       Track cell selections
:meth:`~lib.sheet.CSheet.OnLeftClick`                                            Override left-click behavior to prevent left-click edit initiation
:meth:`~lib.sheet.CSheet.OnLeftDoubleClick`                                      Initiate the cell editor on a double-click
:meth:`~lib.sheet.CSheet.OnRangeSelect`                                          Track which cells are selected so that copy/paste behavior can be implemented
:meth:`~lib.sheet.CSheet.OnRightClick`                                           Move grid cursor when a cell is right-clicked
:meth:`~lib.sheet.CSheet.OnRowSize`                                              
:meth:`~lib.sheet.CSheet.Paste`                                                  Paste the contents of the clipboard into the currently selected cells
:meth:`~lib.sheet.CSheet.SetNumberCols`                                          Set the number of columns in the sheet
:meth:`~lib.sheet.CSheet.SetNumberRows`                                          Set the number of rows in the sheet
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: CSheet(grid.Grid)



   .. method:: __init__(self, parent)


   .. method:: Clear(self)

      Clear the currently selected cells 


   .. method:: Copy(self)

      Copy the currently selected cells to the clipboard 


   .. method:: OnCellChange(self, event)


   .. method:: OnColSize(self, event)


   .. method:: OnGridSelectCell(self, event)

      Track cell selections 


   .. method:: OnLeftClick(self, event)

      Override left-click behavior to prevent left-click edit initiation 


   .. method:: OnLeftDoubleClick(self, event)

      Initiate the cell editor on a double-click 


   .. method:: OnRangeSelect(self, event)

      Track which cells are selected so that copy/paste behavior can be implemented 


   .. method:: OnRightClick(self, event)

      Move grid cursor when a cell is right-clicked 


   .. method:: OnRowSize(self, event)


   .. method:: Paste(self)

      Paste the contents of the clipboard into the currently selected cells 


   .. method:: SetNumberCols(self, numCols=1)

      Set the number of columns in the sheet 


   .. method:: SetNumberRows(self, numRows=1)

      Set the number of rows in the sheet