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

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

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


Provides the ability to insert a status bar into your Tkinter dialog.
This example was adapted from Fredrik Lundh [#lundh]_.

-----------------
GStatusBar Widget
-----------------

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

class :dc:`GStatusBar([parent])`
    Your standard 'status bar' widget, which is basically a sunken label, 
    that has read()/write() methods associated with it.
    
    Arguments:
       :a:`parent` : :c:`Tkinter.Frame` 
         Parent widget, widget we insert into.
   
    :df:`disable()`
        Set the status bar to ignore read/write events.
    
    :df:`enable()`
        Set the statusbar to respond to read/write events.
    
    :df:`read()`
        Returns the information on the status bar. None is returned if
        the statusbar is disabled. 
    
    :df:`updatevars()`
        No vars; always returns 1.
    
    :df:`write(input)`
        Write a string to the active status bar. To clear the statusbar
        use the empty string (""). Disabled statusbar does not respond
        to write events.


---- 

.. [#lundh] 
   Lundh, Fredrik. "Status Bars". An Introduction to Tkinter. 27 July
   2004.
   <http://local.eleceng.uct.ac.za/courses/EEE103W/python/www.pythonware.com/library/tkinter/introduction/x996-status-bars.htm>