Home | History | Annotate | Download | only in library
      1 :mod:`ScrolledText` --- Scrolled Text Widget
      2 ============================================
      3 
      4 .. module:: ScrolledText
      5    :platform: Tk
      6    :synopsis: Text widget with a vertical scroll bar.
      7 .. sectionauthor:: Fred L. Drake, Jr. <fdrake (a] acm.org>
      8 
      9 
     10 The :mod:`ScrolledText` module provides a class of the same name which
     11 implements a basic text widget which has a vertical scroll bar configured to do
     12 the "right thing."  Using the :class:`~ScrolledText.ScrolledText` class is a lot easier than
     13 setting up a text widget and scroll bar directly.  The constructor is the same
     14 as that of the :class:`Tkinter.Text` class.
     15 
     16 .. note::
     17 
     18    :mod:`ScrolledText` has been renamed to :mod:`tkinter.scrolledtext` in Python
     19    3.  The :term:`2to3` tool will automatically adapt imports when converting
     20    your sources to Python 3.
     21 
     22 The text widget and scrollbar are packed together in a :class:`Frame`, and the
     23 methods of the :class:`Grid` and :class:`Pack` geometry managers are acquired
     24 from the :class:`Frame` object.  This allows the :class:`~ScrolledText.ScrolledText` widget to
     25 be used directly to achieve most normal geometry management behavior.
     26 
     27 Should more specific control be necessary, the following attributes are
     28 available:
     29 
     30 
     31 .. attribute:: ScrolledText.frame
     32 
     33    The frame which surrounds the text and scroll bar widgets.
     34 
     35 
     36 .. attribute:: ScrolledText.vbar
     37 
     38    The scroll bar widget.
     39