source: trunk/doc/html/qpalette-h.html

Last change on this file was 190, checked in by rudi, 14 years ago

reference documentation added

File size: 8.9 KB
Line 
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<!-- /home/espenr/tmp/qt-3.3.8-espenr-2499/qt-x11-free-3.3.8/include/qpalette.h:1 -->
3<html>
4<head>
5<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
6<title>qpalette.h Include File</title>
7<style type="text/css"><!--
8fn { margin-left: 1cm; text-indent: -1cm; }
9a:link { color: #004faf; text-decoration: none }
10a:visited { color: #672967; text-decoration: none }
11body { background: #ffffff; color: black; }
12--></style>
13</head>
14<body>
15
16<table border="0" cellpadding="0" cellspacing="0" width="100%">
17<tr bgcolor="#E5E5E5">
18<td valign=center>
19 <a href="index.html">
20<font color="#004faf">Home</font></a>
21 | <a href="classes.html">
22<font color="#004faf">All&nbsp;Classes</font></a>
23 | <a href="mainclasses.html">
24<font color="#004faf">Main&nbsp;Classes</font></a>
25 | <a href="annotated.html">
26<font color="#004faf">Annotated</font></a>
27 | <a href="groups.html">
28<font color="#004faf">Grouped&nbsp;Classes</font></a>
29 | <a href="functions.html">
30<font color="#004faf">Functions</font></a>
31</td>
32<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table><h1 align=center>qpalette.h</h1>
33
34<p>This is the verbatim text of the qpalette.h include file. It is provided only for illustration; the copyright remains with Trolltech.
35<hr>
36<pre>
37/****************************************************************************
38** $Id: qpalette-h.html 2051 2007-02-21 10:04:20Z chehrlic $
39**
40** Definition of QColorGroup and QPalette classes
41**
42** Created : 950323
43**
44** Copyright (C) 1992-2007 Trolltech ASA. All rights reserved.
45**
46** This file is part of the kernel module of the Qt GUI Toolkit.
47**
48** This file may be distributed under the terms of the Q Public License
49** as defined by Trolltech ASA of Norway and appearing in the file
50** LICENSE.QPL included in the packaging of this file.
51**
52** This file may be distributed and/or modified under the terms of the
53** GNU General Public License version 2 as published by the Free Software
54** Foundation and appearing in the file LICENSE.GPL included in the
55** packaging of this file.
56**
57** Licensees holding valid Qt Enterprise Edition or Qt Professional Edition
58** licenses may use this file in accordance with the Qt Commercial License
59** Agreement provided with the Software.
60**
61** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
62** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
63**
64** See http://www.trolltech.com/pricing.html or email sales@trolltech.com for
65** information about Qt Commercial License Agreements.
66** See http://www.trolltech.com/qpl/ for QPL licensing information.
67** See http://www.trolltech.com/gpl/ for GPL licensing information.
68**
69** Contact info@trolltech.com if any conditions of this licensing are
70** not clear to you.
71**
72**********************************************************************/
73
74#ifndef QPALETTE_H
75#define QPALETTE_H
76
77#ifndef QT_H
78#include "qwindowdefs.h"
79#include "qcolor.h"
80#include "qshared.h"
81#include "qbrush.h" // QColor-&gt;QBrush conversion
82#endif // QT_H
83
84#ifndef QT_NO_PALETTE
85
86class QColorGroupPrivate;
87
88class Q_EXPORT QColorGroup
89{
90public:
91 QColorGroup();
92 QColorGroup( const QColor &amp;foreground, const QColor &amp;button,
93 const QColor &amp;light, const QColor &amp;dark, const QColor &amp;mid,
94 const QColor &amp;text, const QColor &amp;base );
95 QColorGroup( const QBrush &amp;foreground, const QBrush &amp;button,
96 const QBrush &amp;light, const QBrush &amp;dark, const QBrush &amp;mid,
97 const QBrush &amp;text, const QBrush &amp;bright_text,
98 const QBrush &amp;base, const QBrush &amp;background);
99 QColorGroup( const QColorGroup &amp; );
100
101 ~QColorGroup();
102
103 QColorGroup&amp; operator =(const QColorGroup&amp;);
104
105 // Do not change the order, the serialization format depends on it
106 enum ColorRole { Foreground, Button, Light, Midlight, Dark, Mid,
107 Text, BrightText, ButtonText, Base, Background, Shadow,
108 Highlight, HighlightedText, Link, LinkVisited,
109 NColorRoles };
110
111 const QColor &amp;color( ColorRole ) const;
112 const QBrush &amp;brush( ColorRole ) const;
113 void setColor( ColorRole, const QColor &amp; );
114 void setBrush( ColorRole, const QBrush &amp; );
115
116 const QColor &amp;foreground() const { return br[Foreground].color(); }
117 const QColor &amp;button() const { return br[Button].color(); }
118 const QColor &amp;light() const { return br[Light].color(); }
119 const QColor &amp;dark() const { return br[Dark].color(); }
120 const QColor &amp;mid() const { return br[Mid].color(); }
121 const QColor &amp;text() const { return br[Text].color(); }
122 const QColor &amp;base() const { return br[Base].color(); }
123 const QColor &amp;background() const { return br[Background].color(); }
124
125 const QColor &amp;midlight() const { return br[Midlight].color(); }
126 const QColor &amp;brightText() const { return br[BrightText].color(); }
127 const QColor &amp;buttonText() const { return br[ButtonText].color(); }
128 const QColor &amp;shadow() const { return br[Shadow].color(); }
129 const QColor &amp;highlight() const { return br[Highlight].color(); }
130 const QColor &amp;highlightedText() const{return br[HighlightedText].color(); }
131 const QColor &amp;link() const { return br[Link].color(); }
132 const QColor &amp;linkVisited() const { return br[LinkVisited].color(); }
133
134 bool operator==( const QColorGroup &amp;g ) const;
135 bool operator!=( const QColorGroup &amp;g ) const
136 { return !(operator==(g)); }
137
138private:
139 QBrush *br;
140 QColorGroupPrivate * d;
141
142 friend class QPalette;
143};
144
145
146class Q_EXPORT QPalette
147{
148public:
149 QPalette();
150 QPalette( const QColor &amp;button );
151 QPalette( const QColor &amp;button, const QColor &amp;background );
152 QPalette( const QColorGroup &amp;active, const QColorGroup &amp;disabled,
153 const QColorGroup &amp;inactive );
154 QPalette( const QPalette &amp; );
155 ~QPalette();
156 QPalette &amp;operator=( const QPalette &amp; );
157
158 enum ColorGroup { Disabled, Active, Inactive, NColorGroups, Normal=Active };
159
160 const QColor &amp;color( ColorGroup, QColorGroup::ColorRole ) const;
161 const QBrush &amp;brush( ColorGroup, QColorGroup::ColorRole ) const;
162 void setColor( ColorGroup, QColorGroup::ColorRole, const QColor &amp; );
163 void setBrush( ColorGroup, QColorGroup::ColorRole, const QBrush &amp; );
164
165 void setColor( QColorGroup::ColorRole, const QColor &amp; );
166 void setBrush( QColorGroup::ColorRole, const QBrush &amp; );
167
168 QPalette copy() const;
169
170 const QColorGroup &amp;active() const { return data-&gt;active; }
171 const QColorGroup &amp;disabled() const { return data-&gt;disabled; }
172 const QColorGroup &amp;inactive() const { return data-&gt;inactive; }
173#ifndef QT_NO_COMPAT
174 const QColorGroup &amp;normal() const { return active(); }
175#endif
176
177 void setActive( const QColorGroup &amp; );
178 void setDisabled( const QColorGroup &amp; );
179 void setInactive( const QColorGroup &amp; );
180#ifndef QT_NO_COMPAT
181 void setNormal( const QColorGroup &amp; cg ) { setActive(cg); }
182#endif
183
184 bool operator==( const QPalette &amp;p ) const;
185 bool operator!=( const QPalette &amp;p ) const
186 { return !(operator==(p)); }
187 bool isCopyOf( const QPalette &amp; );
188
189 int serialNumber() const { return data-&gt;ser_no; }
190
191
192 static QColorGroup::ColorRole foregroundRoleFromMode( Qt::BackgroundMode mode );
193 static QColorGroup::ColorRole backgroundRoleFromMode( Qt::BackgroundMode mode);
194
195private:
196 void detach();
197 const QBrush &amp;directBrush( ColorGroup, QColorGroup::ColorRole ) const;
198 void directSetBrush( ColorGroup, QColorGroup::ColorRole, const QBrush&amp; );
199
200 struct QPalData : public QShared {
201 QColorGroup disabled;
202 QColorGroup active;
203 int ser_no;
204 QColorGroup inactive;
205 } *data;
206};
207
208
209/*****************************************************************************
210 QColorGroup/QPalette stream functions
211 *****************************************************************************/
212
213#ifndef QT_NO_DATASTREAM
214Q_EXPORT QDataStream &amp;operator&lt;&lt;( QDataStream &amp;, const QColorGroup &amp; );
215Q_EXPORT QDataStream &amp;operator&gt;&gt;( QDataStream &amp;, QColorGroup &amp; );
216
217Q_EXPORT QDataStream &amp;operator&lt;&lt;( QDataStream &amp;, const QPalette &amp; );
218Q_EXPORT QDataStream &amp;operator&gt;&gt;( QDataStream &amp;, QPalette &amp; );
219#endif // QT_NO_DATASTREAM
220
221#endif // QT_NO_PALETTE
222#endif // QPALETTE_H
223</pre>
224<!-- eof -->
225<p><address><hr><div align=center>
226<table width=100% cellspacing=0 border=0><tr>
227<td>Copyright &copy; 2007
228<a href="troll.html">Trolltech</a><td align=center><a href="trademarks.html">Trademarks</a>
229<td align=right><div align=right>Qt 3.3.8</div>
230</table></div></address></body>
231</html>
Note: See TracBrowser for help on using the repository browser.