tk/doc/chooseColor.n

   1 '\"
   2 '\" Copyright (c) 1996 Sun Microsystems, Inc.
   3 '\"
   4 '\" See the file "license.terms" for information on usage and redistribution
   5 '\" of this file, and for a DISCLAIMER OF ALL WARRANTIES.
   6 '\"
   7 '\" RCS: @(#) $Id$
   8 '\"
   9 .so man.macros
  10 .TH tk_chooseColor n 4.2 Tk "Tk Built-In Commands"
  11 .BS
  12 '\" Note:  do not modify the .SH NAME line immediately below!
  13 .SH NAME
  14 tk_chooseColor \- pops up a dialog box for the user to select a color.
  15 .PP
  16 .SH SYNOPSIS
  17 \fBtk_chooseColor \fR?\fIoption value ...\fR?
  18 .BE
  19
  20 .SH DESCRIPTION
  21 .PP
  22 The procedure \fBtk_chooseColor\fR pops up a dialog box for the
  23 user to select a color. The following \fIoption\-value\fR pairs are
  24 possible as command line arguments:
  25 .TP
  26 \fB\-initialcolor\fR \fIcolor\fR
  27 Specifies the color to display in the color dialog when it pops
  28 up. \fIcolor\fR must be in a form acceptable to the \fBTk_GetColor\fR
  29 function.
  30 .TP
  31 \fB\-parent\fR \fIwindow\fR
  32 Makes \fIwindow\fR the logical parent of the color dialog. The color
  33 dialog is displayed on top of its parent window.
  34 .TP
  35 \fB\-title\fR \fItitleString\fR
  36 Specifies a string to display as the title of the dialog box. If this
  37 option is not specified, then a default title will be displayed.
  38 .LP
  39 If the user selects a color, \fBtk_chooseColor\fR will return the
  40 name of the color in a form acceptable to \fBTk_GetColor\fR.  If the
  41 user cancels the operation, both commands will return the empty
  42 string.
  43 .SH EXAMPLE
  44 .CS
  45 button .b \-fg [tk_chooseColor \-initialcolor gray \-title "Choose color"]
  46 .CE
  47
  48 .SH KEYWORDS
  49 color selection dialog
  50