Added section on passing contextual information to logging and documentation for...
[python.git] / Doc / library / scrolledtext.rst
blob85456b98f34a387ee5272c619ebabcc19f14a6d2
1 :mod:`ScrolledText` --- Scrolled Text Widget
2 ============================================
4 .. module:: ScrolledText
5    :platform: Tk
6    :synopsis: Text widget with a vertical scroll bar.
7 .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
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` 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.
16 The text widget and scrollbar are packed together in a :class:`Frame`, and the
17 methods of the :class:`Grid` and :class:`Pack` geometry managers are acquired
18 from the :class:`Frame` object.  This allows the :class:`ScrolledText` widget to
19 be used directly to achieve most normal geometry management behavior.
21 Should more specific control be necessary, the following attributes are
22 available:
25 .. attribute:: ScrolledText.frame
27    The frame which surrounds the text and scroll bar widgets.
30 .. attribute:: ScrolledText.vbar
32    The scroll bar widget.