label(n) Tk Built-In Commands label(n)

NAME
       label - Create and manipulate label widgets

SYNOPSIS
       llaabbeell pathName ?options?

SSTTAANNDDAARRDD OOPPTTIIOONNSS
       -aaccttiivveebbaacckkggrroouunndd     -ffoonntt                -ppaaddyy
       -aaccttiivveeffoorreeggrroouunndd     -ffoorreeggrroouunndd          -rreelliieeff
       -aanncchhoorr               -hhiigghhlliigghhttbbaacckkggrroouunndd -ttaakkeeffooccuuss
       -bbaacckkggrroouunndd           -hhiigghhlliigghhttccoolloorr      -tteexxtt
       -bbiittmmaapp               -hhiigghhlliigghhtttthhiicckknneessss  -tteexxttvvaarriiaabbllee
       -bboorrddeerrwwiiddtthh          -iimmaaggee               -uunnddeerrlliinnee
       -ccuurrssoorr               -jjuussttiiffyy             -wwrraapplleennggtthh
       -ddiissaabblleeddffoorreeggrroouunndd   -ppaaddxx

       See the ooppttiioonnss manual entry for details on the standard options.

WWIIDDGGEETT-SSPPEECCIIFFIICC OOPPTTIIOONNSS
       Command-Line Name:-ccoommppoouunndd
       Database Name:  ccoommppoouunndd
       Database Class: CCoommppoouunndd

              Specifies  whether  the  label  should display both an image and
              text, and if so, where the image should be  placed  relative  to
              the  text.   Valid  values  for  this option are bboottttoomm, cceenntteerr,
              lleefftt, nnoonnee, rriigghhtt and ttoopp.  The default value is  nnoonnee,  meaning
              that  the  label will display either an image or text, depending
              on the values of the -iimmaaggee and -bbiittmmaapp options.

       Command-Line Name:-hheeiigghhtt
       Database Name:  hheeiigghhtt
       Database Class: HHeeiigghhtt

              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  TTkkGGeettPPiixxeellss);  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.

       Command-Line Name:-ssttaattee
       Database Name:  ssttaattee
       Database Class: SSttaattee

              Specifies one of three states for the label:  nnoorrmmaall, aaccttiivvee, or
              ddiissaabblleedd.  In normal state the button  is  displayed  using  the
              ffoorreeggrroouunndd and bbaacckkggrroouunndd options.  In active state the label is
              displayed  using  the  aaccttiivveeFFoorreeggrroouunndd   and   aaccttiivveeBBaacckkggrroouunndd
              options.  In the disabled state the ddiissaabblleeddFFoorreeggrroouunndd and bbaacckk-
              ggrroouunndd options determine how the button is displayed.

       Command-Line Name:-wwiiddtthh
       Database Name:  wwiiddtthh
       Database Class: WWiiddtthh

              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  TTkkGGeettPPiixxeellss);  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.



DESCRIPTION
       The llaabbeell command creates a new window (given by the pathName 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 con-
       figure aspects of the label such as its colors, font, text, and initial
       relief.   The llaabbeell 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.

       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 wwrraappLLeennggtthh option) and one of the  char-
       acters  may  optionally  be underlined using the uunnddeerrlliinnee option.  The
       label can be manipulated in a few simple ways,  such  as  changing  its
       relief or text, using the commands described below.


WWIIDDGGEETT CCOOMMMMAANNDD
       The  llaabbeell  command  creates  a new Tcl command whose name is pathName.
       This command may be used to invoke various operations  on  the  widget.
       It has the following general form:
              pathName option ?arg arg ...?
       Option  and  the args determine the exact behavior of the command.  The
       following commands are possible for label widgets:

       pathName ccggeett option
              Returns the current value of the configuration option  given  by
              option.  Option may have any of the values accepted by the llaabbeell
              command.

       pathName ccoonnffiigguurree ?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 avail-
              able options for pathName (see TTkkCCoonnffiigguurreeIInnffoo for  information
              on  the  format  of  this list).  If option is specified with no
              value, 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 option is  specified).   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.  Option may have any
              of the values accepted by the llaabbeell command.


BBIINNDDIINNGGSS
       When a new label is created, it has no default event  bindings:  labels
       are not intended to be interactive.


KKEEYYWWOORRDDSS
       label, widget



Tk                                    4.0                             label(n)