summaryrefslogtreecommitdiffstats
path: root/doc/ttk_scrollbar.n
diff options
context:
space:
mode:
authorhobbs <hobbs>2006-12-13 23:04:32 (GMT)
committerhobbs <hobbs>2006-12-13 23:04:32 (GMT)
commitd4a63ee0259256e40eba77a360b9902afc472bc4 (patch)
tree128697b7c80828f4a3d31417bb432bc8eec88b00 /doc/ttk_scrollbar.n
parent318393c4af319ed15ef4a5d6e3f5b12259fe695d (diff)
downloadtk-d4a63ee0259256e40eba77a360b9902afc472bc4.zip
tk-d4a63ee0259256e40eba77a360b9902afc472bc4.tar.gz
tk-d4a63ee0259256e40eba77a360b9902afc472bc4.tar.bz2
* unix/Makefile.in (install-doc): intentionally skip ttk_dialog.n
installation (not for public consumption) * doc/scrollbar.n, doc/button.n, doc/checkbutton.n: * doc/entry.n, doc/frame.n, doc/label.n, doc/labelframe.n: * doc/menu.n, doc/menubutton.n, doc/panedwindow.n: * doc/radiobutton.n, doc/scrollbar.n, doc/ttk_*: revamp ttk docs to use consist nroff format (not 100% consistent with classic widget docs). Add more man page cross-linking "SEE ALSO".
Diffstat (limited to 'doc/ttk_scrollbar.n')
-rw-r--r--doc/ttk_scrollbar.n51
1 files changed, 29 insertions, 22 deletions
diff --git a/doc/ttk_scrollbar.n b/doc/ttk_scrollbar.n
index 090c964..de4a666 100644
--- a/doc/ttk_scrollbar.n
+++ b/doc/ttk_scrollbar.n
@@ -1,25 +1,37 @@
'\"
-'\" SOURCE: tk/doc/scrollbar.n, r1.4
-'\"
-'\" Copyright (c) 1990-1994 The Regents of the University of California.
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
'\" Copyright (c) 2004 Joe English
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
-'\" $Id: ttk_scrollbar.n,v 1.2 2006/11/15 13:29:17 dkf Exp $
+'\" SOURCE: tk/doc/scrollbar.n, r1.4
+'\" RCS: @(#) $Id: ttk_scrollbar.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $
'\"
.so man.macros
.TH ttk_scrollbar n 8.5 Tk "Tk Themed Widget"
.BS
+.\" Use _ instead of :: as the name becomes a filename on install
.SH NAME
-ttk::scrollbar \- Control the viewport of a scrollable widget
+ttk_scrollbar \- Control the viewport of a scrollable widget
.SH SYNOPSIS
\fBttk::scrollbar\fR \fIpathName \fR?\fIoptions...\fR?
+.BE
+
+.SH DESCRIPTION
+\fBttk::scrollbar\fR widgets are typically linked to an associated window
+that displays a document of some sort, such as a file being edited or a
+drawing.
+A scrollbar displays a \fIthumb\fR in the middle portion of the scrollbar,
+whose position and size provides information about the portion of the
+document visible in the associated window.
+The thumb may be dragged by the user to control the visible region.
+Depending on the theme, two or more arrow buttons may also be present;
+these are used to scroll the visible region in discrete units.
.SO
\-class \-cursor \-style \-takefocus
.SE
+
.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-command command Command
A Tcl script prefix to evaluate
@@ -37,33 +49,20 @@ One of \fBhorizontal\fR or \fBvertical\fR.
Specifies the orientation of the scrollbar.
.BE
-.SH DESCRIPTION
-Scrollbar widgets are typically linked to an associated window
-that displays a document of some sort,
-such as a file being edited or a drawing.
-A scrollbar displays a \fIthumb\fR in the
-middle portion of the scrollbar,
-whose position and size provides information
-about the portion of the document visible in
-the associated window.
-The thumb may be dragged by the user to control the
-visible region.
-Depending on the theme, two or more arrow buttons may also be present;
-these are used to scroll the visible region in discrete units.
.SH "WIDGET COMMAND"
.TP
\fIpathName \fBcget\fR \fIoption\fR
-Returns the current value of the specified \fIoption\fR; see \fIwidget(n)\fR.
+Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR.
.TP
\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
-Modify or query widget options; see \fIwidget(n)\fR.
+Modify or query widget options; see \fIttk_widget(n)\fR.
.TP
\fIpathName \fBget\fR
Returns the scrollbar settings in the form of a list whose
elements are the arguments to the most recent \fBset\fR widget command.
.TP
\fIpathName \fBinstate \fIstatespec\fR ?\fIscript\fR?
-Test the widget state; see \fIwidget(n)\fR.
+Test the widget state; see \fIttk_widget(n)\fR.
.TP
\fIpathName \fBset\fR \fIfirst last\fR
This command is normally invoked by the scrollbar's associated widget
@@ -72,7 +71,8 @@ Specifies the visible range to be displayed.
\fIfirst\fR and \fIlast\fR are real fractions between 0 and 1.
.TP
\fIpathName \fBstate\fR ?\fIstateSpec\fR?
-Modify or query the widget state; see \fIwidget(n)\fR.
+Modify or query the widget state; see \fIttk_widget(n)\fR.
+
.SH "INTERNAL COMMANDS"
The following widget commands are used internally
by the TScrollbar widget class bindings.
@@ -103,6 +103,7 @@ Returns the name of the element under the point given
by \fIx\fR and \fIy\fR, or an empty string if the point does
not lie in any element of the scrollbar.
\fIX\fR and \fIy\fR are pixel coordinates relative to the scrollbar widget.
+
.SH "SCROLLING COMMANDS"
When the user interacts with the scrollbar, for example by dragging
the thumb, the scrollbar notifies the associated widget that it
@@ -138,12 +139,14 @@ is a slight overlap between the old and new views.
\fINumber\fR is either 1, which means the next page should
become visible, or \-1, which means that the previous page should
become visible.
+
.SH "WIDGET STATES"
The scrollbar automatically sets the \fBdisabled\fR state bit.
when the entire range is visible (range is 0.0 to 1.0),
and clears it otherwise.
It also sets the \fBactive\fR and \fBpressed\fR state flags
of individual elements, based on the position and state of the mouse pointer.
+
.SH EXAMPLE
.CS
set f [frame .f]
@@ -156,5 +159,9 @@ grid $f.hsb -row 1 -column 0 -sticky nsew
grid columnconfigure $f 0 -weight 1
grid rowconfigure $f 0 -weight 1
.CE
+
+.SH "SEE ALSO"
+ttk_widget(n), scrollbar(n)
+
.SH KEYWORDS
scrollbar, widget