iwidgets2.2.0 User Commands - promptdialog






NAME

     promptdialog - Create and manipulate a prompt dialog widget


SYNOPSIS

     promptdialog pathName ?options?


INHERITANCE

     itk::Toplevel <- dialogshell <- dialog <- promptdialog


STANDARD OPTIONS

     background      borderWidth    cursor          exportSelection
     foreground      highlightColor highlightThicknessinsertBackground
     insertBorderWidth              insertOffTime   insertOnTimeinsertWidth
     justify         relief         selectBackgroundselectBorderWidth
     selectForeground textVariable

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


ASSOCIATED OPTIONS

     show            state          width

     See the "entry" widget manual entry for details on the above
     associated options.

     childSitePos    fixed          invalid         textBackground
     textFont        validate

     See the "entryfield" widget manual entry for details on  the
     above associated options.

     labelBitmap     labelFont      labelImage      labelMargin
     olabelPos       labelText

     See the "labeledwidget" widget manual entry for  details  on
     the above associated options.


INHERITED OPTIONS

     buttonBoxPadX   buttonBoxPadY  buttonBoxPos    padX
     padY            separator      thickness

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

     master          modality       title

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







DESCRIPTION

     The promptdialog command creates a prompt dialog similar  to
     the  OSF/Motif standard prompt dialog composite widget.  The
     promptdialog is derived from the dialog class  and  is  com-
     posed of a EntryField with commands to manipulate the dialog
     buttons.



METHODS

     The promptdialog command creates a  new  Tcl  command  whose
     name  is pathName.  This command may be used to invoke vari-
     ous operations on the widget.  It has the following  general
     form:

          pathName option ?arg arg ...?

     Option and the args determine the exact behavior of the com-
     mand.   The following commands are possible for promptdialog
     widgets:


ASSOCIATED METHODS

     delete          get            icursor         index
     insert          scan           selection       xview

     See the "entry" widget manual entry for details on the above
     associated methods.

     clear

     See the "entryfield" widget manual entry for details on  the
     above associated methods.


INHERITED METHODS

     add             buttonconfigure                defaulthide
     invoke          show

     See the "buttonbox" widget manual entry for details  on  the
     above inherited methods.

     childsite

     See the "dialogshell" widget manual entry for details on the
     above inherited methods.

     activate        center         deactivate

     See the "shell" widget manual entry for details on the above
     inherited methods.


WIDGET-SPECIFIC METHODS

     pathName cget option
          Returns the current value of the  configuration  option
          given  by  option.   Option  may have any of the values
          accepted by the promptdialog 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 available  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
          option (this list will be identical to the  correspond-
          ing  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 promptdialog command.



COMPONENTS

     Name:           ef
     Class:          Entryfield

          The ef component is the entry field for user  input  in
          the  prompt dialog.  See the "entryfield" widget manual
          entry for details on the ef component item.



EXAMPLE

           option add *textBackground white

           promptdialog .pd -modality global -title Password -labeltext Password: -show *
           .pd buttonconfigure OK -command {.pd deactivate 1}
           .pd hide Apply
           .pd buttonconfigure Cancel -command {.pd deactivate 0}
           .pd hide Help

           if {[.pd activate]} {
               puts "Password entered: [.pd get]"
           } else {
               puts "Password prompt cancelled"
           }



AUTHOR

     Mark L. Ulferts


KEYWORDS

     promptdialog, dialog, dialogshell, shell, widget