.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
.\" ========================================================================
.de Sh \" Subsection heading
.de Sp \" Vertical space (when we can't use .PP)
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
. tm Index:\\$1\t\\n%\t"\\$2"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. \" simple accents for nroff and troff
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
.\" ========================================================================
.TH Tk::Pane 3 "2000-12-30" "Tk800.023" "perl/Tk Documentation"
Tk::Pane \- A window panner
\& $pane = $mw->Scrolled(Pane, Name => 'fred',
\&\fBTk::Pane\fR provides a scrollable frame widget. Once created it can be
treated as a frame, except it is scrollable.
.IP "\fB\-gridded\fR => \fIdirection\fR" 4
.IX Item "-gridded => direction"
Specifies if the top and left edges of the pane should snap to a
grid column. This option is only useful if the widgets in the pane
are managed by the \fIgrid\fR geometry manager. Possible values are
\&\fBx\fR, \fBy\fR and \fBxy\fR.
.IP "\fB\-sticky\fR => \fIstyle\fR" 4
.IX Item "-sticky => style"
If Pane is larger than its requested dimensions, this option may be used to
position (or stretch) the slave within its cavity. \fIStyle\fR is a string that
contains zero or more of the characters n, s, e or w. The string can optionally
contains spaces or commas, but they are ignored. Each letter refers to a side
(north, south, east, or west) that the slave will \*(L"stick\*(R" to. If both n and s
(or e and w) are specified, the slave will be stretched to fill the entire
height (or width) of its cavity.
.IP "\fI$pane\fR\->\fBsee\fR(\fI$widget\fR ?,\fIoptions\fR?)" 4
.IX Item "$pane->see($widget ?,options?)"
Adjusts the view so that \fI$widget\fR is visable. Aditional parameters in
\&\fIoptions-value\fR pairs can be passed, each \fIoption-value\fR pair must be
.IP "\fB\-anchor\fR => \fIanchor\fR" 8
.IX Item "-anchor => anchor"
Specifies how to make the widget visable. If not given then as much of
the widget as possible is made visable.
Possible values are \fBn\fR, \fBs\fR, \fBw\fR, \fBe\fR, \fBnw\fR, \fBne\fR, \fBsw\fR and \fBse\fR.
This will cause an edge on the widget to be aligned with the corresponding
edge on the pane. for example \fBnw\fR will cause the top left of the widget
to be placed at the top left of the pane. \fBs\fR will cause the bottom of the
widget to be placed at the bottom of the pane, and as much of the widget
as possible made visable in the x direction.
.IP "\fI$pane\fR\->\fBxview\fR" 4
Returns a list containing two elements, both of which are real fractions
between 0 and 1. The first element gives the position of the left of the
window, relative to the Pane as a whole (0.5 means it is halfway through the
Pane, for example). The second element gives the position of the right of the
window, relative to the Pane as a whole.
.IP "\fI$pane\fR\->\fBxview\fR(\fI$widget\fR)" 4
.IX Item "$pane->xview($widget)"
Adjusts the view in the window so that \fIwidget\fR is displayed at the left of
.IP "\fI$pane\fR\->\fBxview\fR(\fBmoveto\fR => \fIfraction\fR)" 4
.IX Item "$pane->xview(moveto => fraction)"
Adjusts the view in the window so that \fIfraction\fR of the total width of the
Pane is off-screen to the left. fraction must be a fraction between 0 and 1.
.IP "\fI$pane\fR\->\fBxview\fR(\fBscroll\fR => \fInumber\fR, \fIwhat\fR)" 4
.IX Item "$pane->xview(scroll => number, what)"
This command shifts the view in the window left or right according to \fInumber\fR
and \fIwhat\fR. \fINumber\fR must be an integer. \fIWhat\fR must be either \fBunits\fR or
\&\fBpages\fR or an abbreviation of one of these. If \fIwhat\fR is \fBunits\fR, the view
adjusts left or right by \fInumber\fR*10 screen units on the display; if it is
\&\fBpages\fR then the view adjusts by number screenfuls. If number is negative then
widgets farther to the left become visible; if it is positive then widgets
farther to the right become visible.
.IP "\fI$pane\fR\->\fByview\fR" 4
Returns a list containing two elements, both of which are real fractions
between 0 and 1. The first element gives the position of the top of the
window, relative to the Pane as a whole (0.5 means it is halfway through the
Pane, for example). The second element gives the position of the bottom of the
window, relative to the Pane as a whole.
.IP "\fI$pane\fR\->\fByview\fR(\fI$widget\fR)" 4
.IX Item "$pane->yview($widget)"
Adjusts the view in the window so that \fIwidget\fR is displayed at the top of the
.IP "\fI$pane\fR\->\fByview\fR(\fBmoveto\fR => \fIfraction\fR)" 4
.IX Item "$pane->yview(moveto => fraction)"
Adjusts the view in the window so that \fIfraction\fR of the total width of the
Pane is off-screen to the top. fraction must be a fraction between 0 and 1.
.IP "\fI$pane\fR\->\fByview\fR(\fBscroll\fR => \fInumber\fR, \fIwhat\fR)" 4
.IX Item "$pane->yview(scroll => number, what)"
This command shifts the view in the window up or down according to \fInumber\fR
and \fIwhat\fR. \fINumber\fR must be an integer. \fIWhat\fR must be either \fBunits\fR or
\&\fBpages\fR or an abbreviation of one of these. If \fIwhat\fR is \fBunits\fR, the view
adjusts up or down by \fInumber\fR*10 screen units on the display; if it is
\&\fBpages\fR then the view adjusts by number screenfuls. If number is negative then
widgets farther up become visible; if it is positive then widgets farther down
Graham Barr <\fIgbarr@pobox.com\fR>
Copyright (c) 1997\-1998 Graham Barr. All rights reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
projects / OpenSPARC-T2-DV / blob