131 lines
5.1 KiB
Plaintext
131 lines
5.1 KiB
Plaintext
'\"
|
|
'\" 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.
|
|
'\"
|
|
.TH label n 4.0 Tk "Tk Built-In Commands"
|
|
.so man.macros
|
|
.BS
|
|
'\" Note: do not modify the .SH NAME line immediately below!
|
|
.SH NAME
|
|
label \- Create and manipulate 'label' non-interactive text or image widgets
|
|
.SH SYNOPSIS
|
|
\fBlabel\fR \fIpathName \fR?\fIoptions\fR?
|
|
.SO
|
|
\-activebackground \-disabledforeground \-padx
|
|
\-activeforeground \-font \-pady
|
|
\-anchor \-foreground \-relief
|
|
\-background \-highlightbackground \-takefocus
|
|
\-bitmap \-highlightcolor \-text
|
|
\-borderwidth \-highlightthickness \-textvariable
|
|
\-compound \-image \-underline
|
|
\-cursor \-justify \-wraplength
|
|
.SE
|
|
.SH "WIDGET-SPECIFIC OPTIONS"
|
|
.OP \-height height Height
|
|
Specifies a desired height for the label.
|
|
If an image or bitmap is being displayed in the label then the value is in
|
|
screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
|
|
for text it is in lines of text.
|
|
If this option is not specified, the label's desired height is computed
|
|
from the size of the image or bitmap or text being displayed in it.
|
|
.OP \-state state State
|
|
Specifies one of three states for the label: \fBnormal\fR, \fBactive\fR,
|
|
or \fBdisabled\fR. In normal state the button is displayed using the
|
|
\fB\-foreground\fR and \fB\-background\fR options. In active state
|
|
the label is displayed using the \fB\-activeforeground\fR and
|
|
\fB\-activebackground\fR options. In the disabled state the
|
|
\fB\-disabledforeground\fR and \fB\-background\fR options determine how
|
|
the button is displayed.
|
|
.OP \-width width Width
|
|
Specifies a desired width for the label.
|
|
If an image or bitmap is being displayed in the label then the value is in
|
|
screen units (i.e. any of the forms acceptable to \fBTk_GetPixels\fR);
|
|
for text it is in characters.
|
|
If this option is not specified, the label's desired width is computed
|
|
from the size of the image or bitmap or text being displayed in it.
|
|
.BE
|
|
.SH DESCRIPTION
|
|
.PP
|
|
The \fBlabel\fR command creates a new window (given by the
|
|
\fIpathName\fR argument) and makes it into a label widget.
|
|
Additional
|
|
options, described above, may be specified on the command line
|
|
or in the option database
|
|
to configure aspects of the label such as its colors, font,
|
|
text, and initial relief. The \fBlabel\fR command returns its
|
|
\fIpathName\fR argument. At the time this command is invoked,
|
|
there must not exist a window named \fIpathName\fR, but
|
|
\fIpathName\fR's parent must exist.
|
|
.PP
|
|
A label is a widget that displays a textual string, bitmap or image.
|
|
If text is displayed, it must all be in a single font, but it
|
|
can occupy multiple lines on the screen (if it contains newlines
|
|
or if wrapping occurs because of the \fB\-wraplength\fR option) and
|
|
one of the characters may optionally be underlined using the
|
|
\fB\-underline\fR option.
|
|
The label can be manipulated in a few simple ways, such as
|
|
changing its relief or text, using the commands described below.
|
|
.SH "WIDGET COMMAND"
|
|
.PP
|
|
The \fBlabel\fR command creates a new Tcl command whose
|
|
name is \fIpathName\fR. 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
|
|
\fIOption\fR and the \fIarg\fRs
|
|
determine the exact behavior of the command. The following
|
|
commands are possible for label widgets:
|
|
.TP
|
|
\fIpathName \fBcget\fR \fIoption\fR
|
|
Returns the current value of the configuration option given
|
|
by \fIoption\fR.
|
|
\fIOption\fR may have any of the values accepted by the \fBlabel\fR
|
|
command.
|
|
.TP
|
|
\fIpathName \fBconfigure\fR ?\fIoption\fR? ?\fIvalue option value ...\fR?
|
|
Query or modify the configuration options of the widget.
|
|
If no \fIoption\fR is specified, returns a list describing all of
|
|
the available options for \fIpathName\fR (see \fBTk_ConfigureInfo\fR for
|
|
information on the format of this list). If \fIoption\fR is specified
|
|
with no \fIvalue\fR, 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 \fIoption\fR is specified). If
|
|
one or more \fIoption\-value\fR 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.
|
|
\fIOption\fR may have any of the values accepted by the \fBlabel\fR
|
|
command.
|
|
.SH BINDINGS
|
|
.PP
|
|
When a new label is created, it has no default event bindings:
|
|
labels are not intended to be interactive.
|
|
.SH EXAMPLE
|
|
.PP
|
|
.CS
|
|
# Make the widgets
|
|
\fBlabel\fR .t \-text "This widget is at the top" \-bg red
|
|
\fBlabel\fR .b \-text "This widget is at the bottom" \-bg green
|
|
\fBlabel\fR .l \-text "Left\enHand\enSide"
|
|
\fBlabel\fR .r \-text "Right\enHand\enSide"
|
|
text .mid
|
|
\&.mid insert end "This layout is like Java's BorderLayout"
|
|
# Lay them out
|
|
pack .t \-side top \-fill x
|
|
pack .b \-side bottom \-fill x
|
|
pack .l \-side left \-fill y
|
|
pack .r \-side right \-fill y
|
|
pack .mid \-expand 1 \-fill both
|
|
.CE
|
|
.SH "SEE ALSO"
|
|
labelframe(n), button(n), ttk::label(n)
|
|
.SH KEYWORDS
|
|
label, widget
|
|
'\" Local Variables:
|
|
'\" mode: nroff
|
|
'\" End:
|