iwidgets::checkbox(1) [incr Widgets] iwidgets::checkbox(1)

NAME
       iwidgets::checkbox - Create and manipulate a checkbox widget

SYNOPSIS
       iiwwiiddggeettss::::cchheecckkbbooxx pathName ?options?

IINNHHEERRIITTAANNCCEE
       itk::Widget <- iwidgets::Labeledframe <- iwidgets::Checkbox

SSTTAANNDDAARRDD OOPPTTIIOONNSS
       bbaacckkggrroouunndd      bboorrddeerrWWiiddtthh    ccuurrssoorr          ddiissaabblleeddFFoorreeggrroouunndd
       ffoorreeggrroouunndd      rreelliieeff         sseelleeccttCCoolloorr

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

IINNHHEERRIITTEEDD OOPPTTIIOONNSS
       llaabbeellBBiittmmaapp     llaabbeellFFoonntt      llaabbeellIImmaaggee      llaabbeellMMaarrggiinn
       llaabbeellPPooss        llaabbeellTTeexxtt      llaabbeellVVaarriiaabbllee

       See  the "labeledframe" class manual entry for details on the inherited
       options.

WWIIDDGGEETT-SSPPEECCIIFFIICC OOPPTTIIOONNSS
       Name:   ccoommmmaanndd
       Class:  CCoommmmaanndd
       Command-Line Switch:    -ccoommmmaanndd

              Specifies a Tcl command procedure to be  evaluated  following  a
              change in the current check box selection.

       Name:   oorriieenntt
       Class:  OOrriieenntt
       Command-Line Switch:    -oorriieenntt
       Default Value:  vveerrttiiccaall

              Specifies  the orientation of the checkbuttons within the check-
              box.  Valid values are either "horizontal" or "vertical".




DESCRIPTION
       The iiwwiiddggeettss::::cchheecckkbbooxx command creates a check button box widget  capa-
       ble  of  adding, inserting, deleting, selecting, and configuring check-
       buttons as well as obtaining the currently selected button.


MMEETTHHOODDSS
       The iiwwiiddggeettss::::cchheecckkbbooxx 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.

       Many of the widget commands for the cchheecckkbbooxx take as  one  argument  an
       indicator  of  which  checkbutton of the checkbox to operate on.  These
       indicators are called indexes and allow reference and  manipulation  of
       checkbuttons.   Checkbox indexes may be specified in any of the follow-
       ing forms:

       number      Specifies the checkbutton numerically, where 0  corresponds
                   to the top checkbutton of the checkbox.

       eenndd         Indicates the last checkbutton of the checkbox.

       pattern     If  the  index  doesn't satisfy one of the above forms then
                   this form is used.  Pattern is pattern-matched against  the
                   tag  of each checkbutton in the checkbox, in order from top
                   to bottom, until a matching entry is found.  The  rules  of
                   TTccllSSttrriinnggMMaattcchh are used.


WWIIDDGGEETT-SSPPEECCIIFFIICC MMEETTHHOODDSS
       pathName aadddd tag ?option value option value?
              Adds a new checkbutton to the checkbuttond window on the bottom.
              The command takes additional options which are passed on to  the
              checkbutton  as construction arguments.  These include the stan-
              dard Tk checkbutton options.  The tag is returned.

       pathName bbuuttttoonnccoonnffiigguurree index ?options?
              This command is similar to the ccoonnffiigguurree command, except that it
              applies  to  the  options for an individual checkbutton, whereas
              ccoonnffiigguurreeapplies to the options for the  checkbox  as  a  whole.
              Options  may  have  any of the values accepted by the aadddd widget
              command.  If options are  specified,  options  are  modified  as
              indicated  in  the  command  and  the  command  returns an empty
              string.  If no options are specified, returns a list  describing
              the  current  options  for entry index (see TTkkCCoonnffiigguurreeIInnffoo for
              information on the format of this list).

       pathName ccggeett option
              Returns the current value of the configuration option  given  by
              option.  Option may have any of the values accepted by the iiwwiidd-
              ggeettss::::cchheecckkbbooxx 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 iiwwiiddggeettss::::cchheecckkbbooxx command.

       pathName ddeelleettee index
              Deletes a specified checkbutton given an index.

       pathName ddeesseelleecctt index
              Deselects a specified checkbutton given an index.

       pathName ffllaasshh index
              Flashes a specified checkbutton given an index.

       pathName ggeett ?index?
              Returns the tags of the currently selected checkbuttons  or  the
              selection status of specific checkbutton when given an index.

       pathName iinnddeexx index
              Returns the numerical index corresponding to index.

       pathName iinnsseerrtt index tag ?option value option value ...?
              Same as the aadddd command except that it inserts the new checkbut-
              ton just before the one given by index, instead of appending  to
              the  end  of the checkbox.  The option, and value arguments have
              the same interpretation as for the aadddd widget command.

       pathName sseelleecctt index
              Selects a specified checkbutton given an index.


EEXXAAMMPPLLEE
               package require Iwidgets 4.0
               iwidgets::checkbox .cb -labeltext Styles
               .cb add bold -text Bold
               .cb add italic -text Italic
               .cb add underline -text Underline
               .cb select underline

               pack .cb -padx 10 -pady 10 -fill both -expand yes



AUTHOR       John A. Tucker

KKEEYYWWOORRDDSS
       checkbox, widget



Tk                                                       iwidgets::checkbox(1)