label
Create and manipulate label widgets
(label widget-name ?options?)
:anchor :background
:bitmap :borderwidth
:cursor :font
:foreground :highlightbackground
:highlightcolor :highlightthickness
:image :justify
:padx :pady
:relief :takefocus
:text :textvariable
:underline :wraplength
- Name: environment
- Class: Environment
- Option keyword: :environment
- STklos slot name: environment
- Specifies the environment in which the :textvariable must be taken.
By convention, the value #f denotes the
STk global environment (the default value of this option is false).
- Name: height
- Class: Height
- Option keyword: :height
- STklos slot name: 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 Tk_GetPixels);
for text it is in lines of text.
If this option isn't specified, the label's desired height is computed
from the size of the image or bitmap or text being displayed in it.
- Name: width
- Class: Width
- Option keyword: :width
- STklos slot name: 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 Tk_GetPixels);
for text it is in characters.
If this option isn't specified, the label's desired width is computed
from the size of the image or bitmap or text being displayed in it.
The label procedure creates a new window (given by the
widget-name argument) and makes it into a label widget.
Additional
options, described above, may be specified on the procedure line
or in the option database
to configure aspects of the label such as its colors, font,
text, and initial relief. The label procedure returns its
widget-name argument. At the time this procedure is invoked,
there must not exist a window named widget-name, but
widget-name's parent must exist.
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 wrapLength option) and
one of the characters may optionally be underlined using the
underline option.
The label can be manipulated in a few simple ways, such as
changing its relief or text, using the procedures described below.
The label procedure creates a new STk procedure whose
name is widget-name. This
procedure may be used to invoke various
operations on the widget. It has the following general form:
(widget-name option ?arg arg ...?)
Option and the args
determine the exact behavior of the procedure. The following
procedures are possible for label widgets:
- (widget-name 'cget option)
-
Returns the current value of the configuration option given
by option.
Option may have any of the values accepted by the label
procedure.
- (widget-name 'configure ?option? ?value option value ...?)
-
Query or modify the configuration options of the widget.
If no option is specified, returns a list describing all of
the available options for widget-name (see Tk_ConfigureInfo for
information on the format of this list). If option is specified
with no value, then the procedure returns a list describing the
one named option (this list will be identical to the corresponding
sublist of the value returned if no option is specified). If
one or more option-value pairs are specified, then the procedure
modifies the given widget option(s) to have the given value(s); in
this case the procedure returns an empty string.
Option may have any of the values accepted by the label
procedure.
When a new label is created, it has no default event bindings:
labels are not intended to be interactive.
message
Back to the STk main page