|  | Home · All Classes · Modules

# QRegion Class Reference
[QtGui module]

The QRegion class specifies a clip region for a painter. More...

### Types

- enum RegionType { Rectangle, Ellipse }

### Methods

- __init__ (self)
- __init__ (self, int x, int y, int w, int h, RegionType type = QRegion.Rectangle)
- __init__ (self, QRect r, RegionType type = QRegion.Rectangle)
- __init__ (self, QPolygon a, Qt.FillRule fillRule = Qt.OddEvenFill)
- __init__ (self, QBitmap bitmap)
- __init__ (self, QRegion region)
- __init__ (self, QVariant variant)
- QRect boundingRect (self)
- bool contains (self, QPoint p)
- bool contains (self, QRect r)
- QRegion eor (self, QRegion r)
- QRegion intersect (self, QRegion r)
- QRegion intersected (self, QRegion r)
- QRegion intersected (self, QRect r)
- bool intersects (self, QRegion r)
- bool intersects (self, QRect r)
- bool isEmpty (self)
- int numRects (self)
- int rectCount (self)
- list-of-QRect rects (self)
- QRegion subtract (self, QRegion r)
- QRegion subtracted (self, QRegion r)
- translate (self, int dx, int dy)
- translate (self, QPoint p)
- QRegion translated (self, int dx, int dy)
- QRegion translated (self, QPoint p)
- QRegion unite (self, QRegion r)
- QRegion united (self, QRegion r)
- QRegion united (self, QRect r)
- QRegion xored (self, QRegion r)

### Special Methods

- QRegion __add__ (self, QRegion r)
- QRegion __add__ (self, QRect r)
- QRegion __and__ (self, QRegion r)
- QRegion __and__ (self, QRect r)
- int __bool__ (self)
- int __contains__ (self, QPoint p)
- int __contains__ (self, QRect r)
- bool __eq__ (self, QRegion r)
- QRegion __iadd__ (self, QRegion r)
- QRegion __iadd__ (self, QRect r)
- QRegion __iand__ (self, QRegion r)
- QRegion __iand__ (self, QRect r)
- QRegion __ior__ (self, QRegion r)
- QRegion __isub__ (self, QRegion r)
- QRegion __ixor__ (self, QRegion r)
- QRegion __mul__ (self, QMatrix m)
- QRegion __mul__ (self, QTransform m)
- bool __ne__ (self, QRegion r)
- QRegion __or__ (self, QRegion r)
- QRegion __sub__ (self, QRegion r)
- QRegion __xor__ (self, QRegion r)

## Detailed Description

The QRegion class specifies a clip region for a painter.

QRegion is used with QPainter.setClipRegion() to limit the paint area to what needs to be painted. There is also a QWidget.repaint() function that takes a QRegion parameter. QRegion is the best tool for minimizing the amount of screen area to be updated by a repaint.

This class is not suitable for constructing shapes for rendering, especially as outlines. Use QPainterPath to create paths and shapes for use with QPainter.

QRegion is an implicitly shared class.

### Creating and Using Regions

A region can be created from a rectangle, an ellipse, a polygon or a bitmap. Complex regions may be created by combining simple regions using united(), intersected(), subtracted(), or xored() (exclusive or). You can move a region using translate().

You can test whether a region isEmpty() or if it contains() a QPoint or QRect. The bounding rectangle can be found with boundingRect().

The function rects() gives a decomposition of the region into rectangles.

Example of using complex regions:

     void MyWidget.paintEvent(QPaintEvent *)
     {
         QRegion r1(QRect(100, 100, 200, 80),    // r1: elliptic region
                    QRegion.Ellipse);
         QRegion r2(QRect(100, 120, 90, 30));    // r2: rectangular region
         QRegion r3 = r1.intersected(r2);        // r3: intersection

         QPainter painter(this);
         painter.setClipRegion(r3);
         ...                                     // paint clipped graphics
     }

### Additional License Information

On Embedded Linux, Windows CE and X11 platforms, parts of this class rely on code obtained under the following licenses:

Copyright (c) 1987 X Consortium

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Except as contained in this notice, the name of the X Consortium shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Software without prior written authorization from the X Consortium.

Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts.

All Rights Reserved

Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that both that copyright notice and this permission notice appear in supporting documentation, and that the name of Digital not be used in advertising or publicity pertaining to distribution of the software without specific, written prior permission.

DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

## Type Documentation

### QRegion.RegionType

Specifies the shape of the region to be created.

Constant | Value | Description
--- | --- | ---
`QRegion.Rectangle` | `0` | the region covers the entire rectangle.
`QRegion.Ellipse` | `1` | the region is an ellipse inside the rectangle.

## Method Documentation

### QRegion.__init__ (self)

Constructs an empty region.

See also isEmpty().

### QRegion.__init__ (self, int x, int y, int w, int h, RegionType type = QRegion.Rectangle)

Constructs a rectangular or elliptic region.

If t is `Rectangle`, the region is the filled rectangle (x, y, w, h). If t is `Ellipse`, the region is the filled ellipse with center at (x + w / 2, y + h / 2) and size (w ,h).

### QRegion.__init__ (self, QRect r, RegionType type = QRegion.Rectangle)

Constructs a polygon region from the point array a with the fill rule specified by fillRule.

If fillRule is Qt.WindingFill, the polygon region is defined using the winding algorithm; if it is Qt.OddEvenFill, the odd-even fill algorithm is used.

Warning: This constructor can be used to create complex regions that will slow down painting when used.

### QRegion.__init__ (self, QPolygon a, Qt.FillRule fillRule = Qt.OddEvenFill)

### QRegion.__init__ (self, QBitmap bitmap)

Constructs a new region which is equal to region r.

### QRegion.__init__ (self, QRegion region)

Constructs a region from the bitmap bm.

The resulting region consists of the pixels in bitmap bm that are Qt.color1, as if each pixel was a 1 by 1 rectangle.

This constructor may create complex regions that will slow down painting when used. Note that drawing masked pixmaps can be done much faster using QPixmap.setMask().

### QRegion.__init__ (self, QVariant variant)

This is an overloaded function.

Create a region based on the rectange r with region type t.

If the rectangle is invalid a null region will be created.

See also QRegion.RegionType.

### QRect QRegion.boundingRect (self)

Returns the bounding rectangle of this region. An empty region gives a rectangle that is QRect.isNull().

### bool QRegion.contains (self, QPoint p)

Returns true if the region contains the point p; otherwise returns false.

### bool QRegion.contains (self, QRect r)

This is an overloaded function.

Returns true if the region overlaps the rectangle r; otherwise returns false.

### QRegion QRegion.eor (self, QRegion r)

### QRegion QRegion.intersect (self, QRegion r)

### QRegion QRegion.intersected (self, QRegion r)

Returns a region which is the intersection of this region and r.

The figure shows the intersection of two elliptical regions.

This function was introduced in Qt 4.2.

See also subtracted(), united(), and xored().

### QRegion QRegion.intersected (self, QRect r)

Returns a region which is the intersection of this region and the given rect.

This function was introduced in Qt 4.4.

See also subtracted(), united(), and xored().

### bool QRegion.intersects (self, QRegion r)

Returns true if this region intersects with region, otherwise returns false.

This function was introduced in Qt 4.2.

### bool QRegion.intersects (self, QRect r)

Returns true if this region intersects with rect, otherwise returns false.

This function was introduced in Qt 4.2.

### bool QRegion.isEmpty (self)

Returns true if the region is empty; otherwise returns false. An empty region is a region that contains no points.

Example:

     QRegion r1(10, 10, 20, 20);
     r1.isEmpty();               // false

     QRegion r3;
     r3.isEmpty();               // true

     QRegion r2(40, 40, 20, 20);
     r3 = r1.intersected(r2);    // r3: intersection of r1 and r2
     r3.isEmpty();               // true

     r3 = r1.united(r2);         // r3: union of r1 and r2
     r3.isEmpty();               // false

### int QRegion.numRects (self)

### int QRegion.rectCount (self)

Returns the number of rectangles that will be returned in rects().

This function was introduced in Qt 4.6.

### list-of-QRect QRegion.rects (self)

Returns an array of non-overlapping rectangles that make up the region.

The union of all the rectangles is equal to the original region.

See also setRects().

### QRegion QRegion.subtract (self, QRegion r)

### QRegion QRegion.subtracted (self, QRegion r)

Returns a region which is r subtracted from this region.

The figure shows the result when the ellipse on the right is subtracted from the ellipse on the left (`left - right`).

This function was introduced in Qt 4.2.

See also intersected(), united(), and xored().

### QRegion.translate (self, int dx, int dy)

Translates (moves) the region dx along the X axis and dy along the Y axis.

### QRegion.translate (self, QPoint p)

This is an overloaded function.

Translates the region point.x() along the x axis and point.y() along the y axis, relative to the current position. Positive values move the region to the right and down.

Translates to the given point.

### QRegion QRegion.translated (self, int dx, int dy)

Returns a copy of the region that is translated dx along the x axis and dy along the y axis, relative to the current position. Positive values move the region to the right and down.

This function was introduced in Qt 4.1.

See also translate().

### QRegion QRegion.translated (self, QPoint p)

This is an overloaded function.

Returns a copy of the regtion that is translated p.x() along the x axis and p.y() along the y axis, relative to the current position. Positive values move the rectangle to the right and down.

This function was introduced in Qt 4.1.

See also translate().

### QRegion QRegion.unite (self, QRegion r)

### QRegion QRegion.united (self, QRegion r)

Returns a region which is the union of this region and r.

The figure shows the union of two elliptical regions.

This function was introduced in Qt 4.2.

See also intersected(), subtracted(), and xored().

### QRegion QRegion.united (self, QRect r)

Returns a region which is the union of this region and the given rect.

This function was introduced in Qt 4.4.

See also intersected(), subtracted(), and xored().

### QRegion QRegion.xored (self, QRegion r)

Returns a region which is the exclusive or (XOR) of this region and r.

The figure shows the exclusive or of two elliptical regions.

This function was introduced in Qt 4.2.

See also intersected(), united(), and subtracted().

### QRegion QRegion.__add__ (self, QRegion r)

### QRegion QRegion.__add__ (self, QRect r)

### QRegion QRegion.__and__ (self, QRegion r)

### QRegion QRegion.__and__ (self, QRect r)

### int QRegion.__bool__ (self)

### int QRegion.__contains__ (self, QPoint p)

### int QRegion.__contains__ (self, QRect r)

### bool QRegion.__eq__ (self, QRegion r)

### QRegion QRegion.__iadd__ (self, QRegion r)

### QRegion QRegion.__iadd__ (self, QRect r)

### QRegion QRegion.__iand__ (self, QRegion r)

### QRegion QRegion.__iand__ (self, QRect r)

### QRegion QRegion.__ior__ (self, QRegion r)

### QRegion QRegion.__isub__ (self, QRegion r)

### QRegion QRegion.__ixor__ (self, QRegion r)

### QRegion QRegion.__mul__ (self, QMatrix m)

### QRegion QRegion.__mul__ (self, QTransform m)

### bool QRegion.__ne__ (self, QRegion r)

### QRegion QRegion.__or__ (self, QRegion r)

### QRegion QRegion.__sub__ (self, QRegion r)

### QRegion QRegion.__xor__ (self, QRegion r)