Georg Brandl | ac6060c | 2008-05-17 18:44:45 +0000 | [diff] [blame] | 1 | :mod:`tkinter.scrolledtext` --- Scrolled Text Widget |
| 2 | ==================================================== |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 3 | |
Georg Brandl | ac6060c | 2008-05-17 18:44:45 +0000 | [diff] [blame] | 4 | .. module:: tkinter.scrolledtext |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 5 | :platform: Tk |
| 6 | :synopsis: Text widget with a vertical scroll bar. |
| 7 | .. sectionauthor:: Fred L. Drake, Jr. <fdrake@acm.org> |
| 8 | |
| 9 | |
Georg Brandl | ac6060c | 2008-05-17 18:44:45 +0000 | [diff] [blame] | 10 | The :mod:`tkinter.scrolledtext` module provides a class of the same name which |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 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 |
Georg Brandl | ac6060c | 2008-05-17 18:44:45 +0000 | [diff] [blame] | 14 | as that of the :class:`tkinter.Text` class. |
Georg Brandl | 116aa62 | 2007-08-15 14:28:22 +0000 | [diff] [blame] | 15 | |
| 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. |
| 20 | |
| 21 | Should more specific control be necessary, the following attributes are |
| 22 | available: |
| 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. |