# iwidgets2.2.0 User Commands - messagedialog

##

## NAME

         messagedialog -  Create  and  manipulate  a  message  dialog
         widget

## SYNOPSIS

         messagedialog pathName ?options?

## INHERITANCE

         itk::Toplevel <- Shell <-  Dialogshell  <-  Dialog  <-  Mes-
         sagedialog

## STANDARD OPTIONS

         anchor          background     bitmap          cursor
         font            foreground     image           justify
         text            wrapLength

         See the "options" manual entry for details on  the  standard
         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.

## WIDGET-SPECIFIC OPTIONS

         Name:           imagePos
         Class:          Position
         Command-Line Switch:           -imagepos

              Specifies the image position relative  to  the  message
              text: n, s, e, or w.  The default is w.

         Name:           textPadX
         Class:          Pad
         Command-Line Switch:           -textpadx

              Specifies a  non-negative  value  indicating  how  much
              extra  space  to  request for the message text in the X
              direction.  The value may have any of the forms accept-
              able to Tk_GetPixels.

         Name:           textPadY
         Class:          Pad
         Command-Line Switch:           -textpady

              Specifies a  non-negative  value  indicating  how  much
              extra  space  to  request for the message text in the X
              direction.  The value may have any of the forms accept-
              able to Tk_GetPixels.

##

## DESCRIPTION

         The messagedialog command creates a message dialog composite
         widget.  The  messagedialog is derived from the Dialog class
         and is composed of an image and associated message text with
         commands to manipulate the dialog buttons.

## METHODS

         The messagedialog 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 messagedialog
         widgets:

## INHERITED METHODS

         add             buttonconfigure                defaulthide
         insert          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 "dialogshell" 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 messagedialog 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 messagedialog command.

## COMPONENTS

         Name:           image
         Class:          Label

              The image component is the bitmap or image of the  mes-
              sage  dialog.   See the "label" widget manual entry for
              details on the image component item.

         Name:           msg
         Class:          Label

              The msg component provides the textual portion  of  the
              message  dialog.   See  the "label" widget manual entry
              for details on the msg component item.

## EXAMPLE

               #
               # Standard question message dialog used for confirmation.
               #
               messagedialog .md -title "Message Dialog" -text "Are you sure ?" \
                              -bitmap questhead -modality global

               .md hide Help
               .md buttonconfigure OK -text Yes
               .md buttonconfigure Cancel -text No

               if {[.md activate]} {
                  .md configure -text "Are you really sure ?"
                  if {[.md activate]} {
                              puts stdout "Yes"
                  } else {
                              puts stdout "No"
                  }
               } else {
                  puts stdout "No"

               }

               destroy .md

               #
               # Copyright notice with automatic deactivation.
               #
               messagedialog .cr -title "Copyright" -bitmap @dsc.xbm -imagepos n \
                   -text "Copyright 1995 DSC Communications Corporation\n \
                                  All rights reserved"

               .cr hide Apply
               .cr hide Cancel
               .cr hide Help

               .cr activate
               after 10000 ".cr deactivate"

## AUTHOR

         Mark L. Ulferts

## KEYWORDS

         messagedialog, dialog, dialogshell, shell, widget