Displays a text string and/or image.
Format
hwtk::label - pathName ?option value? …
Description
A hwtk::label widget displays a textual label and/or image. The label may be linked
to a Tcl variable to automatically change the displayed text.
Standard Options
- -borderwidth
- Database name: borderWidth
- Database class: BorderWidth
- The desired width of the widget border. Defaults to 0.
- -clientdata
- Database name: clientData
- Database class: ClientData
- Acts as a data storage for a widgets. User can store any data and this
will not have any effect on widget property.
- -compound
- Database name: compound
- Database class: Compound
- Specifies if the widget should display text and bitmaps/images at the
same time, and if so, where the bitmap/image should be placed relative
to the text. Must be one of the values none, bottom, top, left, right,
or center. For example, the (default) value none specifies that the
bitmap or image should (if defined) be displayed instead of the text,
the value left specifies that the bitmap or image should be displayed to
the left of the text, and the value center specifies that the bitmap or
image should be displayed on top of the text.
- -cursor
- Database name: cursor
- Database class: Cursor
- Specifies the mouse cursor to be used for the widget. See
Tk_GetCursor and cursors(n) in the Tk
reference manual for the legal values. If set to the empty string (the
default), the cursor is inherited from the parent widget.
- -help
- Database name: help
- Database class: Text
- Specifies the text or help message that displays when the cursor moves
over the widget.
- -helpcommand
- Database name: helpcommand
- Database class: Command
- Dynamic help which calls an assigned -helpcommand
when the user moves the mouse on the widget. The text which is returned
by the -helpcommand will be in turn be displayed on
the tooltip.
- -image
- Database name: image
- Database class: Image
- Specifies an image to display in the widget, which must have been
created with the image create command. Typically, if the image option is
specified then it overrides other options that specify a bitmap or
textual value to display in the widget, though this is controlled by the
compound option; the image option may be reset to an empty string to
re-enable a bitmap or text display.
- -relief
- Database name: relief
- Database class: Relief
- Specifies the 3D effect desired for the widget. Acceptable values are
raised, sunken,
flat, ridge,
solid, and groove. The value
indicates how the interior of the widget should appear relative to its
exterior; for example, raised means the interior of the widget should
appear to protrude from the screen, relative to the exterior of the
widget.
- -state
- Database name: state
- Database class: State
- May be set to normal or disabled to control the disabled state bit.
- -takefocus
- Database name: takeFocus
- Database class: TakeFocus
- Determines whether the window accepts the focus during keyboard
traversal. Either 0, 1, a command prefix (to which the widget path is
appended, and which should return 0 or 1), or the empty string. See
options(n) in the Tk reference manual for the full
description.
- -text
- Database name: text
- Database class: Text
- Specifies a string to be displayed inside the widget. The way in which
the string is displayed depends on the particular widget and may be
determined by other options, such as anchor or justify.
- -textvariable
- Database name: textVariable
- Database class: Variable
- Specifies the name of a global variable. The value of the variable is a
text string to be displayed inside the widget; if the variable value
changes then the widget will automatically update itself to reflect the
new value. The way in which the string is displayed in the widget
depends on the particular widget and may be determined by other options,
such as anchor or justify.
- -underline
- Database name: underline
- Database class: Underline
- Specifies the integer index of a character to underline in the widget.
This option is used by the default bindings to implement keyboard
traversal for menu buttons and menu entries. 0 corresponds to the first
character of the text displayed in the widget, 1 to the next character,
and so on.
- -width
- Database name: width
- Database class: Width
- Specifies the width of a widget.
Widget-Specific Options
- -anchor
- Database name: anchor
- Database class: Anchor
- Specifies how the information in the widget is positioned relative to
the inner margins. Legal values are n,
ne, e, se,
s, sw, w,
nw, and center. See also
-justify.
- -justify
- Database name: justify
- Database class: Justify
- Specifies how the text is aligned within the entry widget. One of
left, center, or
right.
- -padding
- Database name: padding
- Database class: Pad
- Specifies the amount of extra space to allocate for the widget. The
padding is a list of up to four length specifications left, top, right,
bottom. If fewer than four elements are specified, bottom defaults to
top, right defaults to left, and top defaults to left.
- -relief
- Database name: relief
- Database class: Relief
- Specifies the 3D effect desired for the widget border. Valid values are
flat, groove,
raised, ridge,
solid, and sunken.
- -wraplength
- Database name: wrapLength
- Database class: WrapLength
- Specifies the maximum line length (in pixels). If this option is less
than or equal to zero, then automatic wrapping is not performed;
otherwise the text is split into lines such that no line is longer than
the specified value.
Widget Command
- pathName
configure
?option? ?value option value …?
- Query or modify the configuration options of the widget. If one or more
option-value 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. If option is specified with no
value, then the command returns a list describing the named
option: the elements of the list are the option
name, database name, database class, default value, and current value.
If no option is specified, returns a list describing all of the
available options for pathName.
- pathName
cget
option
- Returns the current value of the configuration option given by
option.
- pathName
identify
element x y
- Returns the name of the element under the point given by x and y, or an
empty string if the point does not lie within any element. x and y are
pixel coordinates relative to the widget. Some widgets accept other
identify subcommands.
- pathName
instate
statespec ?script?
- Test the widget’s state. If script is not specified, returns 1 if the
widget state matches statespec and 0 otherwise. If script is specified,
equivalent to
if{[pathNameinstatestateSpec]}script
- pathName
state
?stateSpec?
- Modify or inquire widget state. If stateSpec is
present, sets the widget state: for each flag in
stateSpec, sets the corresponding flag or clears it
if prefixed by an exclamation point. Returns a new state spec indicating
which flags were changed:
setchanges[pathNamestatespec]
pathNamestate$changes
will
restore pathName to the original state. If
stateSpec is not specified, returns a list of the
currently-enabled state flags.
Example
#::hwtk::label
::hwtk::dialog .d -title "::hwtk::label"
set f [.d recess]
::hwtk::label $f.l1 -relief sunken -image productHyperWorks-24.png -help "Image label"
::hwtk::label $f.l2 -text "Text label" -help "Text label with flat relief"
::hwtk::label $f.l3 -text "Text label relief raised" -relief raised -help "Text label with raised relief"
grid $f.l1 -sticky w
grid $f.l2 -sticky w
grid $f.l3 -sticky w
.d post