tabnotebook.n

这是一个Linux下的集成开发环境

'\"
'\" Copyright (c) 1995 DSC Technologies Corporation
'\"
'\" See the file "license.terms" for information on usage and redistribution
'\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
'\"
'\" @(#) tabnotebook.n
'/"
.so man.macros
.HS tabnotebook iwid
.BS
'\" Note:  do not modify the .SH NAME line immediately below!
.SH NAME
tabnotebook \- create and manipulate tabnotebook widgets
.SH SYNOPSIS
\fBtabnotebook\fR \fIpathName\fR? \fIoptions\fR?
.SH "INHERITANCE"
itk::Widget <- tabnotebook
.SH "STANDARD OPTIONS"
.LP
.nf
.ta 4c 8c 12c
\fBbackground\fR	\fBdisabledForeground\fR	\fBforeground\fR	\fBscrollCommand\fR
\fBcursor\fR	\fBfont\fR	\fBheight\fR	\fBwidth\fR
.fi
.LP
See the "options" manual entry for details on the standard options.
.SH "WIDGET-SPECIFIC OPTIONS"
.LP
.nf
Name:	\fBangle\fR
Class:	\fBAngle\fR
Command-Line Switch:	\fB-angle\fR
.fi
.IP
Specifes the angle of slope from the inner edge to the outer edge of the tab. 
An angle of 0 specifies square tabs. Valid ranges are 0 to 45 degrees 
inclusive. Default is 15 degrees. If \fBtabPos\fR is e or w, this option 
is ignored.
.LP
.nf
Name:	\fBauto\fR
Class:	\fBAuto\fR
Command-Line Switch:	\fB-auto\fR
.fi
.IP
Specifies whether to use the automatic packing/unpacking algorithm of the 
notebook. A value of true indicates that page frames will be unpacked and 
packed acoording to the algorithm described in the select command. A value 
of \fBfalse\fR leaves the current page packed and 
subsequent \fBselects\fR, \fBnext\fR, or \fBprevious\fR commands do not 
switch pages automatically. In either case the page's associated 
command (see the \fBadd\fR command's description of the command option) is 
invoked. The value may have any of the forms accepted by 
the \fBTcl_GetBoolean\fR, such as \fBtrue\fR, \fBfalse\fR, \fB0\fR, 
\fB1\fR, \fByes\fR, or \fBno\fR.
.LP
.nf
Name:	\fBbackdrop\fR
Class:	\fBBackdrop\fR
Command-Line Switch:	\fB-backdrop\fR
.fi
.IP
Specifies a background color to use when filling in the backdrop area 
behind the tabs.
.LP
.nf
Name:	\fBbackground\fR
Class:	\fBBackground\fR
Command-Line Switch:	\fB-background\fR
.fi
.IP
Specifies a background color to use for displaying a page and its associated 
tab. This can be thought of as the selected tab background color, since the 
tab associated with the selected page is the selected tab.
.LP
.nf
Name:	\fBbevelAmount\fR
Class:	\fBBevelAmount\fR
Command-Line Switch:	\fB-bevelamount\fR
.fi
.IP
Specifes the size of tab corners. A value of 0 with \fBangle\fR set to 
0 results in square tabs. A \fBbevelAmount\fR of 4, means that the tab will 
be drawn with angled corners that cut in 4 pixels from the edge of 
the tab. The default is 0.
.LP
.nf
Name:	\fBborderWidth\fR
Class:	\fBBorderWidth\fR
Command-Line Switch:	\fB-borderwidth\fR
.fi
.IP
Specifies the width of shadowed border to place around the notebook area of 
the tabnotebook. The default value is 2.
.LP
.nf
Name:	\fBdisabledForeground\fR
Class:	\fBDisabledForeground\fR
Command-Line Switch:	\fB-disabledforeground\fR
.fi
.IP
Specifies a foreground color to use for displaying a tab's label when 
its \fBstate\fR is disabled.
.LP
.nf
Name:	\fBequalTabs\fR
Class:	\fBEqualTabs\fR
Command-Line Switch:	\fB-equaltabs\fR
.fi
.IP
Specifies whether to force tabs to be equal sized or not. A value 
of \fBtrue\fR means constrain tabs to be equal sized. A value 
of \fBfalse\fR allows each tab to size based on the text label size. The 
value may have any of the forms accepted by the \fBTcl_GetBoolean\fR, such 
as \fBtrue\fR, \fBfalse\fR, \fB0\fR, \fB1\fR, \fByes\fR, or \fBno\fR.
.IP
For horizontally positioned tabs (\fBtabpos\fR is either \fBs\fR or \fBn\fR),
\fBtrue\fR forces all tabs to be equal width (the width being equal to 
the longest label plus any \fBpadX\fR specified). Horizontal tabs are 
always equal in height. 
.IP
For vertically positioned tabs (\fBtabpos\fR is either \fBw\fR or \fBe\fR), 
\fBtrue\fR forces all tabs to be equal height (the height being equal to the 
height of the label with the largest font). Vertically oriented tabs 
are always equal in width.
.LP
.nf
Name:	\fBforeground\fR
Class:	\fBForeground\fR
Command-Line Switch:	\fB-foreground\fR
.fi
.IP
Specifies a foreground color to use for displaying a page and its associated 
tab label. This can be thought of as the selected tab background color, 
since the tab associated with the selected page is the selected tab.
.LP
.nf
Name:	\fBgap\fR
Class:	\fBGap\fR
Command-Line Switch:	\fB-gap\fR
.fi
.IP
Specifies the amount of pixel space to place between each tab. Value may 
be any pixel offset value. In addition, a special keyword \fBoverlap\fR 
can be used as the value to achieve a standard overlap of tabs. This value 
may have any of the forms acceptable to \fBTk_GetPixels\fR.
.LP
.nf
Name:	\fBmargin\fR
Class:	\fBMargin\fR
Command-Line Switch:	\fB-Bmargin\fR
.fi
.IP
Specifies the amount of space to place between the outside edge of the 
tabnotebook and the outside edge of its tabs. If \fBtabPos\fR is \fBs\fR, 
this is the amount of space between the bottom edge of the tabnotebook and 
the bottom edge of the set of tabs. If \fBtabPos\fR is \fBn\fR, this is 
the amount of space between the top edge of the tabnotebook and the top 
edge of the set of tabs. If \fBtabPos\fR is \fBe\fR, this is the amount of 
space between the right edge of the tabnotebook and the right edge of the 
set of tabs. If \fBtabPos\fR is \fBw\fR, this is the amount of space 
between the left edge of the tabnotebook and the left edge of the set 
of tabs. This value may have any of the forms acceptable to \fBTk_GetPixels\fR.
.LP
.nf
Name:	\fBpadX\fR
Class:	\fBPadX\fR
Command-Line Switch:	\fB-padx\fR
.fi
.IP
Specifies a non-negative value indicating how much extra space to request 
for a tab around its label in the X-direction. When computing how large 
a window it needs, the tab will add this amount to the width it would 
normally need The tab will end up with extra internal space to the left 
and right of its text label. This value may have any of the forms acceptable 
to \fBTk_GetPixels\fR.
.LP
.nf
Name:	\fBpadY\fR
Class:	\fBPadY\fR
Command-Line Switch:	\fB-pady\fR
.fi
.IP
Specifies a non-negative value indicating how much extra space to request for 
a tab around its label in the Y-direction. When computing how large a 
window it needs, the tab will add this amount to the height it would normally 
need The tab will end up with extra internal space to the top and bottom of 
its text label. This value may have any of the forms acceptable 
to \fBTk_GetPixels\fR.
.LP
.nf
Name:	\fBraiseSelect\fR
Class:	\fBRaiseSelect\fR
Command-Line Switch:	\fB-raiseselect\fR
.fi
.IP
Specifes whether to slightly raise the selected tab from the rest of the 
tabs. The selected tab is drawn 2 pixels closer to the outside of the 
tabnotebook than the unselected tabs. A value of \fBtrue\fR says to 
raise selected tabs, a value of \fBfalse\fR turns this feature off. The 
default is \fBfalse\fR. The value may have any of the forms accepted 
by the \fBTcl_GetBoolean\fR, such as \fBtrue\fR, \fBfalse\fR, \fB0\fR, 
\fB1\fR, \fByes\fR, or \fBno\fR.
.LP
.nf
Name:	\fBstart\fR
Class:	\fBStart\fR
Command-Line Switch:	\fB-start\fR
.fi
.IP
Specifies the amount of space to place between the left or top edge of the 
tabnotebook and the starting edge of its tabs. For horizontally positioned 
tabs, this is the amount of space between the left edge of the notebook and 
the left edge of the first tab. For vertically positioned tabs, this is the 
amount of space between the top of the notebook and the top of the first 
tab. This value may change if the user performs a MButton-2 scroll on the 
tabs. This value may have any of the forms acceptable to \fBTk_GetPixels\fR.
.LP
.nf
Name:	\fBstate\fR
Class:	\fBState\fR
Command-Line Switch:	\fB-state\fR
.fi
.IP
Sets the active state of the tabnotebook. Specifying \fBnormal\fR allows 
all pages to be selectable. Specifying \fBdisabled\fR disables the notebook 
causing all page tabs to be drawn in the \fBdisabledForeground\fR color.
.LP
.nf
Name:	\fBtabBackground\fR
Class:	\fBTabBackground\fR
Command-Line Switch:	\fB-tabbackground\fR
.fi
.IP
Specifies a background color to use for displaying tab backgrounds when 
they are in their unselected state. This is the background associated with 
tabs on all pages other than the selected page.
.LP
.nf
Name:	\fBtabBorders\fR
Class:	\fBTabBorders\fR
Command-Line Switch:	\fB-tabborders\fR
.fi
.IP
Specifies whether to draw the borders of tabs that are not selected. 
Specifying \fBtrue\fR (the default) draws these borders, 
specifying \fBfalse\fR draws only the border around the selected tab. The 
value may have any of the forms accepted by the \fBTcl_GetBoolean\fR, 
such as \fBtrue\fR, \fBfalse\fR, \fB0\fR, \fB1\fR,\fB yes\fR, or \fBno\fR.
.LP
.nf
Name:	\fBtabForeground\fR
Class:	\fBTabForeground\fR
Command-Line Switch:	\fB-tabforeground\fR
.fi
.IP
Specifies a foreground color to use for displaying tab labels when they 
are in their unselected state. This is the foreground associated with tabs 
on all pages other than the selected page.
.LP
.nf
Name:	\fBtabPos\fR
Class:	\fBTabPos\fR
Command-Line Switch:	\fB-tabpos\fR
.fi
.IP
Specifies the location of the set of tabs in relation to the notebook 
area. Must be n, s, e, or w. Defaults to s.
.BE
.SH DESCRIPTION
.PP
The \fBtabnotebook\fR command creates a new window (given by the pathName 
argument) and makes it into a \fBtabnotebook\fR widget. Additional options, 
described above may be specified on the command line or in the option 
database to configure aspects of the tabnotebook such as its colors, font, 
and text. The tabnotebook command returns its pathName argument. At the 
time this command is invoked, there must not exist a window named 
pathName, but pathName's parent must exist.
.PP
A \fBtabnotebook\fR is a widget that contains a set of tabbed pages. It 
displays one page from the set as the selected page. A Tab displays the 
label for the page to which it is attached and serves as a page 
selector. When a page's tab is selected, the page's contents are displayed 
in the page area. The selected tab has a three-dimensional effect to make 
it appear to float above the other tabs. The tabs are displayed as a group 
along either the left, top, right, or bottom edge. When first created a 
tabnotebook has no pages. Pages may be added or deleted using widget 
commands described below.
.PP
A special option may be provided to the tabnotebook. The \fB-auto\fR 
option specifies whether the tabnotebook will automatically handle the 
unpacking and packing of pages when pages are selected. A value of 
true signifies that the notebook will automatically manage it. This is the 
default value. A value of false signifies the notebook will not perform 
automatic switching of pages.
.SH NOTEBOOK PAGES
A tabnotebook's pages area contains a single child site frame. When a 
new page is created it is a child of this frame. The page's child site 
frame serves as a geometry container for applications to pack widgets 
into. It is this frame that is automatically unpacked or packed when 
the auto option is true. This creates the effect of one page being visible 
at a time. When a new page is selected, the previously selected page's 
child site frame is automatically unpacked from the tabnotebook's child 
site frame and the newly selected page's child site is packed into the 
tabnotebook's child site frame.
.PP
However, sometimes it is desirable to handle page changes in a different 
manner. By specifying the \fBauto\fR option as \fBfalse\fR, child site 
packing can be disabled and done differently. For example, all widgets 
might be packed into the first page's child site \fBframe\fR. Then when 
a new page is selected, the application can reconfigure the widgets 
and give the appearance that the page was flipped.
.PP
In both cases the command option for a page specifies a Tcl Command 
to execute when the page is selected. In the case of \fBauto\fR 
being \fBtrue\fR, it is between the unpacking of the previously selected 
page and the packing of the newly selected page.
.PP
Notebook pages can also be controlled with scroll bars or other widgets 
that obey the \fBscrollcommand\fR protocol. By giving a scrollbar 
a \fB-command\fR to call the tabnotebook's \fBselect\fR method, the 
tabnotebook can be controlled with a scrollbar.
.PP
The notebook area is implemented with the notebook mega widget.
.SH TABS
Tabs appear along the edge of the notebook area. Tabs are drawn to appear 
attached to their associated page. When a tab is clicked on, the associated 
page is selected and the tab is drawn as raised above all other tabs and as