head	1.15;
access;
symbols
	core-8-5-9:1.12.2.2
	core-8-5-8:1.12.2.1
	macosx-cocoa-merge:1.15
	macosx-cocoa-premerge:1.15
	macosx-carbon-freeze:1.15
	core-8-5-7:1.12.2.1
	core-8-5-6:1.12.2.1
	core-8-6-b1:1.15
	core-8-6-a3:1.15
	core-8-5-5:1.12.2.1
	core-8-6-a2:1.14
	core-8-5-4:1.12.2.1
	core-8-5-3:1.12.2.1
	core-8-6-a1:1.13
	core-8-5-branch:1.12.0.2
	core-8-5-2:1.12
	core-8-5-1:1.12
	core-8-5-0:1.11
	core-8-5-b3:1.9
	core-8-5-b2:1.6
	core-8-5-b1:1.3
	core-stablilizer-merge:1.3
	core-stabilizer-branch:1.3.0.2
	core-stabilizer-merge:1.12.2.1
	core-8-5-a6:1.3;
locks; strict;
comment	@# @;


1.15
date	2008.09.23.13.36.57;	author dkf;	state Exp;
branches;
next	1.14;

1.14
date	2008.06.30.22.57.03;	author dkf;	state Exp;
branches;
next	1.13;

1.13
date	2008.05.09.18.35.00;	author patthoyts;	state Exp;
branches;
next	1.12;

1.12
date	2008.01.29.15.38.00;	author dkf;	state Exp;
branches
	1.12.2.1;
next	1.11;

1.11
date	2007.12.13.15.23.44;	author dgp;	state Exp;
branches;
next	1.10;

1.10
date	2007.12.10.16.21.01;	author jenglish;	state Exp;
branches;
next	1.9;

1.9
date	2007.11.01.10.59.43;	author dkf;	state Exp;
branches;
next	1.8;

1.8
date	2007.10.30.21.29.59;	author dkf;	state Exp;
branches;
next	1.7;

1.7
date	2007.10.29.16.04.14;	author dkf;	state Exp;
branches;
next	1.6;

1.6
date	2007.10.26.20.13.23;	author dgp;	state Exp;
branches;
next	1.5;

1.5
date	2007.10.23.15.44.36;	author dkf;	state Exp;
branches;
next	1.4;

1.4
date	2007.10.22.14.33.13;	author dkf;	state Exp;
branches;
next	1.3;

1.3
date	2006.12.13.23.04.33;	author hobbs;	state Exp;
branches
	1.3.2.1;
next	1.2;

1.2
date	2006.11.15.13.29.17;	author dkf;	state Exp;
branches;
next	1.1;

1.1
date	2006.10.31.01.42.25;	author hobbs;	state Exp;
branches;
next	;

1.3.2.1
date	2007.10.24.12.59.31;	author dgp;	state Exp;
branches;
next	1.3.2.2;

1.3.2.2
date	2007.10.27.04.23.15;	author dgp;	state Exp;
branches;
next	1.3.2.3;

1.3.2.3
date	2007.11.01.16.37.16;	author dgp;	state Exp;
branches;
next	1.3.2.4;

1.3.2.4
date	2007.12.10.18.39.28;	author dgp;	state Exp;
branches;
next	1.3.2.5;

1.3.2.5
date	2008.01.29.17.35.51;	author dgp;	state Exp;
branches;
next	1.3.2.6;

1.3.2.6
date	2008.06.25.16.46.02;	author dgp;	state Exp;
branches;
next	;

1.12.2.1
date	2008.05.11.00.31.03;	author patthoyts;	state Exp;
branches;
next	1.12.2.2;

1.12.2.2
date	2010.08.26.02.06.09;	author hobbs;	state Exp;
branches;
next	;


desc
@@


1.15
log
@Fix [Bug 2118116]
@
text
@'\"
'\" 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.
'\" 
'\" SOURCE: tk/doc/scrollbar.n, r1.4
'\" 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"
.BS
.SH NAME
ttk::scrollbar \- Control the viewport of a scrollable widget 
.SH SYNOPSIS
\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.
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 ttk_widget
\-class	\-cursor	\-style
\-takefocus
.SE
.SH "WIDGET-SPECIFIC OPTIONS"
.OP \-command command Command
A Tcl script prefix to evaluate 
to change the view in the widget associated with the scrollbar.
Additional arguments are appended to the value of this option,
as described in \fBSCROLLING COMMANDS\fR below,
whenever the user requests a view change by manipulating the scrollbar.
.RS
.PP
This option typically consists of a two-element list,
containing the name of a scrollable widget followed by
either \fBxview\fR (for horizontal scrollbars)
or \fByview\fR (for vertical scrollbars).
.RE
.OP \-orient orient Orient
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.
.TP
\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\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 \fBidentify\fR \fIx y\fR
Returns the name of the element at position \fIx\fR, \fIy\fR.
See \fIttk::widget(n)\fR.
.TP
\fIpathName \fBinstate \fIstatespec\fR ?\fIscript\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 
from an \fB\-xscrollcommand\fR or \fB\-yscrollcommand\fR callback.
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 \fIttk::widget(n)\fR.
.SH "INTERNAL COMMANDS"
.PP
The following widget commands are used internally
by the TScrollbar widget class bindings.
.TP
\fIpathName \fBdelta \fIdeltaX deltaY\fR
Returns a real number indicating the fractional change in
the scrollbar setting that corresponds to a given change
in thumb position.  For example, if the scrollbar is horizontal,
the result indicates how much the scrollbar setting must change
to move the thumb \fIdeltaX\fR pixels to the right (\fIdeltaY\fR is
ignored in this case).
If the scrollbar is vertical, the result indicates how much the
scrollbar setting must change to move the thumb \fIdeltaY\fR pixels
down.  The arguments and the result may be zero or negative.
.TP
\fIpathName \fBfraction \fIx y\fR
Returns a real number between 0 and 1 indicating where the point
given by \fIx\fR and \fIy\fR lies in the trough area of the scrollbar,
where 0.0 corresponds to the top or left of the trough
and 1.0 corresponds to the bottom or right.
\fIX\fR and \fIy\fR are pixel coordinates relative to the scrollbar
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.
The scrollbar makes the notification by evaluating a Tcl command
generated from the scrollbar's \fB\-command\fR option.
The command may take any of the following forms.
In each case, \fIprefix\fR is the contents of the
\fB\-command\fR option, which usually has a form like \fB.t yview\fR
.TP
\fIprefix \fBmoveto \fIfraction\fR
\fIFraction\fR is a real number between 0 and 1.
The widget should adjust its view so that the point given
by \fIfraction\fR appears at the beginning of the widget.
If \fIfraction\fR is 0 it refers to the beginning of the
document.  1.0 refers to the end of the document, 0.333
refers to a point one-third of the way through the document,
and so on.
.TP
\fIprefix \fBscroll \fInumber \fBunits\fR
The widget should adjust its view by \fInumber\fR units.
The units are defined in whatever way makes sense for the widget,
such as characters or lines in a text widget.
\fINumber\fR is either 1, which means one unit should scroll off
the top or left of the window, or \-1, which means that one unit
should scroll off the bottom or right of the window.
.TP
\fIprefix \fBscroll \fInumber \fBpages\fR
The widget should adjust its view by \fInumber\fR pages.
It is up to the widget to define the meaning of a page;  typically
it is slightly less than what fits in the window, so that there
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"
.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]
ttk::scrollbar $f.vsb \-orient vertical \-command [list $f.t yview]
text $f.t \-xscrollcommand [list $f.hsb set] \-yscrollcommand [list $f.vsb set] 
grid $f.t \-row 0 \-column 0 \-sticky nsew
grid $f.vsb \-row 0 \-column 1 \-sticky nsew
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
'\" Local Variables:
'\" mode: nroff
'\" End:
@


1.14
log
@Minor doc updates (removing out of date changebars, improving typedef formatting,
 etc.)
@
text
@a0 1
'\" -*- nroff -*-
d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.13 2008/05/09 18:35:00 patthoyts Exp $
d164 3
@


1.13
log
@Document the identify command as present on all ttk widgets
@
text
@d1 1
d10 1
a10 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.12 2008/01/29 15:38:00 dkf Exp $
d21 1
d53 1
d81 1
d106 1
d142 1
d149 1
@


1.12
log
@Adjusted handling of the standard options part of the Ttk manual pages so
that they are documented in the correct location. [Bug 1876493]
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.11 2007/12/13 15:23:44 dgp Exp $
d62 4
a100 6
.TP
\fIpathName \fBidentify\fR \fIx y\fR
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.
@


1.12.2.1
log
@Backported documentation fixes from HEAD
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.13 2008/05/09 18:35:00 patthoyts Exp $
a61 4
\fIpathName \fBidentify\fR \fIx y\fR
Returns the name of the element at position \fIx\fR, \fIy\fR.
See \fIttk::widget(n)\fR.
.TP
d97 6
@


1.12.2.2
log
@        Major backport of 8.6 Ttk for 8.5.9.  Most changes were only being
        committed to head (8.6), although they could apply for 8.5 as well.
        This re-sync makes future work easier to maintain and adds some
        useful work for 8.5 users. Notable changes:
        - Lots of code cleanup
        - Some bug fixes never backported
        - Addition of ttk::spinbox
        - minor color changes
        - Improved Vista/7 styling
        - Move to tile version 0.8.6 (pseudo-package)
        - ABI and API compatible (even $w identify)
        - minor new features (extended $w identify)
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.15 2008/09/23 13:36:57 dkf Exp $
a19 1
.PP
a50 1
.PP
a77 1
.PP
a101 1
.PP
a136 1
.PP
a142 1
.PP
a157 3
'\" Local Variables:
'\" mode: nroff
'\" End:
@


1.11
log
@merge stable branch onto HEAD
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.3.2.4 2007/12/10 18:39:28 dgp Exp $
d29 3
a31 2
.SO
\-class	\-cursor	\-style	\-takefocus
@


1.10
log
@Remove extra .BEs that got added by mistake somewhere.
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.9 2007/11/01 10:59:43 dkf Exp $
@


1.9
log
@Make documentation use the name that scripts use as much as possible.
[Bug 1640073]
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.8 2007/10/30 21:29:59 dkf Exp $
a48 1
.BE
@


1.8
log
@More documentation improvements
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.7 2007/10/29 16:04:14 dkf Exp $
d12 1
a12 1
.TH ttk_scrollbar n 8.5 Tk "Tk Themed Widget"
a13 1
.\" Use _ instead of :: as the name becomes a filename on install
d15 1
a15 1
ttk_scrollbar \- Control the viewport of a scrollable widget 
d53 1
a53 1
Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR.
d56 1
a56 1
Modify or query widget options; see \fIttk_widget(n)\fR.
d63 1
a63 1
Test the widget state; see \fIttk_widget(n)\fR.
d72 1
a72 1
Modify or query the widget state; see \fIttk_widget(n)\fR.
d157 1
a157 1
ttk_widget(n), scrollbar(n)
@


1.7
log
@Lots more GOOBE stuff. Now works with 'make html'!
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.6 2007/10/26 20:13:23 dgp Exp $
d40 2
a41 1
.br
d46 1
@


1.6
log
@        * doc/*.1:              Revert doc changes that broke
        * doc/*.3:              `make html` so we can get the release
        * doc/*.n:              out the door.
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $
a19 1

a32 1

a48 1

d66 1
a66 1
from an \fB-xscrollcommand\fR or \fB-yscrollcommand\fR callback.
a71 1

a101 1

a136 1

a142 1

d146 8
a153 8
ttk::scrollbar $f.hsb -orient horizontal -command [list $f.t xview]
ttk::scrollbar $f.vsb -orient vertical -command [list $f.t yview]
text $f.t -xscrollcommand [list $f.hsb set] -yscrollcommand [list $f.vsb set] 
grid $f.t -row 0 -column 0 -sticky nsew
grid $f.vsb -row 0 -column 1 -sticky nsew
grid $f.hsb -row 1 -column 0 -sticky nsew
grid columnconfigure $f 0 -weight 1
grid rowconfigure $f 0 -weight 1
a154 1

a156 1

@


1.5
log
@Rendering-with-groff GOOBE.
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.4 2007/10/22 14:33:13 dkf Exp $
d22 9
a30 8
\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.
d32 1
a32 2
\-class	\-cursor	\-style
\-takefocus
d34 1
d37 9
a45 8
A Tcl script prefix to evaluate to change the view in the widget associated
with the scrollbar. Additional arguments are appended to the value of this
option, as described in \fBSCROLLING COMMANDS\fR below, whenever the user
requests a view change by manipulating the scrollbar.
.RS
.PP
This option typically consists of a two-element list, containing the name of a
scrollable widget followed by either \fBxview\fR (for horizontal scrollbars)
a46 1
.RE
d48 2
a49 2
One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the
scrollbar.
d51 1
d55 1
a55 3
.
Returns the current value of the specified \fIoption\fR; see
\fIttk_widget(n)\fR.
a57 1
.
d61 2
a62 3
.
Returns the scrollbar settings in the form of a list whose elements are the
arguments to the most recent \fBset\fR widget command.
a64 1
.
d68 4
a71 5
.
This command is normally invoked by the scrollbar's associated widget from an
\fB\-xscrollcommand\fR or \fB\-yscrollcommand\fR callback. Specifies the
visible range to be displayed. \fIfirst\fR and \fIlast\fR are real fractions
between 0 and 1.
a73 1
.
d75 1
d77 2
a78 2
The following widget commands are used internally by the TScrollbar widget
class bindings.
d81 9
a89 9
.
Returns a real number indicating the fractional change in the scrollbar
setting that corresponds to a given change in thumb position. For example, if
the scrollbar is horizontal, the result indicates how much the scrollbar
setting must change to move the thumb \fIdeltaX\fR pixels to the right
(\fIdeltaY\fR is ignored in this case). If the scrollbar is vertical, the
result indicates how much the scrollbar setting must change to move the thumb
\fIdeltaY\fR pixels down. The arguments and the result may be zero or
negative.
d92 8
a99 7
.
Returns a real number between 0 and 1 indicating where the point given by
\fIx\fR and \fIy\fR lies in the trough area of the scrollbar, where 0.0
corresponds to the top or left of the trough and 1.0 corresponds to the bottom
or right. \fIX\fR and \fIy\fR are pixel coordinates relative to the scrollbar
widget. If \fIx\fR and \fIy\fR refer to a point outside the trough, the
closest point in the trough is used.
d102 3
a104 3
.
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.
d106 1
d108 7
a114 5
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.
The scrollbar makes the notification by evaluating a Tcl command generated
from the scrollbar's \fB\-command\fR option. The command may take any of the
following forms. In each case, \fIprefix\fR is the contents of the
d118 7
a124 6
.
\fIFraction\fR is a real number between 0 and 1. The widget should adjust its
view so that the point given by \fIfraction\fR appears at the beginning of the
widget. If \fIfraction\fR is 0 it refers to the beginning of the document. 1.0
refers to the end of the document, 0.333 refers to a point one-third of the
way through the document, and so on.
d127 6
a132 6
.
The widget should adjust its view by \fInumber\fR units. The units are defined
in whatever way makes sense for the widget, such as characters or lines in a
text widget. \fINumber\fR is either 1, which means one unit should scroll off
the top or left of the window, or \-1, which means that one unit should scroll
off the bottom or right of the window.
d135 8
a142 6
.
The widget should adjust its view by \fInumber\fR pages. It is up to the
widget to define the meaning of a page; typically it is slightly less than
what fits in the window, so that there 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.
d144 6
a149 4
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.
d153 3
a155 6
ttk::scrollbar $f.hsb -orient horizontal \e
        -command [list $f.t xview]
ttk::scrollbar $f.vsb -orient vertical \e
        -command [list $f.t yview]
text $f.t -xscrollcommand [list $f.hsb set] \e
        -yscrollcommand [list $f.vsb set]
d162 1
d165 1
@


1.4
log
@Documentation improvements, all minor.
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $
d31 2
a32 1
\-class	\-cursor	\-style	\-takefocus
a33 1

d40 2
a41 1
.br
d45 1
a49 1

a79 1

a108 1

a139 1

a144 1

d148 6
a153 3
ttk::scrollbar $f.hsb -orient horizontal -command [list $f.t xview]
ttk::scrollbar $f.vsb -orient vertical -command [list $f.t yview]
text $f.t -xscrollcommand [list $f.hsb set] -yscrollcommand [list $f.vsb set]
a159 1

a161 1

@


1.3
log
@	* 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".
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: popup.n,v 1.4 2004/06/21 20:59:29 dkf Exp $
d22 8
a29 9
\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.
d36 4
a39 5
A Tcl script prefix to evaluate 
to change the view in the widget associated with the scrollbar.
Additional arguments are appended to the value of this option,
as described in \fBSCROLLING COMMANDS\fR below,
whenever the user requests a view change by manipulating the scrollbar.
d41 2
a42 3
This option typically consists of a two-element list,
containing the name of a scrollable widget followed by
either \fBxview\fR (for horizontal scrollbars)
d45 2
a46 2
One of \fBhorizontal\fR or \fBvertical\fR.
Specifies the orientation of the scrollbar.
d52 3
a54 1
Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR.
d57 1
d61 3
a63 2
Returns the scrollbar settings in the form of a list whose
elements are the arguments to the most recent \fBset\fR widget command.
d66 1
d70 5
a74 4
This command is normally invoked by the scrollbar's associated widget 
from an \fB-xscrollcommand\fR or \fB-yscrollcommand\fR callback.
Specifies the visible range to be displayed.
\fIfirst\fR and \fIlast\fR are real fractions between 0 and 1.
d77 1
d81 2
a82 2
The following widget commands are used internally
by the TScrollbar widget class bindings.
d85 9
a93 9
Returns a real number indicating the fractional change in
the scrollbar setting that corresponds to a given change
in thumb position.  For example, if the scrollbar is horizontal,
the result indicates how much the scrollbar setting must change
to move the thumb \fIdeltaX\fR pixels to the right (\fIdeltaY\fR is
ignored in this case).
If the scrollbar is vertical, the result indicates how much the
scrollbar setting must change to move the thumb \fIdeltaY\fR pixels
down.  The arguments and the result may be zero or negative.
d96 7
a102 8
Returns a real number between 0 and 1 indicating where the point
given by \fIx\fR and \fIy\fR lies in the trough area of the scrollbar,
where 0.0 corresponds to the top or left of the trough
and 1.0 corresponds to the bottom or right.
\fIX\fR and \fIy\fR are pixel coordinates relative to the scrollbar
widget.
If \fIx\fR and \fIy\fR refer to a point outside the trough, the closest
point in the trough is used.
d105 3
a107 3
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.
d111 5
a115 7
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.
The scrollbar makes the notification by evaluating a Tcl command
generated from the scrollbar's \fB\-command\fR option.
The command may take any of the following forms.
In each case, \fIprefix\fR is the contents of the
d119 6
a124 7
\fIFraction\fR is a real number between 0 and 1.
The widget should adjust its view so that the point given
by \fIfraction\fR appears at the beginning of the widget.
If \fIfraction\fR is 0 it refers to the beginning of the
document.  1.0 refers to the end of the document, 0.333
refers to a point one-third of the way through the document,
and so on.
d127 6
a132 6
The widget should adjust its view by \fInumber\fR units.
The units are defined in whatever way makes sense for the widget,
such as characters or lines in a text widget.
\fINumber\fR is either 1, which means one unit should scroll off
the top or left of the window, or \-1, which means that one unit
should scroll off the bottom or right of the window.
d135 6
a140 7
The widget should adjust its view by \fInumber\fR pages.
It is up to the widget to define the meaning of a page;  typically
it is slightly less than what fits in the window, so that there
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.
d143 4
a146 5
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.
d153 1
a153 1
text $f.t -xscrollcommand [list $f.hsb set] -yscrollcommand [list $f.vsb set] 
@


1.3.2.1
log
@merge updates from HEAD
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.3 2006/12/13 23:04:33 hobbs Exp $
d22 9
a30 8
\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.
d32 1
a32 2
\-class	\-cursor	\-style
\-takefocus
d34 1
d37 9
a45 8
A Tcl script prefix to evaluate to change the view in the widget associated
with the scrollbar. Additional arguments are appended to the value of this
option, as described in \fBSCROLLING COMMANDS\fR below, whenever the user
requests a view change by manipulating the scrollbar.
.RS
.PP
This option typically consists of a two-element list, containing the name of a
scrollable widget followed by either \fBxview\fR (for horizontal scrollbars)
a46 1
.RE
d48 2
a49 2
One of \fBhorizontal\fR or \fBvertical\fR. Specifies the orientation of the
scrollbar.
d51 1
d55 1
a55 3
.
Returns the current value of the specified \fIoption\fR; see
\fIttk_widget(n)\fR.
a57 1
.
d61 2
a62 3
.
Returns the scrollbar settings in the form of a list whose elements are the
arguments to the most recent \fBset\fR widget command.
a64 1
.
d68 4
a71 5
.
This command is normally invoked by the scrollbar's associated widget from an
\fB\-xscrollcommand\fR or \fB\-yscrollcommand\fR callback. Specifies the
visible range to be displayed. \fIfirst\fR and \fIlast\fR are real fractions
between 0 and 1.
a73 1
.
d75 1
d77 2
a78 2
The following widget commands are used internally by the TScrollbar widget
class bindings.
d81 9
a89 9
.
Returns a real number indicating the fractional change in the scrollbar
setting that corresponds to a given change in thumb position. For example, if
the scrollbar is horizontal, the result indicates how much the scrollbar
setting must change to move the thumb \fIdeltaX\fR pixels to the right
(\fIdeltaY\fR is ignored in this case). If the scrollbar is vertical, the
result indicates how much the scrollbar setting must change to move the thumb
\fIdeltaY\fR pixels down. The arguments and the result may be zero or
negative.
d92 8
a99 7
.
Returns a real number between 0 and 1 indicating where the point given by
\fIx\fR and \fIy\fR lies in the trough area of the scrollbar, where 0.0
corresponds to the top or left of the trough and 1.0 corresponds to the bottom
or right. \fIX\fR and \fIy\fR are pixel coordinates relative to the scrollbar
widget. If \fIx\fR and \fIy\fR refer to a point outside the trough, the
closest point in the trough is used.
d102 3
a104 3
.
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.
d106 1
d108 7
a114 5
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.
The scrollbar makes the notification by evaluating a Tcl command generated
from the scrollbar's \fB\-command\fR option. The command may take any of the
following forms. In each case, \fIprefix\fR is the contents of the
d118 7
a124 6
.
\fIFraction\fR is a real number between 0 and 1. The widget should adjust its
view so that the point given by \fIfraction\fR appears at the beginning of the
widget. If \fIfraction\fR is 0 it refers to the beginning of the document. 1.0
refers to the end of the document, 0.333 refers to a point one-third of the
way through the document, and so on.
d127 6
a132 6
.
The widget should adjust its view by \fInumber\fR units. The units are defined
in whatever way makes sense for the widget, such as characters or lines in a
text widget. \fINumber\fR is either 1, which means one unit should scroll off
the top or left of the window, or \-1, which means that one unit should scroll
off the bottom or right of the window.
d135 8
a142 6
.
The widget should adjust its view by \fInumber\fR pages. It is up to the
widget to define the meaning of a page; typically it is slightly less than
what fits in the window, so that there 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.
d144 6
a149 4
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.
d153 3
a155 6
ttk::scrollbar $f.hsb -orient horizontal \e
        -command [list $f.t xview]
ttk::scrollbar $f.vsb -orient vertical \e
        -command [list $f.t yview]
text $f.t -xscrollcommand [list $f.hsb set] \e
        -yscrollcommand [list $f.vsb set]
d162 1
d165 1
@


1.3.2.2
log
@merge updates from HEAD
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.3.2.1 2007/10/24 12:59:31 dgp Exp $
d22 8
a29 9
\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.
d31 2
a32 1
\-class	\-cursor	\-style	\-takefocus
a33 1

d36 8
a43 9
A Tcl script prefix to evaluate 
to change the view in the widget associated with the scrollbar.
Additional arguments are appended to the value of this option,
as described in \fBSCROLLING COMMANDS\fR below,
whenever the user requests a view change by manipulating the scrollbar.
.br
This option typically consists of a two-element list,
containing the name of a scrollable widget followed by
either \fBxview\fR (for horizontal scrollbars)
d45 1
d47 2
a48 2
One of \fBhorizontal\fR or \fBvertical\fR.
Specifies the orientation of the scrollbar.
a49 1

d53 3
a55 1
Returns the current value of the specified \fIoption\fR; see \fIttk_widget(n)\fR.
d58 1
d62 3
a64 2
Returns the scrollbar settings in the form of a list whose
elements are the arguments to the most recent \fBset\fR widget command.
d67 1
d71 5
a75 4
This command is normally invoked by the scrollbar's associated widget 
from an \fB-xscrollcommand\fR or \fB-yscrollcommand\fR callback.
Specifies the visible range to be displayed.
\fIfirst\fR and \fIlast\fR are real fractions between 0 and 1.
d78 1
a79 1

d81 2
a82 2
The following widget commands are used internally
by the TScrollbar widget class bindings.
d85 9
a93 9
Returns a real number indicating the fractional change in
the scrollbar setting that corresponds to a given change
in thumb position.  For example, if the scrollbar is horizontal,
the result indicates how much the scrollbar setting must change
to move the thumb \fIdeltaX\fR pixels to the right (\fIdeltaY\fR is
ignored in this case).
If the scrollbar is vertical, the result indicates how much the
scrollbar setting must change to move the thumb \fIdeltaY\fR pixels
down.  The arguments and the result may be zero or negative.
d96 7
a102 8
Returns a real number between 0 and 1 indicating where the point
given by \fIx\fR and \fIy\fR lies in the trough area of the scrollbar,
where 0.0 corresponds to the top or left of the trough
and 1.0 corresponds to the bottom or right.
\fIX\fR and \fIy\fR are pixel coordinates relative to the scrollbar
widget.
If \fIx\fR and \fIy\fR refer to a point outside the trough, the closest
point in the trough is used.
d105 3
a107 3
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.
a108 1

d110 5
a114 7
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.
The scrollbar makes the notification by evaluating a Tcl command
generated from the scrollbar's \fB\-command\fR option.
The command may take any of the following forms.
In each case, \fIprefix\fR is the contents of the
d118 6
a123 7
\fIFraction\fR is a real number between 0 and 1.
The widget should adjust its view so that the point given
by \fIfraction\fR appears at the beginning of the widget.
If \fIfraction\fR is 0 it refers to the beginning of the
document.  1.0 refers to the end of the document, 0.333
refers to a point one-third of the way through the document,
and so on.
d126 6
a131 6
The widget should adjust its view by \fInumber\fR units.
The units are defined in whatever way makes sense for the widget,
such as characters or lines in a text widget.
\fINumber\fR is either 1, which means one unit should scroll off
the top or left of the window, or \-1, which means that one unit
should scroll off the bottom or right of the window.
d134 6
a139 8
The widget should adjust its view by \fInumber\fR pages.
It is up to the widget to define the meaning of a page;  typically
it is slightly less than what fits in the window, so that there
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.

d141 4
a144 6
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.

d148 6
a153 3
ttk::scrollbar $f.hsb -orient horizontal -command [list $f.t xview]
ttk::scrollbar $f.vsb -orient vertical -command [list $f.t yview]
text $f.t -xscrollcommand [list $f.hsb set] -yscrollcommand [list $f.vsb set] 
a159 1

a161 1

@


1.3.2.3
log
@merge updates from HEAD
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id$
d12 1
a12 1
.TH ttk::scrollbar n 8.5 Tk "Tk Themed Widget"
d14 1
d16 1
a16 1
ttk::scrollbar \- Control the viewport of a scrollable widget 
d20 1
d34 1
d42 1
a42 2
.RS
.PP
a46 1
.RE
d51 1
d55 1
a55 1
Returns the current value of the specified \fIoption\fR; see \fIttk::widget(n)\fR.
d58 1
a58 1
Modify or query widget options; see \fIttk::widget(n)\fR.
d65 1
a65 1
Test the widget state; see \fIttk::widget(n)\fR.
d69 1
a69 1
from an \fB\-xscrollcommand\fR or \fB\-yscrollcommand\fR callback.
d74 2
a75 1
Modify or query the widget state; see \fIttk::widget(n)\fR.
d106 1
d142 1
d149 1
d153 8
a160 8
ttk::scrollbar $f.hsb \-orient horizontal \-command [list $f.t xview]
ttk::scrollbar $f.vsb \-orient vertical \-command [list $f.t yview]
text $f.t \-xscrollcommand [list $f.hsb set] \-yscrollcommand [list $f.vsb set] 
grid $f.t \-row 0 \-column 0 \-sticky nsew
grid $f.vsb \-row 0 \-column 1 \-sticky nsew
grid $f.hsb \-row 1 \-column 0 \-sticky nsew
grid columnconfigure $f 0 \-weight 1
grid rowconfigure $f 0 \-weight 1
d162 1
d164 2
a165 1
ttk::widget(n), scrollbar(n)
@


1.3.2.4
log
@merge updates from HEAD
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.3.2.3 2007/11/01 16:37:16 dgp Exp $
d49 1
@


1.3.2.5
log
@merge updates from HEAD
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.11 2007/12/13 15:23:44 dgp Exp $
d29 2
a30 3
.SO ttk_widget
\-class	\-cursor	\-style
\-takefocus
@


1.3.2.6
log
@merge updates from 8.5 branch
@
text
@d9 1
a9 1
'\" RCS: @@(#) $Id: ttk_scrollbar.n,v 1.3.2.5 2008/01/29 17:35:51 dgp Exp $
a61 4
\fIpathName \fBidentify\fR \fIx y\fR
Returns the name of the element at position \fIx\fR, \fIy\fR.
See \fIttk::widget(n)\fR.
.TP
d97 6
@


1.2
log
@Convert \fP to \fR so that man-page scrapers have an easier time.
@
text
@a1 3
'\" SOURCE: tk/doc/scrollbar.n, r1.4
'\"
'\" Copyright (c) 1990-1994 The Regents of the University of California.
d8 2
a9 1
'\" $Id: ttk_scrollbar.n,v 1.1 2006/10/31 01:42:25 hobbs Exp $
d14 1
d16 1
a16 1
ttk::scrollbar \- Control the viewport of a scrollable widget 
d19 12
d34 1
a51 13
.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.
d55 1
a55 1
Returns the current value of the specified \fIoption\fR; see \fIwidget(n)\fR.
d58 1
a58 1
Modify or query widget options; see \fIwidget(n)\fR.
d65 1
a65 1
Test the widget state; see \fIwidget(n)\fR.
d74 2
a75 1
Modify or query the widget state; see \fIwidget(n)\fR.
d106 1
d142 1
d149 1
d162 4
@


1.1
log
@	* doc/ttk_Geometry.3, doc/ttk_Theme.3, doc/ttk_button.n:
	* doc/ttk_checkbutton.n, doc/ttk_combobox.n, doc/ttk_dialog.n:
	* doc/ttk_entry.n, doc/ttk_frame.n, doc/ttk_image.n:
	* doc/ttk_intro.n, doc/ttk_label.n, doc/ttk_labelframe.n:
	* doc/ttk_menubutton.n, doc/ttk_notebook.n, doc/ttk_panedwindow.n:
	* doc/ttk_progressbar.n, doc/ttk_radiobutton.n, doc/ttk_scrollbar.n:
	* doc/ttk_separator.n, doc/ttk_sizegrip.n, doc/ttk_style.n:
	* doc/ttk_treeview.n, doc/ttk_widget.n,:
	* generic/ttk/ttk.decls, generic/ttk/ttkBlink.c:
	* generic/ttk/ttkButton.c, generic/ttk/ttkCache.c:
	* generic/ttk/ttkClamTheme.c, generic/ttk/ttkClassicTheme.c:
	* generic/ttk/ttkDecls.h, generic/ttk/ttkDefaultTheme.c:
	* generic/ttk/ttkElements.c, generic/ttk/ttkEntry.c:
	* generic/ttk/ttkFrame.c, generic/ttk/ttkImage.c:
	* generic/ttk/ttkInit.c, generic/ttk/ttkLabel.c:
	* generic/ttk/ttkLayout.c, generic/ttk/ttkManager.c:
	* generic/ttk/ttkManager.h, generic/ttk/ttkNotebook.c:
	* generic/ttk/ttkPanedwindow.c, generic/ttk/ttkProgress.c:
	* generic/ttk/ttkScale.c, generic/ttk/ttkScroll.c:
	* generic/ttk/ttkScrollbar.c, generic/ttk/ttkSeparator.c:
	* generic/ttk/ttkSquare.c, generic/ttk/ttkState.c:
	* generic/ttk/ttkStubInit.c, generic/ttk/ttkStubLib.c:
	* generic/ttk/ttkTagSet.c, generic/ttk/ttkTheme.c:
	* generic/ttk/ttkTheme.h, generic/ttk/ttkThemeInt.h:
	* generic/ttk/ttkTrace.c, generic/ttk/ttkTrack.c:
	* generic/ttk/ttkTreeview.c, generic/ttk/ttkWidget.c:
	* generic/ttk/ttkWidget.h:
	* library/demos/ttk_demo.tcl, library/demos/ttk_iconlib.tcl:
	* library/demos/ttk_repeater.tcl:
	* library/ttk/altTheme.tcl, library/ttk/aquaTheme.tcl:
	* library/ttk/button.tcl, library/ttk/clamTheme.tcl:
	* library/ttk/classicTheme.tcl, library/ttk/combobox.tcl:
	* library/ttk/cursors.tcl, library/ttk/defaults.tcl:
	* library/ttk/dialog.tcl, library/ttk/entry.tcl:
	* library/ttk/fonts.tcl, library/ttk/icons.tcl:
	* library/ttk/keynav.tcl, library/ttk/menubutton.tcl:
	* library/ttk/notebook.tcl, library/ttk/panedwindow.tcl:
	* library/ttk/progress.tcl, library/ttk/scale.tcl:
	* library/ttk/scrollbar.tcl, library/ttk/sizegrip.tcl:
	* library/ttk/treeview.tcl, library/ttk/ttk.tcl:
	* library/ttk/utils.tcl, library/ttk/winTheme.tcl:
	* library/ttk/xpTheme.tcl:
	* macosx/ttkMacOSXTheme.c:
	* tests/ttk/all.tcl, tests/ttk/bwidget.test, tests/ttk/combobox.test:
	* tests/ttk/entry.test, tests/ttk/image.test:
	* tests/ttk/labelframe.test, tests/ttk/layout.test:
	* tests/ttk/misc.test, tests/ttk/notebook.test:
	* tests/ttk/panedwindow.test, tests/ttk/progressbar.test:
	* tests/ttk/scrollbar.test, tests/ttk/treetags.test:
	* tests/ttk/treeview.test, tests/ttk/ttk.test, tests/ttk/validate.test:
	* win/ttkWinMonitor.c, win/ttkWinTheme.c, win/ttkWinXPTheme.c:
	First import of Ttk themed Tk widgets as branched from tile 0.7.8

	* generic/tkInt.h, generic/tkWindow.c: add Ttk_Init call, copy
	tk classic widgets to ::tk namespace.
	* library/tk.tcl: add source of ttk/ttk.tcl, define $::ttk::library.
	* unix/Makefile.in, win/Makefile.in: add Ttk build bits
	* win/configure, win/configure.in: check for uxtheme.h (XP theme).
@
text
@d11 1
a11 1
'\" $Id: scrollbar.n,v 1.3 2006/08/04 05:04:10 jenglish Exp $
d28 1
a28 1
as described in \fBSCROLLING COMMANDS\fP below,
d33 2
a34 2
either \fBxview\fP (for horizontal scrollbars)
or \fByview\fP (for vertical scrollbars).
d36 1
a36 1
One of \fBhorizontal\fP or \fBvertical\fP.
d56 1
a56 1
Returns the current value of the specified \fIoption\fP; see \fIwidget(n)\fP.
d59 1
a59 1
Modify or query widget options; see \fIwidget(n)\fP.
d66 1
a66 1
Test the widget state; see \fIwidget(n)\fP.
d70 1
a70 1
from an \fB-xscrollcommand\fP or \fB-yscrollcommand\fP callback.
d75 1
a75 1
Modify or query the widget state; see \fIwidget(n)\fP.
d142 1
a142 1
The scrollbar automatically sets the \fBdisabled\fP state bit.
d145 1
a145 1
It also sets the \fBactive\fP and \fBpressed\fP state flags
@

