====================================
``grail.widgets.gsimplegrid`` module
====================================
.. include:: ../../version.h
.. include:: ref.h


.. contents:: Table of Contents
   :backlinks: top

.. Warning::

   Currently lacks the Tkinter style of accessing/configuring
   components. Meaning the :f:`cget`/:f:`configure` methods do not
   function correctly on this widget.

-----------
Description
-----------

The :c:`GSimpleGrid` widget is what is known as a *Compound Widget*. This
widget provides you with the a *very* simple way of generating a NxM grid
that corresponds to a 2-D list of :c:`RTV` objects with the same NxM
layout.

------------------
GSimpleGrid Widget
------------------

The :c:`GSimpleGrid` widget inherits from,
  * :c:`gwidget.GWidget` (grail.widgets.gwidget_)
  * :c:`objsignal.Emitter` (grail.objsignal_)

class :dc:`GSimpleGrid([parent, **keywords])`
    Provides a very simple grid layout based on a 2-D list of :c:`RTV`
    objects.

    Arguments:
      :a:`parent` : :c:`Tkinter.Frame` 
         Parent widget, widget we insert into.

      :a:`keywords` 
         Variable keyword list defined below.


    Keywords:
      :a:`rtvs`
        A NxM 2-D list of :c:`RTV` objects that indicates the layout of
        the simple grid's :c:`GTextEntry` objects.
      :a:`textentrywidth`
        Width of each of the text entries.
      :a:`hlabels`:
        A list of strings to insert along the horizontal top of the
        grid.  The length of the list of strings should be equivalent to
        N widgets in the NxM :a:`rtvs` list.

    Signal:
      :d:`const.sigON_TEXT_ENTRY_CHANGE`
        Emitted when one of the text entries changes. This is generated
        with the new string from the changed entry as an argument.

    Components:
      None. 

      This widget is an old style widget that has not been updated to
      allow component access via the Tkinter :f:`cget` and
      :f:`configure` functions.
    
    :df:`disable()`
        Set all the entries so they ignore the user events.
    
    :df:`enable()`
        Set all the entries so they respond to user events.
    
    :df:`findtextentries(str_)`
        Returns a list of text entries containing the same string.
    
    :df:`getcolumncount()`
        Returns the number of columns in the grid.
    
    :df:`getrowcount()`
        Returns the number of rows in the grid.
    
    :df:`nmthtextentry(col, row)`
        Retrieves the entry widget located at (row,col) in the grid.
    
    :df:`updatevars()`
        Synchronizes each of the rtvs with their respective entries.