source: trunk/src/gui/painting/qregion.h@ 139

Last change on this file since 139 was 113, checked in by Dmitry A. Kuminov, 16 years ago

gui: Implemented the OS/2 bits of QRegion (#37).
File size: 8.4 KB
Line 
1/****************************************************************************
2**
3** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
4** Contact: Qt Software Information ([email protected])
5**
6** This file is part of the QtGui module of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial Usage
10** Licensees holding valid Qt Commercial licenses may use this file in
11** accordance with the Qt Commercial License Agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and Nokia.
14**
15** GNU Lesser General Public License Usage
16** Alternatively, this file may be used under the terms of the GNU Lesser
17** General Public License version 2.1 as published by the Free Software
18** Foundation and appearing in the file LICENSE.LGPL included in the
19** packaging of this file. Please review the following information to
20** ensure the GNU Lesser General Public License version 2.1 requirements
21** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
22**
23** In addition, as a special exception, Nokia gives you certain
24** additional rights. These rights are described in the Nokia Qt LGPL
25** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this
26** package.
27**
28** GNU General Public License Usage
29** Alternatively, this file may be used under the terms of the GNU
30** General Public License version 3.0 as published by the Free Software
31** Foundation and appearing in the file LICENSE.GPL included in the
32** packaging of this file. Please review the following information to
33** ensure the GNU General Public License version 3.0 requirements will be
34** met: http://www.gnu.org/copyleft/gpl.html.
35**
36** If you are unsure which license is appropriate for your use, please
37** contact the sales department at [email protected].
38** $QT_END_LICENSE$
39**
40****************************************************************************/
41
42#ifndef QREGION_H
43#define QREGION_H
44
45#include <QtCore/qatomic.h>
46#include <QtCore/qrect.h>
47#include <QtGui/qwindowdefs.h>
48
49#ifndef QT_NO_DATASTREAM
50#include <QtCore/qdatastream.h>
51#endif
52
53QT_BEGIN_HEADER
54
55QT_BEGIN_NAMESPACE
56
57QT_MODULE(Gui)
58
59template <class T> class QVector;
60class QVariant;
61
62#if defined(Q_WS_QWS) || defined(Q_WS_X11) || defined(Q_WS_MAC) || defined(Q_OS_WINCE)
63struct QRegionPrivate;
64#endif
65
66class QBitmap;
67
68class Q_GUI_EXPORT QRegion
69{
70public:
71 enum RegionType { Rectangle, Ellipse };
72
73 QRegion();
74 QRegion(int x, int y, int w, int h, RegionType t = Rectangle);
75 QRegion(const QRect &r, RegionType t = Rectangle);
76 QRegion(const QPolygon &pa, Qt::FillRule fillRule = Qt::OddEvenFill);
77#ifdef QT3_SUPPORT
78 QT3_SUPPORT_CONSTRUCTOR QRegion(const QPolygon &pa, bool winding);
79#endif
80 QRegion(const QRegion &region);
81 QRegion(const QBitmap &bitmap);
82 ~QRegion();
83 QRegion &operator=(const QRegion &);
84
85#ifdef QT3_SUPPORT
86 inline QT3_SUPPORT bool isNull() const { return isEmpty(); }
87#endif
88 bool isEmpty() const;
89
90 bool contains(const QPoint &p) const;
91 bool contains(const QRect &r) const;
92
93 void translate(int dx, int dy);
94 inline void translate(const QPoint &p) { translate(p.x(), p.y()); }
95 QRegion translated(int dx, int dy) const;
96 inline QRegion translated(const QPoint &p) const { return translated(p.x(), p.y()); }
97
98 // ### Qt 5: make these four functions QT4_SUPPORT
99 QRegion unite(const QRegion &r) const;
100 QRegion unite(const QRect &r) const;
101 QRegion intersect(const QRegion &r) const;
102 QRegion intersect(const QRect &r) const;
103 QRegion subtract(const QRegion &r) const;
104 QRegion eor(const QRegion &r) const;
105
106 inline QRegion united(const QRegion &r) const { return unite(r); }
107 inline QRegion united(const QRect &r) const { return unite(r); }
108 inline QRegion intersected(const QRegion &r) const { return intersect(r); }
109 inline QRegion intersected(const QRect &r) const { return intersect(r); }
110 inline QRegion subtracted(const QRegion &r) const { return subtract(r); }
111 inline QRegion xored(const QRegion &r) const { return eor(r); }
112
113 bool intersects(const QRegion &r) const;
114 bool intersects(const QRect &r) const;
115
116 QRect boundingRect() const;
117 QVector<QRect> rects() const;
118 void setRects(const QRect *rect, int num);
119 int numRects() const;
120
121 const QRegion operator|(const QRegion &r) const;
122 const QRegion operator+(const QRegion &r) const;
123 const QRegion operator+(const QRect &r) const;
124 const QRegion operator&(const QRegion &r) const;
125 const QRegion operator&(const QRect &r) const;
126 const QRegion operator-(const QRegion &r) const;
127 const QRegion operator^(const QRegion &r) const;
128 QRegion& operator|=(const QRegion &r);
129 QRegion& operator+=(const QRegion &r);
130 QRegion& operator+=(const QRect &r);
131 QRegion& operator&=(const QRegion &r);
132 QRegion& operator&=(const QRect &r);
133 QRegion& operator-=(const QRegion &r);
134 QRegion& operator^=(const QRegion &r);
135
136 bool operator==(const QRegion &r) const;
137 inline bool operator!=(const QRegion &r) const { return !(operator==(r)); }
138 operator QVariant() const;
139
140#ifdef qdoc
141 Handle handle() const;
142#endif
143#ifndef qdoc
144#if defined(Q_WS_WIN)
145 inline HRGN handle() const { ensureHandle(); return d->rgn; }
146#elif defined(Q_WS_PM)
147 inline HRGN handle(int targetHeight = 0) const {
148 if (d->rgn == NULLHANDLE || d->height != targetHeight)
149 updateHandle(targetHeight);
150 return d->rgn;
151 }
152#elif defined(Q_WS_X11)
153 inline Region handle() const { if(!d->rgn) updateX11Region(); return d->rgn; }
154#elif defined(Q_WS_MAC)
155#if defined Q_WS_MAC32
156 RgnHandle toQDRgn() const;
157 static QRegion fromQDRgn(RgnHandle shape);
158#endif
159#ifdef QT_MAC_USE_COCOA
160 inline HIMutableShapeRef handle(bool unused = false) const
161 { Q_UNUSED(unused); return toHIMutableShape(); }
162#else
163 inline RgnHandle handle() const { return handle(false); }
164 inline RgnHandle handle(bool) const { return toQDRgn(); }
165#endif
166 HIMutableShapeRef toHIMutableShape() const;
167 static QRegion fromHIShapeRef(HIShapeRef shape);
168#elif defined(Q_WS_QWS)
169 inline void *handle() const { return d->qt_rgn; }
170#endif
171#endif
172
173#ifndef QT_NO_DATASTREAM
174 friend Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QRegion &);
175 friend Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QRegion &);
176#endif
177private:
178 QRegion copy() const; // helper of detach.
179 void detach();
180#if defined(Q_WS_WIN)
181 void ensureHandle() const;
182 QRegion winCombine(const QRegion &r, int num) const;
183#elif defined(Q_WS_PM)
184 QRegion pmCombine(const QRegion &r, int op) const;
185 void updateHandle(int targetHeight) const;
186#elif defined(Q_WS_X11)
187 void updateX11Region() const;
188 void *clipRectangles(int &num) const;
189 friend void *qt_getClipRects(const QRegion &r, int &num);
190#elif defined(Q_WS_MAC)
191 static OSStatus shape2QRegionHelper(int inMessage, HIShapeRef inShape,
192 const CGRect *inRect, void *inRefcon);
193#endif
194 friend bool qt_region_strictContains(const QRegion &region,
195 const QRect &rect);
196 friend struct QRegionPrivate;
197
198#ifndef QT_NO_DATASTREAM
199 void exec(const QByteArray &ba, int ver = 0, QDataStream::ByteOrder byteOrder = QDataStream::BigEndian);
200#endif
201 struct QRegionData {
202 QBasicAtomicInt ref;
203#if defined(Q_WS_WIN)
204 HRGN rgn;
205#elif defined(Q_WS_PM)
206 HRGN rgn;
207 int height;
208#elif defined(Q_WS_X11)
209 Region rgn;
210 void *xrectangles;
211#elif defined(Q_WS_MAC) && !defined(QT_MAC_USE_COCOA)
212 mutable RgnHandle unused; // Here for binary compatability reasons. ### Qt 5 remove.
213#endif
214#if defined(Q_WS_QWS) || defined(Q_WS_X11) || defined(Q_WS_MAC) || defined(Q_OS_WINCE)
215 QRegionPrivate *qt_rgn;
216#endif
217 };
218#if defined(Q_WS_WIN)
219 friend class QETWidget;
220#endif
221 struct QRegionData *d;
222 static struct QRegionData shared_empty;
223 static void cleanUp(QRegionData *x);
224};
225
226/*****************************************************************************
227 QRegion stream functions
228 *****************************************************************************/
229
230#ifndef QT_NO_DATASTREAM
231Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QRegion &);
232Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QRegion &);
233#endif
234
235#ifndef QT_NO_DEBUG_STREAM
236Q_GUI_EXPORT QDebug operator<<(QDebug, const QRegion &);
237#endif
238
239QT_END_NAMESPACE
240
241QT_END_HEADER
242
243#endif // QREGION_H
Note: See TracBrowser for help on using the repository browser.