.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "chooseColor 3"
.TH chooseColor 3 2023-07-25 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Tk::chooseColor \- pops up a dialog box for the user to select a color.
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\ \ \ \ \fR\f(CI$color\fR\fI\fR = \fI\fR\f(CI$widget\fR\fI\fR\->\fBchooseColor\fR?(\fI\-option\fR=>\fIvalue\fR, ...)?;
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The method \fBchooseColor\fR is implemented as a perl wrapper
on the core tk "command" \fBtk_chooseColor\fR, and \fR\f(CI$widget\fR\fI\fR
is passed as the argument to the hidden \fB\-parent\fR option.
The implementation of internal \fBtk_chooseColor\fR is platform
specific, on Win32 it is a native dialog, and on UNIX/X11 it is implemented
in terms of Tk::ColorEditor.
.PP
The \fBchooseColor\fR method pops up a dialog box for the
user to select a color. The following \fIoption-value\fR pairs are
possible as command line arguments:
.IP \fB\-initialcolor\fR=>\fIcolor\fR 4
.IX Item "-initialcolor=>color"
Specifies the color to display in the color dialog when it pops
up. \fIcolor\fR must be in a form acceptable to the \fBTk_GetColor\fR
function.
.IP \fB\-parent\fR=>$widget 4
.IX Item "-parent=>$widget"
Makes \f(CW$widget\fR the logical parent of the color dialog. The color
dialog is displayed on top of its parent window.
.IP \fB\-title\fR=>\fItitleString\fR 4
.IX Item "-title=>titleString"
Specifies a string to display as the title of the dialog box. If this
option is not specified, then a default title will be displayed.
.PP
If the user selects a color, \fBtk_chooseColor\fR will return the
name of the color in a form acceptable to \fBTk_GetColor\fR.  If the
user cancels the operation, the command will return \fBundef\fR.
.SH EXAMPLE
.IX Header "EXAMPLE"
.Vb 2
\& $widget\->configure(\-fg => $parent\->chooseColor(\-initialcolor => \*(Aqgray\*(Aq,
\&                                                \-title => "Choose color"));
.Ve
.SH KEYWORDS
.IX Header "KEYWORDS"
color selection dialog