blob: 138720e4785f6ba5c637d1771cd5c4f83cc355c9 [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.
Terry Jan Reedyfa089b92016-06-11 15:02:54 -04007
Georg Brandl116aa622007-08-15 14:28:22 +00008.. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org>
9
Terry Jan Reedyfa089b92016-06-11 15:02:54 -040010**Source code:** :source:`Lib/tkinter/scrolledtext.py`
11
12--------------
Georg Brandl116aa622007-08-15 14:28:22 +000013
Georg Brandlac6060c2008-05-17 18:44:45 +000014The :mod:`tkinter.scrolledtext` module provides a class of the same name which
Georg Brandl116aa622007-08-15 14:28:22 +000015implements a basic text widget which has a vertical scroll bar configured to do
16the "right thing." Using the :class:`ScrolledText` class is a lot easier than
17setting up a text widget and scroll bar directly. The constructor is the same
Georg Brandlac6060c2008-05-17 18:44:45 +000018as that of the :class:`tkinter.Text` class.
Georg Brandl116aa622007-08-15 14:28:22 +000019
20The text widget and scrollbar are packed together in a :class:`Frame`, and the
21methods of the :class:`Grid` and :class:`Pack` geometry managers are acquired
22from the :class:`Frame` object. This allows the :class:`ScrolledText` widget to
23be used directly to achieve most normal geometry management behavior.
24
25Should more specific control be necessary, the following attributes are
26available:
27
28
29.. attribute:: ScrolledText.frame
30
31 The frame which surrounds the text and scroll bar widgets.
32
33
34.. attribute:: ScrolledText.vbar
35
36 The scroll bar widget.