]> granicus.if.org Git - python/commitdiff
Added documentation on the ScrolledText module.
authorFred Drake <fdrake@acm.org>
Mon, 3 Dec 2001 21:18:30 +0000 (21:18 +0000)
committerFred Drake <fdrake@acm.org>
Mon, 3 Dec 2001 21:18:30 +0000 (21:18 +0000)
Doc/lib/tkinter.tex

index 91d7c79c910f1930c4de86f3509ad9b529330f68..ba1bcc1f518957f3a090290b63a8b6cdddf9c1a1 100644 (file)
@@ -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}