summaryrefslogtreecommitdiffstats
path: root/doc/html/qcolordialog.html
blob: 023ccee1742292ebe6e422857383363b8d9331a2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/src/dialogs/qcolordialog.cpp:1411 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<title>QColorDialog Class</title>
<style type="text/css"><!--
fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; }
--></style>
</head>
<body>

<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
 <a href="index.html">
<font color="#004faf">Home</font></a>
 | <a href="classes.html">
<font color="#004faf">All&nbsp;Classes</font></a>
 | <a href="mainclasses.html">
<font color="#004faf">Main&nbsp;Classes</font></a>
 | <a href="annotated.html">
<font color="#004faf">Annotated</font></a>
 | <a href="groups.html">
<font color="#004faf">Grouped&nbsp;Classes</font></a>
 | <a href="functions.html">
<font color="#004faf">Functions</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>QColorDialog Class Reference</h1>

<p>The QColorDialog class provides a dialog widget for specifying colors.
<a href="#details">More...</a>
<p><tt>#include &lt;<a href="qcolordialog-h.html">qcolordialog.h</a>&gt;</tt>
<p>Inherits <a href="qdialog.html">QDialog</a>.
<p><a href="qcolordialog-members.html">List of all member functions.</a>
<h2>Static Public Members</h2>
<ul>
<li class=fn>QColor <a href="#getColor"><b>getColor</b></a> ( const&nbsp;QColor&nbsp;&amp;&nbsp;initial = white, QWidget&nbsp;*&nbsp;parent = 0, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
<li class=fn>QRgb <a href="#getRgba"><b>getRgba</b></a> ( QRgb&nbsp;initial, bool&nbsp;*&nbsp;ok = 0, QWidget&nbsp;*&nbsp;parent = 0, const&nbsp;char&nbsp;*&nbsp;name = 0 )</li>
<li class=fn>int <a href="#customCount"><b>customCount</b></a> ()</li>
<li class=fn>QRgb <a href="#customColor"><b>customColor</b></a> ( int&nbsp;i )</li>
<li class=fn>void <a href="#setCustomColor"><b>setCustomColor</b></a> ( int&nbsp;i, QRgb&nbsp;c )</li>
<li class=fn>void <a href="#setStandardColor"><b>setStandardColor</b></a> ( int&nbsp;i, QRgb&nbsp;c )</li>
</ul>
<hr><a name="details"></a><h2>Detailed Description</h2>


The QColorDialog class provides a dialog widget for specifying colors.



<p> 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.
<p> The static functions provide modal color dialogs.

<p> The static <a href="#getColor">getColor</a>() function shows the dialog and allows the
user to specify a color. The <a href="#getRgba">getRgba</a>() function does the same but
also allows the user to specify a color with an alpha channel
(transparency) value.
<p> The user can store <a href="#customCount">customCount</a>() different custom colors. The
custom colors are shared by all color dialogs, and remembered
during the execution of the program. Use <a href="#setCustomColor">setCustomColor</a>() to set
the custom colors, and use <a href="#customColor">customColor</a>() to get them.
<p> <center><img src="qcolordlg-w.png"></center> <p>See also <a href="dialogs.html">Dialog Classes</a> and <a href="graphics.html">Graphics Classes</a>.

<hr><h2>Member Function Documentation</h2>
<h3 class=fn>QRgb <a name="customColor"></a>QColorDialog::customColor ( int&nbsp;i )<tt> [static]</tt>
</h3>
Returns custom color number <em>i</em> as a QRgb.

<h3 class=fn>int <a name="customCount"></a>QColorDialog::customCount ()<tt> [static]</tt>
</h3>
Returns the number of custom colors supported by QColorDialog. All
color dialogs share the same custom colors.

<h3 class=fn><a href="qcolor.html">QColor</a> <a name="getColor"></a>QColorDialog::getColor ( const&nbsp;<a href="qcolor.html">QColor</a>&nbsp;&amp;&nbsp;initial = white, <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;parent = 0, const&nbsp;char&nbsp;*&nbsp;name = 0 )<tt> [static]</tt>
</h3>
Pops up a modal color dialog, lets the user choose a color, and
returns that color. The color is initially set to <em>initial</em>. The
dialog is a child of <em>parent</em> and is called <em>name</em>. It returns
an invalid (see <a href="qcolor.html#isValid">QColor::isValid</a>()) color if the user cancels the
dialog. All colors allocated by the dialog will be deallocated
before this function returns.

<p>Examples: <a href="tutorial2-08.html#x2601">chart/setdataform.cpp</a> and <a href="scribble-example.html#x909">scribble/scribble.cpp</a>.
<h3 class=fn>QRgb <a name="getRgba"></a>QColorDialog::getRgba ( QRgb&nbsp;initial, bool&nbsp;*&nbsp;ok = 0, <a href="qwidget.html">QWidget</a>&nbsp;*&nbsp;parent = 0, const&nbsp;char&nbsp;*&nbsp;name = 0 )<tt> [static]</tt>
</h3>
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 <em>initial</em>. The dialog is a child of <em>parent</em>
and called <em>name</em>.
<p> If <em>ok</em> is non-null, <em>*</em><em>ok</em> is set to TRUE if the user clicked
OK, and to FALSE if the user clicked Cancel.
<p> If the user clicks Cancel, the <em>initial</em> value is returned.

<h3 class=fn>void <a name="setCustomColor"></a>QColorDialog::setCustomColor ( int&nbsp;i, QRgb&nbsp;c )<tt> [static]</tt>
</h3>
Sets custom color number <em>i</em> to the QRgb value <em>c</em>.

<h3 class=fn>void <a name="setStandardColor"></a>QColorDialog::setStandardColor ( int&nbsp;i, QRgb&nbsp;c )<tt> [static]</tt>
</h3>
Sets standard color number <em>i</em> to the QRgb value <em>c</em>.

<!-- eof -->
<hr><p>
This file is part of the <a href="index.html">Qt toolkit</a>.
Copyright &copy; 1995-2007
<a href="http://www.trolltech.com/">Trolltech</a>. All Rights Reserved.<p><address><hr><div align=center>
<table width=100% cellspacing=0 border=0><tr>
<td>Copyright &copy; 2007
<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
<td align=right><div align=right>Qt 3.3.8</div>
</table></div></address></body>
</html>