labelframe.n
上传用户:rrhhcc
上传日期:2015-12-11
资源大小:54129k
文件大小:6k
- '"
- '" Copyright (c) 1990-1994 The Regents of the University of California.
- '" Copyright (c) 1994-1996 Sun Microsystems, Inc.
- '"
- '" See the file "license.terms" for information on usage and redistribution
- '" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
- '"
- '"
- '" RCS: @(#) $Id: labelframe.n,v 1.1 2001/09/26 21:36:19 pspjuth Exp $
- '"
- .so man.macros
- .TH labelframe n 8.4 Tk "Tk Built-In Commands"
- .BS
- '" Note: do not modify the .SH NAME line immediately below!
- .SH NAME
- labelframe - Create and manipulate labelframe widgets
- .SH SYNOPSIS
- fBlabelframefR fIpathNamefR ?fIoptionsfR?
- .SO
- -borderwidth -highlightbackground -pady
- -cursor -highlightcolor -relief
- -font -highlightthickness -takefocus
- -foreground -padx -text
- .SE
- .SH "WIDGET-SPECIFIC OPTIONS"
- .OP -background background Background
- This option is the same as the standard fBbackgroundfR option
- except that its value may also be specified as an empty string.
- In this case, the widget will display no background or border, and
- no colors will be consumed from its colormap for its background
- and border.
- .OP -class class Class
- Specifies a class for the window.
- This class will be used when querying the option database for
- the window's other options, and it will also be used later for
- other purposes such as bindings.
- The fBclassfR option may not be changed with the fBconfigurefR
- widget command.
- .OP -colormap colormap Colormap
- Specifies a colormap to use for the window.
- The value may be either fBnewfR, in which case a new colormap is
- created for the window and its children, or the name of another
- window (which must be on the same screen and have the same visual
- as fIpathNamefR), in which case the new window will use the colormap
- from the specified window.
- If the fBcolormapfR option is not specified, the new window
- uses the same colormap as its parent.
- This option may not be changed with the fBconfigurefR
- widget command.
- .OP -container container Container
- The value must be a boolean. If true, it means that this window will
- be used as a container in which some other application will be embedded
- (for example, a Tk toplevel can be embedded using the fB-usefR option).
- The window will support the appropriate window manager protocols for
- things like geometry requests. The window should not have any
- children of its own in this application.
- This option may not be changed with the fBconfigurefR
- widget command.
- .OP -height height Height
- Specifies the desired height for the window in any of the forms
- acceptable to fBTk_GetPixelsfR.
- If this option is less than or equal to zero then the window will
- not request any size at all.
- .OP -labelanchor labelAnchor LabelAnchor
- Specifies where to place the label. A label is only displayed if the
- fB-textfR option is not the empty string.
- Valid values for this option are (listing them clockwise)
- fBnwfR, fBnfR, fBnefR, fBenfR, fBefR, fBesfR,
- fBsefR, fBsfR,fBswfR, fBwsfR, fBwfR and fBwnfR.
- The default value is fBnwfR.
- .OP -labelwidget labelWidget LabelWidget
- Specifies a widget to use as label. This overrides any fB-textfR
- option. The widget must exist before being used as fB-labelwidgetfR
- and if it is not a descendant of this window, it will be raised
- above it in the stacking order.
- .OP -visual visual Visual
- Specifies visual information for the new window in any of the
- forms accepted by fBTk_GetVisualfR.
- If this option is not specified, the new window will use the same
- visual as its parent.
- The fBvisualfR option may not be modified with the fBconfigurefR
- widget command.
- .OP -width width Width
- Specifies the desired width for the window in any of the forms
- acceptable to fBTk_GetPixelsfR.
- If this option is less than or equal to zero then the window will
- not request any size at all.
- .BE
- .SH DESCRIPTION
- .PP
- The fBlabelframefR command creates a new window (given by the
- fIpathNamefR argument) and makes it into a labelframe widget.
- Additional
- options, described above, may be specified on the command line
- or in the option database
- to configure aspects of the labelframe such as its background color
- and relief. The fBlabelframefR command returns the
- path name of the new window.
- .PP
- A labelframe is a simple widget. Its primary purpose is to act as a
- spacer or container for complex window layouts. It has the features
- of a fBframefR plus the ability to display a label.
- .SH "WIDGET COMMAND"
- .PP
- The fBlabelframefR command creates a new Tcl command whose
- name is the same as the path name of the labelframe's window. This
- command may be used to invoke various
- operations on the widget. It has the following general form:
- .CS
- fIpathName option fR?fIarg arg ...fR?
- .CE
- fIPathNamefR is the name of the command, which is the same as
- the labelframe widget's path name. fIOptionfR and the fIargfRs
- determine the exact behavior of the command. The following
- commands are possible for frame widgets:
- .TP
- fIpathName fBcgetfR fIoptionfR
- Returns the current value of the configuration option given
- by fIoptionfR.
- fIOptionfR may have any of the values accepted by the fBlabelframefR
- command.
- .TP
- fIpathName fBconfigurefR ?fIoptionfR? fI?value option value ...fR?
- Query or modify the configuration options of the widget.
- If no fIoptionfR is specified, returns a list describing all of
- the available options for fIpathNamefR (see fBTk_ConfigureInfofR for
- information on the format of this list). If fIoptionfR is specified
- with no fIvaluefR, then the command returns a list describing the
- one named option (this list will be identical to the corresponding
- sublist of the value returned if no fIoptionfR is specified). If
- one or more fIoption-valuefR pairs are specified, then the command
- modifies the given widget option(s) to have the given value(s); in
- this case the command returns an empty string.
- fIOptionfR may have any of the values accepted by the fBlabelframefR
- command.
- .SH BINDINGS
- .PP
- When a new labelframe is created, it has no default event bindings:
- labelframes are not intended to be interactive.
- .SH "SEE ALSO"
- frame(n), label(n)
- .SH KEYWORDS
- labelframe, widget