Seth Woolley's Man Viewer

button(n) - button, button - Create and manipulate button widgets - man n button

([section] manual, -k keyword, -K [section] search, -f whatis)
man plain no title

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



NAME
       button - Create and manipulate button widgets

SYNOPSIS
       button  pathName ?options?  -activebackground   -foreground    -repeat-
       delay      -activeforeground   -highlightbackground     -repeatinterval
       -anchor   -highlightcolor     -takefocus     -background    -highlight-
       thickness -text -bitmap   -image    -textvariable  -borderwidth   -jus-
       tify  -underline     -cursor   -padx     -wraplength     -disabledfore-
       ground -pady -font     -relief

WIDGET-SPECIFIC OPTIONS
       Specifies a Tcl command to associate with the button.  This command  is
       typically  invoked when mouse button 1 is released over the button win-
       dow.  Specifies whether the button should display  both  an  image  and
       text, and if(3,n) so, where the image should be placed relative to the text.
       Valid values for this option are bottom, center, left, none, right  and
       top.   The  default value is none, meaning that the button will display
       either an image or text, depending on the  values  of  the  -image  and
       -bitmap  options.   Specifies one of three states for the default ring:
       normal, active, or disabled.  In active state, the button is drawn with
       the  platform  specific  appearance  for  a  default button.  In normal
       state, the button is drawn with the platform specific appearance for  a
       non-default  button,  leaving  enough  space to draw the default button
       appearance.  The normal and active states will result in(1,8) buttons of the
       same size.  In disabled state, the button is drawn with the non-default
       button appearance without leaving space  for  the  default  appearance.
       The  disabled  state  may  result  in(1,8)  a smaller button than the active
       state.  ring.  Specifies a desired height for the button.  If an  image
       or  bitmap is being displayed in(1,8) the button then the value is in(1,8) screen
       units(1,7) (i.e. any of the forms acceptable to Tk_GetPixels); for  text  it
       is  in(1,8)  lines  of  text.   If this option isn't specified, the button's
       desired height is computed from the size of the image or bitmap or text
       being displayed in(1,8) it.  Specifies an alternative relief for the button,
       to be used when the mouse cursor is over the widget.  This  option  can
       be  used  to make toolbar buttons, by configuring -relief flat -overre-
       lief raised.  If the value of this option is the empty string(3,n), then  no
       alternative  relief  is  used when the mouse cursor is over the button.
       The empty string(3,n) is the default value.  Specifies one of  three  states
       for the button:  normal, active, or disabled.  In normal state the but-
       ton is displayed using the  foreground  and  background  options.   The
       active state is typically used when the pointer is over the button.  In
       active state the button is displayed  using  the  activeForeground  and
       activeBackground  options.  Disabled state means that the button should
       be insensitive:  the default bindings will refuse to activate the  wid-
       get  and will ignore mouse button presses.  In this state the disabled-
       Foreground and background options determine  how  the  button  is  dis-
       played.  Specifies a desired width for the button.  If an image or bit-
       map is being displayed in(1,8) the button then the value is in(1,8) screen  units(1,7)
       (i.e.  any  of the forms acceptable to Tk_GetPixels); for text it is in(1,8)
       characters.  If this option isn't specified, the button's desired width
       is  computed  from  the  size of the image or bitmap or text being dis-
       played in(1,8) it.


DESCRIPTION
       The button command creates a new window (given by  the  pathName  argu-
       ment) and makes it into a button widget.  Additional options, described
       above, may be specified on the command line or in(1,8) the  option  database
       to  configure aspects of the button such as its colors, font, text, and
       initial relief.  The button command returns its pathName argument.   At
       the  time(1,2,n)  this command is invoked, there must not exist a window named(5,8)
       pathName, but pathName's parent must exist.

       A button is a widget that displays a textual string(3,n), bitmap  or  image.
       If  text  is  displayed,  it  must  all be in(1,8) a single font, but it can
       occupy multiple lines on the screen (if(3,n)  it  contains  newlines  or  if(3,n)
       wrapping  occurs because of the wrapLength option) and one of the char-
       acters may optionally be underlined using the underline option.  It can
       display  itself  in(1,8)  either  of  three different ways, according to the
       state option; it can be made to appear raised, sunken, or flat; and  it
       can  be  made  to  flash.   When a user invokes the button (by pressing
       mouse button 1 with the cursor over the button), then the  Tcl  command
       specified in(1,8) the -command option is invoked.


WIDGET COMMAND
       The  button  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 button widgets:

       pathName cget option
              Returns  the  current value of the configuration option given by
              option.  Option may have any of the values accepted by the  but-
              ton command.

       pathName 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 avail-
              able  options for pathName (see Tk_ConfigureInfo 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(5,8)
              option (this list will be identical to the corresponding sublist
              of  the  value  returned  if(3,n) 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(1,8) this
              case the command returns an empty string.  Option may  have  any
              of the values accepted by the button command.

       pathName flash
              Flash the button.  This is accomplished by redisplaying the but-
              ton several times, alternating between active and normal colors.
              At  the  end  of  the  flash the button is left in(1,8) the same nor-
              mal/active state as when the command was invoked.  This  command
              is ignored if(3,n) the button's state is disabled.

       pathName invoke
              Invoke  the  Tcl command associated with the button, if(3,n) there is
              one.  The return value is the return value from the Tcl command,
              or  an  empty  string(3,n) if(3,n) there is no command associated with the
              button.  This command is ignored if(3,n) the button's state  is  dis-
              abled.


DEFAULT BINDINGS
       Tk  automatically  creates  class  bindings  for buttons that give them
       default behavior:

       [1]    A button activates whenever the mouse passes over it and deacti-
              vates whenever the mouse leaves the button.  Under Windows, this
              binding is only active when mouse button 1 has been pressed over
              the button.

       [2]    A  button's  relief is changed to sunken whenever mouse button 1
              is pressed over the button, and the relief is  restored  to  its
              original value when button 1 is later released.

       [3]    If  mouse  button  1 is pressed over a button and later released
              over the button, the button is invoked.  However, if(3,n)  the  mouse
              is  not over the button when button 1 is released, then no invo-
              cation occurs.

       [4]    When a button has the input focus, the space key causes the but-
              ton to be invoked.

       If the button's state is disabled then none of the above actions occur:
       the button is completely non-responsive.

       The behavior of buttons can be changed by  defining  new  bindings  for
       individual widgets or by redefining the class bindings.


KEYWORDS
       button, widget



Tk                                    4.4                            button(n)

References for this manual (incoming links)