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

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

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

Contains the GGroup widget.

-------
Example
-------

The following example will create a :c:`GGroup` widget with a button
within it.

.. Python::

 from grail.widgets import *
 
 root = gwidgetinit()
 root.title("GGroup Example")
 
 group = GGroup(root, text="My group")
 button = GButton(group.interior(), text="button in group")
 group.pack(anchor='nw', expand=1, fill='x')
 button.pack(padx=4, pady=4, expand=1, fill='x')
 
 root.mainloop()
   
The above script will create a window that appears as follows,

.. figure:: figure-ggroup-example.gif
   :alt: Screen shot of the GGroup widget.

   Example of the :c:`GGroup` widget.


-------------
GGroup Widget
-------------

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

class :dc:`GGroup([parent, **keywords])`
    A small 'border' around a collection of widgets.
   
    Arguments:
       :a:`parent` : :c:`Tkinter.Frame` 
          Parent widget, widget we insert into.

       :a:`keywords` 
          Variable keyword list defined below.
      
    Keyword:
      :a:`text`
        The text displayed as part of the group.

      :a:`rtv`
        Sets an grail.rtv_ variable that will update the group's text
        field if the RTV variable changes.

    Components:
      None.
    
    Signals:
      None.
    
    :df:`destroy()`
        Handle the Tkinter clean-up request.
    
    :df:`disable()`
        Doesn't do anything (can't disable per se).
    
    :df:`enable()`
        Doesn't do anything (can't enable per se).
    
    :df:`interior()`
        Retrieves the internal frame (inside the group).
    
    :df:`updatevars()`
        Synchronize RTV variables with GGroups text value.
        
        In this case the user can not modify the contents of the group,
        therefore we don't have to a thing!