src/gui/painting/qregion.h
changeset 0 1918ee327afb
child 3 41300fa6a67c
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
       
     4 ** All rights reserved.
       
     5 ** Contact: Nokia Corporation (qt-info@nokia.com)
       
     6 **
       
     7 ** This file is part of the QtGui module of the Qt Toolkit.
       
     8 **
       
     9 ** $QT_BEGIN_LICENSE:LGPL$
       
    10 ** No Commercial Usage
       
    11 ** This file contains pre-release code and may not be distributed.
       
    12 ** You may use this file in accordance with the terms and conditions
       
    13 ** contained in the Technology Preview License Agreement accompanying
       
    14 ** this package.
       
    15 **
       
    16 ** GNU Lesser General Public License Usage
       
    17 ** Alternatively, this file may be used under the terms of the GNU Lesser
       
    18 ** General Public License version 2.1 as published by the Free Software
       
    19 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    20 ** packaging of this file.  Please review the following information to
       
    21 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    23 **
       
    24 ** In addition, as a special exception, Nokia gives you certain additional
       
    25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
       
    26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
       
    27 **
       
    28 ** If you have questions regarding the use of this file, please contact
       
    29 ** Nokia at qt-info@nokia.com.
       
    30 **
       
    31 **
       
    32 **
       
    33 **
       
    34 **
       
    35 **
       
    36 **
       
    37 **
       
    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 
       
    53 QT_BEGIN_HEADER
       
    54 
       
    55 QT_BEGIN_NAMESPACE
       
    56 
       
    57 QT_MODULE(Gui)
       
    58 
       
    59 template <class T> class QVector;
       
    60 class QVariant;
       
    61 
       
    62 #if defined(Q_WS_QWS) || defined(Q_WS_X11) || defined(Q_WS_MAC) || defined(Q_WS_WIN) || defined(Q_OS_SYMBIAN)
       
    63 struct QRegionPrivate;
       
    64 #endif
       
    65 
       
    66 class QBitmap;
       
    67 
       
    68 class Q_GUI_EXPORT QRegion
       
    69 {
       
    70 public:
       
    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_X11)
       
   147     inline Region handle() const { if(!d->rgn) updateX11Region(); return d->rgn; }
       
   148 #elif defined(Q_WS_MAC)
       
   149 #if defined Q_WS_MAC32
       
   150     RgnHandle toQDRgn() const;
       
   151     RgnHandle toQDRgnForUpdate_sys() const;
       
   152     static QRegion fromQDRgn(RgnHandle shape);
       
   153 #endif
       
   154 #ifdef QT_MAC_USE_COCOA
       
   155     inline HIMutableShapeRef handle(bool unused = false) const
       
   156     { Q_UNUSED(unused); return toHIMutableShape(); }
       
   157 #else
       
   158     inline RgnHandle handle() const { return handle(false); }
       
   159     inline RgnHandle handle(bool) const { return toQDRgn(); }
       
   160 #endif
       
   161     HIMutableShapeRef toHIMutableShape() const;
       
   162     static QRegion fromHIShapeRef(HIShapeRef shape);
       
   163 #elif defined(Q_WS_QWS)
       
   164     inline void *handle() const { return d->qt_rgn; }
       
   165 #endif
       
   166 #endif
       
   167 
       
   168 #ifndef QT_NO_DATASTREAM
       
   169     friend Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QRegion &);
       
   170     friend Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QRegion &);
       
   171 #endif
       
   172 private:
       
   173     QRegion copy() const;   // helper of detach.
       
   174     void detach();
       
   175 #if defined(Q_WS_WIN)
       
   176     void ensureHandle() const;
       
   177     QRegion winCombine(const QRegion &r, int num) const;
       
   178 #elif defined(Q_WS_X11)
       
   179     void updateX11Region() const;
       
   180     void *clipRectangles(int &num) const;
       
   181     friend void *qt_getClipRects(const QRegion &r, int &num);
       
   182 #elif defined(Q_WS_MAC)
       
   183     static OSStatus shape2QRegionHelper(int inMessage, HIShapeRef inShape,
       
   184                                         const CGRect *inRect, void *inRefcon);
       
   185 #endif
       
   186     friend bool qt_region_strictContains(const QRegion &region,
       
   187                                          const QRect &rect);
       
   188     friend struct QRegionPrivate;
       
   189 
       
   190 #ifndef QT_NO_DATASTREAM
       
   191     void exec(const QByteArray &ba, int ver = 0, QDataStream::ByteOrder byteOrder = QDataStream::BigEndian);
       
   192 #endif
       
   193     struct QRegionData {
       
   194         QBasicAtomicInt ref;
       
   195 #if defined(Q_WS_WIN)
       
   196         HRGN   rgn;
       
   197 #elif defined(Q_WS_X11)
       
   198         Region rgn;
       
   199         void *xrectangles;
       
   200 #elif defined(Q_WS_MAC) && !defined(QT_MAC_USE_COCOA)
       
   201         mutable RgnHandle unused; // Here for binary compatability reasons. ### Qt 5 remove.
       
   202 #endif
       
   203 #if defined(Q_WS_QWS) || defined(Q_WS_X11) || defined(Q_WS_MAC) || defined(Q_WS_WIN) || defined(Q_OS_SYMBIAN)
       
   204         QRegionPrivate *qt_rgn;
       
   205 #endif
       
   206     };
       
   207 #if defined(Q_WS_WIN)
       
   208     friend class QETWidget;
       
   209 #endif
       
   210     struct QRegionData *d;
       
   211     static struct QRegionData shared_empty;
       
   212     static void cleanUp(QRegionData *x);
       
   213 };
       
   214 
       
   215 /*****************************************************************************
       
   216   QRegion stream functions
       
   217  *****************************************************************************/
       
   218 
       
   219 #ifndef QT_NO_DATASTREAM
       
   220 Q_GUI_EXPORT QDataStream &operator<<(QDataStream &, const QRegion &);
       
   221 Q_GUI_EXPORT QDataStream &operator>>(QDataStream &, QRegion &);
       
   222 #endif
       
   223 
       
   224 #ifndef QT_NO_DEBUG_STREAM
       
   225 Q_GUI_EXPORT QDebug operator<<(QDebug, const QRegion &);
       
   226 #endif
       
   227 
       
   228 QT_END_NAMESPACE
       
   229 
       
   230 QT_END_HEADER
       
   231 
       
   232 #endif // QREGION_H