doc/dialog.n

   1 '\"
   2 '\" Copyright (c) 1992 The Regents of the University of California.
   3 '\" Copyright (c) 1994 Sun Microsystems, Inc.
   4 '\" Copyright (c) 1996-1999 Christian Werner
   5 '\"
   6 '\" See the file "license.terms" for information on usage and redistribution
   7 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   8 '\"
   9 .so man.macros
  10 .TH ck_dialog n 8.0 Ck "Ck Built-In Commands"
  11 .BS
  12 '\" Note:  do not modify the .SH NAME line immediately below!
  13 .SH NAME
  14 ck_dialog \- Create dialog and wait for response
  15 .SH SYNOPSIS
  16 \fBck_dialog \fIwindow title text string string ...\fR
  17 .BE
  18
  19 .SH DESCRIPTION
  20 .PP
  21 This procedure is part of the Ck script library.
  22 Its arguments describe a dialog box:
  23 .TP
  24 \fIwindow\fR
  25 Name of top-level window to use for dialog.  Any existing window
  26 by this name is destroyed.
  27 .TP
  28 \fItitle\fR
  29 Text to appear in the window's top line as title for the dialog.
  30 .TP
  31 \fItext\fR
  32 Message to appear in the top portion of the dialog box.
  33 .TP
  34 \fIstring\fR
  35 There will be one button for each of these arguments.
  36 Each \fIstring\fR specifies text to display in a button,
  37 in order from left to right.
  38 .PP
  39 After creating a dialog box, \fBck_dialog\fR waits for the user to
  40 select one of the buttons either by clicking on the button with the
  41 mouse or by typing return or space to invoke the focus button (if any).
  42 Then it returns the index of the selected button:  0 for the leftmost
  43 button, 1 for the button next to it, and so on.
  44
  45 .SH KEYWORDS
  46 bitmap, dialog