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

NAME
       iwidgets::labeledframe - Create and manipulate a labeled frame widget

SYNOPSIS
       iiwwiiddggeettss::::llaabbeelleeddffrraammee pathName ?options?

IINNHHEERRIITTAANNCCEE
       itk::Archetype <- iwidgets::Labeledframe

SSTTAANNDDAARRDD OOPPTTIIOONNSS
       bbaacckkggrroouunndd      bboorrddeerrwwiiddtthh    ccuurrssoorr
       ffoorreeggrroouunndd      rreelliieeff

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

WWIIDDGGEETT-SSPPEECCIIFFIICC OOPPTTIIOONNSS
       Name:           iiPPaaddXX
       Class:          IIPPaadd
       Command-Line Switch:           -iippaaddxx

              Specifies  horizontal  padding  space between the border and the
              childsite.  The value may have any of the  forms  acceptable  to
              TTkkGGeettPPiixxeellss.  The default is 0.

       Name:           iiPPaaddYY
       Class:          IIPPaadd
       Command-Line Switch:           -iippaaddyy

              Specifies  vertical  padding  space  between  the border and the
              childsite.  The value may have any of the  forms  acceptable  to
              TTkkGGeettPPiixxeellss.  The default is 0.

       Name:           llaabbeellBBiittmmaapp
       Class:          BBiittmmaapp
       Command-Line Switch:           -llaabbeellbbiittmmaapp

              Specifies  a bitmap to display in the label, in any of the forms
              acceptable to TTkkGGeettBBiittmmaapp.  This option overrides the labeltext
              option.

       Name:           llaabbeellIImmaaggee
       Class:          IImmaaggee
       Command-Line Switch:           -llaabbeelliimmaaggee

              Specifies  a image to be used as the label. The image may be any
              of the values created by the iimmaaggee ccrreeaattee command.  This  option
              overrides both the labelbitmap and labeletext options.

       Name:           llaabbeellMMaarrggiinn
       Class:          MMaarrggiinn
       Command-Line Switch:           -llaabbeellmmaarrggiinn

              Specifies  the distance between the inner ede of the hull frames
              relief, and the label in any of the forms acceptable to  TTkkGGeett-
              PPiixxeellss.  The default is 10 pixels.

       Name:           llaabbeellTTeexxtt
       Class:          TTeexxtt
       Command-Line Switch:           -llaabbeelltteexxtt

              Specifies the text of the label around the childsite.

       Name:           llaabbeellVVaarriiaabbllee
       Class:          VVaarriiaabbllee
       Command-Line Switch:           -llaabbeellvvaarriiaabbllee

              Specifies the text variable of the label around the childsite.

       Name:           llaabbeellFFoonntt
       Class:          FFoonntt
       Command-Line Switch:           -llaabbeellffoonntt

              Specifies the font of the label around the childsite.

       Name:           llaabbeellPPooss
       Class:          PPoossiittiioonn
       Command-Line Switch:           -llaabbeellppooss

              Specifies the position of the label within the grooved relief of
              the hull widget.
               nnee,, nn,, nnww,, ssee,, ss,, ssww,, eenn,, ee,, eess,, wwnn,, ww,, wwss  Default is nn.




DESCRIPTION
       The iiwwiiddggeettss::::llaabbeelleeddffrraammee command creates a hull frame with a  grooved
       relief, a label positioned within the grooved relief of the hull frame,
       and a frame childsite.  The frame childsite can filled with any  widget
       via  a  derived  class or though the use of the childsite method.  This
       class was designed to be a general purpose base  class  for  supporting
       the  combination of labeled frame and a childsite.  The options include
       the ability to position the label at configurable locations within  the
       grooved relief of the hull frame, and control the display of the label.

MMEETTHHOODDSS
       The iiwwiiddggeettss::::llaabbeelleeddffrraammee 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 labeledframe widgets:

WWIIDDGGEETT-SSPPEECCIIFFIICC MMEETTHHOODDSS
       pathName cchhiillddssiittee
              Return the path name of the child site.

       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::::llaabbeelleeddffrraammee 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::::llaabbeelleeddffrraammee command.


CCOOMMPPOONNEENNTTSS
       Name:           llaabbeell
       Class:          llaabbeell

              The  label  component provides the label for the labeled widget.
              See the "label" widget manual entry for  details  on  the  label
              component item.



EEXXAAMMPPLLEE
              The  labeledframe  was  primarily meant to be a base class.  The
              Radiobox is a good example of a derived classe of  the  labeled-
              frame  class.   In  order to provide equal support for composite
              classes, the 'childsite' methods also exists.  The following  is
              an example of 'childsite' method usage.


               package require Iwidgets 4.0
               iwidgets::labeledframe .lw -labeltext "Entry Frame" -labelpos n
               pack .lw -fill both -expand yes -padx 10 -pady 10
               set cs [.lw childsite]

               pack [iwidgets::entryfield $cs.entry1 -labeltext "Name:"] -side top -fill x
               pack [iwidgets::spinint $cs.entry2 -labeltext "Number:"] -side top -fill x
               pack [iwidgets::pushbutton $cs.entry3 -text "Details:"] -side top -fill x



AUTHOR       John A. Tucker

KKEEYYWWOORRDDSS
       labeledframe, widget



Tk                                                   iwidgets::labeledframe(1)