home *** CD-ROM | disk | FTP | other *** search
/ InfoMagic Source Code 1993 July / THE_SOURCE_CODE_CD_ROM.iso / languages / tcl / tk3.3b1 / doc / dialog.n < prev    next >
Encoding:
Text File  |  1993-07-09  |  2.9 KB  |  77 lines
  1. '\"
  2. '\" Copyright (c) 1992 The Regents of the University of California.
  3. '\" All rights reserved.
  4. '\"
  5. '\" Permission is hereby granted, without written agreement and without
  6. '\" license or royalty fees, to use, copy, modify, and distribute this
  7. '\" documentation for any purpose, provided that the above copyright
  8. '\" notice and the following two paragraphs appear in all copies.
  9. '\"
  10. '\" IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY
  11. '\" FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  12. '\" ARISING OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
  13. '\" CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  14. '\"
  15. '\" THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
  16. '\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
  17. '\" AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  18. '\" ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
  19. '\" PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  20. '\" 
  21. '\" $Header: /user6/ouster/wish/man/RCS/dialog.n,v 1.1 93/07/09 11:36:32 ouster Exp $ SPRITE (Berkeley)
  22. '/" 
  23. .so man.macros
  24. .HS tk_dialog tk 7.0
  25. .BS
  26. '\" Note:  do not modify the .SH NAME line immediately below!
  27. .SH NAME
  28. tk_dialog \- Create modal dialog and wait for response
  29. .SH SYNOPSIS
  30. \fBtk_dialog \fIwindow title text bitmap default string string ...\fR
  31. .BE
  32.  
  33. .SH DESCRIPTION
  34. .PP
  35. This procedure is part of the Tk script library.
  36. Its arguments describe a dialog box:
  37. .TP
  38. \fIwindow\fR
  39. Name of top-level window to use for dialog.  Any existing window
  40. by this name is destroyed.
  41. .TP
  42. \fItitle\fR
  43. Text to appear in the window manager's title bar for the dialog.
  44. .TP
  45. \fItext\fR
  46. Message to appear in the top portion of the dialog box.
  47. .TP
  48. \fIbitmap\fR
  49. If non-empty, specifies a bitmap to display in the top portion of
  50. the dialog, to the left of the text.
  51. If this is an empty string then no bitmap is displayed in the dialog.
  52. .TP
  53. \fIdefault\fR
  54. If this is an integer greater than or equal to zero, then it gives
  55. the index of the button that is to be the default button for the dialog
  56. (0 for the leftmost button, and so on).
  57. If less than zero or an empty string then there won't be any default
  58. button.
  59. .TP
  60. \fIstring\fR
  61. There will be one button for each of these arguments.
  62. Each \fIstring\fR specifies text to display in a button,
  63. in order from left to right.
  64. .PP
  65. After creating a dialog box, \fBtk_dialog\fR waits for the user to
  66. select one of the buttons either by clicking on the button with the
  67. mouse or by typing return to invoke the default button (if any).
  68. Then it returns the index of the selected button:  0 for the leftmost
  69. button, 1 for the button next to it, and so on.
  70. .PP
  71. While waiting for the user to respond, \fBtk_dialog\fR sets a local
  72. grab.  This prevents the user from interacting with the application
  73. in any way except to invoke the dialog box.
  74.  
  75. .SH KEYWORDS
  76. bitmap, dialog, modal
  77.