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

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

SYNOPSIS
       iiwwiiddggeettss::::sshheellll pathName ?options?

IINNHHEERRIITTAANNCCEE
       itk::Toplevel <- iwidgets::Shell

SSTTAANNDDAARRDD OOPPTTIIOONNSS
       bbaacckkggrroouunndd      ccuurrssoorr         ffoorreeggrroouunndd

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

IINNHHEERRIITTEEDD OOPPTTIIOONNSS
       ttiittllee

       See  the  "Toplevel"  manual  entry  for details on the above inherited
       options.


WWIIDDGGEETT-SSPPEECCIIFFIICC OOPPTTIIOONNSS
       Name:           hheeiigghhtt
       Class:          HHeeiigghhtt
       Command-Line Switch:           -hheeiigghhtt

              Specifies the height of the shell.  The value may  be  specified
              in any of the forms acceptable to TTkkGGeettPPiixxeellss.  A value of zero
              causes the height to be adjusted to the required value based  on
              the  size  requests  of  the components placed in the childsite.
              Otherwise, the height is fixed.  The  default  is  zero.   NOTE:
              This may cause some amount of flickering on slower machines.  To
              prevent it simply set the width  and  height  to  a  appropriate
              value.

       Name:           mmaasstteerr
       Class:          WWiinnddooww
       Command-Line Switch:           -mmaasstteerr

              Defines  the  shell  as being a transient window with the master
              window given by the master option.  The master window should  be
              either  another  existing  toplevel  window or {} for no master.
              The default is {} for shells and "." for dialogs.

       Name:           mmooddaalliittyy
       Class:          MMooddaalliittyy
       Command-Line Switch:           -mmooddaalliittyy

              Allows the shell to grab control of the screen in one  of  three
              different ways: aapppplliiccaattiioonn, ssyysstteemm, or nnoonnee.  Application modal
              prevents any other toplevel windows within the application which
              are  direct  children  of  '.' from gaining focus.  System modal
              locks the screen and prevents all  windows  from  gaining  focus
              regardless of application.  A modality of none performs no grabs
              at all.  The default is none.

       Name:           ppaaddXX
       Class:          PPaadd
       Command-Line Switch:           -ppaaddxx

              Specifies a padding distance for the childsite in  the  X-direc-
              tion  in  any  of  the  forms  acceptable  to TTkkGGeettPPiixxeellss.  The
              default is 10.

       Name:           ppaaddYY
       Class:          PPaadd
       Command-Line Switch:           -ppaaddyy

              Specifies a padding distance for the childsite in  the  Y-direc-
              tion  in  any  of  the  forms  acceptable  to TTkkGGeettPPiixxeellss.  The
              default is 10.

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

              Specifies the width of the shell.  The value may be specified in
              any  of  the  forms acceptable to TTkkGGeettPPiixxeellss.  A value of zero
              causes the width to be adjusted to the required value  based  on
              the  size  requests  of  the components placed in the childsite.
              Otherwise, the width is fixed.  The default is zero.  NOTE: This
              may cause some amount of flickering on slower machines.  To pre-
              vent it simply set the width and height to a appropriate  value.



DESCRIPTION
       The iiwwiiddggeettss::::sshheellll command creates a shell which is a top level widget
       which supports modal operation.


MMEETTHHOODDSS
       The iiwwiiddggeettss::::sshheellll command create 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 shell widgets:

WWIIDDGGEETT-SSPPEECCIIFFIICC MMEETTHHOODDSS
       pathName aaccttiivvaattee
              Display  the shell and wait based on the modality.  For applica-
              tion and system modal activations, perform a grab operation, and
              wait for the result.  The result may be returned via an argument
              to the ddeeaaccttiivvaattee method.

       pathName cceenntteerr ?widget?
              Centers the shell with respect to another  widget.   The  widget
              argument  is  optional.   If  provided, it should be the path of
              another widget with to center upon.  If absent, then  the  shell
              will be centered on the screen as a whole.

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

       pathName cchhiillddssiittee
              Returns the pathname of the child site widget.

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

       pathName ddeeaaccttiivvaattee ?arg?
              Deactivate  the  display  of  the  shell.   The  method takes an
              optional argument to be passed  to  the  aaccttiivvaattee  method  which
              returns  the value.  The optional argument is only effective for
              application and system modal dialogs.


CCOOMMPPOONNEENNTTSS
       Name:           sshheellllcchhiillddssiittee
       Class:          ffrraammee

              The shellchildsite component is the  user  child  site  for  the
              shell.   See  the "frame" widget manual entry for details on the
              shellchildsite component item.


EEXXAAMMPPLLEE
               package require Iwidgets 4.0
               iwidgets::shell .sh -modality application -padx 20 -pady 20 -title Shell

               pack [label [.sh childsite].l -text SHELL]

               .sh center
               .sh activate


AUTHOR       Mark L. Ulferts

       Kris Raney


KKEEYYWWOORRDDSS
       shell, widget



Tk                                                          iwidgets::shell(1)