Mercurial > cpython-lru_cache-weakref
diff Doc/lib/tkinter.tex @ 21175:c9a796400a51 legacy-trunk
Added documentation on the ScrolledText module.
| author | Fred Drake <fdrake@acm.org> |
|---|---|
| date | Mon, 03 Dec 2001 21:18:30 +0000 |
| parents | d4509cf93f50 |
| children | 44ebeab269c5 |
line wrap: on
line diff
--- a/Doc/lib/tkinter.tex Mon Dec 03 20:58:29 2001 +0000 +++ b/Doc/lib/tkinter.tex Mon Dec 03 21:18:30 2001 +0000 @@ -107,6 +107,9 @@ % \modulesynopsis{Constants used by Tkinter} % FIXME +\item[\refmodule{ScrolledText}] +Text widget with a vertical scroll bar built in. + \item[\module{tkColorChooser}] Dialog to let the user choose a color. @@ -1470,6 +1473,40 @@ \end{methoddesc} + +\section{\module{ScrolledText} --- + Scrolled Text Widget} + +\declaremodule{standard}{ScrolledText} + \platform{Tk} +\modulesynopsis{Text widget with a vertical scroll bar.} +\sectionauthor{Fred L. Drake, Jr.}{fdrake@acm.org} + +The \module{ScrolledText} module provides a class of the same name +which implements a basic text widget which has a vertical scroll bar +configured to do the ``right thing.'' Using the \class{ScrolledText} +class is a lot easier than setting up a text widget and scroll bar +directly. The constructor is the same as that of the +\class{Tkinter.Text} class. + +The text widget and scrollbar are packed together in a \class{Frame}, +and the methods of the \class{Pack} geometry manager are acquired from +the \class{Frame} object. This allows the \class{ScrolledText} widget +to be used directly to achieve most normal geometry management +behavior. + +Should more specific control be necessary, the following attributes +are available: + +\begin{memberdesc}[ScrolledText]{frame} + The frame which surrounds the text and scroll bar widgets. +\end{memberdesc} + +\begin{memberdesc}[ScrolledText]{vbar} + The scroll bar widget. +\end{memberdesc} + + \input{libturtle}
