diff options
author | Fred Drake <fdrake@acm.org> | 2001-12-03 21:18:30 (GMT) |
---|---|---|
committer | Fred Drake <fdrake@acm.org> | 2001-12-03 21:18:30 (GMT) |
commit | 1a76386194964955f1c72a1d39a55fa19680555a (patch) | |
tree | 1be864fe30998ee0f352e416ce26742db9693ac3 /Doc/lib | |
parent | c54fc3179fd95fc0807de602f5bb6efb0bebf942 (diff) | |
download | cpython-1a76386194964955f1c72a1d39a55fa19680555a.zip cpython-1a76386194964955f1c72a1d39a55fa19680555a.tar.gz cpython-1a76386194964955f1c72a1d39a55fa19680555a.tar.bz2 |
Added documentation on the ScrolledText module.
Diffstat (limited to 'Doc/lib')
-rw-r--r-- | Doc/lib/tkinter.tex | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/Doc/lib/tkinter.tex b/Doc/lib/tkinter.tex index 91d7c79..ba1bcc1 100644 --- a/Doc/lib/tkinter.tex +++ b/Doc/lib/tkinter.tex @@ -107,6 +107,9 @@ Other modules that provide Tk support include: % \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 @@ Instead, the \method{tix_resetoptions()} method must be used. \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} |