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


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

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

Defines a special frame that is a grail type frame.
    
This frame essentially inherits the benefits of the :c:`GWidget` object, and
behaves like a :c:`Tkinter.Frame` [#tkinter-frame]_. 
    
Children of this frame are all sub-widgets.  For example if you create a
:c:`GFrame` and put a button on that frame, then the button is a child of the
:c:`GFrame`.

-------------
GFrame Widget
-------------

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

class :dc:`GFrame([parent, *args, **kws])`
    Builds a frame, similar to a :c:`Tkinter.Frame`.
    
    :df:`disable()`
        Disables all children on the frame (they become inactive).
    
    :df:`enable()`
        Enables all children on the frame (they become active).

    :df:`updatevars()`
        Walks through all the children on the frame and calls updatevars().


---------
Reference
---------

.. [#tkinter-frame]
   
   John W. Shipman. "The Frame widget." *Tkinter Reference: a GUI for
   Python*. 2005 September 3. 2005 December 13.
   <http://infohost.nmt.edu/tcc/help/pubs/tkinter/frame.html>