QCanvasPixmap Class

Home | All Classes | Main Classes | Annotated | Grouped Classes | Functions |

# QCanvasPixmap Class Reference
[canvas module]

The QCanvasPixmap class provides a pixmap in a QCanvas. More...

`#include <qcanvas.h>`

Inherits QPixmap.

List of all member functions.

## Public Members

- QCanvasPixmap ( const QString & datafilename )
- QCanvasPixmap ( const QImage & image )
- QCanvasPixmap ( const QPixmap & pm, const QPoint & offset )
- ~QCanvasPixmap ()
- int offsetX () const
- int offsetY () const
- void setOffset ( int x, int y )

## Detailed Description

The QCanvasPixmap class provides a pixmap in a QCanvas.

The pixmap is a QPixmap and can only be set in the constructor. There are three different constructors, one taking a QPixmap, one a QImage and one a file name that refers to a file in any supported file format (see QImageIO).

Since QCanvasSprite needs (and other uses of pixmaps often need) a hot spot, QCanvasPixmap provides one. When you create the QCanvasPixmap from a PNG file or from a QImage that has a QImage::offset(), the offset() is initialized appropriately, otherwise the constructor leaves it at (0,0). You can set it later using setOffset(). When the QCanvasPixmap is used in a QCanvasSprite, the offset position is the point at QCanvasItem::x() and QCanvasItem::y(), not the top-left corner of the pixmap.

Note that for QCanvasPixmap objects created by a QCanvasSprite, the position of each QCanvasPixmap object is set so that the hot spot stays in the same position.

Like any other canvas item canvas pixmaps can be moved with QCanvasItem::move() and QCanvasItem::moveBy(), or by setting coordinates with QCanvasItem::setX(), QCanvasItem::setY() and QCanvasItem::setZ().

See also QCanvasPixmapArray, QCanvasItem, QCanvasSprite, Graphics Classes and Image Processing Classes.

## Member Function Documentation

### QCanvasPixmap::QCanvasPixmap ( const QString & datafilename )

Constructs a QCanvasPixmap from an image file at the location specified in datafilename by loading it.

### QCanvasPixmap::QCanvasPixmap ( const QImage & image )

Constructs a QCanvasPixmap from the image image.

### QCanvasPixmap::QCanvasPixmap ( const QPixmap & pm, const QPoint & offset )

Constructs a QCanvasPixmap from the pixmap pm using the offset offset.

### QCanvasPixmap::~QCanvasPixmap ()

Destroys the pixmap.

### int QCanvasPixmap::offsetX () const

Returns the X-offset of the pixmap's hot spot.

See also setOffset().

### int QCanvasPixmap::offsetY () const

Returns the Y-offset of the pixmap's hot spot.

See also setOffset().

### void QCanvasPixmap::setOffset ( int x, int y )

Sets the offset of the pixmap's hot spot to (x, y).

Note that you must not call this function if any QCanvasSprites are currently showing this pixmap.

This file is part of the Qt toolkit, copyright © 1995-2001 Trolltech, all rights reserved.