summaryrefslogtreecommitdiffstats
path: root/doc/ttk_scrollbar.n
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ttk_scrollbar.n')
-rw-r--r--doc/ttk_scrollbar.n9
1 files changed, 8 insertions, 1 deletions
diff --git a/doc/ttk_scrollbar.n b/doc/ttk_scrollbar.n
index 5fa55f9..6874780 100644
--- a/doc/ttk_scrollbar.n
+++ b/doc/ttk_scrollbar.n
@@ -1,3 +1,4 @@
+'\" -*- nroff -*-
'\"
'\" Copyright (c) 1994-1996 Sun Microsystems, Inc.
'\" Copyright (c) 2004 Joe English
@@ -6,7 +7,7 @@
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" SOURCE: tk/doc/scrollbar.n, r1.4
-'\" RCS: @(#) $Id: ttk_scrollbar.n,v 1.13 2008/05/09 18:35:00 patthoyts Exp $
+'\" RCS: @(#) $Id: ttk_scrollbar.n,v 1.14 2008/06/30 22:57:03 dkf Exp $
'\"
.so man.macros
.TH ttk::scrollbar n 8.5 Tk "Tk Themed Widget"
@@ -17,6 +18,7 @@ ttk::scrollbar \- Control the viewport of a scrollable widget
\fBttk::scrollbar\fR \fIpathName \fR?\fIoptions...\fR?
.BE
.SH DESCRIPTION
+.PP
\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.
@@ -48,6 +50,7 @@ or \fByview\fR (for vertical scrollbars).
One of \fBhorizontal\fR or \fBvertical\fR.
Specifies the orientation of the scrollbar.
.SH "WIDGET COMMAND"
+.PP
.TP
\fIpathName \fBcget\fR \fIoption\fR
Returns the current value of the specified \fIoption\fR; see \fIttk::widget(n)\fR.
@@ -75,6 +78,7 @@ Specifies the visible range to be displayed.
\fIpathName \fBstate\fR ?\fIstateSpec\fR?
Modify or query the widget state; see \fIttk::widget(n)\fR.
.SH "INTERNAL COMMANDS"
+.PP
The following widget commands are used internally
by the TScrollbar widget class bindings.
.TP
@@ -99,6 +103,7 @@ widget.
If \fIx\fR and \fIy\fR refer to a point outside the trough, the closest
point in the trough is used.
.SH "SCROLLING COMMANDS"
+.PP
When the user interacts with the scrollbar, for example by dragging
the thumb, the scrollbar notifies the associated widget that it
must change its view.
@@ -134,12 +139,14 @@ is a slight overlap between the old and new views.
become visible, or \-1, which means that the previous page should
become visible.
.SH "WIDGET STATES"
+.PP
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
+.PP
.CS
set f [frame .f]
ttk::scrollbar $f.hsb \-orient horizontal \-command [list $f.t xview]