blob: 520970f168bf6fd8762297ff4971155c497c2149 [file] [log] [blame]
Georg Brandlac6060c2008-05-17 18:44:45 +00001:mod:`tkinter.scrolledtext` --- Scrolled Text Widget
2====================================================
Georg Brandl116aa622007-08-15 14:28:22 +00003
Georg Brandlac6060c2008-05-17 18:44:45 +00004.. module:: tkinter.scrolledtext
Georg Brandl116aa622007-08-15 14:28:22 +00005 :platform: Tk
6 :synopsis: Text widget with a vertical scroll bar.
7.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
8
9
Georg Brandlac6060c2008-05-17 18:44:45 +000010The :mod:`tkinter.scrolledtext` module provides a class of the same name which
Georg Brandl116aa622007-08-15 14:28:22 +000011implements a basic text widget which has a vertical scroll bar configured to do
12the "right thing." Using the :class:`ScrolledText` class is a lot easier than
13setting up a text widget and scroll bar directly. The constructor is the same
Georg Brandlac6060c2008-05-17 18:44:45 +000014as that of the :class:`tkinter.Text` class.
Georg Brandl116aa622007-08-15 14:28:22 +000015
16The text widget and scrollbar are packed together in a :class:`Frame`, and the
17methods of the :class:`Grid` and :class:`Pack` geometry managers are acquired
18from the :class:`Frame` object. This allows the :class:`ScrolledText` widget to
19be used directly to achieve most normal geometry management behavior.
20
21Should more specific control be necessary, the following attributes are
22available:
23
24
25.. attribute:: ScrolledText.frame
26
27 The frame which surrounds the text and scroll bar widgets.
28
29
30.. attribute:: ScrolledText.vbar
31
32 The scroll bar widget.