Qt Toolkit - QPaintDevice Class

# QPaintDevice Class Reference

The base class of objects that can be painted. More...

`#include <qpaintdevice.h>`

Inherited by QPicture, QPixmap, QPrinter and QWidget.

List of all member functions.

## Public Members

- virtual ~QPaintDevice ()
- int devType () const
- bool isExtDev () const
- bool paintingActive () const
- HANDLE handle () const
- Display* x11Display () const

## Protected Members

- QPaintDevice ( uint devflags )
- virtual bool cmd ( int, QPainter *, QPDevCmdParam * )
- virtual int metric ( int ) const
- virtual int fontMet ( QFont *, int, const char * = 0, int = 0 ) const
- virtual int fontInf ( QFont *, int ) const

## Related Functions

(Note that these are not member functions.)

- void bitBlt (QPaintDevice * dst, int dx, int dy, const QPaintDevice * src, int sx, int sy, int sw, int sh, RasterOp rop, bool ignoreMask)
- void bitBlt (QPaintDevice * dst, const QPoint & dp, const QPaintDevice * src, const QRect & sr, RasterOp rop)

## Detailed Description

The base class of objects that can be painted.

A paint device is an abstraction of a two-dimensional space that can be drawn using a QPainter. The drawing capabilities are implemented by the subclasses: QWidget, QPixmap, QPicture and QPrinter.

The default coordinate system of a paint device has its origin located at the top left position. X increases to the right and Y increases downwards. The unit is one pixel. There are several ways to set up a user-defined coordinate system using the painter, for example by QPainter::setWorldMatrix().

Example (draw on a paint device):

        void MyWidget::paintEvent( QPaintEvent * )
        {
            QPainter p;                             // our painter
            p.begin( this );                        // start painting widget
            p.setPen( red );                        // blue outline
            p.setBrush( yellow );                   // yellow fill
            p.drawEllipse( 10,20, 100,100 );        // 100x100 ellipse at 10,20
            p.end();                                // painting done
        }

The bit block transfer is an extremely useful operation for copying pixels from one paint device to another (or to itself). It is implemented as the global function bitBlt().

Example (scroll widget contents 10 pixels to the right):

        bitBlt( myWidget, 10,0, myWidget );

Warning: Qt requires that a QApplication object must exist before any paint devices can be created. Paint devices access window system resources, and these resources are not initialized before an application object is created.

## Member Function Documentation

### QPaintDevice::QPaintDevice ( uint devflags ) `[protected]`

Constructs a paint device with internal flags devflags. This constructor can only be invoked from subclasses of QPaintDevice.

### QPaintDevice::~QPaintDevice () `[virtual]`

Destroys the paint device and frees window system resources.

### bool QPaintDevice::cmd ( int, QPainter *, QPDevCmdParam * ) `[virtual protected]`

Internal virtual function that interprets drawing commands from the painter.

Implemented by subclasses that have no direct support for drawing graphics (external paint devices, for example QPicture).

Reimplemented in QPicture and QPrinter.

### int QPaintDevice::devType () const

Returns the device type identifier: `PDT_WIDGET, PDT_PIXMAP, PDT_PRINTER, PDT_PICTURE` or `PDT_UNDEF.`

### int QPaintDevice::fontInf ( QFont *, int ) const `[virtual protected]`

Internal virtual function. Reserved for future use.

### int QPaintDevice::fontMet ( QFont *, int, const char * = 0, int = 0 ) const `[virtual protected]`

Internal virtual function. Reserved for future use.

### HANDLE QPaintDevice::handle () const

Returns the window system handle of the paint device, for low-level access. Using this function is not portable.

The HANDLE type varies with platform; see qpaintdevice.h and qwindowdefs.h for details.

See also: x11Display().

### bool QPaintDevice::isExtDev () const

Returns TRUE if the device is a so-called external paint device.

External paint devices cannot be bitBlt()'ed from. QPicture and QPrinter are external paint devices.

### int QPaintDevice::metric ( int ) const `[virtual protected]`

Internal virtual function that returns paint device metrics.

Please use the QPaintDeviceMetrics class instead.

Reimplemented in QPixmap, QWidget, QPicture and QPrinter.

### bool QPaintDevice::paintingActive () const

Returns TRUE if the device is being painted, i.e. someone has called QPainter::begin() and not yet QPainter::end() for this device.

See also: QPainter::isActive().

### Display * QPaintDevice::x11Display () const

Returns a pointer to the X display (X11 only). Using this function is not portable.

See also: handle().

## Related Functions

### void bitBlt (QPaintDevice * dst, int dx, int dy, const QPaintDevice * src, int sx, int sy, int sw, int sh, RasterOp rop, bool ignoreMask)

This function copies a block of pixels from one paint device to another (bitBlt means bit block transfer).

Arguments:

- dst is the paint device to copy to.
- dx and dy is the position to copy to.
- src is the paint device to copy from.
- sx and sy is the position to copy from.
- sw and sh is the width and height of the block to be copied.
- rop defines the raster operation to be used when copying.

If sw is 0 or sh is 0, then bitBlt will do nothing.

If sw is negative, then bitBlt calculates `sw = src->width - sx.` If sh is negative, then bitBlt calculates `sh = src->height - sy.`

The rop argument can be one of:

- `CopyROP:` dst = src.
- `OrROP:` dst = dst OR src.
- `XorROP:` dst = dst XOR src.
- `EraseROP:` dst = (NOT src) AND dst
- `NotCopyROP:` dst = NOT src
- `NotOrROP:` dst = (NOT src) OR dst
- `NotXorROP:` dst = (NOT src) XOR dst
- `NotEraseROP:` dst = src AND dst
- `NotROP:` dst = NOT dst

The ignoreMask argument (default FALSE) applies where src is a QPixmap with a mask. If ignoreMask is TRUE, bitBlt ignores the pixmap's mask.

BitBlt has two restrictions:

1. The src device must be QWidget or QPixmap. You cannot copy pixels from a picture or a printer (external device).
2. The src device may not have pixel depth greater than dst. You cannot copy from an 8 bit pixmap to a 1 bit pixmap.

Examples: desktop/desktop.cpp hello/hello.cpp xform/xform.cpp showimg/showimg.cpp biff/biff.cpp

### void bitBlt (QPaintDevice * dst, const QPoint & dp, const QPaintDevice * src, const QRect & sr, RasterOp rop)

Overloaded bitBlt() with the destination point dp and source rectangle sr.

Search the documentation, FAQ, qt-interest archive and more (uses www.troll.no):

This file is part of the Qt toolkit, copyright © 1995-99 Troll Tech, all rights reserved.

It was generated from the following files:

- qpaintdevice.h: 1999/01/18
- qpaintdevice_x11.cpp: 1998/07/03