The QGraphicsPixmapItem class provides a pixmap item that you can add to a QGraphicsScene. More...

#include <qgraphicsitem.h>

Inheritance diagram for QGraphicsPixmapItem:

Collaboration diagram for QGraphicsPixmapItem:

Public Types
enum	ShapeMode { MaskShape , BoundingRectShape , HeuristicMaskShape }
	This enum describes how QGraphicsPixmapItem calculates its shape and opaque area. More...

enum	{ Type = 7 }

Public Types inherited from QGraphicsItem
enum	GraphicsItemFlag { ItemIsMovable = 0x1 , ItemIsSelectable = 0x2 , ItemIsFocusable = 0x4 , ItemClipsToShape = 0x8 , ItemClipsChildrenToShape = 0x10 , ItemIgnoresTransformations = 0x20 , ItemIgnoresParentOpacity = 0x40 , ItemDoesntPropagateOpacityToChildren = 0x80 , ItemStacksBehindParent = 0x100 , ItemUsesExtendedStyleOption = 0x200 , ItemHasNoContents = 0x400 , ItemSendsGeometryChanges = 0x800 , ItemAcceptsInputMethod = 0x1000 , ItemNegativeZStacksBehindParent = 0x2000 , ItemIsPanel = 0x4000 , ItemIsFocusScope = 0x8000 , ItemSendsScenePositionChanges = 0x10000 , ItemStopsClickFocusPropagation = 0x20000 , ItemStopsFocusHandling = 0x40000 , ItemContainsChildrenInShape = 0x80000 }
	This enum describes different flags that you can set on an item to toggle different features in the item's behavior. More...

enum	GraphicsItemChange { ItemPositionChange , ItemVisibleChange = 2 , ItemEnabledChange , ItemSelectedChange , ItemParentChange , ItemChildAddedChange , ItemChildRemovedChange , ItemTransformChange , ItemPositionHasChanged , ItemTransformHasChanged , ItemSceneChange , ItemVisibleHasChanged , ItemEnabledHasChanged , ItemSelectedHasChanged , ItemParentHasChanged , ItemSceneHasChanged , ItemCursorChange , ItemCursorHasChanged , ItemToolTipChange , ItemToolTipHasChanged , ItemFlagsChange , ItemFlagsHaveChanged , ItemZValueChange , ItemZValueHasChanged , ItemOpacityChange , ItemOpacityHasChanged , ItemScenePositionHasChanged , ItemRotationChange , ItemRotationHasChanged , ItemScaleChange , ItemScaleHasChanged , ItemTransformOriginPointChange , ItemTransformOriginPointHasChanged }
	This enum describes the state changes that are notified by QGraphicsItem::itemChange(). More...

enum	CacheMode { NoCache , ItemCoordinateCache , DeviceCoordinateCache }

enum	PanelModality { NonModal , PanelModal , SceneModal }

enum	{ Type = 1 , UserType = 65536 }

Public Member Functions
	QGraphicsPixmapItem (QGraphicsItem *parent=nullptr)
	Constructs a QGraphicsPixmapItem.

	QGraphicsPixmapItem (const QPixmap &pixmap, QGraphicsItem *parent=nullptr)
	Constructs a QGraphicsPixmapItem, using pixmap as the default pixmap.

	~QGraphicsPixmapItem ()
	Destroys the QGraphicsPixmapItem.

QPixmap	pixmap () const
	Returns the item's pixmap, or an invalid QPixmap if no pixmap has been set.

void	setPixmap (const QPixmap &pixmap)
	Sets the item's pixmap to pixmap.

Qt::TransformationMode	transformationMode () const
	Returns the transformation mode of the pixmap.

void	setTransformationMode (Qt::TransformationMode mode)
	Sets the pixmap item's transformation mode to mode, and toggles an update of the item.

QPointF	offset () const
	Returns the pixmap item's offset, which defines the point of the top-left corner of the pixmap, in local coordinates.

void	setOffset (const QPointF &offset)
	Sets the pixmap item's offset to offset.

void	setOffset (qreal x, qreal y)

QRectF	boundingRect () const override
	\reimp

QPainterPath	shape () const override
	\reimp

bool	contains (const QPointF &point) const override
	\reimp

void	paint (QPainter painter, const QStyleOptionGraphicsItem option, QWidget *widget) override
	\reimp

bool	isObscuredBy (const QGraphicsItem *item) const override
	\reimp

QPainterPath	opaqueArea () const override
	\reimp

int	type () const override
	\reimp

ShapeMode	shapeMode () const
	Returns the item's shape mode.

void	setShapeMode (ShapeMode mode)
	Sets the item's shape mode to mode.

Public Member Functions inherited from QGraphicsItem
	QGraphicsItem (QGraphicsItem *parent=nullptr)
	Constructs a QGraphicsItem with the given parent item.

virtual	~QGraphicsItem ()
	Destroys the QGraphicsItem and all its children.

QGraphicsScene *	scene () const
	Returns the current scene for the item, or \nullptr if the item is not stored in a scene.

QGraphicsItem *	parentItem () const
	Returns a pointer to this item's parent item.

QGraphicsItem *	topLevelItem () const
	Returns this item's top-level item.

QGraphicsObject *	parentObject () const

QGraphicsWidget *	parentWidget () const

QGraphicsWidget *	topLevelWidget () const

QGraphicsWidget *	window () const

QGraphicsItem *	panel () const

void	setParentItem (QGraphicsItem *parent)
	Sets this item's parent item to newParent.

QList< QGraphicsItem * >	childItems () const

bool	isWidget () const

bool	isWindow () const

bool	isPanel () const

QGraphicsObject *	toGraphicsObject ()

const QGraphicsObject *	toGraphicsObject () const

QGraphicsItemGroup *	group () const
	Returns a pointer to this item's item group, or \nullptr if this item is not member of a group.

void	setGroup (QGraphicsItemGroup *group)
	Adds this item to the item group group.

GraphicsItemFlags	flags () const
	Returns this item's flags.

void	setFlag (GraphicsItemFlag flag, bool enabled=true)
	If enabled is true, the item flag flag is enabled; otherwise, it is disabled.

void	setFlags (GraphicsItemFlags flags)
	Sets the item flags to flags.

CacheMode	cacheMode () const

void	setCacheMode (CacheMode mode, const QSize &cacheSize=QSize())

PanelModality	panelModality () const

void	setPanelModality (PanelModality panelModality)

bool	isBlockedByModalPanel (QGraphicsItem **blockingPanel=nullptr) const

QCursor	cursor () const
	Returns the current cursor shape for the item.

void	setCursor (const QCursor &cursor)
	Sets the current cursor shape for the item to cursor.

bool	hasCursor () const
	Returns `true` if this item has a cursor set; otherwise, false is returned.

void	unsetCursor ()
	Clears the cursor from this item.

bool	isVisible () const
	Returns `true` if the item is visible; otherwise, false is returned.

bool	isVisibleTo (const QGraphicsItem *parent) const

void	setVisible (bool visible)
	If visible is true, the item is made visible.

void	hide ()
	Hides the item (items are visible by default).

void	show ()
	Shows the item (items are visible by default).

bool	isEnabled () const
	Returns `true` if the item is enabled; otherwise, false is returned.

void	setEnabled (bool enabled)
	If enabled is true, the item is enabled; otherwise, it is disabled.

bool	isSelected () const
	Returns `true` if this item is selected; otherwise, false is returned.

void	setSelected (bool selected)
	If selected is true and this item is selectable, this item is selected; otherwise, it is unselected.

bool	acceptDrops () const
	Returns `true` if this item can accept drag and drop events; otherwise, returns `false`.

void	setAcceptDrops (bool on)
	If on is true, this item will accept drag and drop events; otherwise, it is transparent for drag and drop events.

qreal	opacity () const

qreal	effectiveOpacity () const

void	setOpacity (qreal opacity)

Qt::MouseButtons	acceptedMouseButtons () const
	Returns the mouse buttons that this item accepts mouse events for.

void	setAcceptedMouseButtons (Qt::MouseButtons buttons)
	Sets the mouse buttons that this item accepts mouse events for.

bool	acceptHoverEvents () const

void	setAcceptHoverEvents (bool enabled)

bool	acceptTouchEvents () const

void	setAcceptTouchEvents (bool enabled)

bool	filtersChildEvents () const

void	setFiltersChildEvents (bool enabled)

bool	handlesChildEvents () const

void	setHandlesChildEvents (bool enabled)

bool	isActive () const

void	setActive (bool active)

bool	hasFocus () const
	Returns `true` if this item is active, and it or its \l{focusProxy()}{focus proxy} has keyboard input focus; otherwise, returns `false`.

void	setFocus (Qt::FocusReason focusReason=Qt::OtherFocusReason)
	Gives keyboard input focus to this item.

void	clearFocus ()
	Takes keyboard input focus from the item.

QGraphicsItem *	focusProxy () const

void	setFocusProxy (QGraphicsItem *item)

QGraphicsItem *	focusItem () const

QGraphicsItem *	focusScopeItem () const

void	grabMouse ()

void	ungrabMouse ()

void	grabKeyboard ()

void	ungrabKeyboard ()

QPointF	pos () const
	Returns the position of the item in parent coordinates.

qreal	x () const
	This convenience function is equivalent to calling pos().x().

void	setX (qreal x)

qreal	y () const
	This convenience function is equivalent to calling pos().y().

void	setY (qreal y)

QPointF	scenePos () const
	Returns the item's position in scene coordinates.

void	setPos (const QPointF &pos)
	Sets the position of the item to pos, which is in parent coordinates.

void	setPos (qreal x, qreal y)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This convenience function is equivalent to calling setPos(QPointF(x, y)).

void	moveBy (qreal dx, qreal dy)
	Moves the item by dx points horizontally, and dy point vertically.

void	ensureVisible (const QRectF &rect=QRectF(), int xmargin=50, int ymargin=50)
	If this item is part of a scene that is viewed by a QGraphicsView, this convenience function will attempt to scroll the view to ensure that rect is visible inside the view's viewport.

void	ensureVisible (qreal x, qreal y, qreal w, qreal h, int xmargin=50, int ymargin=50)
	This convenience function is equivalent to calling ensureVisible(QRectF(x, y, w, h), xmargin, ymargin).

QTransform	transform () const

QTransform	sceneTransform () const

QTransform	deviceTransform (const QTransform &viewportTransform) const

QTransform	itemTransform (const QGraphicsItem other, bool ok=nullptr) const

void	setTransform (const QTransform &matrix, bool combine=false)

void	resetTransform ()

void	setRotation (qreal angle)

qreal	rotation () const

void	setScale (qreal scale)

qreal	scale () const

QList< QGraphicsTransform * >	transformations () const

void	setTransformations (const QList< QGraphicsTransform * > &transformations)

QPointF	transformOriginPoint () const

void	setTransformOriginPoint (const QPointF &origin)

void	setTransformOriginPoint (qreal ax, qreal ay)

virtual void	advance (int phase)
	This virtual function is called twice for all items by the QGraphicsScene::advance() slot.

qreal	zValue () const
	Returns the Z-value of the item.

void	setZValue (qreal z)
	Sets the Z-value of the item to z.

void	stackBefore (const QGraphicsItem *sibling)

QRectF	childrenBoundingRect () const
	Returns the bounding rect of this item's descendants (i.e., its children, their children, etc.) in local coordinates.

QRectF	sceneBoundingRect () const
	Returns the bounding rect of this item in scene coordinates, by combining sceneTransform() with boundingRect().

bool	isClipped () const
	Returns `true` if this item is clipped.

QPainterPath	clipPath () const

virtual bool	collidesWithItem (const QGraphicsItem *other, Qt::ItemSelectionMode mode=Qt::IntersectsItemShape) const
	Returns `true` if this item collides with other; otherwise returns `false`.

virtual bool	collidesWithPath (const QPainterPath &path, Qt::ItemSelectionMode mode=Qt::IntersectsItemShape) const
	Returns `true` if this item collides with path.

QList< QGraphicsItem * >	collidingItems (Qt::ItemSelectionMode mode=Qt::IntersectsItemShape) const
	Returns a list of all items that collide with this item.

bool	isObscured (const QRectF &rect=QRectF()) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

bool	isObscured (qreal x, qreal y, qreal w, qreal h) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

QRegion	boundingRegion (const QTransform &itemToDeviceTransform) const

qreal	boundingRegionGranularity () const

void	setBoundingRegionGranularity (qreal granularity)

void	update (const QRectF &rect=QRectF())
	Schedules a redraw of the area covered by rect in this item.

void	update (qreal x, qreal y, qreal width, qreal height)
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This convenience function is equivalent to calling update(QRectF(x, y, width, height)).

void	scroll (qreal dx, qreal dy, const QRectF &rect=QRectF())

QPointF	mapToItem (const QGraphicsItem *item, const QPointF &point) const
	Maps the point point, which is in this item's coordinate system, to item's coordinate system, and returns the mapped coordinate.

QPointF	mapToParent (const QPointF &point) const
	Maps the point point, which is in this item's coordinate system, to its parent's coordinate system, and returns the mapped coordinate.

QPointF	mapToScene (const QPointF &point) const
	Maps the point point, which is in this item's coordinate system, to the scene's coordinate system, and returns the mapped coordinate.

QPolygonF	mapToItem (const QGraphicsItem *item, const QRectF &rect) const
	Maps the rectangle rect, which is in this item's coordinate system, to item's coordinate system, and returns the mapped rectangle as a polygon.

QPolygonF	mapToParent (const QRectF &rect) const
	Maps the rectangle rect, which is in this item's coordinate system, to its parent's coordinate system, and returns the mapped rectangle as a polygon.

QPolygonF	mapToScene (const QRectF &rect) const
	Maps the rectangle rect, which is in this item's coordinate system, to the scene's coordinate system, and returns the mapped rectangle as a polygon.

QRectF	mapRectToItem (const QGraphicsItem *item, const QRectF &rect) const

QRectF	mapRectToParent (const QRectF &rect) const

QRectF	mapRectToScene (const QRectF &rect) const

QPolygonF	mapToItem (const QGraphicsItem *item, const QPolygonF &polygon) const
	Maps the polygon polygon, which is in this item's coordinate system, to item's coordinate system, and returns the mapped polygon.

QPolygonF	mapToParent (const QPolygonF &polygon) const
	Maps the polygon polygon, which is in this item's coordinate system, to its parent's coordinate system, and returns the mapped polygon.

QPolygonF	mapToScene (const QPolygonF &polygon) const
	Maps the polygon polygon, which is in this item's coordinate system, to the scene's coordinate system, and returns the mapped polygon.

QPainterPath	mapToItem (const QGraphicsItem *item, const QPainterPath &path) const
	Maps the path path, which is in this item's coordinate system, to item's coordinate system, and returns the mapped path.

QPainterPath	mapToParent (const QPainterPath &path) const
	Maps the path path, which is in this item's coordinate system, to its parent's coordinate system, and returns the mapped path.

QPainterPath	mapToScene (const QPainterPath &path) const
	Maps the path path, which is in this item's coordinate system, to the scene's coordinate system, and returns the mapped path.

QPointF	mapFromItem (const QGraphicsItem *item, const QPointF &point) const
	Maps the point point, which is in item's coordinate system, to this item's coordinate system, and returns the mapped coordinate.

QPointF	mapFromParent (const QPointF &point) const
	Maps the point point, which is in this item's parent's coordinate system, to this item's coordinate system, and returns the mapped coordinate.

QPointF	mapFromScene (const QPointF &point) const
	Maps the point point, which is in this item's scene's coordinate system, to this item's coordinate system, and returns the mapped coordinate.

QPolygonF	mapFromItem (const QGraphicsItem *item, const QRectF &rect) const
	Maps the rectangle rect, which is in item's coordinate system, to this item's coordinate system, and returns the mapped rectangle as a polygon.

QPolygonF	mapFromParent (const QRectF &rect) const
	Maps the rectangle rect, which is in this item's parent's coordinate system, to this item's coordinate system, and returns the mapped rectangle as a polygon.

QPolygonF	mapFromScene (const QRectF &rect) const
	Maps the rectangle rect, which is in this item's scene's coordinate system, to this item's coordinate system, and returns the mapped rectangle as a polygon.

QRectF	mapRectFromItem (const QGraphicsItem *item, const QRectF &rect) const

QRectF	mapRectFromParent (const QRectF &rect) const

QRectF	mapRectFromScene (const QRectF &rect) const

QPolygonF	mapFromItem (const QGraphicsItem *item, const QPolygonF &polygon) const
	Maps the polygon polygon, which is in item's coordinate system, to this item's coordinate system, and returns the mapped polygon.

QPolygonF	mapFromParent (const QPolygonF &polygon) const
	Maps the polygon polygon, which is in this item's parent's coordinate system, to this item's coordinate system, and returns the mapped polygon.

QPolygonF	mapFromScene (const QPolygonF &polygon) const
	Maps the polygon polygon, which is in this item's scene's coordinate system, to this item's coordinate system, and returns the mapped polygon.

QPainterPath	mapFromItem (const QGraphicsItem *item, const QPainterPath &path) const
	Maps the path path, which is in item's coordinate system, to this item's coordinate system, and returns the mapped path.

QPainterPath	mapFromParent (const QPainterPath &path) const
	Maps the path path, which is in this item's parent's coordinate system, to this item's coordinate system, and returns the mapped path.

QPainterPath	mapFromScene (const QPainterPath &path) const
	Maps the path path, which is in this item's scene's coordinate system, to this item's coordinate system, and returns the mapped path.

QPointF	mapToItem (const QGraphicsItem *item, qreal x, qreal y) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This convenience function is equivalent to calling mapToItem(item, QPointF(x, y)).

QPointF	mapToParent (qreal x, qreal y) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This convenience function is equivalent to calling mapToParent(QPointF(x, y)).

QPointF	mapToScene (qreal x, qreal y) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This convenience function is equivalent to calling mapToScene(QPointF(x, y)).

QPolygonF	mapToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapToParent (qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapToScene (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectToItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectToParent (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectToScene (qreal x, qreal y, qreal w, qreal h) const

QPointF	mapFromItem (const QGraphicsItem *item, qreal x, qreal y) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This convenience function is equivalent to calling mapFromItem(item, QPointF(x, y)).

QPointF	mapFromParent (qreal x, qreal y) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This convenience function is equivalent to calling mapFromParent(QPointF(x, y)).

QPointF	mapFromScene (qreal x, qreal y) const
	This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.This convenience function is equivalent to calling mapFromScene(QPointF(x, y)).

QPolygonF	mapFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapFromParent (qreal x, qreal y, qreal w, qreal h) const

QPolygonF	mapFromScene (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromItem (const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromParent (qreal x, qreal y, qreal w, qreal h) const

QRectF	mapRectFromScene (qreal x, qreal y, qreal w, qreal h) const

bool	isAncestorOf (const QGraphicsItem *child) const
	Returns `true` if this item is an ancestor of child (i.e., if this item is child's parent, or one of child's parent's ancestors).

QGraphicsItem *	commonAncestorItem (const QGraphicsItem *other) const

bool	isUnderMouse () const

QVariant	data (int key) const
	Returns this item's custom data for the key key as a QVariant.

void	setData (int key, const QVariant &value)
	Sets this item's custom data for the key key to value.

Qt::InputMethodHints	inputMethodHints () const
	Returns the current input method hints of this item.

void	setInputMethodHints (Qt::InputMethodHints hints)
	Sets the current input method hints of this item to hints.

void	installSceneEventFilter (QGraphicsItem *filterItem)
	Installs an event filter for this item on filterItem, causing all events for this item to first pass through filterItem's sceneEventFilter() function.

void	removeSceneEventFilter (QGraphicsItem *filterItem)
	Removes an event filter on this item from filterItem.

Protected Member Functions
bool	supportsExtension (Extension extension) const override

void	setExtension (Extension extension, const QVariant &variant) override

QVariant	extension (const QVariant &variant) const override

Protected Member Functions inherited from QGraphicsItem
void	updateMicroFocus ()
	Updates the item's micro focus.

virtual bool	sceneEventFilter (QGraphicsItem watched, QEvent event)
	Filters events for the item watched.

virtual bool	sceneEvent (QEvent *event)
	This virtual function receives events to this item.

virtual void	contextMenuEvent (QGraphicsSceneContextMenuEvent *event)
	This event handler can be reimplemented in a subclass to process context menu events.

virtual void	dragEnterEvent (QGraphicsSceneDragDropEvent *event)
	This event handler, for event event, can be reimplemented to receive drag enter events for this item.

virtual void	dragLeaveEvent (QGraphicsSceneDragDropEvent *event)
	This event handler, for event event, can be reimplemented to receive drag leave events for this item.

virtual void	dragMoveEvent (QGraphicsSceneDragDropEvent *event)
	This event handler, for event event, can be reimplemented to receive drag move events for this item.

virtual void	dropEvent (QGraphicsSceneDragDropEvent *event)
	This event handler, for event event, can be reimplemented to receive drop events for this item.

virtual void	focusInEvent (QFocusEvent *event)
	This event handler, for event event, can be reimplemented to receive focus in events for this item.

virtual void	focusOutEvent (QFocusEvent *event)
	This event handler, for event event, can be reimplemented to receive focus out events for this item.

virtual void	hoverEnterEvent (QGraphicsSceneHoverEvent *event)
	This event handler, for event event, can be reimplemented to receive hover enter events for this item.

virtual void	hoverMoveEvent (QGraphicsSceneHoverEvent *event)
	This event handler, for event event, can be reimplemented to receive hover move events for this item.

virtual void	hoverLeaveEvent (QGraphicsSceneHoverEvent *event)
	This event handler, for event event, can be reimplemented to receive hover leave events for this item.

virtual void	keyPressEvent (QKeyEvent *event)
	This event handler, for event event, can be reimplemented to receive key press events for this item.

virtual void	keyReleaseEvent (QKeyEvent *event)
	This event handler, for event event, can be reimplemented to receive key release events for this item.

virtual void	mousePressEvent (QGraphicsSceneMouseEvent *event)
	This event handler, for event event, can be reimplemented to receive mouse press events for this item.

virtual void	mouseMoveEvent (QGraphicsSceneMouseEvent *event)
	This event handler, for event event, can be reimplemented to receive mouse move events for this item.

virtual void	mouseReleaseEvent (QGraphicsSceneMouseEvent *event)
	This event handler, for event event, can be reimplemented to receive mouse release events for this item.

virtual void	mouseDoubleClickEvent (QGraphicsSceneMouseEvent *event)
	This event handler, for event event, can be reimplemented to receive mouse double-click events for this item.

virtual void	wheelEvent (QGraphicsSceneWheelEvent *event)
	This event handler, for event event, can be reimplemented to receive wheel events for this item.

virtual void	inputMethodEvent (QInputMethodEvent *event)
	This event handler, for event event, can be reimplemented to receive input method events for this item.

virtual QVariant	inputMethodQuery (Qt::InputMethodQuery query) const
	This method is only relevant for input items.

virtual QVariant	itemChange (GraphicsItemChange change, const QVariant &value)
	This virtual function is called by QGraphicsItem to notify custom items that some part of the item's state changes.

	QGraphicsItem (QGraphicsItemPrivate &dd, QGraphicsItem *parent)

void	addToIndex ()

void	removeFromIndex ()

void	prepareGeometryChange ()
	Prepares the item for a geometry change.

Additional Inherited Members
Protected Types inherited from QGraphicsItem
enum	Extension { UserExtension = 0x80000000 }

Protected Attributes inherited from QGraphicsItem
QScopedPointer< QGraphicsItemPrivate >	d_ptr

Related Symbols inherited from QGraphicsItem
template< class T >	qgraphicsitem_cast (QGraphicsItem *item)

Detailed Description

The QGraphicsPixmapItem class provides a pixmap item that you can add to a QGraphicsScene.

Since: 4.2

\inmodule QtWidgets

To set the item's pixmap, pass a QPixmap to QGraphicsPixmapItem's constructor, or call the setPixmap() function. The pixmap() function returns the current pixmap.

QGraphicsPixmapItem uses pixmap's optional alpha mask to provide a reasonable implementation of boundingRect(), shape(), and contains().

The pixmap is drawn at the item's (0, 0) coordinate, as returned by offset(). You can change the drawing offset by calling setOffset().

You can set the pixmap's transformation mode by calling setTransformationMode(). By default, Qt::FastTransformation is used, which provides fast, non-smooth scaling. Qt::SmoothTransformation enables QPainter::SmoothPixmapTransform on the painter, and the quality depends on the platform and viewport. The result is usually not as good as calling QPixmap::scale() directly. Call transformationMode() to get the current transformation mode for the item.

See also: QGraphicsPathItem, QGraphicsRectItem, QGraphicsEllipseItem, QGraphicsTextItem, QGraphicsPolygonItem, QGraphicsLineItem, {Graphics View Framework}

Definition at line 764 of file qgraphicsitem.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
Type

Definition at line 796 of file qgraphicsitem.h.

◆ ShapeMode

enum QGraphicsPixmapItem::ShapeMode

This enum describes how QGraphicsPixmapItem calculates its shape and opaque area.

The default value is MaskShape.

\value MaskShape The shape is determined by calling QPixmap::mask(). This shape includes only the opaque pixels of the pixmap. Because the shape is more complex, however, it can be slower than the other modes, and uses more memory.

\value BoundingRectShape The shape is determined by tracing the outline of the pixmap. This is the fastest shape mode, but it does not take into account any transparent areas on the pixmap.

\value HeuristicMaskShape The shape is determine by calling QPixmap::createHeuristicMask(). The performance and memory consumption is similar to MaskShape.

Enumerator
MaskShape
BoundingRectShape
HeuristicMaskShape

Definition at line 767 of file qgraphicsitem.h.

Constructor & Destructor Documentation

◆ QGraphicsPixmapItem() [1/2]

QGraphicsPixmapItem::QGraphicsPixmapItem ( QGraphicsItem * parent = nullptr )

explicit

Constructs a QGraphicsPixmapItem.

parent is passed to QGraphicsItem's constructor.

See also: QGraphicsScene::addItem()

Definition at line 9376 of file qgraphicsitem.cpp.

◆ QGraphicsPixmapItem() [2/2]

QGraphicsPixmapItem::QGraphicsPixmapItem	(	const QPixmap &	pixmap,
		QGraphicsItem *	parent = nullptr )

explicit

Constructs a QGraphicsPixmapItem, using pixmap as the default pixmap.

parent is passed to QGraphicsItem's constructor.

See also: QGraphicsScene::addItem()

Definition at line 9364 of file qgraphicsitem.cpp.

References pixmap(), and setPixmap().

Here is the call graph for this function:

◆ ~QGraphicsPixmapItem()

QGraphicsPixmapItem::~QGraphicsPixmapItem ( )

Destroys the QGraphicsPixmapItem.

Definition at line 9384 of file qgraphicsitem.cpp.

Member Function Documentation

◆ boundingRect()

QRectF QGraphicsPixmapItem::boundingRect ( ) const

overridevirtual

\reimp

Implements QGraphicsItem.

Definition at line 9486 of file qgraphicsitem.cpp.

References QRectF::adjusted(), d, and QGraphicsItem::ItemIsSelectable.

Here is the call graph for this function:

◆ contains()

bool QGraphicsPixmapItem::contains ( const QPointF & point ) const

overridevirtual

\reimp

Reimplemented from QGraphicsItem.

Definition at line 9516 of file qgraphicsitem.cpp.

References QGraphicsItem::contains().

Here is the call graph for this function:

◆ extension()

QVariant QGraphicsPixmapItem::extension ( const QVariant & variant ) const

overrideprotectedvirtual

Reimplemented from QGraphicsItem.

Definition at line 9610 of file qgraphicsitem.cpp.

References Q_UNUSED, and variant.

◆ isObscuredBy()

bool QGraphicsPixmapItem::isObscuredBy ( const QGraphicsItem * item ) const

overridevirtual

\reimp

Reimplemented from QGraphicsItem.

Definition at line 9542 of file qgraphicsitem.cpp.

References QGraphicsItem::isObscuredBy(), and item.

Here is the call graph for this function:

◆ offset()

QPointF QGraphicsPixmapItem::offset ( ) const

Returns the pixmap item's offset, which defines the point of the top-left corner of the pixmap, in local coordinates.

See also: setOffset()

Definition at line 9453 of file qgraphicsitem.cpp.

References d.

Referenced by QGraphicsEffectSource::pixmap(), and setOffset().

Here is the caller graph for this function:

◆ opaqueArea()

QPainterPath QGraphicsPixmapItem::opaqueArea ( ) const

overridevirtual

\reimp

Reimplemented from QGraphicsItem.

Definition at line 9550 of file qgraphicsitem.cpp.

References shape().

Here is the call graph for this function:

◆ paint()

void QGraphicsPixmapItem::paint	(	QPainter *	painter,
		const QStyleOptionGraphicsItem *	option,
		QWidget *	widget )

overridevirtual

\reimp

Implements QGraphicsItem.

Definition at line 9524 of file qgraphicsitem.cpp.

References d, QPainter::drawPixmap(), painter, Q_UNUSED, qt_graphicsItem_highlightSelected(), QPainter::setRenderHint(), QPainter::SmoothPixmapTransform, Qt::SmoothTransformation, QStyle::State_Selected, and widget.

Here is the call graph for this function:

◆ pixmap()

QPixmap QGraphicsPixmapItem::pixmap ( ) const

Returns the item's pixmap, or an invalid QPixmap if no pixmap has been set.

See also: setPixmap()

Definition at line 9408 of file qgraphicsitem.cpp.

References d.

Referenced by QGraphicsPixmapItem(), and setPixmap().

Here is the caller graph for this function:

◆ setExtension()

void QGraphicsPixmapItem::setExtension	(	Extension	extension,
		const QVariant &	variant )

overrideprotectedvirtual

Reimplemented from QGraphicsItem.

Definition at line 9601 of file qgraphicsitem.cpp.

References extension(), Q_UNUSED, and variant.

Here is the call graph for this function:

◆ setOffset() [1/2]

void QGraphicsPixmapItem::setOffset ( const QPointF & offset )

Sets the pixmap item's offset to offset.

QGraphicsPixmapItem will draw its pixmap using offset for its top-left corner.

See also: offset()

Definition at line 9465 of file qgraphicsitem.cpp.

References d, offset(), QGraphicsItem::prepareGeometryChange(), and QGraphicsItem::update().

Referenced by setOffset().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOffset() [2/2]

void QGraphicsPixmapItem::setOffset	(	qreal	x,
		qreal	y )

inline

Since: 4.3

This convenience function is equivalent to calling setOffset(QPointF(x, y)).

Definition at line 812 of file qgraphicsitem.h.

References setOffset().

Here is the call graph for this function:

◆ setPixmap()

void QGraphicsPixmapItem::setPixmap ( const QPixmap & pixmap )

Sets the item's pixmap to pixmap.

See also: pixmap()

Definition at line 9393 of file qgraphicsitem.cpp.

References d, pixmap(), QGraphicsItem::prepareGeometryChange(), and QGraphicsItem::update().

Referenced by QGraphicsPixmapItem().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setShapeMode()

void QGraphicsPixmapItem::setShapeMode ( ShapeMode mode )

Sets the item's shape mode to mode.

The shape mode describes how QGraphicsPixmapItem calculates its shape. The default mode is MaskShape.

See also: shapeMode(), ShapeMode

Definition at line 9580 of file qgraphicsitem.cpp.

References d.

◆ setTransformationMode()

void QGraphicsPixmapItem::setTransformationMode ( Qt::TransformationMode mode )

Sets the pixmap item's transformation mode to mode, and toggles an update of the item.

The default mode is Qt::FastTransformation, which provides quick transformation with no smoothing.

Qt::SmoothTransformation enables QPainter::SmoothPixmapTransform on the painter, and the quality depends on the platform and viewport. The result is usually not as good as calling QPixmap::scale() directly.

See also: transformationMode()

Definition at line 9438 of file qgraphicsitem.cpp.

References d, and QGraphicsItem::update().

Here is the call graph for this function:

◆ shape()

QPainterPath QGraphicsPixmapItem::shape ( ) const

overridevirtual

\reimp

Reimplemented from QGraphicsItem.

Definition at line 9502 of file qgraphicsitem.cpp.

References d, and QGraphicsPixmapItemPrivate::updateShape().

Referenced by opaqueArea().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ shapeMode()

QGraphicsPixmapItem::ShapeMode QGraphicsPixmapItem::shapeMode ( ) const

Returns the item's shape mode.

The shape mode describes how QGraphicsPixmapItem calculates its shape. The default mode is MaskShape.

See also: setShapeMode(), ShapeMode

Definition at line 9569 of file qgraphicsitem.cpp.

◆ supportsExtension()

bool QGraphicsPixmapItem::supportsExtension ( Extension extension ) const

overrideprotectedvirtual

Reimplemented from QGraphicsItem.

Definition at line 9592 of file qgraphicsitem.cpp.

References extension(), and Q_UNUSED.

Here is the call graph for this function:

◆ transformationMode()

Qt::TransformationMode QGraphicsPixmapItem::transformationMode ( ) const

Returns the transformation mode of the pixmap.

The default mode is Qt::FastTransformation, which provides quick transformation with no smoothing.

See also: setTransformationMode()

Definition at line 9421 of file qgraphicsitem.cpp.

References d.

◆ type()

int QGraphicsPixmapItem::type ( ) const

overridevirtual

\reimp

Reimplemented from QGraphicsItem.

Definition at line 9558 of file qgraphicsitem.cpp.

References Type.

The documentation for this class was generated from the following files:

qtbase/src/widgets/graphicsview/qgraphicsitem.h (798150129804d2efb1f5049cc3b9661279877dd6)
qtbase/src/widgets/graphicsview/qgraphicsitem.cpp (41c95615fc6f58d584f5658d062e35fda17dc3f8)

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

◆ ShapeMode

Constructor & Destructor Documentation

◆ QGraphicsPixmapItem() [1/2]

◆ QGraphicsPixmapItem() [2/2]

◆ ~QGraphicsPixmapItem()

Member Function Documentation

◆ boundingRect()

◆ contains()

◆ extension()

◆ isObscuredBy()

◆ offset()

◆ opaqueArea()

◆ paint()

◆ pixmap()

◆ setExtension()

◆ setOffset() [1/2]

◆ setOffset() [2/2]

◆ setPixmap()

◆ setShapeMode()

◆ setTransformationMode()

◆ shape()

◆ shapeMode()

◆ supportsExtension()

◆ transformationMode()

◆ type()