diff options
Diffstat (limited to 'doc/man/man3/qcolordialog.3qt')
| -rw-r--r-- | doc/man/man3/qcolordialog.3qt | 80 |
1 files changed, 80 insertions, 0 deletions
diff --git a/doc/man/man3/qcolordialog.3qt b/doc/man/man3/qcolordialog.3qt new file mode 100644 index 000000000..7904f9842 --- /dev/null +++ b/doc/man/man3/qcolordialog.3qt @@ -0,0 +1,80 @@ +'\" t +.TH QColorDialog 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the +.\" license file included in the distribution for a complete license +.\" statement. +.\" +.ad l +.nh +.SH NAME +QColorDialog \- Dialog widget for specifying colors +.SH SYNOPSIS +\fC#include <qcolordialog.h>\fR +.PP +Inherits QDialog. +.PP +.SS "Static Public Members" +<li class=fn>QColor \fBgetColor\fR ( const QColor & initial = white, QWidget * parent = 0, const char * name = 0 ) <li class=fn>QRgb \fBgetRgba\fR ( QRgb initial, bool * ok = 0, QWidget * parent = 0, const char * name = 0 ) <li class=fn>int \fBcustomCount\fR () <li class=fn>QRgb \fBcustomColor\fR ( int i ) <li class=fn>void \fBsetCustomColor\fR ( int i, QRgb c ) <li class=fn>void \fBsetStandardColor\fR ( int i, QRgb c ) +.SH DESCRIPTION +The QColorDialog class provides a dialog widget for specifying colors. +.PP +The color dialog's function is to allow users to choose colors. For example, you might use this in a drawing program to allow the user to set the brush color. +.PP +The static functions provide modal color dialogs. +.PP +The static getColor() function shows the dialog and allows the user to specify a color. The getRgba() function does the same but also allows the user to specify a color with an alpha channel (transparency) value. +.PP +The user can store customCount() different custom colors. The custom colors are shared by all color dialogs, and remembered during the execution of the program. Use setCustomColor() to set the custom colors, and use customColor() to get them. +.PP +<center> +.ce 1 +.B "[Image Omitted]" +.PP +</center> +.PP +See also Dialog Classes and Graphics Classes. +.SH MEMBER FUNCTION DOCUMENTATION +.SH "QRgb QColorDialog::customColor ( int i )\fC [static]\fR" +Returns custom color number \fIi\fR as a QRgb. +.SH "int QColorDialog::customCount ()\fC [static]\fR" +Returns the number of custom colors supported by QColorDialog. All color dialogs share the same custom colors. +.SH "QColor QColorDialog::getColor ( const QColor & initial = white, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" +Pops up a modal color dialog, lets the user choose a color, and returns that color. The color is initially set to \fIinitial\fR. The dialog is a child of \fIparent\fR and is called \fIname\fR. It returns an invalid (see QColor::isValid()) color if the user cancels the dialog. All colors allocated by the dialog will be deallocated before this function returns. +.PP +Examples: +.)l chart/setdataform.cpp and scribble/scribble.cpp. +.SH "QRgb QColorDialog::getRgba ( QRgb initial, bool * ok = 0, QWidget * parent = 0, const char * name = 0 )\fC [static]\fR" +Pops up a modal color dialog to allow the user to choose a color and an alpha channel (transparency) value. The color+alpha is initially set to \fIinitial\fR. The dialog is a child of \fIparent\fR and called \fIname\fR. +.PP +If \fIok\fR is non-null, \fI*\fR\fIok\fR is set to TRUE if the user clicked OK, and to FALSE if the user clicked Cancel. +.PP +If the user clicks Cancel, the \fIinitial\fR value is returned. +.SH "void QColorDialog::setCustomColor ( int i, QRgb c )\fC [static]\fR" +Sets custom color number \fIi\fR to the QRgb value \fIc\fR. +.SH "void QColorDialog::setStandardColor ( int i, QRgb c )\fC [static]\fR" +Sets standard color number \fIi\fR to the QRgb value \fIc\fR. + +.SH "SEE ALSO" +.BR http://doc.trolltech.com/qcolordialog.html +.BR http://www.trolltech.com/faq/tech.html +.SH COPYRIGHT +Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the +license file included in the distribution for a complete license +statement. +.SH AUTHOR +Generated automatically from the source code. +.SH BUGS +If you find a bug in Qt, please report it as described in +.BR http://doc.trolltech.com/bughowto.html . +Good bug reports help us to help you. Thank you. +.P +The definitive Qt documentation is provided in HTML format; it is +located at $QTDIR/doc/html and can be read using Qt Assistant or with +a web browser. This man page is provided as a convenience for those +users who prefer man pages, although this format is not officially +supported by Trolltech. +.P +If you find errors in this manual page, please report them to +.BR qt-bugs@trolltech.com . +Please include the name of the manual page (qcolordialog.3qt) and the Qt +version (3.3.8). |