Google Git
Sign in
third-party-mirror / orbit / refs/heads/master / . / qt-everywhere-src-5.15.1 / qtbase / src / widgets / graphicsview / qgraphicsitem.cpp
blob: 38cab60fc29558922c7d5389b143111531bfbd16 [file] [log] [blame]
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtWidgets module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\class QGraphicsItem
\brief The QGraphicsItem class is the base class for all graphical
items in a QGraphicsScene.
\since 4.2
\ingroup graphicsview-api
\inmodule QtWidgets
It provides a light-weight foundation for writing your own custom items.
This includes defining the item's geometry, collision detection, its
painting implementation and item interaction through its event handlers.
QGraphicsItem is part of the \l{Graphics View Framework}
\image graphicsview-items.png
For convenience, Qt provides a set of standard graphics items for the most
common shapes. These are:
\list
\li QGraphicsEllipseItem provides an ellipse item
\li QGraphicsLineItem provides a line item
\li QGraphicsPathItem provides an arbitrary path item
\li QGraphicsPixmapItem provides a pixmap item
\li QGraphicsPolygonItem provides a polygon item
\li QGraphicsRectItem provides a rectangular item
\li QGraphicsSimpleTextItem provides a simple text label item
\li QGraphicsTextItem provides an advanced text browser item
\endlist
All of an item's geometric information is based on its local coordinate
system. The item's position, pos(), is the only function that does not
operate in local coordinates, as it returns a position in parent
coordinates. \l {The Graphics View Coordinate System} describes the coordinate
system in detail.
You can set whether an item should be visible (i.e., drawn, and accepting
events), by calling setVisible(). Hiding an item will also hide its
children. Similarly, you can enable or disable an item by calling
setEnabled(). If you disable an item, all its children will also be
disabled. By default, items are both visible and enabled. To toggle
whether an item is selected or not, first enable selection by setting
the ItemIsSelectable flag, and then call setSelected(). Normally,
selection is toggled by the scene, as a result of user interaction.
To write your own graphics item, you first create a subclass of
QGraphicsItem, and then start by implementing its two pure virtual public
functions: boundingRect(), which returns an estimate of the area painted
by the item, and paint(), which implements the actual painting. For
example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 0
The boundingRect() function has many different purposes.
QGraphicsScene bases its item index on boundingRect(), and
QGraphicsView uses it both for culling invisible items, and for
determining the area that needs to be recomposed when drawing
overlapping items. In addition, QGraphicsItem's collision
detection mechanisms use boundingRect() to provide an efficient
cut-off. The fine grained collision algorithm in
collidesWithItem() is based on calling shape(), which returns an
accurate outline of the item's shape as a QPainterPath.
QGraphicsScene expects all items boundingRect() and shape() to
remain unchanged unless it is notified. If you want to change an
item's geometry in any way, you must first call
prepareGeometryChange() to allow QGraphicsScene to update its
bookkeeping.
Collision detection can be done in two ways:
\list 1
\li Reimplement shape() to return an accurate shape for your item,
and rely on the default implementation of collidesWithItem() to do
shape-shape intersection. This can be rather expensive if the
shapes are complex.
\li Reimplement collidesWithItem() to provide your own custom item
and shape collision algorithm.
\endlist
The contains() function can be called to determine whether the item \e
contains a point or not. This function can also be reimplemented by the
item. The default behavior of contains() is based on calling shape().
Items can contain other items, and also be contained by other items. All
items can have a parent item and a list of children. Unless the item has
no parent, its position is in \e parent coordinates (i.e., the parent's
local coordinates). Parent items propagate both their position and their
transformation to all children.
\image graphicsview-parentchild.png
\target Transformations
\section1 Transformations
QGraphicsItem supports projective transformations in addition to its base
position, pos(). There are several ways to change an item's transformation.
For simple transformations, you can call either of the convenience
functions setRotation() or setScale(), or you can pass any transformation
matrix to setTransform(). For advanced transformation control you also have
the option of setting several combined transformations by calling
setTransformations().
Item transformations accumulate from parent to child, so if both a parent
and child item are rotated 90 degrees, the child's total transformation
will be 180 degrees. Similarly, if the item's parent is scaled to 2x its
original size, its children will also be twice as large. An item's
transformation does not affect its own local geometry; all geometry
functions (e.g., contains(), update(), and all the mapping functions) still
operate in local coordinates. For convenience, QGraphicsItem provides the
functions sceneTransform(), which returns the item's total transformation
matrix (including its position and all parents' positions and
transformations), and scenePos(), which returns its position in scene
coordinates. To reset an item's matrix, call resetTransform().
Certain transformation operations produce a different outcome depending on
the order in which they are applied. For example, if you scale an
transform, and then rotate it, you may get a different result than if the
transform was rotated first. However, the order you set the transformation
properties on QGraphicsItem does not affect the resulting transformation;
QGraphicsItem always applies the properties in a fixed, defined order:
\list
\li The item's base transform is applied (transform())
\li The item's transformations list is applied in order (transformations())
\li The item is rotated relative to its transform origin point (rotation(), transformOriginPoint())
\li The item is scaled relative to its transform origin point (scale(), transformOriginPoint())
\endlist
\section1 Painting
The paint() function is called by QGraphicsView to paint the item's
contents. The item has no background or default fill of its own; whatever
is behind the item will shine through all areas that are not explicitly
painted in this function. You can call update() to schedule a repaint,
optionally passing the rectangle that needs a repaint. Depending on
whether or not the item is visible in a view, the item may or may not be
repainted; there is no equivalent to QWidget::repaint() in QGraphicsItem.
Items are painted by the view, starting with the parent items and then
drawing children, in ascending stacking order. You can set an item's
stacking order by calling setZValue(), and test it by calling
zValue(), where items with low z-values are painted before items with
high z-values. Stacking order applies to sibling items; parents are always
drawn before their children.
\section1 Sorting
All items are drawn in a defined, stable order, and this same order decides
which items will receive mouse input first when you click on the scene.
Normally you don't have to worry about sorting, as the items follow a
"natural order", following the logical structure of the scene.
An item's children are stacked on top of the parent, and sibling items are
stacked by insertion order (i.e., in the same order that they were either
added to the scene, or added to the same parent). If you add item A, and
then B, then B will be on top of A. If you then add C, the items' stacking
order will be A, then B, then C.
\image graphicsview-zorder.png
This example shows the stacking order of all limbs of the robot from the
\l{graphicsview/dragdroprobot}{Drag and Drop Robot} example. The torso is
the root item (all other items are children or descendants of the torso),
so it is drawn first. Next, the head is drawn, as it is the first item in
the torso's list of children. Then the upper left arm is drawn. As the
lower arm is a child of the upper arm, the lower arm is then drawn,
followed by the upper arm's next sibling, which is the upper right arm, and
so on.
For advanced users, there are ways to alter how your items are sorted:
\list
\li You can call setZValue() on an item to explicitly stack it on top of, or
under, other sibling items. The default Z value for an item is 0. Items
with the same Z value are stacked by insertion order.
\li You can call stackBefore() to reorder the list of children. This will
directly modify the insertion order.
\li You can set the ItemStacksBehindParent flag to stack a child item behind
its parent.
\endlist
The stacking order of two sibling items also counts for each item's
children and descendant items. So if one item is on top of another, then
all its children will also be on top of all the other item's children as
well.
\section1 Events
QGraphicsItem receives events from QGraphicsScene through the virtual
function sceneEvent(). This function distributes the most common events
to a set of convenience event handlers:
\list
\li contextMenuEvent() handles context menu events
\li focusInEvent() and focusOutEvent() handle focus in and out events
\li hoverEnterEvent(), hoverMoveEvent(), and hoverLeaveEvent() handles
hover enter, move and leave events
\li inputMethodEvent() handles input events, for accessibility support
\li keyPressEvent() and keyReleaseEvent() handle key press and release events
\li mousePressEvent(), mouseMoveEvent(), mouseReleaseEvent(), and
mouseDoubleClickEvent() handles mouse press, move, release, click and
doubleclick events
\endlist
You can filter events for any other item by installing event filters. This
functionality is separate from Qt's regular event filters (see
QObject::installEventFilter()), which only work on subclasses of QObject. After
installing your item as an event filter for another item by calling
installSceneEventFilter(), the filtered events will be received by the virtual
function sceneEventFilter(). You can remove item event filters by calling
removeSceneEventFilter().
\section1 Custom Data
Sometimes it's useful to register custom data with an item, be it a custom
item, or a standard item. You can call setData() on any item to store data
in it using a key-value pair (the key being an integer, and the value is a
QVariant). To get custom data from an item, call data(). This
functionality is completely untouched by Qt itself; it is provided for the
user's convenience.
\sa QGraphicsScene, QGraphicsView, {Graphics View Framework}
*/
/*!
\enum QGraphicsItem::anonymous
The value returned by the virtual type() function in standard
graphics item classes in Qt. All such standard graphics item classes
in Qt are associated with a unique value for Type, e.g. the value
returned by QGraphicsPathItem::type() is 2.
\value Type
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 18
\value UserType The lowest value returned by the virtual type()
function for custom subclasses of QGraphicsItem.
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 1
*/
/*!
\enum QGraphicsPathItem::anonymous
The value returned by the virtual type() function.
\value Type A graphics path item
*/
/*!
\enum QGraphicsRectItem::anonymous
The value returned by the virtual type() function.
\value Type A graphics rect item
*/
/*!
\enum QGraphicsEllipseItem::anonymous
The value returned by the virtual type() function.
\value Type A graphics ellipse item
*/
/*!
\enum QGraphicsPolygonItem::anonymous
The value returned by the virtual type() function.
\value Type A graphics polygon item
*/
/*!
\enum QGraphicsPixmapItem::anonymous
The value returned by the virtual type() function.
\value Type A graphics pixmap item
*/
/*!
\enum QGraphicsTextItem::anonymous
The value returned by the virtual type() function.
\value Type A graphics text item
*/
/*!
\enum QGraphicsSimpleTextItem::anonymous
The value returned by the virtual type() function.
\value Type A graphics simple text item
*/
/*!
\enum QGraphicsItemGroup::anonymous
The value returned by the virtual type() function.
\value Type A graphics item group
*/
/*!
\enum QGraphicsLineItem::anonymous
The value returned by the virtual type() function.
\value Type A graphics line item
*/
/*!
\enum QGraphicsItem::GraphicsItemFlag
This enum describes different flags that you can set on an item to
toggle different features in the item's behavior.
All flags are disabled by default.
\value ItemIsMovable The item supports interactive movement using
the mouse. By clicking on the item and then dragging, the item
will move together with the mouse cursor. If the item has
children, all children are also moved. If the item is part of a
selection, all selected items are also moved. This feature is
provided as a convenience through the base implementation of
QGraphicsItem's mouse event handlers.
\value ItemIsSelectable The item supports selection. Enabling this
feature will enable setSelected() to toggle selection for the
item. It will also let the item be selected automatically as a
result of calling QGraphicsScene::setSelectionArea(), by clicking
on an item, or by using rubber band selection in QGraphicsView.
\value ItemIsFocusable The item supports keyboard input focus (i.e., it is
an input item). Enabling this flag will allow the item to accept focus,
which again allows the delivery of key events to
QGraphicsItem::keyPressEvent() and QGraphicsItem::keyReleaseEvent().
\value ItemClipsToShape The item clips to its own shape. The item cannot
draw or receive mouse, tablet, drag and drop or hover events outside its
shape. It is disabled by default. This behavior is enforced by
QGraphicsView::drawItems() or QGraphicsScene::drawItems(). This flag was
introduced in Qt 4.3.
\value ItemClipsChildrenToShape The item clips the painting of all its
descendants to its own shape. Items that are either direct or indirect
children of this item cannot draw outside this item's shape. By default,
this flag is disabled; children can draw anywhere. This behavior is
enforced by QGraphicsView::drawItems() or
QGraphicsScene::drawItems(). This flag was introduced in Qt 4.3.
\note This flag is similar to ItemContainsChildrenInShape but in addition
enforces the containment by clipping the children.
\value ItemIgnoresTransformations The item ignores inherited
transformations (i.e., its position is still anchored to its parent, but
the parent or view rotation, zoom or shear transformations are ignored).
This flag is useful for keeping text label items horizontal and unscaled,
so they will still be readable if the view is transformed. When set, the
item's view geometry and scene geometry will be maintained separately. You
must call deviceTransform() to map coordinates and detect collisions in
the view. By default, this flag is disabled. This flag was introduced in
Qt 4.3. \note With this flag set you can still scale the item itself, and
that scale transformation will influence the item's children.
\value ItemIgnoresParentOpacity The item ignores its parent's opacity. The
item's effective opacity is the same as its own; it does not combine with
the parent's opacity. This flags allows your item to keep its absolute
opacity even if the parent is semitransparent. This flag was introduced in
Qt 4.5.
\value ItemDoesntPropagateOpacityToChildren The item doesn't propagate its
opacity to its children. This flag allows you to create a semitransparent
item that does not affect the opacity of its children. This flag was
introduced in Qt 4.5.
\value ItemStacksBehindParent The item is stacked behind its parent. By
default, child items are stacked on top of the parent item. But setting
this flag, the child will be stacked behind it. This flag is useful for
drop shadow effects and for decoration objects that follow the parent
item's geometry without drawing on top of it. This flag was introduced
in Qt 4.5.
\value ItemUsesExtendedStyleOption The item makes use of either
\l{QStyleOptionGraphicsItem::} {exposedRect} or
\l{QStyleOptionGraphicsItem::} {matrix} in
QStyleOptionGraphicsItem. By default, the
\l{QStyleOptionGraphicsItem::} {exposedRect} is initialized to the
item's boundingRect() and the
\l{QStyleOptionGraphicsItem::}{matrix} is untransformed. You can
enable this flag for the style options to be set up with more
fine-grained values. Note that
QStyleOptionGraphicsItem::levelOfDetail is unaffected by this flag
and always initialized to 1. Use
QStyleOptionGraphicsItem::levelOfDetailFromTransform() if you need
a higher value. This flag was introduced in Qt 4.6.
\value ItemHasNoContents The item does not paint anything (i.e., calling
paint() on the item has no effect). You should set this flag on items that
do not need to be painted to ensure that Graphics View avoids unnecessary
painting preparations. This flag was introduced in Qt 4.6.
\value ItemSendsGeometryChanges The item enables itemChange()
notifications for ItemPositionChange, ItemPositionHasChanged,
ItemTransformChange, ItemTransformHasChanged, ItemRotationChange,
ItemRotationHasChanged, ItemScaleChange, ItemScaleHasChanged,
ItemTransformOriginPointChange, and ItemTransformOriginPointHasChanged. For
performance reasons, these notifications are disabled by default. You must
enable this flag to receive notifications for position and transform
changes. This flag was introduced in Qt 4.6.
\value ItemAcceptsInputMethod The item supports input methods typically
used for Asian languages.
This flag was introduced in Qt 4.6.
\value ItemNegativeZStacksBehindParent The item automatically
stacks behind it's parent if it's z-value is negative. This flag
enables setZValue() to toggle ItemStacksBehindParent. This flag
was introduced in Qt 4.6.
\value ItemIsPanel The item is a panel. A panel provides activation and
contained focus handling. Only one panel can be active at a time (see
QGraphicsItem::isActive()). When no panel is active, QGraphicsScene
activates all non-panel items. Window items (i.e.,
QGraphicsItem::isWindow() returns \c true) are panels. This flag was
introduced in Qt 4.6.
\omitvalue ItemIsFocusScope \omit Internal only (for now). \endomit
\value ItemSendsScenePositionChanges The item enables itemChange()
notifications for ItemScenePositionHasChanged. For performance reasons,
these notifications are disabled by default. You must enable this flag
to receive notifications for scene position changes. This flag was
introduced in Qt 4.6.
\omitvalue ItemStopsClickFocusPropagation \omit The item stops propagating
click focus to items underneath when being clicked on. This flag
allows you create a non-focusable item that can be clicked on without
changing the focus. \endomit
\omitvalue ItemStopsFocusHandling \omit Same as
ItemStopsClickFocusPropagation, but also suppresses focus-out. This flag
allows you to completely take over focus handling.
This flag was introduced in Qt 4.7. \endomit
\value ItemContainsChildrenInShape This flag indicates that all of the
item's direct or indirect children only draw within the item's shape.
Unlike ItemClipsChildrenToShape, this restriction is not enforced. Set
ItemContainsChildrenInShape when you manually assure that drawing
is bound to the item's shape and want to avoid the cost associated with
enforcing the clip. Setting this flag enables more efficient drawing and
collision detection. The flag is disabled by default.
\note If both this flag and ItemClipsChildrenToShape are set, the clip
will be enforced. This is equivalent to just setting
ItemClipsChildrenToShape.
This flag was introduced in Qt 5.4.
*/
/*!
\enum QGraphicsItem::GraphicsItemChange
This enum describes the state changes that are notified by
QGraphicsItem::itemChange(). The notifications are sent as the state
changes, and in some cases, adjustments can be made (see the documentation
for each change for details).
Note: Be careful with calling functions on the QGraphicsItem itself inside
itemChange(), as certain function calls can lead to unwanted
recursion. For example, you cannot call setPos() in itemChange() on an
ItemPositionChange notification, as the setPos() function will again call
itemChange(ItemPositionChange). Instead, you can return the new, adjusted
position from itemChange().
\value ItemEnabledChange The item's enabled state changes. If the item is
presently enabled, it will become disabled, and vice verca. The value
argument is the new enabled state (i.e., true or false). Do not call
setEnabled() in itemChange() as this notification is delivered. Instead,
you can return the new state from itemChange().
\value ItemEnabledHasChanged The item's enabled state has changed. The
value argument is the new enabled state (i.e., true or false). Do not call
setEnabled() in itemChange() as this notification is delivered. The return
value is ignored.
\value ItemMatrixChange The item's affine transformation matrix is
changing. This value is obsolete; you can use ItemTransformChange instead.
\value ItemPositionChange The item's position changes. This notification
is sent if the ItemSendsGeometryChanges flag is enabled, and when the
item's local position changes, relative to its parent (i.e., as a result
of calling setPos() or moveBy()). The value argument is the new position
(i.e., a QPointF). You can call pos() to get the original position. Do
not call setPos() or moveBy() in itemChange() as this notification is
delivered; instead, you can return the new, adjusted position from
itemChange(). After this notification, QGraphicsItem immediately sends the
ItemPositionHasChanged notification if the position changed.
\value ItemPositionHasChanged The item's position has changed. This
notification is sent if the ItemSendsGeometryChanges flag is enabled, and
after the item's local position, relative to its parent, has changed. The
value argument is the new position (the same as pos()), and QGraphicsItem
ignores the return value for this notification (i.e., a read-only
notification).
\value ItemTransformChange The item's transformation matrix changes. This
notification is sent if the ItemSendsGeometryChanges flag is enabled, and
when the item's local transformation matrix changes (i.e., as a result of
calling setTransform(). The value argument is the new matrix (i.e., a
QTransform); to get the old matrix, call transform(). Do not call
setTransform() or set any of the transformation properties in itemChange()
as this notification is delivered; instead, you can return the new matrix
from itemChange(). This notification is not sent if you change the
transformation properties.
\value ItemTransformHasChanged The item's transformation matrix has
changed either because setTransform is called, or one of the
transformation properties is changed. This notification is sent if the
ItemSendsGeometryChanges flag is enabled, and after the item's local
transformation matrix has changed. The value argument is the new matrix
(same as transform()), and QGraphicsItem ignores the return value for this
notification (i.e., a read-only notification).
\value ItemRotationChange The item's rotation property changes. This
notification is sent if the ItemSendsGeometryChanges flag is enabled, and
when the item's rotation property changes (i.e., as a result of calling
setRotation()). The value argument is the new rotation (i.e., a double);
to get the old rotation, call rotation(). Do not call setRotation() in
itemChange() as this notification is delivered; instead, you can return
the new rotation from itemChange().
\value ItemRotationHasChanged The item's rotation property has changed.
This notification is sent if the ItemSendsGeometryChanges flag is enabled,
and after the item's rotation property has changed. The value argument is
the new rotation (i.e., a double), and QGraphicsItem ignores the return
value for this notification (i.e., a read-only notification). Do not call
setRotation() in itemChange() as this notification is delivered.
\value ItemScaleChange The item's scale property changes. This notification
is sent if the ItemSendsGeometryChanges flag is enabled, and when the item's
scale property changes (i.e., as a result of calling setScale()). The value
argument is the new scale (i.e., a double); to get the old scale, call
scale(). Do not call setScale() in itemChange() as this notification is
delivered; instead, you can return the new scale from itemChange().
\value ItemScaleHasChanged The item's scale property has changed. This
notification is sent if the ItemSendsGeometryChanges flag is enabled, and
after the item's scale property has changed. The value argument is the new
scale (i.e., a double), and QGraphicsItem ignores the return value for this
notification (i.e., a read-only notification). Do not call setScale() in
itemChange() as this notification is delivered.
\value ItemTransformOriginPointChange The item's transform origin point
property changes. This notification is sent if the ItemSendsGeometryChanges
flag is enabled, and when the item's transform origin point property changes
(i.e., as a result of calling setTransformOriginPoint()). The value argument
is the new origin point (i.e., a QPointF); to get the old origin point, call
transformOriginPoint(). Do not call setTransformOriginPoint() in itemChange()
as this notification is delivered; instead, you can return the new transform
origin point from itemChange().
\value ItemTransformOriginPointHasChanged The item's transform origin point
property has changed. This notification is sent if the ItemSendsGeometryChanges
flag is enabled, and after the item's transform origin point property has
changed. The value argument is the new origin point (i.e., a QPointF), and
QGraphicsItem ignores the return value for this notification (i.e., a read-only
notification). Do not call setTransformOriginPoint() in itemChange() as this
notification is delivered.
\value ItemSelectedChange The item's selected state changes. If the item is
presently selected, it will become unselected, and vice verca. The value
argument is the new selected state (i.e., true or false). Do not call
setSelected() in itemChange() as this notification is delivered; instead, you
can return the new selected state from itemChange().
\value ItemSelectedHasChanged The item's selected state has changed. The
value argument is the new selected state (i.e., true or false). Do not
call setSelected() in itemChange() as this notification is delivered. The
return value is ignored.
\value ItemVisibleChange The item's visible state changes. If the item is
presently visible, it will become invisible, and vice verca. The value
argument is the new visible state (i.e., true or false). Do not call
setVisible() in itemChange() as this notification is delivered; instead,
you can return the new visible state from itemChange().
\value ItemVisibleHasChanged The item's visible state has changed. The
value argument is the new visible state (i.e., true or false). Do not call
setVisible() in itemChange() as this notification is delivered. The return
value is ignored.
\value ItemParentChange The item's parent changes. The value argument is
the new parent item (i.e., a QGraphicsItem pointer). Do not call
setParentItem() in itemChange() as this notification is delivered;
instead, you can return the new parent from itemChange().
\value ItemParentHasChanged The item's parent has changed. The value
argument is the new parent (i.e., a pointer to a QGraphicsItem). Do not
call setParentItem() in itemChange() as this notification is
delivered. The return value is ignored.
\value ItemChildAddedChange A child is added to this item. The value
argument is the new child item (i.e., a QGraphicsItem pointer). Do not
pass this item to any item's setParentItem() function as this notification
is delivered. The return value is unused; you cannot adjust anything in
this notification. Note that the new child might not be fully constructed
when this notification is sent; calling pure virtual functions on
the child can lead to a crash.
\value ItemChildRemovedChange A child is removed from this item. The value
argument is the child item that is about to be removed (i.e., a
QGraphicsItem pointer). The return value is unused; you cannot adjust
anything in this notification.
\value ItemSceneChange The item is moved to a new scene. This notification is
also sent when the item is added to its initial scene, and when it is removed.
The item's scene() is the old scene, or \nullptr if the item has not been added
to a scene yet. The value argument is the new scene (i.e., a QGraphicsScene
pointer), or \nullptr if the item is removed from a scene. Do not
override this change by passing this item to QGraphicsScene::addItem() as this
notification is delivered; instead, you can return the new scene from
itemChange(). Use this feature with caution; objecting to a scene change can
quickly lead to unwanted recursion.
\value ItemSceneHasChanged The item's scene has changed. The item's scene() is
the new scene. This notification is also sent when the item is added to its
initial scene, and when it is removed.The value argument is the new scene
(i.e., a pointer to a QGraphicsScene). Do not call setScene() in itemChange()
as this notification is delivered. The return value is ignored.
\value ItemCursorChange The item's cursor changes. The value argument is
the new cursor (i.e., a QCursor). Do not call setCursor() in itemChange()
as this notification is delivered. Instead, you can return a new cursor
from itemChange().
\value ItemCursorHasChanged The item's cursor has changed. The value
argument is the new cursor (i.e., a QCursor). Do not call setCursor() as
this notification is delivered. The return value is ignored.
\value ItemToolTipChange The item's tooltip changes. The value argument is
the new tooltip (i.e., a QToolTip). Do not call setToolTip() in
itemChange() as this notification is delivered. Instead, you can return a
new tooltip from itemChange().
\value ItemToolTipHasChanged The item's tooltip has changed. The value
argument is the new tooltip (i.e., a QToolTip). Do not call setToolTip()
as this notification is delivered. The return value is ignored.
\value ItemFlagsChange The item's flags change. The value argument is the
new flags (i.e., a quint32). Do not call setFlags() in itemChange() as
this notification is delivered. Instead, you can return the new flags from
itemChange().
\value ItemFlagsHaveChanged The item's flags have changed. The value
argument is the new flags (i.e., a quint32). Do not call setFlags() in
itemChange() as this notification is delivered. The return value is
ignored.
\value ItemZValueChange The item's Z-value changes. The value argument is
the new Z-value (i.e., a double). Do not call setZValue() in itemChange()
as this notification is delivered. Instead, you can return a new Z-value
from itemChange().
\value ItemZValueHasChanged The item's Z-value has changed. The value
argument is the new Z-value (i.e., a double). Do not call setZValue() as
this notification is delivered. The return value is ignored.
\value ItemOpacityChange The item's opacity changes. The value argument is
the new opacity (i.e., a double). Do not call setOpacity() in itemChange()
as this notification is delivered. Instead, you can return a new opacity
from itemChange().
\value ItemOpacityHasChanged The item's opacity has changed. The value
argument is the new opacity (i.e., a double). Do not call setOpacity() as
this notification is delivered. The return value is ignored.
\value ItemScenePositionHasChanged The item's scene position has changed.
This notification is sent if the ItemSendsScenePositionChanges flag is
enabled, and after the item's scene position has changed (i.e., the
position or transformation of the item itself or the position or
transformation of any ancestor has changed). The value argument is the
new scene position (the same as scenePos()), and QGraphicsItem ignores
the return value for this notification (i.e., a read-only notification).
*/
/*!
\enum QGraphicsItem::CacheMode
\since 4.4
This enum describes QGraphicsItem's cache modes. Caching is used to speed
up rendering by allocating and rendering to an off-screen pixel buffer,
which can be reused when the item requires redrawing. For some paint
devices, the cache is stored directly in graphics memory, which makes
rendering very quick.
\value NoCache The default; all item caching is
disabled. QGraphicsItem::paint() is called every time the item needs
redrawing.
\value ItemCoordinateCache Caching is enabled for the item's logical
(local) coordinate system. QGraphicsItem creates an off-screen pixel
buffer with a configurable size / resolution that you can pass to
QGraphicsItem::setCacheMode(). Rendering quality will typically degrade,
depending on the resolution of the cache and the item transformation. The
first time the item is redrawn, it will render itself into the cache, and
the cache is then reused for every subsequent expose. The cache is also
reused as the item is transformed. To adjust the resolution of the cache,
you can call setCacheMode() again.
\value DeviceCoordinateCache Caching is enabled at the paint device level,
in device coordinates. This mode is for items that can move, but are not
rotated, scaled or sheared. If the item is transformed directly or
indirectly, the cache will be regenerated automatically. Unlike
ItemCoordinateCacheMode, DeviceCoordinateCache always renders at maximum
quality.
\sa QGraphicsItem::setCacheMode()
*/
/*!
\enum QGraphicsItem::Extension
\internal
Note: This is provided as a hook to avoid future problems related
to adding virtual functions. See also extension(),
supportsExtension() and setExtension().
*/
/*!
\enum QGraphicsItem::PanelModality
\since 4.6
This enum specifies the behavior of a modal panel. A modal panel
is one that blocks input to other panels. Note that items that
are children of a modal panel are not blocked.
The values are:
\value NonModal The panel is not modal and does not block input to
other panels. This is the default value for panels.
\value PanelModal The panel is modal to a single item hierarchy
and blocks input to its parent pane, all grandparent panels, and
all siblings of its parent and grandparent panels.
\value SceneModal The window is modal to the entire scene and
blocks input to all panels.
\sa QGraphicsItem::setPanelModality(), QGraphicsItem::panelModality(), QGraphicsItem::ItemIsPanel
*/
#include "qgraphicsitem.h"
#include "qgraphicsscene.h"
#include "qgraphicsscene_p.h"
#include "qgraphicssceneevent.h"
#include "qgraphicsview.h"
#include "qgraphicswidget.h"
#include "qgraphicsproxywidget.h"
#include "qgraphicsscenebsptreeindex_p.h"
#include <QtCore/qbitarray.h>
#include <QtCore/qpoint.h>
#include <QtCore/qstack.h>
#include <QtCore/qtimer.h>
#include <QtCore/qvariant.h>
#include <QtCore/qvarlengtharray.h>
#include <QtCore/qnumeric.h>
#include <QtWidgets/qapplication.h>
#include <QtGui/qbitmap.h>
#include <QtGui/qpainter.h>
#include <QtGui/qpainterpath.h>
#include <QtGui/qpixmapcache.h>
#include <QtWidgets/qstyleoption.h>
#include <QtGui/qevent.h>
#include <QtGui/qinputmethod.h>
#if QT_CONFIG(graphicseffect)
#include <QtWidgets/qgraphicseffect.h>
#endif
#include <private/qgraphicsitem_p.h>
#include <private/qgraphicswidget_p.h>
#include <private/qwidgettextcontrol_p.h>
#include <private/qtextdocumentlayout_p.h>
#include <private/qtextengine_p.h>
#include <private/qwidget_p.h>
#include <private/qapplication_p.h>
#include <private/qgesturemanager_p.h>
#include <private/qdebug_p.h>
QT_BEGIN_NAMESPACE
static inline void _q_adjustRect(QRect *rect)
{
Q_ASSERT(rect);
if (!rect->width())
rect->adjust(0, 0, 1, 0);
if (!rect->height())
rect->adjust(0, 0, 0, 1);
}
/*
### Move this into QGraphicsItemPrivate
*/
class QGraphicsItemCustomDataStore
{
public:
QHash<const QGraphicsItem *, QMap<int, QVariant> > data;
};
Q_GLOBAL_STATIC(QGraphicsItemCustomDataStore, qt_dataStore)
/*!
\internal
Returns a QPainterPath of \a path when stroked with the \a pen.
Ignoring dash pattern.
*/
static QPainterPath qt_graphicsItem_shapeFromPath(const QPainterPath &path, const QPen &pen)
{
// We unfortunately need this hack as QPainterPathStroker will set a width of 1.0
// if we pass a value of 0.0 to QPainterPathStroker::setWidth()
const qreal penWidthZero = qreal(0.00000001);
if (path == QPainterPath() || pen == Qt::NoPen)
return path;
QPainterPathStroker ps;
ps.setCapStyle(pen.capStyle());
if (pen.widthF() <= 0.0)
ps.setWidth(penWidthZero);
else
ps.setWidth(pen.widthF());
ps.setJoinStyle(pen.joinStyle());
ps.setMiterLimit(pen.miterLimit());
QPainterPath p = ps.createStroke(path);
p.addPath(path);
return p;
}
/*!
\internal
*/
QGraphicsItemPrivate::QGraphicsItemPrivate()
: z(0),
opacity(1.),
scene(nullptr),
parent(nullptr),
transformData(nullptr),
graphicsEffect(nullptr),
index(-1),
siblingIndex(-1),
itemDepth(-1),
focusProxy(nullptr),
subFocusItem(nullptr),
focusScopeItem(nullptr),
imHints(Qt::ImhNone),
panelModality(QGraphicsItem::NonModal),
acceptedMouseButtons(0x1f),
visible(true),
explicitlyHidden(false),
enabled(true),
explicitlyDisabled(false),
selected(false),
acceptsHover(false),
acceptDrops(false),
isMemberOfGroup(false),
handlesChildEvents(false),
itemDiscovered(false),
hasCursor(false),
ancestorFlags(0),
cacheMode(0),
hasBoundingRegionGranularity(false),
isWidget(false),
dirty(false),
dirtyChildren(false),
localCollisionHack(false),
inSetPosHelper(false),
needSortChildren(false),
allChildrenDirty(false),
fullUpdatePending(false),
flags(0),
paintedViewBoundingRectsNeedRepaint(false),
dirtySceneTransform(true),
geometryChanged(true),
inDestructor(false),
isObject(false),
ignoreVisible(false),
ignoreOpacity(false),
acceptTouchEvents(false),
acceptedTouchBeginEvent(false),
filtersDescendantEvents(false),
sceneTransformTranslateOnly(false),
notifyBoundingRectChanged(false),
notifyInvalidated(false),
mouseSetsFocus(true),
explicitActivate(false),
wantsActive(false),
holesInSiblingIndex(false),
sequentialOrdering(true),
updateDueToGraphicsEffect(false),
scenePosDescendants(false),
pendingPolish(false),
mayHaveChildWithGraphicsEffect(false),
isDeclarativeItem(false),
sendParentChangeNotification(false),
dirtyChildrenBoundingRect(true),
globalStackingOrder(-1),
q_ptr(nullptr)
{
}
/*!
\internal
*/
QGraphicsItemPrivate::~QGraphicsItemPrivate()
{
}
/*!
\internal
Propagates the ancestor flag \a flag with value \a enabled to all this
item's children. If \a root is false, the flag is also set on this item
(default is true).
*/
void QGraphicsItemPrivate::updateAncestorFlag(QGraphicsItem::GraphicsItemFlag childFlag,
AncestorFlag flag, bool enabled, bool root)
{
Q_Q(QGraphicsItem);
if (root) {
// For root items only. This is the item that has either enabled or
// disabled \a childFlag, or has been reparented.
switch (int(childFlag)) {
case -2:
flag = AncestorFiltersChildEvents;
enabled = q->filtersChildEvents();
break;
case -1:
flag = AncestorHandlesChildEvents;
enabled = q->handlesChildEvents();
break;
case QGraphicsItem::ItemClipsChildrenToShape:
flag = AncestorClipsChildren;
enabled = flags & QGraphicsItem::ItemClipsChildrenToShape;
break;
case QGraphicsItem::ItemIgnoresTransformations:
flag = AncestorIgnoresTransformations;
enabled = flags & QGraphicsItem::ItemIgnoresTransformations;
break;
case QGraphicsItem::ItemContainsChildrenInShape:
flag = AncestorContainsChildren;
enabled = flags & QGraphicsItem::ItemContainsChildrenInShape;
break;
default:
return;
}
if (parent) {
// Inherit the enabled-state from our parents.
if ((parent->d_ptr->ancestorFlags & flag)
|| (int(parent->d_ptr->flags & childFlag) == childFlag)
|| (int(childFlag) == -1 && parent->d_ptr->handlesChildEvents)
|| (int(childFlag) == -2 && parent->d_ptr->filtersDescendantEvents)) {
enabled = true;
ancestorFlags |= flag;
} else {
ancestorFlags &= ~flag;
}
} else {
// Top-level root items don't have any ancestors, so there are no
// ancestor flags either.
ancestorFlags = 0;
}
} else {
// Don't set or propagate the ancestor flag if it's already correct.
if (((ancestorFlags & flag) && enabled) || (!(ancestorFlags & flag) && !enabled))
return;
// Set the flag.
if (enabled)
ancestorFlags |= flag;
else
ancestorFlags &= ~flag;
// Don't process children if the item has the main flag set on itself.
if ((int(childFlag) != -1 && int(flags & childFlag) == childFlag)
|| (int(childFlag) == -1 && handlesChildEvents)
|| (int(childFlag) == -2 && filtersDescendantEvents))
return;
}
for (int i = 0; i < children.size(); ++i)
children.at(i)->d_ptr->updateAncestorFlag(childFlag, flag, enabled, false);
}
void QGraphicsItemPrivate::updateAncestorFlags()
{
int flags = 0;
if (parent) {
// Inherit the parent's ancestor flags.
QGraphicsItemPrivate *pd = parent->d_ptr.data();
flags = pd->ancestorFlags;
// Add in flags from the parent.
if (pd->filtersDescendantEvents)
flags |= AncestorFiltersChildEvents;
if (pd->handlesChildEvents)
flags |= AncestorHandlesChildEvents;
if (pd->flags & QGraphicsItem::ItemClipsChildrenToShape)
flags |= AncestorClipsChildren;
if (pd->flags & QGraphicsItem::ItemIgnoresTransformations)
flags |= AncestorIgnoresTransformations;
if (pd->flags & QGraphicsItem::ItemContainsChildrenInShape)
flags |= AncestorContainsChildren;
}
if (ancestorFlags == flags)
return; // No change; stop propagation.
ancestorFlags = flags;
// Propagate to children recursively.
for (int i = 0; i < children.size(); ++i)
children.at(i)->d_ptr->updateAncestorFlags();
}
/*!
\internal
Propagates item group membership.
*/
void QGraphicsItemPrivate::setIsMemberOfGroup(bool enabled)
{
Q_Q(QGraphicsItem);
isMemberOfGroup = enabled;
if (!qgraphicsitem_cast<QGraphicsItemGroup *>(q)) {
foreach (QGraphicsItem *child, children)
child->d_func()->setIsMemberOfGroup(enabled);
}
}
/*!
\internal
Maps any item pos properties of \a event to \a item's coordinate system.
*/
void QGraphicsItemPrivate::remapItemPos(QEvent *event, QGraphicsItem *item)
{
Q_Q(QGraphicsItem);
switch (event->type()) {
case QEvent::GraphicsSceneMouseMove:
case QEvent::GraphicsSceneMousePress:
case QEvent::GraphicsSceneMouseRelease:
case QEvent::GraphicsSceneMouseDoubleClick: {
QGraphicsSceneMouseEvent *mouseEvent = static_cast<QGraphicsSceneMouseEvent *>(event);
mouseEvent->setPos(item->mapFromItem(q, mouseEvent->pos()));
mouseEvent->setLastPos(item->mapFromItem(q, mouseEvent->pos()));
for (int i = 0x1; i <= 0x10; i <<= 1) {
if (mouseEvent->buttons() & i) {
Qt::MouseButton button = Qt::MouseButton(i);
mouseEvent->setButtonDownPos(button, item->mapFromItem(q, mouseEvent->buttonDownPos(button)));
}
}
break;
}
case QEvent::GraphicsSceneWheel: {
QGraphicsSceneWheelEvent *wheelEvent = static_cast<QGraphicsSceneWheelEvent *>(event);
wheelEvent->setPos(item->mapFromItem(q, wheelEvent->pos()));
break;
}
case QEvent::GraphicsSceneContextMenu: {
QGraphicsSceneContextMenuEvent *contextEvent = static_cast<QGraphicsSceneContextMenuEvent *>(event);
contextEvent->setPos(item->mapFromItem(q, contextEvent->pos()));
break;
}
case QEvent::GraphicsSceneHoverMove: {
QGraphicsSceneHoverEvent *hoverEvent = static_cast<QGraphicsSceneHoverEvent *>(event);
hoverEvent->setPos(item->mapFromItem(q, hoverEvent->pos()));
break;
}
default:
break;
}
}
/*!
\internal
Maps the point \a pos from scene to item coordinates. If \a view is passed and the item
is untransformable, this function will correctly map \a pos from the scene using the
view's transformation.
*/
QTransform QGraphicsItemPrivate::genericMapFromSceneTransform(const QWidget *viewport) const
{
Q_Q(const QGraphicsItem);
if (!itemIsUntransformable())
return sceneTransform.inverted();
const QGraphicsView *view = viewport
? qobject_cast<QGraphicsView *>(viewport->parentWidget())
: nullptr;
if (view == nullptr)
return sceneTransform.inverted();
// ### More ping pong than needed.
const QTransform viewportTransform = view->viewportTransform();
return viewportTransform * q->deviceTransform(viewportTransform).inverted();
}
QPointF QGraphicsItemPrivate::genericMapFromScene(const QPointF &pos,
const QWidget *viewport) const
{
return genericMapFromSceneTransform(viewport).map(pos);
}
/*!
\internal
Combines this item's position and transform onto \a transform.
If you need to change this function (e.g., adding more transformation
modes / options), make sure to change all places marked with COMBINE.
*/
void QGraphicsItemPrivate::combineTransformToParent(QTransform *x, const QTransform *viewTransform) const
{
// COMBINE
if (viewTransform && itemIsUntransformable()) {
*x = q_ptr->deviceTransform(*viewTransform);
} else {
if (transformData)
*x *= transformData->computedFullTransform();
if (!pos.isNull())
*x *= QTransform::fromTranslate(pos.x(), pos.y());
}
}
/*!
\internal
Combines this item's position and transform onto \a transform.
If you need to change this function (e.g., adding more transformation
modes / options), make sure to change QGraphicsItem::deviceTransform() as
well.
*/
void QGraphicsItemPrivate::combineTransformFromParent(QTransform *x, const QTransform *viewTransform) const
{
// COMBINE
if (viewTransform && itemIsUntransformable()) {
*x = q_ptr->deviceTransform(*viewTransform);
} else {
x->translate(pos.x(), pos.y());
if (transformData)
*x = transformData->computedFullTransform(x);
}
}
void QGraphicsItemPrivate::updateSceneTransformFromParent()
{
if (parent) {
Q_ASSERT(!parent->d_ptr->dirtySceneTransform);
if (parent->d_ptr->sceneTransformTranslateOnly) {
sceneTransform = QTransform::fromTranslate(parent->d_ptr->sceneTransform.dx() + pos.x(),
parent->d_ptr->sceneTransform.dy() + pos.y());
} else {
sceneTransform = parent->d_ptr->sceneTransform;
sceneTransform.translate(pos.x(), pos.y());
}
if (transformData) {
sceneTransform = transformData->computedFullTransform(&sceneTransform);
sceneTransformTranslateOnly = (sceneTransform.type() <= QTransform::TxTranslate);
} else {
sceneTransformTranslateOnly = parent->d_ptr->sceneTransformTranslateOnly;
}
} else if (!transformData) {
sceneTransform = QTransform::fromTranslate(pos.x(), pos.y());
sceneTransformTranslateOnly = 1;
} else if (transformData->onlyTransform) {
sceneTransform = transformData->transform;
if (!pos.isNull())
sceneTransform *= QTransform::fromTranslate(pos.x(), pos.y());
sceneTransformTranslateOnly = (sceneTransform.type() <= QTransform::TxTranslate);
} else if (pos.isNull()) {
sceneTransform = transformData->computedFullTransform();
sceneTransformTranslateOnly = (sceneTransform.type() <= QTransform::TxTranslate);
} else {
sceneTransform = QTransform::fromTranslate(pos.x(), pos.y());
sceneTransform = transformData->computedFullTransform(&sceneTransform);
sceneTransformTranslateOnly = (sceneTransform.type() <= QTransform::TxTranslate);
}
dirtySceneTransform = 0;
}
/*!
\internal
Make sure not to trigger any pure virtual function calls (e.g.,
prepareGeometryChange) if the item is in its destructor, i.e.
inDestructor is 1.
*/
void QGraphicsItemPrivate::setParentItemHelper(QGraphicsItem *newParent, const QVariant *newParentVariant,
const QVariant *thisPointerVariant)
{
Q_Q(QGraphicsItem);
if (newParent == parent)
return;
if (isWidget)
static_cast<QGraphicsWidgetPrivate *>(this)->fixFocusChainBeforeReparenting((newParent &&
newParent->isWidget()) ? static_cast<QGraphicsWidget *>(newParent) : nullptr,
scene);
if (scene) {
// Deliver the change to the index
if (scene->d_func()->indexMethod != QGraphicsScene::NoIndex)
scene->d_func()->index->itemChange(q, QGraphicsItem::ItemParentChange, newParent);
// Disable scene pos notifications for old ancestors
if (scenePosDescendants || (flags & QGraphicsItem::ItemSendsScenePositionChanges))
scene->d_func()->setScenePosItemEnabled(q, false);
}
if (subFocusItem && parent) {
// Make sure none of the old parents point to this guy.
subFocusItem->d_ptr->clearSubFocus(parent);
}
// We anticipate geometry changes. If the item is deleted, it will be
// removed from the index at a later stage, and the whole scene will be
// updated.
if (!inDestructor)
q_ptr->prepareGeometryChange();
if (parent) {
// Remove from current parent
parent->d_ptr->removeChild(q);
if (thisPointerVariant)
parent->itemChange(QGraphicsItem::ItemChildRemovedChange, *thisPointerVariant);
}
// Update toplevelitem list. If this item is being deleted, its parent
// will be 0 but we don't want to register/unregister it in the TLI list.
if (scene && !inDestructor) {
if (parent && !newParent) {
scene->d_func()->registerTopLevelItem(q);
} else if (!parent && newParent) {
scene->d_func()->unregisterTopLevelItem(q);
}
}
// Ensure any last parent focus scope does not point to this item or any of
// its descendents.
QGraphicsItem *p = parent;
QGraphicsItem *parentFocusScopeItem = nullptr;
while (p) {
if (p->d_ptr->flags & QGraphicsItem::ItemIsFocusScope) {
// If this item's focus scope's focus scope item points
// to this item or a descendent, then clear it.
QGraphicsItem *fsi = p->d_ptr->focusScopeItem;
if (q_ptr == fsi || q_ptr->isAncestorOf(fsi)) {
parentFocusScopeItem = fsi;
p->d_ptr->focusScopeItem = nullptr;
fsi->d_ptr->focusScopeItemChange(false);
}
break;
}
p = p->d_ptr->parent;
}
// Update graphics effect optimization flag
if (newParent && (graphicsEffect || mayHaveChildWithGraphicsEffect))
newParent->d_ptr->updateChildWithGraphicsEffectFlagRecursively();
// Update focus scope item ptr in new scope.
QGraphicsItem *newFocusScopeItem = subFocusItem ? subFocusItem : parentFocusScopeItem;
if (newFocusScopeItem && newParent) {
QGraphicsItem *p = newParent;
while (p) {
if (p->d_ptr->flags & QGraphicsItem::ItemIsFocusScope) {
if (subFocusItem && subFocusItem != q_ptr) {
// Find the subFocusItem's topmost focus scope within the new parent's focusscope
QGraphicsItem *ancestorScope = nullptr;
QGraphicsItem *p2 = subFocusItem->d_ptr->parent;
while (p2 && p2 != p) {
if (p2->d_ptr->flags & QGraphicsItem::ItemIsFocusScope)
ancestorScope = p2;
if (p2->d_ptr->flags & QGraphicsItem::ItemIsPanel)
break;
if (p2 == q_ptr)
break;
p2 = p2->d_ptr->parent;
}
if (ancestorScope)
newFocusScopeItem = ancestorScope;
}
p->d_ptr->focusScopeItem = newFocusScopeItem;
newFocusScopeItem->d_ptr->focusScopeItemChange(true);
// Ensure the new item is no longer the subFocusItem. The
// only way to set focus on a child of a focus scope is
// by setting focus on the scope itself.
if (subFocusItem && !p->focusItem())
subFocusItem->d_ptr->clearSubFocus();
break;
}
p = p->d_ptr->parent;
}
}
// Resolve depth.
invalidateDepthRecursively();
if ((parent = newParent)) {
if (parent->d_func()->scene && parent->d_func()->scene != scene) {
// Move this item to its new parent's scene
parent->d_func()->scene->addItem(q);
} else if (!parent->d_func()->scene && scene) {
// Remove this item from its former scene
scene->removeItem(q);
}
parent->d_ptr->addChild(q);
if (thisPointerVariant)
parent->itemChange(QGraphicsItem::ItemChildAddedChange, *thisPointerVariant);
if (scene) {
// Re-enable scene pos notifications for new ancestors
if (scenePosDescendants || (flags & QGraphicsItem::ItemSendsScenePositionChanges))
scene->d_func()->setScenePosItemEnabled(q, true);
}
// Propagate dirty flags to the new parent
markParentDirty(/*updateBoundingRect=*/true);
// Inherit ancestor flags from the new parent.
updateAncestorFlags();
// Update item visible / enabled.
if (parent->d_ptr->visible != visible) {
if (!parent->d_ptr->visible || !explicitlyHidden)
setVisibleHelper(parent->d_ptr->visible, /* explicit = */ false, /* update = */ false);
}
if (parent->isEnabled() != enabled) {
if (!parent->d_ptr->enabled || !explicitlyDisabled)
setEnabledHelper(parent->d_ptr->enabled, /* explicit = */ false, /* update = */ false);
}
// Auto-activate if visible and the parent is active.
if (visible && parent->isActive())
q->setActive(true);
} else {
// Inherit ancestor flags from the new parent.
updateAncestorFlags();
if (!inDestructor) {
// Update item visible / enabled.
if (!visible && !explicitlyHidden)
setVisibleHelper(true, /* explicit = */ false);
if (!enabled && !explicitlyDisabled)
setEnabledHelper(true, /* explicit = */ false);
}
}
dirtySceneTransform = 1;
if (!inDestructor && (transformData || (newParent && newParent->d_ptr->transformData)))
transformChanged();
// Restore the sub focus chain.
if (subFocusItem) {
subFocusItem->d_ptr->setSubFocus(newParent);
if (parent && parent->isActive())
subFocusItem->setFocus();
}
// Deliver post-change notification
if (newParentVariant)
q->itemChange(QGraphicsItem::ItemParentHasChanged, *newParentVariant);
if (isObject)
emit static_cast<QGraphicsObject *>(q)->parentChanged();
}
/*!
\internal
Returns the bounding rect of this item's children (excluding itself).
*/
void QGraphicsItemPrivate::childrenBoundingRectHelper(QTransform *x, QRectF *rect, QGraphicsItem *topMostEffectItem)
{
Q_Q(QGraphicsItem);
QRectF childrenRect;
QRectF *result = rect;
rect = &childrenRect;
const bool setTopMostEffectItem = !topMostEffectItem;
for (int i = 0; i < children.size(); ++i) {
QGraphicsItem *child = children.at(i);
QGraphicsItemPrivate *childd = child->d_ptr.data();
if (setTopMostEffectItem)
topMostEffectItem = child;
bool hasPos = !childd->pos.isNull();
if (hasPos || childd->transformData) {
// COMBINE
QTransform matrix = childd->transformToParent();
if (x)
matrix *= *x;
*rect |= matrix.mapRect(child->d_ptr->effectiveBoundingRect(topMostEffectItem));
if (!childd->children.isEmpty())
childd->childrenBoundingRectHelper(&matrix, rect, topMostEffectItem);
} else {
if (x)
*rect |= x->mapRect(child->d_ptr->effectiveBoundingRect(topMostEffectItem));
else
*rect |= child->d_ptr->effectiveBoundingRect(topMostEffectItem);
if (!childd->children.isEmpty())
childd->childrenBoundingRectHelper(x, rect, topMostEffectItem);
}
}
if (flags & QGraphicsItem::ItemClipsChildrenToShape){
if (x)
*rect &= x->mapRect(q->boundingRect());
else
*rect &= q->boundingRect();
}
*result |= *rect;
}
void QGraphicsItemPrivate::initStyleOption(QStyleOptionGraphicsItem *option, const QTransform &worldTransform,
const QRegion &exposedRegion, bool allItems) const
{
Q_ASSERT(option);
Q_Q(const QGraphicsItem);
// Initialize standard QStyleOption values.
const QRectF brect = q->boundingRect();
option->state = QStyle::State_None;
option->rect = brect.toRect();
option->levelOfDetail = 1;
option->exposedRect = brect;
// Style animations require a QObject-based animation target.
// If a plain QGraphicsItem is used to draw animated controls,
// QStyle is let to send animation updates to the whole scene.
option->styleObject = q_ptr->toGraphicsObject();
if (!option->styleObject)
option->styleObject = scene;
if (selected)
option->state |= QStyle::State_Selected;
if (enabled)
option->state |= QStyle::State_Enabled;
if (q->hasFocus())
option->state |= QStyle::State_HasFocus;
if (scene) {
if (scene->d_func()->hoverItems.contains(q_ptr))
option->state |= QStyle::State_MouseOver;
if (q == scene->mouseGrabberItem())
option->state |= QStyle::State_Sunken;
}
if (!(flags & QGraphicsItem::ItemUsesExtendedStyleOption))
return;
// Initialize QStyleOptionGraphicsItem specific values (matrix, exposedRect).
option->matrix = worldTransform.toAffine(); //### discards perspective
if (!allItems) {
// Determine the item's exposed area
option->exposedRect = QRectF();
const QTransform reverseMap = worldTransform.inverted();
for (const QRect &exposedRect : exposedRegion) {
option->exposedRect |= reverseMap.mapRect(QRectF(exposedRect));
if (option->exposedRect.contains(brect))
break;
}
option->exposedRect &= brect;
}
}
/*!
\internal
Empty all cached pixmaps from the pixmap cache.
*/
void QGraphicsItemCache::purge()
{
QPixmapCache::remove(key);
key = QPixmapCache::Key();
const auto &constDeviceData = deviceData; // avoid detach
for (const auto &data : constDeviceData)
QPixmapCache::remove(data.key);
deviceData.clear();
allExposed = true;
exposed.clear();
}
/*!
Constructs a QGraphicsItem with the given \a parent item.
It does not modify the parent object returned by QObject::parent().
If \a parent is \nullptr, you can add the item to a scene by calling
QGraphicsScene::addItem(). The item will then become a top-level item.
\sa QGraphicsScene::addItem(), setParentItem()
*/
QGraphicsItem::QGraphicsItem(QGraphicsItem *parent)
: d_ptr(new QGraphicsItemPrivate)
{
d_ptr->q_ptr = this;
setParentItem(parent);
}
/*!
\internal
*/
QGraphicsItem::QGraphicsItem(QGraphicsItemPrivate &dd, QGraphicsItem *parent)
: d_ptr(&dd)
{
d_ptr->q_ptr = this;
setParentItem(parent);
}
/*!
Destroys the QGraphicsItem and all its children. If this item is currently
associated with a scene, the item will be removed from the scene before it
is deleted.
\note It is more efficient to remove the item from the QGraphicsScene before
destroying the item.
*/
QGraphicsItem::~QGraphicsItem()
{
if (d_ptr->isObject) {
QGraphicsObject *o = static_cast<QGraphicsObject *>(this);
QObjectPrivate *p = QObjectPrivate::get(o);
p->wasDeleted = true;
if (p->declarativeData) {
p->wasDeleted = true; // needed, so that destroying the declarative data does the right thing
if (static_cast<QAbstractDeclarativeDataImpl*>(p->declarativeData)->ownedByQml1) {
if (QAbstractDeclarativeData::destroyed_qml1)
QAbstractDeclarativeData::destroyed_qml1(p->declarativeData, o);
} else {
if (QAbstractDeclarativeData::destroyed)
QAbstractDeclarativeData::destroyed(p->declarativeData, o);
}
p->declarativeData = nullptr;
p->wasDeleted = false;
}
}
d_ptr->inDestructor = 1;
d_ptr->removeExtraItemCache();
#ifndef QT_NO_GESTURES
if (d_ptr->isObject && !d_ptr->gestureContext.isEmpty()) {
QGraphicsObject *o = static_cast<QGraphicsObject *>(this);
if (QGestureManager *manager = QGestureManager::instance(QGestureManager::DontForceCreation)) {
const auto types = d_ptr->gestureContext.keys(); // FIXME: iterate over the map directly?
for (Qt::GestureType type : types)
manager->cleanupCachedGestures(o, type);
}
}
#endif
clearFocus();
setFocusProxy(nullptr);
// Update focus scope item ptr.
QGraphicsItem *p = d_ptr->parent;
while (p) {
if (p->flags() & ItemIsFocusScope) {
if (p->d_ptr->focusScopeItem == this)
p->d_ptr->focusScopeItem = nullptr;
break;
}
p = p->d_ptr->parent;
}
if (!d_ptr->children.isEmpty()) {
while (!d_ptr->children.isEmpty())
delete d_ptr->children.first();
Q_ASSERT(d_ptr->children.isEmpty());
}
if (d_ptr->scene) {
d_ptr->scene->d_func()->removeItemHelper(this);
} else {
d_ptr->resetFocusProxy();
setParentItem(nullptr);
}
#if QT_CONFIG(graphicseffect)
delete d_ptr->graphicsEffect;
#endif // QT_CONFIG(graphicseffect)
if (d_ptr->transformData) {
for(int i = 0; i < d_ptr->transformData->graphicsTransforms.size(); ++i) {
QGraphicsTransform *t = d_ptr->transformData->graphicsTransforms.at(i);
static_cast<QGraphicsTransformPrivate *>(t->d_ptr.data())->item = nullptr;
delete t;
}
}
delete d_ptr->transformData;
if (QGraphicsItemCustomDataStore *dataStore = qt_dataStore())
dataStore->data.remove(this);
}
/*!
Returns the current scene for the item, or \nullptr if the item is
not stored in a scene.
To add or move an item to a scene, call QGraphicsScene::addItem().
*/
QGraphicsScene *QGraphicsItem::scene() const
{
return d_ptr->scene;
}
/*!
Returns a pointer to this item's item group, or \nullptr if this
item is not member of a group.
\sa QGraphicsItemGroup, QGraphicsScene::createItemGroup()
*/
QGraphicsItemGroup *QGraphicsItem::group() const
{
if (!d_ptr->isMemberOfGroup)
return nullptr;
QGraphicsItem *parent = const_cast<QGraphicsItem *>(this);
while ((parent = parent->d_ptr->parent)) {
if (QGraphicsItemGroup *group = qgraphicsitem_cast<QGraphicsItemGroup *>(parent))
return group;
}
// Unreachable; if d_ptr->isMemberOfGroup is != 0, then one parent of this
// item is a group item.
return nullptr;
}
/*!
Adds this item to the item group \a group. If \a group is \nullptr, this item is
removed from any current group and added as a child of the previous
group's parent.
\sa group(), QGraphicsScene::createItemGroup()
*/
void QGraphicsItem::setGroup(QGraphicsItemGroup *group)
{
if (!group) {
if (QGraphicsItemGroup *group = this->group())
group->removeFromGroup(this);
} else {
group->addToGroup(this);
}
}
/*!
Returns a pointer to this item's parent item. If this item does not have a
parent, \nullptr is returned.
\sa setParentItem(), childItems()
*/
QGraphicsItem *QGraphicsItem::parentItem() const
{
return d_ptr->parent;
}
/*!
Returns this item's top-level item. The top-level item is the item's
topmost ancestor item whose parent is \nullptr. If an item has no
parent, its own pointer is returned (i.e., a top-level item is its
own top-level item).
\sa parentItem()
*/
QGraphicsItem *QGraphicsItem::topLevelItem() const
{
QGraphicsItem *parent = const_cast<QGraphicsItem *>(this);
while (QGraphicsItem *grandPa = parent->parentItem())
parent = grandPa;
return parent;
}
/*!
\since 4.6
Returns a pointer to the item's parent, cast to a QGraphicsObject. Returns
\nullptr if the parent item is not a QGraphicsObject.
\sa parentItem(), childItems()
*/
QGraphicsObject *QGraphicsItem::parentObject() const
{
QGraphicsItem *p = d_ptr->parent;
return (p && p->d_ptr->isObject) ? static_cast<QGraphicsObject *>(p) : nullptr;
}
/*!
\since 4.4
Returns a pointer to the item's parent widget. The item's parent widget is
the closest parent item that is a widget.
\sa parentItem(), childItems()
*/
QGraphicsWidget *QGraphicsItem::parentWidget() const
{
QGraphicsItem *p = parentItem();
while (p && !p->isWidget())
p = p->parentItem();
return (p && p->isWidget()) ? static_cast<QGraphicsWidget *>(p) : nullptr;
}
/*!
\since 4.4
Returns a pointer to the item's top level widget (i.e., the item's
ancestor whose parent is \nullptr, or whose parent is not a widget), or
\nullptr if this item does not have a top level widget. If the item
is its own top level widget, this function returns a pointer to the
item itself.
*/
QGraphicsWidget *QGraphicsItem::topLevelWidget() const
{
if (const QGraphicsWidget *p = parentWidget())
return p->topLevelWidget();
return isWidget() ? static_cast<QGraphicsWidget *>(const_cast<QGraphicsItem *>(this)) : nullptr;
}
/*!
\since 4.4
Returns the item's window, or \nullptr if this item does not have a
window. If the item is a window, it will return itself. Otherwise
it will return the closest ancestor that is a window.
\sa QGraphicsWidget::isWindow()
*/
QGraphicsWidget *QGraphicsItem::window() const
{
QGraphicsItem *p = panel();
if (p && p->isWindow())
return static_cast<QGraphicsWidget *>(p);
return nullptr;
}
/*!
\since 4.6
Returns the item's panel, or \nullptr if this item does not have a
panel. If the item is a panel, it will return itself. Otherwise it
will return the closest ancestor that is a panel.
\sa isPanel(), ItemIsPanel
*/
QGraphicsItem *QGraphicsItem::panel() const
{
if (d_ptr->flags & ItemIsPanel)
return const_cast<QGraphicsItem *>(this);
return d_ptr->parent ? d_ptr->parent->panel() : nullptr;
}
/*!
\since 4.6
Return the graphics item cast to a QGraphicsObject, if the class is actually a
graphics object, 0 otherwise.
*/
QGraphicsObject *QGraphicsItem::toGraphicsObject()
{
return d_ptr->isObject ? static_cast<QGraphicsObject *>(this) : nullptr;
}
/*!
\since 4.6
Return the graphics item cast to a QGraphicsObject, if the class is actually a
graphics object, 0 otherwise.
*/
const QGraphicsObject *QGraphicsItem::toGraphicsObject() const
{
return d_ptr->isObject ? static_cast<const QGraphicsObject *>(this) : nullptr;
}
/*!
Sets this item's parent item to \a newParent. If this item already
has a parent, it is first removed from the previous parent. If \a
newParent is 0, this item will become a top-level item.
Note that this implicitly adds this graphics item to the scene of
the parent. You should not \l{QGraphicsScene::addItem()}{add} the
item to the scene yourself.
The behavior when calling this function on an item that is an ancestor of
\a newParent is undefined.
\sa parentItem(), childItems()
*/
void QGraphicsItem::setParentItem(QGraphicsItem *newParent)
{
if (newParent == this) {
qWarning("QGraphicsItem::setParentItem: cannot assign %p as a parent of itself", this);
return;
}
if (newParent == d_ptr->parent)
return;
const QVariant newParentVariant(itemChange(QGraphicsItem::ItemParentChange,
QVariant::fromValue<QGraphicsItem *>(newParent)));
newParent = qvariant_cast<QGraphicsItem *>(newParentVariant);
if (newParent == d_ptr->parent)
return;
const QVariant thisPointerVariant(QVariant::fromValue<QGraphicsItem *>(this));
d_ptr->setParentItemHelper(newParent, &newParentVariant, &thisPointerVariant);
}
/*!
\fn QList<QGraphicsItem *> QGraphicsItem::children() const
\obsolete
Use childItems() instead.
\sa setParentItem()
*/
/*!
\since 4.4
Returns a list of this item's children.
The items are sorted by stacking order. This takes into account both the
items' insertion order and their Z-values.
\sa setParentItem(), zValue(), {QGraphicsItem#Sorting}{Sorting}
*/
QList<QGraphicsItem *> QGraphicsItem::childItems() const
{
const_cast<QGraphicsItem *>(this)->d_ptr->ensureSortedChildren();
return d_ptr->children;
}
/*!
\since 4.4
Returns \c true if this item is a widget (i.e., QGraphicsWidget); otherwise,
returns \c false.
*/
bool QGraphicsItem::isWidget() const
{
return d_ptr->isWidget;
}
/*!
\since 4.4
Returns \c true if the item is a QGraphicsWidget window, otherwise returns
false.
\sa QGraphicsWidget::windowFlags()
*/
bool QGraphicsItem::isWindow() const
{
return d_ptr->isWidget && (static_cast<const QGraphicsWidget *>(this)->windowType() & Qt::Window);
}
/*!
\since 4.6
Returns \c true if the item is a panel; otherwise returns \c false.
\sa QGraphicsItem::panel(), ItemIsPanel
*/
bool QGraphicsItem::isPanel() const
{
return d_ptr->flags & ItemIsPanel;
}
/*!
Returns this item's flags. The flags describe what configurable features
of the item are enabled and not. For example, if the flags include
ItemIsFocusable, the item can accept input focus.
By default, no flags are enabled.
\sa setFlags(), setFlag()
*/
QGraphicsItem::GraphicsItemFlags QGraphicsItem::flags() const
{
return GraphicsItemFlags(d_ptr->flags);
}
/*!
If \a enabled is true, the item flag \a flag is enabled; otherwise, it is
disabled.
\sa flags(), setFlags()
*/
void QGraphicsItem::setFlag(GraphicsItemFlag flag, bool enabled)
{
if (enabled)
setFlags(GraphicsItemFlags(d_ptr->flags) | flag);
else
setFlags(GraphicsItemFlags(d_ptr->flags) & ~flag);
}
/*!
Sets the item flags to \a flags. All flags in \a flags are enabled; all
flags not in \a flags are disabled.
If the item had focus and \a flags does not enable ItemIsFocusable, the
item loses focus as a result of calling this function. Similarly, if the
item was selected, and \a flags does not enabled ItemIsSelectable, the
item is automatically unselected.
By default, no flags are enabled. (QGraphicsWidget enables the
ItemSendsGeometryChanges flag by default in order to track position
changes.)
\sa flags(), setFlag()
*/
void QGraphicsItem::setFlags(GraphicsItemFlags flags)
{
// Notify change and check for adjustment.
if (quint32(d_ptr->flags) == quint32(flags))
return;
flags = GraphicsItemFlags(itemChange(ItemFlagsChange, quint32(flags)).toUInt());
if (quint32(d_ptr->flags) == quint32(flags))
return;
if (d_ptr->scene && d_ptr->scene->d_func()->indexMethod != QGraphicsScene::NoIndex)
d_ptr->scene->d_func()->index->itemChange(this, ItemFlagsChange, &flags);
// Flags that alter the geometry of the item (or its children).
const quint32 geomChangeFlagsMask = (ItemClipsChildrenToShape | ItemClipsToShape | ItemIgnoresTransformations | ItemIsSelectable);
bool fullUpdate = (quint32(flags) & geomChangeFlagsMask) != (d_ptr->flags & geomChangeFlagsMask);
if (fullUpdate)
d_ptr->updatePaintedViewBoundingRects(/*children=*/true);
// Keep the old flags to compare the diff.
GraphicsItemFlags oldFlags = GraphicsItemFlags(d_ptr->flags);
// Update flags.
d_ptr->flags = flags;
if (!(d_ptr->flags & ItemIsFocusable) && hasFocus()) {
// Clear focus on the item if it has focus when the focusable flag
// is unset.
clearFocus();
}
if (!(d_ptr->flags & ItemIsSelectable) && isSelected()) {
// Unselect the item if it is selected when the selectable flag is
// unset.
setSelected(false);
}
if ((flags & ItemClipsChildrenToShape) != (oldFlags & ItemClipsChildrenToShape)) {
// Item children clipping changes. Propagate the ancestor flag to
// all children.
d_ptr->updateAncestorFlag(ItemClipsChildrenToShape);
// The childrenBoundingRect is clipped to the boundingRect in case of ItemClipsChildrenToShape,
// which means we have to invalidate the cached childrenBoundingRect whenever this flag changes.
d_ptr->dirtyChildrenBoundingRect = 1;
d_ptr->markParentDirty(true);
}
if ((flags & ItemContainsChildrenInShape) != (oldFlags & ItemContainsChildrenInShape)) {
// Item children containtment changes. Propagate the ancestor flag to all children.
d_ptr->updateAncestorFlag(ItemContainsChildrenInShape);
}
if ((flags & ItemIgnoresTransformations) != (oldFlags & ItemIgnoresTransformations)) {
// Item children clipping changes. Propagate the ancestor flag to
// all children.
d_ptr->updateAncestorFlag(ItemIgnoresTransformations);
}
if ((flags & ItemNegativeZStacksBehindParent) != (oldFlags & ItemNegativeZStacksBehindParent)) {
// NB! We change the flags directly here, so we must also update d_ptr->flags.
// Note that this has do be done before the ItemStacksBehindParent check
// below; otherwise we will loose the change.
// Update stack-behind.
if (d_ptr->z < qreal(0.0))
flags |= ItemStacksBehindParent;
else
flags &= ~ItemStacksBehindParent;
d_ptr->flags = flags;
}
if ((flags & ItemStacksBehindParent) != (oldFlags & ItemStacksBehindParent)) {
// NB! This check has to come after the ItemNegativeZStacksBehindParent
// check above. Be careful.
// Ensure child item sorting is up to date when toggling this flag.
if (d_ptr->parent)
d_ptr->parent->d_ptr->needSortChildren = 1;
else if (d_ptr->scene)
d_ptr->scene->d_func()->needSortTopLevelItems = 1;
}
if ((flags & ItemAcceptsInputMethod) != (oldFlags & ItemAcceptsInputMethod)) {
// Update input method sensitivity in any views.
if (d_ptr->scene)
d_ptr->scene->d_func()->updateInputMethodSensitivityInViews();
}
if ((flags & ItemIsPanel) != (oldFlags & ItemIsPanel)) {
bool becomesPanel = (flags & ItemIsPanel);
if ((d_ptr->panelModality != NonModal) && d_ptr->scene) {
// update the panel's modal state
if (becomesPanel)
d_ptr->scene->d_func()->enterModal(this);
else
d_ptr->scene->d_func()->leaveModal(this);
}
if (d_ptr->isWidget && (becomesPanel || parentWidget())) {
QGraphicsWidget *w = static_cast<QGraphicsWidget *>(this);
QGraphicsWidget *focusFirst = w;
QGraphicsWidget *focusLast = w;
for (;;) {
QGraphicsWidget *test = focusLast->d_func()->focusNext;
if (!w->isAncestorOf(test) || test == w)
break;
focusLast = test;
}
if (becomesPanel) {
// unlink own widgets from focus chain
QGraphicsWidget *beforeMe = w->d_func()->focusPrev;
QGraphicsWidget *afterMe = focusLast->d_func()->focusNext;
beforeMe->d_func()->focusNext = afterMe;
afterMe->d_func()->focusPrev = beforeMe;
focusFirst->d_func()->focusPrev = focusLast;
focusLast->d_func()->focusNext = focusFirst;
if (!isAncestorOf(focusFirst->d_func()->focusNext))
focusFirst->d_func()->focusNext = w;
} else if (QGraphicsWidget *pw = parentWidget()) {
// link up own widgets to focus chain
QGraphicsWidget *beforeMe = pw;
QGraphicsWidget *afterMe = pw->d_func()->focusNext;
beforeMe->d_func()->focusNext = w;
afterMe->d_func()->focusPrev = focusLast;
w->d_func()->focusPrev = beforeMe;
focusLast->d_func()->focusNext = afterMe;
}
}
}
if (d_ptr->scene) {
if ((flags & ItemSendsScenePositionChanges) != (oldFlags & ItemSendsScenePositionChanges)) {
if (flags & ItemSendsScenePositionChanges)
d_ptr->scene->d_func()->registerScenePosItem(this);
else
d_ptr->scene->d_func()->unregisterScenePosItem(this);
}
d_ptr->scene->d_func()->markDirty(this, QRectF(), /*invalidateChildren=*/true);
}
// Notify change.
itemChange(ItemFlagsHaveChanged, quint32(flags));
}
/*!
\since 4.4
Returns the cache mode for this item. The default mode is NoCache (i.e.,
cache is disabled and all painting is immediate).
\sa setCacheMode()
*/
QGraphicsItem::CacheMode QGraphicsItem::cacheMode() const
{
return QGraphicsItem::CacheMode(d_ptr->cacheMode);
}
/*!
\since 4.4
Sets the item's cache mode to \a mode.
The optional \a logicalCacheSize argument is used only by
ItemCoordinateCache mode, and describes the resolution of the cache
buffer; if \a logicalCacheSize is (100, 100), QGraphicsItem will fit the
item into 100x100 pixels in graphics memory, regardless of the logical
size of the item itself. By default QGraphicsItem uses the size of
boundingRect(). For all other cache modes than ItemCoordinateCache, \a
logicalCacheSize is ignored.
Caching can speed up rendering if your item spends a significant time
redrawing itself. In some cases the cache can also slow down rendering, in
particular when the item spends less time redrawing than QGraphicsItem
spends redrawing from the cache.
When caching is enabled, an item's paint() function will generally draw into an
offscreen pixmap cache; for any subsequent
repaint requests, the Graphics View framework will redraw from the
cache. This approach works particularly well with QGLWidget, which stores
all the cache as OpenGL textures.
Be aware that QPixmapCache's cache limit may need to be changed to obtain
optimal performance.
You can read more about the different cache modes in the CacheMode
documentation.
\note Enabling caching does not imply that the item's paint() function will be
called only in response to an explicit update() call. For instance, under
memory pressure, Qt may decide to drop some of the cache information;
in such cases an item's paint() function will be called even if there
was no update() call (that is, exactly as if there were no caching enabled).
\sa CacheMode, QPixmapCache::setCacheLimit()
*/
void QGraphicsItem::setCacheMode(CacheMode mode, const QSize &logicalCacheSize)
{
CacheMode lastMode = CacheMode(d_ptr->cacheMode);
d_ptr->cacheMode = mode;
bool noVisualChange = (mode == NoCache && lastMode == NoCache)
|| (mode == NoCache && lastMode == DeviceCoordinateCache)
|| (mode == DeviceCoordinateCache && lastMode == NoCache)
|| (mode == DeviceCoordinateCache && lastMode == DeviceCoordinateCache);
if (mode == NoCache) {
d_ptr->removeExtraItemCache();
} else {
QGraphicsItemCache *cache = d_ptr->extraItemCache();
// Reset old cache
cache->purge();
if (mode == ItemCoordinateCache) {
if (lastMode == mode && cache->fixedSize == logicalCacheSize)
noVisualChange = true;
cache->fixedSize = logicalCacheSize;
}
}
if (!noVisualChange)
update();
}
/*!
\since 4.6
Returns the modality for this item.
*/
QGraphicsItem::PanelModality QGraphicsItem::panelModality() const
{
return d_ptr->panelModality;
}
/*!
\since 4.6
Sets the modality for this item to \a panelModality.
Changing the modality of a visible item takes effect immediately.
*/
void QGraphicsItem::setPanelModality(PanelModality panelModality)
{
if (d_ptr->panelModality == panelModality)
return;
PanelModality previousModality = d_ptr->panelModality;
bool enterLeaveModal = (isPanel() && d_ptr->scene && isVisible());
if (enterLeaveModal && panelModality == NonModal)
d_ptr->scene->d_func()->leaveModal(this);
d_ptr->panelModality = panelModality;
if (enterLeaveModal && d_ptr->panelModality != NonModal)
d_ptr->scene->d_func()->enterModal(this, previousModality);
}
/*!
\since 4.6
Returns \c true if this item is blocked by a modal panel, false otherwise. If \a blockingPanel is
non-zero, \a blockingPanel will be set to the modal panel that is blocking this item. If this
item is not blocked, \a blockingPanel will not be set by this function.
This function always returns \c false for items not in a scene.
\sa panelModality(), setPanelModality(), PanelModality
*/
bool QGraphicsItem::isBlockedByModalPanel(QGraphicsItem **blockingPanel) const
{
if (!d_ptr->scene)
return false;
QGraphicsItem *dummy = nullptr;
if (!blockingPanel)
blockingPanel = &dummy;
const QGraphicsScenePrivate *scene_d = d_ptr->scene->d_func();
if (scene_d->modalPanels.isEmpty())
return false;
// ###
if (!scene_d->popupWidgets.isEmpty() && scene_d->popupWidgets.first() == this)
return false;
for (int i = 0; i < scene_d->modalPanels.count(); ++i) {
QGraphicsItem *modalPanel = scene_d->modalPanels.at(i);
if (modalPanel->panelModality() == QGraphicsItem::SceneModal) {
// Scene modal panels block all non-descendents.
if (modalPanel != this && !modalPanel->isAncestorOf(this)) {
*blockingPanel = modalPanel;
return true;
}
} else {
// Window modal panels block ancestors and siblings/cousins.
if (modalPanel != this
&& !modalPanel->isAncestorOf(this)
&& commonAncestorItem(modalPanel)) {
*blockingPanel = modalPanel;
return true;
}
}
}
return false;
}
#ifndef QT_NO_TOOLTIP
/*!
Returns the item's tool tip, or an empty QString if no tool tip has been
set.
\sa setToolTip(), QToolTip
*/
QString QGraphicsItem::toolTip() const
{
return d_ptr->extra(QGraphicsItemPrivate::ExtraToolTip).toString();
}
/*!
Sets the item's tool tip to \a toolTip. If \a toolTip is empty, the item's
tool tip is cleared.
\sa toolTip(), QToolTip
*/
void QGraphicsItem::setToolTip(const QString &toolTip)
{
const QVariant toolTipVariant(itemChange(ItemToolTipChange, toolTip));
d_ptr->setExtra(QGraphicsItemPrivate::ExtraToolTip, toolTipVariant.toString());
itemChange(ItemToolTipHasChanged, toolTipVariant);
}
#endif // QT_NO_TOOLTIP
#ifndef QT_NO_CURSOR
/*!
Returns the current cursor shape for the item. The mouse cursor
will assume this shape when it's over this item.
See the \l{Qt::CursorShape}{list of predefined cursor objects} for a
range of useful shapes.
An editor item might want to use an I-beam cursor:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 2
If no cursor has been set, the cursor of the item beneath is used.
\sa setCursor(), hasCursor(), unsetCursor(), QWidget::cursor,
QApplication::overrideCursor()
*/
QCursor QGraphicsItem::cursor() const
{
return qvariant_cast<QCursor>(d_ptr->extra(QGraphicsItemPrivate::ExtraCursor));
}
/*!
Sets the current cursor shape for the item to \a cursor. The mouse cursor
will assume this shape when it's over this item.
See the \l{Qt::CursorShape}{list of predefined cursor objects} for a
range of useful shapes.
An editor item might want to use an I-beam cursor:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 3
If no cursor has been set, the cursor of the item beneath is used.
\sa cursor(), hasCursor(), unsetCursor(), QWidget::cursor,
QApplication::overrideCursor()
*/
void QGraphicsItem::setCursor(const QCursor &cursor)
{
const QVariant cursorVariant(itemChange(ItemCursorChange, QVariant::fromValue<QCursor>(cursor)));
d_ptr->setExtra(QGraphicsItemPrivate::ExtraCursor, qvariant_cast<QCursor>(cursorVariant));
d_ptr->hasCursor = 1;
if (d_ptr->scene) {
d_ptr->scene->d_func()->allItemsUseDefaultCursor = false;
const auto views = d_ptr->scene->views();
for (QGraphicsView *view : views) {
view->viewport()->setMouseTracking(true);
// Note: Some of this logic is duplicated in QGraphicsView's mouse events.
if (view->underMouse()) {
const QPoint viewPoint = view->mapFromGlobal(QCursor::pos());
const QPointF cursorPos = mapFromScene(view->mapToScene(viewPoint));
// the cursor can only change if the current item is under the mouse
if (boundingRect().contains(cursorPos)) {
const auto itemsUnderCursor = view->items(viewPoint);
for (QGraphicsItem *itemUnderCursor : itemsUnderCursor) {
if (itemUnderCursor->hasCursor()) {
QMetaObject::invokeMethod(view, "_q_setViewportCursor",
Q_ARG(QCursor, itemUnderCursor->cursor()));
break;
}
}
}
break;
}
}
}
itemChange(ItemCursorHasChanged, cursorVariant);
}
/*!
Returns \c true if this item has a cursor set; otherwise, false is returned.
By default, items don't have any cursor set. cursor() will return a
standard pointing arrow cursor.
\sa unsetCursor()
*/
bool QGraphicsItem::hasCursor() const
{
return d_ptr->hasCursor;
}
/*!
Clears the cursor from this item.
\sa hasCursor(), setCursor()
*/
void QGraphicsItem::unsetCursor()
{
if (!d_ptr->hasCursor)
return;
d_ptr->unsetExtra(QGraphicsItemPrivate::ExtraCursor);
d_ptr->hasCursor = 0;
if (d_ptr->scene) {
const auto views = d_ptr->scene->views();
for (QGraphicsView *view : views) {
if (view->underMouse() && view->itemAt(view->mapFromGlobal(QCursor::pos())) == this) {
QMetaObject::invokeMethod(view, "_q_unsetViewportCursor");
break;
}
}
}
}
#endif // QT_NO_CURSOR
/*!
Returns \c true if the item is visible; otherwise, false is returned.
Note that the item's general visibility is unrelated to whether or not it
is actually being visualized by a QGraphicsView.
\sa setVisible()
*/
bool QGraphicsItem::isVisible() const
{
return d_ptr->visible;
}
/*!
\since 4.4
Returns \c true if the item is visible to \a parent; otherwise, false is
returned. \a parent can be \nullptr, in which case this function will return
whether the item is visible to the scene or not.
An item may not be visible to its ancestors even if isVisible() is true. It
may also be visible to its ancestors even if isVisible() is false. If
any ancestor is hidden, the item itself will be implicitly hidden, in which
case this function will return false.
\sa isVisible(), setVisible()
*/
bool QGraphicsItem::isVisibleTo(const QGraphicsItem *parent) const
{
const QGraphicsItem *p = this;
if (d_ptr->explicitlyHidden)
return false;
do {
if (p == parent)
return true;
if (p->d_ptr->explicitlyHidden)
return false;
} while ((p = p->d_ptr->parent));
return parent == nullptr;
}
/*!
\internal
Sets this item's visibility to \a newVisible. If \a explicitly is true,
this item will be "explicitly" \a newVisible; otherwise, it.. will not be.
*/
void QGraphicsItemPrivate::setVisibleHelper(bool newVisible, bool explicitly,
bool update, bool hiddenByPanel)
{
Q_Q(QGraphicsItem);
// Update explicit bit.
if (explicitly)
explicitlyHidden = newVisible ? 0 : 1;
// Check if there's nothing to do.
if (visible == quint32(newVisible))
return;
// Don't show child if parent is not visible
if (parent && newVisible && !parent->d_ptr->visible)
return;
// Modify the property.
const QVariant newVisibleVariant(q_ptr->itemChange(QGraphicsItem::ItemVisibleChange,
quint32(newVisible)));
newVisible = newVisibleVariant.toBool();
if (visible == quint32(newVisible))
return;
visible = newVisible;
// Schedule redrawing
if (update) {
QGraphicsItemCache *c = (QGraphicsItemCache *)qvariant_cast<void *>(extra(ExtraCacheData));
if (c)
c->purge();
if (scene) {
#if QT_CONFIG(graphicseffect)
invalidateParentGraphicsEffectsRecursively();
#endif // QT_CONFIG(graphicseffect)
scene->d_func()->markDirty(q_ptr, QRectF(), /*invalidateChildren=*/false, /*force=*/true);
}
}
// Certain properties are dropped as an item becomes invisible.
bool hasFocus = q_ptr->hasFocus();
if (!newVisible) {
if (scene) {
if (scene->d_func()->mouseGrabberItems.contains(q))
q->ungrabMouse();
if (scene->d_func()->keyboardGrabberItems.contains(q))
q->ungrabKeyboard();
if (q->isPanel() && panelModality != QGraphicsItem::NonModal)
scene->d_func()->leaveModal(q_ptr);
}
if (hasFocus && scene) {
// Hiding the focus item or the closest non-panel ancestor of the focus item
QGraphicsItem *focusItem = scene->focusItem();
bool clear = true;
if (isWidget && !focusItem->isPanel()) {
do {
if (focusItem == q_ptr) {
clear = !static_cast<QGraphicsWidget *>(q_ptr)->focusNextPrevChild(true);
break;
}
} while ((focusItem = focusItem->parentWidget()) && !focusItem->isPanel());
}
if (clear)
clearFocusHelper(/* giveFocusToParent = */ false, hiddenByPanel);
}
if (q_ptr->isSelected())
q_ptr->setSelected(false);
} else {
geometryChanged = 1;
paintedViewBoundingRectsNeedRepaint = 1;
if (scene) {
if (isWidget) {
QGraphicsWidget *widget = static_cast<QGraphicsWidget *>(q_ptr);
if (widget->windowType() == Qt::Popup)
scene->d_func()->addPopup(widget);
}
if (q->isPanel() && panelModality != QGraphicsItem::NonModal) {
scene->d_func()->enterModal(q_ptr);
}
}
}
// Update children with explicitly = false.
const bool updateChildren = update && !((flags & QGraphicsItem::ItemClipsChildrenToShape
|| flags & QGraphicsItem::ItemContainsChildrenInShape)
&& !(flags & QGraphicsItem::ItemHasNoContents));
foreach (QGraphicsItem *child, children) {
if (!newVisible || !child->d_ptr->explicitlyHidden)
child->d_ptr->setVisibleHelper(newVisible, false, updateChildren, hiddenByPanel);
}
// Update activation
if (scene && q->isPanel()) {
if (newVisible) {
if (parent && parent->isActive())
q->setActive(true);
} else {
if (q->isActive())
scene->setActivePanel(parent);
}
}
// Enable subfocus
if (scene) {
if (newVisible) {
// Item is shown
QGraphicsItem *p = parent;
bool done = false;
while (p) {
if (p->flags() & QGraphicsItem::ItemIsFocusScope) {
QGraphicsItem *fsi = p->d_ptr->focusScopeItem;
if (q_ptr == fsi || q_ptr->isAncestorOf(fsi)) {
done = true;
while (fsi->d_ptr->focusScopeItem && fsi->d_ptr->focusScopeItem->isVisible())
fsi = fsi->d_ptr->focusScopeItem;
fsi->d_ptr->setFocusHelper(Qt::OtherFocusReason, /* climb = */ true,
/* focusFromHide = */ false);
}
break;
}
p = p->d_ptr->parent;
}
if (!done) {
QGraphicsItem *fi = subFocusItem;
if (fi && fi != scene->focusItem()) {
scene->setFocusItem(fi);
} else if (flags & QGraphicsItem::ItemIsFocusScope &&
!scene->focusItem() &&
q->isAncestorOf(scene->d_func()->lastFocusItem)) {
q_ptr->setFocus();
}
}
} else {
// Item is hidden
if (hasFocus) {
QGraphicsItem *p = parent;
while (p) {
if (p->flags() & QGraphicsItem::ItemIsFocusScope) {
if (p->d_ptr->visible) {
p->d_ptr->setFocusHelper(Qt::OtherFocusReason, /* climb = */ true,
/* focusFromHide = */ true);
}
break;
}
p = p->d_ptr->parent;
}
}
}
}
// Deliver post-change notification.
q_ptr->itemChange(QGraphicsItem::ItemVisibleHasChanged, newVisibleVariant);
if (isObject)
emit static_cast<QGraphicsObject *>(q_ptr)->visibleChanged();
}
/*!
If \a visible is true, the item is made visible. Otherwise, the item is
made invisible. Invisible items are not painted, nor do they receive any
events. In particular, mouse events pass right through invisible items,
and are delivered to any item that may be behind. Invisible items are also
unselectable, they cannot take input focus, and are not detected by
QGraphicsScene's item location functions.
If an item becomes invisible while grabbing the mouse, (i.e., while it is
receiving mouse events,) it will automatically lose the mouse grab, and
the grab is not regained by making the item visible again; it must receive
a new mouse press to regain the mouse grab.
Similarly, an invisible item cannot have focus, so if the item has focus
when it becomes invisible, it will lose focus, and the focus is not
regained by simply making the item visible again.
If you hide a parent item, all its children will also be hidden. If you
show a parent item, all children will be shown, unless they have been
explicitly hidden (i.e., if you call setVisible(false) on a child, it will
not be reshown even if its parent is hidden, and then shown again).
Items are visible by default; it is unnecessary to call
setVisible() on a new item.
\note An item with opacity set to 0 will still be considered visible,
although it will be treated like an invisible item: mouse events will pass
through it, it will not be included in the items returned by
QGraphicsView::items(), and so on. However, the item will retain the focus.
\sa isVisible(), show(), hide(), setOpacity()
*/
void QGraphicsItem::setVisible(bool visible)
{
d_ptr->setVisibleHelper(visible,
/* explicit = */ true,
/* update = */ true,
/* hiddenByPanel = */ isPanel());
}
/*!
\fn void QGraphicsItem::hide()
Hides the item (items are visible by default).
This convenience function is equivalent to calling \c setVisible(false).
\sa show(), setVisible()
*/
/*!
\fn void QGraphicsItem::show()
Shows the item (items are visible by default).
This convenience function is equivalent to calling \c setVisible(true).
\sa hide(), setVisible()
*/
/*!
Returns \c true if the item is enabled; otherwise, false is returned.
\sa setEnabled()
*/
bool QGraphicsItem::isEnabled() const
{
return d_ptr->enabled;
}
/*!
\internal
Sets this item's visibility to \a newEnabled. If \a explicitly is true,
this item will be "explicitly" \a newEnabled; otherwise, it.. will not be.
*/
void QGraphicsItemPrivate::setEnabledHelper(bool newEnabled, bool explicitly, bool update)
{
// Update explicit bit.
if (explicitly)
explicitlyDisabled = newEnabled ? 0 : 1;
// Check if there's nothing to do.
if (enabled == quint32(newEnabled))
return;
// Certain properties are dropped when an item is disabled.
if (!newEnabled) {
if (scene && scene->mouseGrabberItem() == q_ptr)
q_ptr->ungrabMouse();
if (q_ptr->hasFocus()) {
// Disabling the closest non-panel ancestor of the focus item
// causes focus to pop to the next item, otherwise it's cleared.
QGraphicsItem *focusItem = scene->focusItem();
bool clear = true;
if (isWidget && !focusItem->isPanel() && q_ptr->isAncestorOf(focusItem)) {
do {
if (focusItem == q_ptr) {
clear = !static_cast<QGraphicsWidget *>(q_ptr)->focusNextPrevChild(true);
break;
}
} while ((focusItem = focusItem->parentWidget()) && !focusItem->isPanel());
}
if (clear)
q_ptr->clearFocus();
}
if (q_ptr->isSelected())
q_ptr->setSelected(false);
}
// Modify the property.
const QVariant newEnabledVariant(q_ptr->itemChange(QGraphicsItem::ItemEnabledChange,
quint32(newEnabled)));
enabled = newEnabledVariant.toBool();
// Schedule redraw.
if (update)
q_ptr->update();
foreach (QGraphicsItem *child, children) {
if (!newEnabled || !child->d_ptr->explicitlyDisabled)
child->d_ptr->setEnabledHelper(newEnabled, /* explicitly = */ false);
}
// Deliver post-change notification.
q_ptr->itemChange(QGraphicsItem::ItemEnabledHasChanged, newEnabledVariant);
if (isObject)
emit static_cast<QGraphicsObject *>(q_ptr)->enabledChanged();
}
/*!
If \a enabled is true, the item is enabled; otherwise, it is disabled.
Disabled items are visible, but they do not receive any events, and cannot
take focus nor be selected. Mouse events are discarded; they are not
propagated unless the item is also invisible, or if it does not accept
mouse events (see acceptedMouseButtons()). A disabled item cannot become the
mouse grabber, and as a result of this, an item loses the grab if it
becomes disabled when grabbing the mouse, just like it loses focus if it
had focus when it was disabled.
Disabled items are traditionally drawn using grayed-out colors (see \l
QPalette::Disabled).
If you disable a parent item, all its children will also be disabled. If
you enable a parent item, all children will be enabled, unless they have
been explicitly disabled (i.e., if you call setEnabled(false) on a child,
it will not be reenabled if its parent is disabled, and then enabled
again).
Items are enabled by default.
\note If you install an event filter, you can still intercept events
before they are delivered to items; this mechanism disregards the item's
enabled state.
\sa isEnabled()
*/
void QGraphicsItem::setEnabled(bool enabled)
{
d_ptr->setEnabledHelper(enabled, /* explicitly = */ true);
}
/*!
Returns \c true if this item is selected; otherwise, false is returned.
Items that are in a group inherit the group's selected state.
Items are not selected by default.
\sa setSelected(), QGraphicsScene::setSelectionArea()
*/
bool QGraphicsItem::isSelected() const
{
if (QGraphicsItemGroup *group = this->group())
return group->isSelected();
return d_ptr->selected;
}
/*!
If \a selected is true and this item is selectable, this item is selected;
otherwise, it is unselected.
If the item is in a group, the whole group's selected state is toggled by
this function. If the group is selected, all items in the group are also
selected, and if the group is not selected, no item in the group is
selected.
Only visible, enabled, selectable items can be selected. If \a selected
is true and this item is either invisible or disabled or unselectable,
this function does nothing.
By default, items cannot be selected. To enable selection, set the
ItemIsSelectable flag.
This function is provided for convenience, allowing individual toggling of
the selected state of an item. However, a more common way of selecting
items is to call QGraphicsScene::setSelectionArea(), which will call this
function for all visible, enabled, and selectable items within a specified
area on the scene.
\sa isSelected(), QGraphicsScene::selectedItems()
*/
void QGraphicsItem::setSelected(bool selected)
{
if (QGraphicsItemGroup *group = this->group()) {
group->setSelected(selected);
return;
}
if (!(d_ptr->flags & ItemIsSelectable) || !d_ptr->enabled || !d_ptr->visible)
selected = false;
if (d_ptr->selected == selected)
return;
const QVariant newSelectedVariant(itemChange(ItemSelectedChange, quint32(selected)));
bool newSelected = newSelectedVariant.toBool();
if (d_ptr->selected == newSelected)
return;
d_ptr->selected = newSelected;
update();
if (d_ptr->scene) {
QGraphicsScenePrivate *sceneD = d_ptr->scene->d_func();
if (selected) {
sceneD->selectedItems << this;
} else {
// QGraphicsScene::selectedItems() lazily pulls out all items that are
// no longer selected.
}
if (!sceneD->selectionChanging)
emit d_ptr->scene->selectionChanged();
}
// Deliver post-change notification.
itemChange(QGraphicsItem::ItemSelectedHasChanged, newSelectedVariant);
}
/*!
\since 4.5
Returns this item's local opacity, which is between 0.0 (transparent) and
1.0 (opaque). This value is combined with parent and ancestor values into
the effectiveOpacity(). The effective opacity decides how the item is
rendered and also affects its visibility when queried by functions such as
QGraphicsView::items().
The opacity property decides the state of the painter passed to the
paint() function. If the item is cached, i.e., ItemCoordinateCache or
DeviceCoordinateCache, the effective property will be applied to the item's
cache as it is rendered.
The default opacity is 1.0; fully opaque.
\sa setOpacity(), paint(), ItemIgnoresParentOpacity,
ItemDoesntPropagateOpacityToChildren
*/
qreal QGraphicsItem::opacity() const
{
return d_ptr->opacity;
}
/*!
\since 4.5
Returns this item's \e effective opacity, which is between 0.0
(transparent) and 1.0 (opaque). This value is a combination of this item's
local opacity, and its parent and ancestors' opacities. The effective
opacity decides how the item is rendered.
\sa opacity(), setOpacity(), paint(), ItemIgnoresParentOpacity,
ItemDoesntPropagateOpacityToChildren
*/
qreal QGraphicsItem::effectiveOpacity() const
{
return d_ptr->effectiveOpacity();
}
/*!
\since 4.5
Sets this item's local \a opacity, between 0.0 (transparent) and 1.0
(opaque). The item's local opacity is combined with parent and ancestor
opacities into the effectiveOpacity().
By default, opacity propagates from parent to child, so if a parent's
opacity is 0.5 and the child is also 0.5, the child's effective opacity
will be 0.25.
The opacity property decides the state of the painter passed to the
paint() function. If the item is cached, i.e., ItemCoordinateCache or
DeviceCoordinateCache, the effective property will be applied to the
item's cache as it is rendered.
There are two item flags that affect how the item's opacity is combined
with the parent: ItemIgnoresParentOpacity and
ItemDoesntPropagateOpacityToChildren.
\note Setting the opacity of an item to 0 will not make the item invisible
(according to isVisible()), but the item will be treated like an invisible
one. See the documentation of setVisible() for more information.
\sa opacity(), effectiveOpacity(), setVisible()
*/
void QGraphicsItem::setOpacity(qreal opacity)
{
// Notify change.
const QVariant newOpacityVariant(itemChange(ItemOpacityChange, opacity));
// Normalized opacity
qreal newOpacity = qBound(qreal(0), newOpacityVariant.toReal(), qreal(1));
// No change? Done.
if (newOpacity == d_ptr->opacity)
return;
bool wasFullyTransparent = d_ptr->isOpacityNull();
d_ptr->opacity = newOpacity;
// Notify change.
itemChange(ItemOpacityHasChanged, newOpacityVariant);
// Update.
if (d_ptr->scene) {
#if QT_CONFIG(graphicseffect)
d_ptr->invalidateParentGraphicsEffectsRecursively();
if (!(d_ptr->flags & ItemDoesntPropagateOpacityToChildren))
d_ptr->invalidateChildGraphicsEffectsRecursively(QGraphicsItemPrivate::OpacityChanged);
#endif // QT_CONFIG(graphicseffect)
d_ptr->scene->d_func()->markDirty(this, QRectF(),
/*invalidateChildren=*/true,
/*force=*/false,
/*ignoreOpacity=*/d_ptr->isOpacityNull());
if (wasFullyTransparent)
d_ptr->paintedViewBoundingRectsNeedRepaint = 1;
}
if (d_ptr->isObject)
emit static_cast<QGraphicsObject *>(this)->opacityChanged();
}
/*!
Returns a pointer to this item's effect if it has one; otherwise \nullptr.
\since 4.6
*/
#if QT_CONFIG(graphicseffect)
QGraphicsEffect *QGraphicsItem::graphicsEffect() const
{
return d_ptr->graphicsEffect;
}
/*!
Sets \a effect as the item's effect. If there already is an effect installed
on this item, QGraphicsItem will delete the existing effect before installing
the new \a effect. You can delete an existing effect by calling
setGraphicsEffect(\nullptr).
If \a effect is the installed effect on a different item, setGraphicsEffect() will remove
the effect from the item and install it on this item.
QGraphicsItem takes ownership of \a effect.
\note This function will apply the effect on itself and all its children.
\since 4.6
*/
void QGraphicsItem::setGraphicsEffect(QGraphicsEffect *effect)
{
if (d_ptr->graphicsEffect == effect)
return;
if (d_ptr->graphicsEffect) {
delete d_ptr->graphicsEffect;
d_ptr->graphicsEffect = nullptr;
} else if (d_ptr->parent) {
d_ptr->parent->d_ptr->updateChildWithGraphicsEffectFlagRecursively();
}
if (effect) {
// Set new effect.
QGraphicsEffectSourcePrivate *sourced = new QGraphicsItemEffectSourcePrivate(this);
QGraphicsEffectSource *source = new QGraphicsEffectSource(*sourced);
d_ptr->graphicsEffect = effect;
effect->d_func()->setGraphicsEffectSource(source);
prepareGeometryChange();
}
}
#endif // QT_CONFIG(graphicseffect)
void QGraphicsItemPrivate::updateChildWithGraphicsEffectFlagRecursively()
{
#if QT_CONFIG(graphicseffect)
QGraphicsItemPrivate *itemPrivate = this;
do {
// parent chain already notified?
if (itemPrivate->mayHaveChildWithGraphicsEffect)
return;
itemPrivate->mayHaveChildWithGraphicsEffect = 1;
} while ((itemPrivate = itemPrivate->parent ? itemPrivate->parent->d_ptr.data() : nullptr));
#endif
}
/*!
\internal
\since 4.6
Returns the effective bounding rect of the given item space rect.
If the item has no effect, the rect is returned unmodified.
If the item has an effect, the effective rect can be extend beyond the
item's bounding rect, depending on the effect.
\sa boundingRect()
*/
QRectF QGraphicsItemPrivate::effectiveBoundingRect(const QRectF &rect) const
{
#if QT_CONFIG(graphicseffect)
Q_Q(const QGraphicsItem);
QGraphicsEffect *effect = graphicsEffect;
if (scene && effect && effect->isEnabled()) {
if (scene->d_func()->views.isEmpty())
return effect->boundingRectFor(rect);
QRectF sceneRect = q->mapRectToScene(rect);
QRectF sceneEffectRect;
const auto views = scene->views();
for (QGraphicsView *view : views) {
QRectF deviceRect = view->d_func()->mapRectFromScene(sceneRect);
QRect deviceEffectRect = effect->boundingRectFor(deviceRect).toAlignedRect();
sceneEffectRect |= view->d_func()->mapRectToScene(deviceEffectRect);
}
return q->mapRectFromScene(sceneEffectRect);
}
#endif // QT_CONFIG(graphicseffect)
return rect;
}
/*!
\internal
\since 4.6
Returns the effective bounding rect of the item.
If the item has no effect, this is the same as the item's bounding rect.
If the item has an effect, the effective rect can be larger than the item's
bouding rect, depending on the effect.
\sa boundingRect()
*/
QRectF QGraphicsItemPrivate::effectiveBoundingRect(QGraphicsItem *topMostEffectItem) const
{
#if QT_CONFIG(graphicseffect)
Q_Q(const QGraphicsItem);
QRectF brect = effectiveBoundingRect(q_ptr->boundingRect());
if (ancestorFlags & QGraphicsItemPrivate::AncestorClipsChildren
|| ancestorFlags & QGraphicsItemPrivate::AncestorContainsChildren
|| topMostEffectItem == q)
return brect;
const QGraphicsItem *effectParent = parent;
while (effectParent) {
QGraphicsEffect *effect = effectParent->d_ptr->graphicsEffect;
if (scene && effect && effect->isEnabled()) {
const QRectF brectInParentSpace = q->mapRectToItem(effectParent, brect);
const QRectF effectRectInParentSpace = effectParent->d_ptr->effectiveBoundingRect(brectInParentSpace);
brect = effectParent->mapRectToItem(q, effectRectInParentSpace);
}
if (effectParent->d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorClipsChildren
|| effectParent->d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorContainsChildren
|| topMostEffectItem == effectParent) {
return brect;
}
effectParent = effectParent->d_ptr->parent;
}
return brect;
#else //QT_CONFIG(graphicseffect)
Q_UNUSED(topMostEffectItem);
return q_ptr->boundingRect();
#endif // QT_CONFIG(graphicseffect)
}
/*!
\internal
\since 4.6
Returns the effective bounding rect of this item in scene coordinates,
by combining sceneTransform() with boundingRect(), taking into account
the effect that the item might have.
If the item has no effect, this is the same as sceneBoundingRect().
\sa effectiveBoundingRect(), sceneBoundingRect()
*/
QRectF QGraphicsItemPrivate::sceneEffectiveBoundingRect() const
{
// Find translate-only offset
// COMBINE
QPointF offset;
const QGraphicsItem *parentItem = q_ptr;
const QGraphicsItemPrivate *itemd;
do {
itemd = parentItem->d_ptr.data();
if (itemd->transformData)
break;
offset += itemd->pos;
} while ((parentItem = itemd->parent));
QRectF br = effectiveBoundingRect();
br.translate(offset);
return !parentItem ? br : parentItem->sceneTransform().mapRect(br);
}
/*!
Returns \c true if this item can accept drag and drop events; otherwise,
returns \c false. By default, items do not accept drag and drop events; items
are transparent to drag and drop.
\sa setAcceptDrops()
*/
bool QGraphicsItem::acceptDrops() const
{
return d_ptr->acceptDrops;
}
/*!
If \a on is true, this item will accept drag and drop events; otherwise,
it is transparent for drag and drop events. By default, items do not
accept drag and drop events.
\sa acceptDrops()
*/
void QGraphicsItem::setAcceptDrops(bool on)
{
d_ptr->acceptDrops = on;
}
/*!
Returns the mouse buttons that this item accepts mouse events for. By
default, all mouse buttons are accepted.
If an item accepts a mouse button, it will become the mouse
grabber item when a mouse press event is delivered for that mouse
button. However, if the item does not accept the button,
QGraphicsScene will forward the mouse events to the first item
beneath it that does.
\sa setAcceptedMouseButtons(), mousePressEvent()
*/
Qt::MouseButtons QGraphicsItem::acceptedMouseButtons() const
{
return Qt::MouseButtons(d_ptr->acceptedMouseButtons);
}
/*!
Sets the mouse \a buttons that this item accepts mouse events for.
By default, all mouse buttons are accepted. If an item accepts a
mouse button, it will become the mouse grabber item when a mouse
press event is delivered for that button. However, if the item
does not accept the mouse button, QGraphicsScene will forward the
mouse events to the first item beneath it that does.
To disable mouse events for an item (i.e., make it transparent for mouse
events), call setAcceptedMouseButtons(0).
\sa acceptedMouseButtons(), mousePressEvent()
*/
void QGraphicsItem::setAcceptedMouseButtons(Qt::MouseButtons buttons)
{
if (Qt::MouseButtons(d_ptr->acceptedMouseButtons) != buttons) {
if (buttons == 0 && d_ptr->scene && d_ptr->scene->mouseGrabberItem() == this
&& d_ptr->scene->d_func()->lastMouseGrabberItemHasImplicitMouseGrab) {
ungrabMouse();
}
d_ptr->acceptedMouseButtons = quint32(buttons);
}
}
/*!
\since 4.4
Returns \c true if an item accepts hover events
(QGraphicsSceneHoverEvent); otherwise, returns \c false. By default,
items do not accept hover events.
\sa setAcceptedMouseButtons()
*/
bool QGraphicsItem::acceptHoverEvents() const
{
return d_ptr->acceptsHover;
}
/*!
\fn bool QGraphicsItem::acceptsHoverEvents() const
\obsolete
Call acceptHoverEvents() instead.
*/
/*!
\since 4.4
If \a enabled is true, this item will accept hover events;
otherwise, it will ignore them. By default, items do not accept
hover events.
Hover events are delivered when there is no current mouse grabber
item. They are sent when the mouse cursor enters an item, when it
moves around inside the item, and when the cursor leaves an
item. Hover events are commonly used to highlight an item when
it's entered, and for tracking the mouse cursor as it hovers over
the item (equivalent to QWidget::mouseTracking).
Parent items receive hover enter events before their children, and
leave events after their children. The parent does not receive a
hover leave event if the cursor enters a child, though; the parent
stays "hovered" until the cursor leaves its area, including its
children's areas.
If a parent item handles child events, it will receive hover move,
drag move, and drop events as the cursor passes through its
children, but it does not receive hover enter and hover leave, nor
drag enter and drag leave events on behalf of its children.
A QGraphicsWidget with window decorations will accept hover events
regardless of the value of acceptHoverEvents().
\sa acceptHoverEvents(), hoverEnterEvent(), hoverMoveEvent(),
hoverLeaveEvent()
*/
void QGraphicsItem::setAcceptHoverEvents(bool enabled)
{
if (d_ptr->acceptsHover == quint32(enabled))
return;
d_ptr->acceptsHover = quint32(enabled);
if (d_ptr->acceptsHover && d_ptr->scene && d_ptr->scene->d_func()->allItemsIgnoreHoverEvents) {
d_ptr->scene->d_func()->allItemsIgnoreHoverEvents = false;
d_ptr->scene->d_func()->enableMouseTrackingOnViews();
}
}
/*!
\fn void QGraphicsItem::setAcceptsHoverEvents(bool enabled)
\obsolete
Use setAcceptHoverEvents(\a enabled) instead.
*/
/*! \since 4.6
Returns \c true if an item accepts \l{QTouchEvent}{touch events};
otherwise, returns \c false. By default, items do not accept touch events.
\sa setAcceptTouchEvents()
*/
bool QGraphicsItem::acceptTouchEvents() const
{
return d_ptr->acceptTouchEvents;
}
/*!
\since 4.6
If \a enabled is true, this item will accept \l{QTouchEvent}{touch events};
otherwise, it will ignore them. By default, items do not accept
touch events.
*/
void QGraphicsItem::setAcceptTouchEvents(bool enabled)
{
if (d_ptr->acceptTouchEvents == quint32(enabled))
return;
d_ptr->acceptTouchEvents = quint32(enabled);
if (d_ptr->acceptTouchEvents && d_ptr->scene && d_ptr->scene->d_func()->allItemsIgnoreTouchEvents) {
d_ptr->scene->d_func()->allItemsIgnoreTouchEvents = false;
d_ptr->scene->d_func()->enableTouchEventsOnViews();
}
}
/*!
\since 4.6
Returns \c true if this item filters child events (i.e., all events
intended for any of its children are instead sent to this item);
otherwise, false is returned.
The default value is false; child events are not filtered.
\sa setFiltersChildEvents()
*/
bool QGraphicsItem::filtersChildEvents() const
{
return d_ptr->filtersDescendantEvents;
}
/*!
\since 4.6
If \a enabled is true, this item is set to filter all events for
all its children (i.e., all events intented for any of its
children are instead sent to this item); otherwise, if \a enabled
is false, this item will only handle its own events. The default
value is false.
\sa filtersChildEvents()
*/
void QGraphicsItem::setFiltersChildEvents(bool enabled)
{
if (d_ptr->filtersDescendantEvents == enabled)
return;
d_ptr->filtersDescendantEvents = enabled;
d_ptr->updateAncestorFlag(QGraphicsItem::GraphicsItemFlag(-2));
}
/*!
\obsolete
Returns \c true if this item handles child events (i.e., all events
intended for any of its children are instead sent to this item);
otherwise, false is returned.
This property is useful for item groups; it allows one item to
handle events on behalf of its children, as opposed to its
children handling their events individually.
The default is to return false; children handle their own events.
The exception for this is if the item is a QGraphicsItemGroup, then
it defaults to return true.
\sa setHandlesChildEvents()
*/
bool QGraphicsItem::handlesChildEvents() const
{
return d_ptr->handlesChildEvents;
}
/*!
\obsolete
If \a enabled is true, this item is set to handle all events for
all its children (i.e., all events intented for any of its
children are instead sent to this item); otherwise, if \a enabled
is false, this item will only handle its own events. The default
value is false.
This property is useful for item groups; it allows one item to
handle events on behalf of its children, as opposed to its
children handling their events individually.
If a child item accepts hover events, its parent will receive
hover move events as the cursor passes through the child, but it
does not receive hover enter and hover leave events on behalf of
its child.
\sa handlesChildEvents()
*/
void QGraphicsItem::setHandlesChildEvents(bool enabled)
{
if (d_ptr->handlesChildEvents == enabled)
return;
d_ptr->handlesChildEvents = enabled;
d_ptr->updateAncestorFlag(QGraphicsItem::GraphicsItemFlag(-1));
}
/*!
\since 4.6
Returns \c true if this item is active; otherwise returns \c false.
An item can only be active if the scene is active. An item is active
if it is, or is a descendent of, an active panel. Items in non-active
panels are not active.
Items that are not part of a panel follow scene activation when the
scene has no active panel.
Only active items can gain input focus.
\sa QGraphicsScene::isActive(), QGraphicsScene::activePanel(), panel(), isPanel()
*/
bool QGraphicsItem::isActive() const
{
if (!d_ptr->scene || !d_ptr->scene->isActive())
return false;
return panel() == d_ptr->scene->activePanel();
}
/*!
\since 4.6
If \a active is true, and the scene is active, this item's panel will be
activated. Otherwise, the panel is deactivated.
If the item is not part of an active scene, \a active will decide what
happens to the panel when the scene becomes active or the item is added to
the scene. If true, the item's panel will be activated when the item is
either added to the scene or the scene is activated. Otherwise, the item
will stay inactive independent of the scene's activated state.
\sa isPanel(), QGraphicsScene::setActivePanel(), QGraphicsScene::isActive()
*/
void QGraphicsItem::setActive(bool active)
{
d_ptr->explicitActivate = 1;
d_ptr->wantsActive = active;
if (d_ptr->scene) {
if (active) {
// Activate this item.
d_ptr->scene->setActivePanel(this);
} else {
QGraphicsItem *activePanel = d_ptr->scene->activePanel();
QGraphicsItem *thisPanel = panel();
if (!activePanel || activePanel == thisPanel) {
// Deactivate this item, and reactivate the parent panel,
// or the last active panel (if any).
QGraphicsItem *nextToActivate = nullptr;
if (d_ptr->parent)
nextToActivate = d_ptr->parent->panel();
if (!nextToActivate)
nextToActivate = d_ptr->scene->d_func()->lastActivePanel;
if (nextToActivate == this || isAncestorOf(nextToActivate))
nextToActivate = nullptr;
d_ptr->scene->setActivePanel(nextToActivate);
}
}
}
}
/*!
Returns \c true if this item is active, and it or its \l{focusProxy()}{focus
proxy} has keyboard input focus; otherwise, returns \c false.
\sa focusItem(), setFocus(), QGraphicsScene::setFocusItem(), isActive()
*/
bool QGraphicsItem::hasFocus() const
{
if (!d_ptr->scene || !d_ptr->scene->isActive())
return false;
if (d_ptr->focusProxy)
return d_ptr->focusProxy->hasFocus();
if (d_ptr->scene->d_func()->focusItem != this)
return false;
return panel() == d_ptr->scene->d_func()->activePanel;
}
/*!
Gives keyboard input focus to this item. The \a focusReason argument will
be passed into any \l{QFocusEvent}{focus event} generated by this function;
it is used to give an explanation of what caused the item to get focus.
Only enabled items that set the ItemIsFocusable flag can accept keyboard
focus.
If this item is not visible, not active, or not associated with a scene,
it will not gain immediate input focus. However, it will be registered as
the preferred focus item for its subtree of items, should it later become
visible.
As a result of calling this function, this item will receive a
\l{focusInEvent()}{focus in event} with \a focusReason. If another item
already has focus, that item will first receive a \l{focusOutEvent()}
{focus out event} indicating that it has lost input focus.
\sa clearFocus(), hasFocus(), focusItem(), focusProxy()
*/
void QGraphicsItem::setFocus(Qt::FocusReason focusReason)
{
d_ptr->setFocusHelper(focusReason, /* climb = */ true, /* focusFromHide = */ false);
}
/*!
\internal
*/
void QGraphicsItemPrivate::setFocusHelper(Qt::FocusReason focusReason, bool climb, bool focusFromHide)
{
// Disabled / unfocusable items cannot accept focus.
if (!q_ptr->isEnabled() || !(flags & QGraphicsItem::ItemIsFocusable))
return;
// Find focus proxy.
QGraphicsItem *f = q_ptr;
while (f->d_ptr->focusProxy)
f = f->d_ptr->focusProxy;
// Return if it already has focus.
if (scene && scene->focusItem() == f)
return;
// Update focus scope item ptr.
QGraphicsItem *p = parent;
while (p) {
if (p->flags() & QGraphicsItem::ItemIsFocusScope) {
QGraphicsItem *oldFocusScopeItem = p->d_ptr->focusScopeItem;
p->d_ptr->focusScopeItem = q_ptr;
if (oldFocusScopeItem)
oldFocusScopeItem->d_ptr->focusScopeItemChange(false);
focusScopeItemChange(true);
if (!p->focusItem() && !focusFromHide) {
// Calling setFocus() on a child of a focus scope that does
// not have focus changes only the focus scope pointer,
// so that focus is restored the next time the scope gains
// focus.
return;
}
break;
}
p = p->d_ptr->parent;
}
if (climb) {
while (f->d_ptr->focusScopeItem && f->d_ptr->focusScopeItem->isVisible())
f = f->d_ptr->focusScopeItem;
}
// Update the child focus chain.
QGraphicsItem *commonAncestor = nullptr;
if (scene && scene->focusItem() && scene->focusItem()->panel() == q_ptr->panel()) {
commonAncestor = scene->focusItem()->commonAncestorItem(f);
scene->focusItem()->d_ptr->clearSubFocus(scene->focusItem(), commonAncestor);
}
f->d_ptr->setSubFocus(f, commonAncestor);
// Update the scene's focus item.
if (scene) {
QGraphicsItem *p = q_ptr->panel();
if ((!p && scene->isActive()) || (p && p->isActive())) {
// Visible items immediately gain focus from scene.
scene->d_func()->setFocusItemHelper(f, focusReason);
}
}
}
/*!
Takes keyboard input focus from the item.
If it has focus, a \l{focusOutEvent()}{focus out event} is sent to this
item to tell it that it is about to lose the focus.
Only items that set the ItemIsFocusable flag, or widgets that set an
appropriate focus policy, can accept keyboard focus.
\sa setFocus(), hasFocus(), QGraphicsWidget::focusPolicy
*/
void QGraphicsItem::clearFocus()
{
d_ptr->clearFocusHelper(/* giveFocusToParent = */ true,
/* hiddenByParentPanel = */ false);
}
/*!
\internal
*/
void QGraphicsItemPrivate::clearFocusHelper(bool giveFocusToParent, bool hiddenByParentPanel)
{
QGraphicsItem *subFocusItem = q_ptr;
if (flags & QGraphicsItem::ItemIsFocusScope) {
while (subFocusItem->d_ptr->focusScopeItem)
subFocusItem = subFocusItem->d_ptr->focusScopeItem;
}
if (giveFocusToParent) {
// Pass focus to the closest parent focus scope
if (!inDestructor) {
QGraphicsItem *p = parent;
while (p) {
if (p->flags() & QGraphicsItem::ItemIsFocusScope) {
if (p->d_ptr->focusScopeItem == q_ptr) {
p->d_ptr->focusScopeItem = nullptr;
if (!subFocusItem->hasFocus()) //if it has focus, focusScopeItemChange is called elsewhere
focusScopeItemChange(false);
}
if (subFocusItem->hasFocus())
p->d_ptr->setFocusHelper(Qt::OtherFocusReason, /* climb = */ false,
/* focusFromHide = */ false);
return;
}
p = p->d_ptr->parent;
}
}
}
if (subFocusItem->hasFocus()) {
// Invisible items with focus must explicitly clear subfocus.
if (!hiddenByParentPanel)
clearSubFocus(q_ptr);
// If this item has the scene's input focus, clear it.
scene->setFocusItem(nullptr);
}
}
/*!
\since 4.6
Returns this item's focus proxy, or \nullptr if this item has no
focus proxy.
\sa setFocusProxy(), setFocus(), hasFocus()
*/
QGraphicsItem *QGraphicsItem::focusProxy() const
{
return d_ptr->focusProxy;
}
/*!
\since 4.6
Sets the item's focus proxy to \a item.
If an item has a focus proxy, the focus proxy will receive
input focus when the item gains input focus. The item itself
will still have focus (i.e., hasFocus() will return true),
but only the focus proxy will receive the keyboard input.
A focus proxy can itself have a focus proxy, and so on. In
such case, keyboard input will be handled by the outermost
focus proxy.
The focus proxy \a item must belong to the same scene as
this item.
\sa focusProxy(), setFocus(), hasFocus()
*/
void QGraphicsItem::setFocusProxy(QGraphicsItem *item)
{
if (item == d_ptr->focusProxy)
return;
if (item == this) {
qWarning("QGraphicsItem::setFocusProxy: cannot assign self as focus proxy");
return;
}
if (item) {
if (item->d_ptr->scene != d_ptr->scene) {
qWarning("QGraphicsItem::setFocusProxy: focus proxy must be in same scene");
return;
}
for (QGraphicsItem *f = item->focusProxy(); f != nullptr; f = f->focusProxy()) {
if (f == this) {
qWarning("QGraphicsItem::setFocusProxy: %p is already in the focus proxy chain", item);
return;
}
}
}
QGraphicsItem *lastFocusProxy = d_ptr->focusProxy;
if (lastFocusProxy)
lastFocusProxy->d_ptr->focusProxyRefs.removeOne(&d_ptr->focusProxy);
d_ptr->focusProxy = item;
if (item)
item->d_ptr->focusProxyRefs << &d_ptr->focusProxy;
}
/*!
\since 4.6
If this item, a child or descendant of this item currently has input
focus, this function will return a pointer to that item. If
no descendant has input focus, \nullptr is returned.
\sa hasFocus(), setFocus(), QWidget::focusWidget()
*/
QGraphicsItem *QGraphicsItem::focusItem() const
{
return d_ptr->subFocusItem;
}
/*!
\internal
Returns this item's focus scope item.
*/
QGraphicsItem *QGraphicsItem::focusScopeItem() const
{
return d_ptr->focusScopeItem;
}
/*!
\since 4.4
Grabs the mouse input.
This item will receive all mouse events for the scene until any of the
following events occurs:
\list
\li The item becomes invisible
\li The item is removed from the scene
\li The item is deleted
\li The item call ungrabMouse()
\li Another item calls grabMouse(); the item will regain the mouse grab
when the other item calls ungrabMouse().
\endlist
When an item gains the mouse grab, it receives a QEvent::GrabMouse
event. When it loses the mouse grab, it receives a QEvent::UngrabMouse
event. These events can be used to detect when your item gains or loses
the mouse grab through other means than receiving mouse button events.
It is almost never necessary to explicitly grab the mouse in Qt, as Qt
grabs and releases it sensibly. In particular, Qt grabs the mouse when you
press a mouse button, and keeps the mouse grabbed until you release the
last mouse button. Also, Qt::Popup widgets implicitly call grabMouse()
when shown, and ungrabMouse() when hidden.
Note that only visible items can grab mouse input. Calling grabMouse() on
an invisible item has no effect.
Keyboard events are not affected.
\sa QGraphicsScene::mouseGrabberItem(), ungrabMouse(), grabKeyboard()
*/
void QGraphicsItem::grabMouse()
{
if (!d_ptr->scene) {
qWarning("QGraphicsItem::grabMouse: cannot grab mouse without scene");
return;
}
if (!d_ptr->visible) {
qWarning("QGraphicsItem::grabMouse: cannot grab mouse while invisible");
return;
}
d_ptr->scene->d_func()->grabMouse(this);
}
/*!
\since 4.4
Releases the mouse grab.
\sa grabMouse(), ungrabKeyboard()
*/
void QGraphicsItem::ungrabMouse()
{
if (!d_ptr->scene) {
qWarning("QGraphicsItem::ungrabMouse: cannot ungrab mouse without scene");
return;
}
d_ptr->scene->d_func()->ungrabMouse(this);
}
/*!
\since 4.4
Grabs the keyboard input.
The item will receive all keyboard input to the scene until one of the
following events occur:
\list
\li The item becomes invisible
\li The item is removed from the scene
\li The item is deleted
\li The item calls ungrabKeyboard()
\li Another item calls grabKeyboard(); the item will regain the keyboard grab
when the other item calls ungrabKeyboard().
\endlist
When an item gains the keyboard grab, it receives a QEvent::GrabKeyboard
event. When it loses the keyboard grab, it receives a
QEvent::UngrabKeyboard event. These events can be used to detect when your
item gains or loses the keyboard grab through other means than gaining
input focus.
It is almost never necessary to explicitly grab the keyboard in Qt, as Qt
grabs and releases it sensibly. In particular, Qt grabs the keyboard when
your item gains input focus, and releases it when your item loses input
focus, or when the item is hidden.
Note that only visible items can grab keyboard input. Calling
grabKeyboard() on an invisible item has no effect.
Keyboard events are not affected.
\sa ungrabKeyboard(), grabMouse(), setFocus()
*/
void QGraphicsItem::grabKeyboard()
{
if (!d_ptr->scene) {
qWarning("QGraphicsItem::grabKeyboard: cannot grab keyboard without scene");
return;
}
if (!d_ptr->visible) {
qWarning("QGraphicsItem::grabKeyboard: cannot grab keyboard while invisible");
return;
}
d_ptr->scene->d_func()->grabKeyboard(this);
}
/*!
\since 4.4
Releases the keyboard grab.
\sa grabKeyboard(), ungrabMouse()
*/
void QGraphicsItem::ungrabKeyboard()
{
if (!d_ptr->scene) {
qWarning("QGraphicsItem::ungrabKeyboard: cannot ungrab keyboard without scene");
return;
}
d_ptr->scene->d_func()->ungrabKeyboard(this);
}
/*!
Returns the position of the item in parent coordinates. If the item has no
parent, its position is given in scene coordinates.
The position of the item describes its origin (local coordinate
(0, 0)) in parent coordinates; this function returns the same as
mapToParent(0, 0).
For convenience, you can also call scenePos() to determine the
item's position in scene coordinates, regardless of its parent.
\sa x(), y(), setPos(), transform(), {The Graphics View Coordinate System}
*/
QPointF QGraphicsItem::pos() const
{
return d_ptr->pos;
}
/*!
\fn QGraphicsItem::x() const
This convenience function is equivalent to calling pos().x().
\sa y()
*/
/*!
\since 4.6
Set's the \a x coordinate of the item's position. Equivalent to
calling setPos(x, y()).
\sa x(), setPos()
*/
void QGraphicsItem::setX(qreal x)
{
if (d_ptr->inDestructor)
return;
if (qIsNaN(x))
return;
setPos(QPointF(x, d_ptr->pos.y()));
}
/*!
\fn QGraphicsItem::y() const
This convenience function is equivalent to calling pos().y().
\sa x()
*/
/*!
\since 4.6
Set's the \a y coordinate of the item's position. Equivalent to
calling setPos(x(), y).
\sa x(), setPos()
*/
void QGraphicsItem::setY(qreal y)
{
if (d_ptr->inDestructor)
return;
if (qIsNaN(y))
return;
setPos(QPointF(d_ptr->pos.x(), y));
}
/*!
Returns the item's position in scene coordinates. This is
equivalent to calling \c mapToScene(0, 0).
\sa pos(), sceneTransform(), {The Graphics View Coordinate System}
*/
QPointF QGraphicsItem::scenePos() const
{
return mapToScene(0, 0);
}
/*!
\internal
Sets the position \a pos.
*/
void QGraphicsItemPrivate::setPosHelper(const QPointF &pos)
{
Q_Q(QGraphicsItem);
inSetPosHelper = 1;
if (scene)
q->prepareGeometryChange();
QPointF oldPos = this->pos;
this->pos = pos;
dirtySceneTransform = 1;
inSetPosHelper = 0;
if (isObject) {
if (pos.x() != oldPos.x())
emit static_cast<QGraphicsObject *>(q_ptr)->xChanged();
if (pos.y() != oldPos.y())
emit static_cast<QGraphicsObject *>(q_ptr)->yChanged();
}
}
/*!
\internal
Sets the transform \a transform.
*/
void QGraphicsItemPrivate::setTransformHelper(const QTransform &transform)
{
q_ptr->prepareGeometryChange();
transformData->transform = transform;
dirtySceneTransform = 1;
transformChanged();
}
/*!
Sets the position of the item to \a pos, which is in parent
coordinates. For items with no parent, \a pos is in scene
coordinates.
The position of the item describes its origin (local coordinate
(0, 0)) in parent coordinates.
\sa pos(), scenePos(), {The Graphics View Coordinate System}
*/
void QGraphicsItem::setPos(const QPointF &pos)
{
if (d_ptr->pos == pos)
return;
if (d_ptr->inDestructor)
return;
// Update and repositition.
if (!(d_ptr->flags & (ItemSendsGeometryChanges | ItemSendsScenePositionChanges))) {
d_ptr->setPosHelper(pos);
if (d_ptr->isWidget)
static_cast<QGraphicsWidget *>(this)->d_func()->setGeometryFromSetPos();
if (d_ptr->scenePosDescendants)
d_ptr->sendScenePosChange();
return;
}
// Notify the item that the position is changing.
const QVariant newPosVariant(itemChange(ItemPositionChange, QVariant::fromValue<QPointF>(pos)));
QPointF newPos = newPosVariant.toPointF();
if (newPos == d_ptr->pos)
return;
// Update and repositition.
d_ptr->setPosHelper(newPos);
// Send post-notification.
itemChange(QGraphicsItem::ItemPositionHasChanged, newPosVariant);
d_ptr->sendScenePosChange();
}
/*!
\fn void QGraphicsItem::setPos(qreal x, qreal y)
\overload
This convenience function is equivalent to calling setPos(QPointF(\a x, \a
y)).
*/
/*!
\fn void QGraphicsItem::moveBy(qreal dx, qreal dy)
Moves the item by \a dx points horizontally, and \a dy point
vertically. This function is equivalent to calling setPos(pos() +
QPointF(\a dx, \a dy)).
*/
/*!
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 \a
rect is visible inside the view's viewport. If \a rect is a null rect (the
default), QGraphicsItem will default to the item's bounding rect. \a xmargin
and \a ymargin are the number of pixels the view should use for margins.
If the specified rect cannot be reached, the contents are scrolled to the
nearest valid position.
If this item is not viewed by a QGraphicsView, this function does nothing.
\sa QGraphicsView::ensureVisible()
*/
void QGraphicsItem::ensureVisible(const QRectF &rect, int xmargin, int ymargin)
{
if (d_ptr->scene) {
QRectF sceneRect;
if (!rect.isNull())
sceneRect = sceneTransform().mapRect(rect);
else
sceneRect = sceneBoundingRect();
foreach (QGraphicsView *view, d_ptr->scene->d_func()->views)
view->ensureVisible(sceneRect, xmargin, ymargin);
}
}
/*!
\fn void QGraphicsItem::ensureVisible(qreal x, qreal y, qreal w, qreal h,
int xmargin = 50, int ymargin = 50)
This convenience function is equivalent to calling
ensureVisible(QRectF(\a x, \a y, \a w, \a h), \a xmargin, \a ymargin).
*/
#if QT_DEPRECATED_SINCE(5, 13)
/*!
\obsolete
Returns the item's affine transformation matrix. This is a subset or the
item's full transformation matrix, and might not represent the item's full
transformation.
Use transform() instead.
\sa setTransform(), sceneTransform()
*/
QMatrix QGraphicsItem::matrix() const
{
return transform().toAffine();
}
#endif
/*!
\since 4.3
Returns this item's transformation matrix.
The transformation matrix is combined with the item's rotation(), scale()
and transformations() into a combined transformations for the item.
The default transformation matrix is an identity matrix.
\sa setTransform(), sceneTransform()
*/
QTransform QGraphicsItem::transform() const
{
if (!d_ptr->transformData)
return QTransform();
return d_ptr->transformData->transform;
}
/*!
\since 4.6
Returns the clockwise rotation, in degrees, around the Z axis. The default
value is 0 (i.e., the item is not rotated).
The rotation is combined with the item's scale(), transform() and
transformations() to map the item's coordinate system to the parent item.
\sa setRotation(), transformOriginPoint(), {Transformations}
*/
qreal QGraphicsItem::rotation() const
{
if (!d_ptr->transformData)
return 0;
return d_ptr->transformData->rotation;
}
/*!
\since 4.6
Sets the clockwise rotation \a angle, in degrees, around the Z axis. The
default value is 0 (i.e., the item is not rotated). Assigning a negative
value will rotate the item counter-clockwise. Normally the rotation angle
is in the range (-360, 360), but it's also possible to assign values
outside of this range (e.g., a rotation of 370 degrees is the same as a
rotation of 10 degrees).
The item is rotated around its transform origin point, which by default
is (0, 0). You can select a different transformation origin by calling
setTransformOriginPoint().
The rotation is combined with the item's scale(), transform() and
transformations() to map the item's coordinate system to the parent item.
\sa rotation(), setTransformOriginPoint(), {Transformations}
*/
void QGraphicsItem::setRotation(qreal angle)
{
prepareGeometryChange();
qreal newRotation = angle;
if (d_ptr->flags & ItemSendsGeometryChanges) {
// Notify the item that the rotation is changing.
const QVariant newRotationVariant(itemChange(ItemRotationChange, angle));
newRotation = newRotationVariant.toReal();
}
if (!d_ptr->transformData)
d_ptr->transformData = new QGraphicsItemPrivate::TransformData;
if (d_ptr->transformData->rotation == newRotation)
return;
d_ptr->transformData->rotation = newRotation;
d_ptr->transformData->onlyTransform = false;
d_ptr->dirtySceneTransform = 1;
// Send post-notification.
if (d_ptr->flags & ItemSendsGeometryChanges)
itemChange(ItemRotationHasChanged, newRotation);
if (d_ptr->isObject)
emit static_cast<QGraphicsObject *>(this)->rotationChanged();
d_ptr->transformChanged();
}
/*!
\since 4.6
Returns the scale factor of the item. The default scale factor is 1.0
(i.e., the item is not scaled).
The scale is combined with the item's rotation(), transform() and
transformations() to map the item's coordinate system to the parent item.
\sa setScale(), rotation(), {Transformations}
*/
qreal QGraphicsItem::scale() const
{
if (!d_ptr->transformData)
return 1.;
return d_ptr->transformData->scale;
}
/*!
\since 4.6
Sets the scale \a factor of the item. The default scale factor is 1.0
(i.e., the item is not scaled). A scale factor of 0.0 will collapse the
item to a single point. If you provide a negative scale factor, the
item will be flipped and mirrored (i.e., rotated 180 degrees).
The item is scaled around its transform origin point, which by default
is (0, 0). You can select a different transformation origin by calling
setTransformOriginPoint().
The scale is combined with the item's rotation(), transform() and
transformations() to map the item's coordinate system to the parent item.
\sa scale(), setTransformOriginPoint(), {Transformations Example}
*/
void QGraphicsItem::setScale(qreal factor)
{
prepareGeometryChange();
qreal newScale = factor;
if (d_ptr->flags & ItemSendsGeometryChanges) {
// Notify the item that the scale is changing.
const QVariant newScaleVariant(itemChange(ItemScaleChange, factor));
newScale = newScaleVariant.toReal();
}
if (!d_ptr->transformData)
d_ptr->transformData = new QGraphicsItemPrivate::TransformData;
if (d_ptr->transformData->scale == newScale)
return;
d_ptr->transformData->scale = newScale;
d_ptr->transformData->onlyTransform = false;
d_ptr->dirtySceneTransform = 1;
// Send post-notification.
if (d_ptr->flags & ItemSendsGeometryChanges)
itemChange(ItemScaleHasChanged, newScale);
if (d_ptr->isObject)
emit static_cast<QGraphicsObject *>(this)->scaleChanged();
d_ptr->transformChanged();
}
/*!
\since 4.6
Returns a list of graphics transforms that currently apply to this item.
QGraphicsTransform is for applying and controlling a chain of individual
transformation operations on an item. It's particularly useful in
animations, where each transform operation needs to be interpolated
independently, or differently.
The transformations are combined with the item's rotation(), scale() and
transform() to map the item's coordinate system to the parent item.
\sa scale(), rotation(), transformOriginPoint(), {Transformations}
*/
QList<QGraphicsTransform *> QGraphicsItem::transformations() const
{
if (!d_ptr->transformData)
return QList<QGraphicsTransform *>();
return d_ptr->transformData->graphicsTransforms;
}
/*!
\since 4.6
Sets a list of graphics \a transformations (QGraphicsTransform) that
currently apply to this item.
If all you want is to rotate or scale an item, you should call setRotation()
or setScale() instead. If you want to set an arbitrary transformation on
an item, you can call setTransform().
QGraphicsTransform is for applying and controlling a chain of individual
transformation operations on an item. It's particularly useful in
animations, where each transform operation needs to be interpolated
independently, or differently.
The transformations are combined with the item's rotation(), scale() and
transform() to map the item's coordinate system to the parent item.
\sa scale(), setTransformOriginPoint(), {Transformations}
*/
void QGraphicsItem::setTransformations(const QList<QGraphicsTransform *> &transformations)
{
prepareGeometryChange();
if (!d_ptr->transformData)
d_ptr->transformData = new QGraphicsItemPrivate::TransformData;
d_ptr->transformData->graphicsTransforms = transformations;
for (int i = 0; i < transformations.size(); ++i)
transformations.at(i)->d_func()->setItem(this);
d_ptr->transformData->onlyTransform = false;
d_ptr->dirtySceneTransform = 1;
d_ptr->transformChanged();
}
/*!
\internal
*/
void QGraphicsItemPrivate::prependGraphicsTransform(QGraphicsTransform *t)
{
if (!transformData)
transformData = new QGraphicsItemPrivate::TransformData;
if (!transformData->graphicsTransforms.contains(t))
transformData->graphicsTransforms.prepend(t);
Q_Q(QGraphicsItem);
t->d_func()->setItem(q);
transformData->onlyTransform = false;
dirtySceneTransform = 1;
transformChanged();
}
/*!
\internal
*/
void QGraphicsItemPrivate::appendGraphicsTransform(QGraphicsTransform *t)
{
if (!transformData)
transformData = new QGraphicsItemPrivate::TransformData;
if (!transformData->graphicsTransforms.contains(t))
transformData->graphicsTransforms.append(t);
Q_Q(QGraphicsItem);
t->d_func()->setItem(q);
transformData->onlyTransform = false;
dirtySceneTransform = 1;
transformChanged();
}
/*!
\since 4.6
Returns the origin point for the transformation in item coordinates.
The default is QPointF(0,0).
\sa setTransformOriginPoint(), {Transformations}
*/
QPointF QGraphicsItem::transformOriginPoint() const
{
if (!d_ptr->transformData)
return QPointF(0,0);
return QPointF(d_ptr->transformData->xOrigin, d_ptr->transformData->yOrigin);
}
/*!
\since 4.6
Sets the \a origin point for the transformation in item coordinates.
\sa transformOriginPoint(), {Transformations}
*/
void QGraphicsItem::setTransformOriginPoint(const QPointF &origin)
{
prepareGeometryChange();
QPointF newOrigin = origin;
if (d_ptr->flags & ItemSendsGeometryChanges) {
// Notify the item that the origin point is changing.
const QVariant newOriginVariant(itemChange(ItemTransformOriginPointChange,
QVariant::fromValue<QPointF>(origin)));
newOrigin = newOriginVariant.toPointF();
}
if (!d_ptr->transformData)
d_ptr->transformData = new QGraphicsItemPrivate::TransformData;
if (d_ptr->transformData->xOrigin == newOrigin.x()
&& d_ptr->transformData->yOrigin == newOrigin.y()) {
return;
}
d_ptr->transformData->xOrigin = newOrigin.x();
d_ptr->transformData->yOrigin = newOrigin.y();
d_ptr->transformData->onlyTransform = false;
d_ptr->dirtySceneTransform = 1;
// Send post-notification.
if (d_ptr->flags & ItemSendsGeometryChanges)
itemChange(ItemTransformOriginPointHasChanged, QVariant::fromValue<QPointF>(newOrigin));
}
/*!
\fn void QGraphicsItem::setTransformOriginPoint(qreal x, qreal y)
\since 4.6
\overload
Sets the origin point for the transformation in item coordinates.
This is equivalent to calling setTransformOriginPoint(QPointF(\a x, \a y)).
\sa setTransformOriginPoint(), {Transformations}
*/
#if QT_DEPRECATED_SINCE(5, 13)
/*!
\obsolete
Use sceneTransform() instead.
\sa transform(), setTransform(), scenePos(), {The Graphics View Coordinate System}
*/
QMatrix QGraphicsItem::sceneMatrix() const
{
d_ptr->ensureSceneTransform();
return d_ptr->sceneTransform.toAffine();
}
#endif
/*!
\since 4.3
Returns this item's scene transformation matrix. This matrix can be used
to map coordinates and geometrical shapes from this item's local
coordinate system to the scene's coordinate system. To map coordinates
from the scene, you must first invert the returned matrix.
Example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 4
Unlike transform(), which returns only an item's local transformation, this
function includes the item's (and any parents') position, and all the transfomation properties.
\sa transform(), setTransform(), scenePos(), {The Graphics View Coordinate System}, {Transformations}
*/
QTransform QGraphicsItem::sceneTransform() const
{
d_ptr->ensureSceneTransform();
return d_ptr->sceneTransform;
}
/*!
\since 4.3
Returns this item's device transformation matrix, using \a
viewportTransform to map from scene to device coordinates. This matrix can
be used to map coordinates and geometrical shapes from this item's local
coordinate system to the viewport's (or any device's) coordinate
system. To map coordinates from the viewport, you must first invert the
returned matrix.
Example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 5
This function is the same as combining this item's scene transform with
the view's viewport transform, but it also understands the
ItemIgnoresTransformations flag. The device transform can be used to do
accurate coordinate mapping (and collision detection) for untransformable
items.
\sa transform(), setTransform(), scenePos(), {The Graphics View Coordinate
System}, itemTransform()
*/
QTransform QGraphicsItem::deviceTransform(const QTransform &viewportTransform) const
{
// Ensure we return the standard transform if we're not untransformable.
if (!d_ptr->itemIsUntransformable()) {
d_ptr->ensureSceneTransform();
return d_ptr->sceneTransform * viewportTransform;
}
// Find the topmost item that ignores view transformations.
const QGraphicsItem *untransformedAncestor = this;
QList<const QGraphicsItem *> parents;
while (untransformedAncestor && ((untransformedAncestor->d_ptr->ancestorFlags
& QGraphicsItemPrivate::AncestorIgnoresTransformations))) {
parents.prepend(untransformedAncestor);
untransformedAncestor = untransformedAncestor->parentItem();
}
if (!untransformedAncestor) {
// Assert in debug mode, continue in release.
Q_ASSERT_X(untransformedAncestor, "QGraphicsItem::deviceTransform",
"Invalid object structure!");
return QTransform();
}
// Determine the inherited origin. Find the parent of the topmost untransformable.
// Use its scene transform to map the position of the untransformable. Then use
// that viewport position as the anchoring point for the untransformable subtree.
QGraphicsItem *parentOfUntransformedAncestor = untransformedAncestor->parentItem();
QTransform inheritedMatrix;
if (parentOfUntransformedAncestor)
inheritedMatrix = parentOfUntransformedAncestor->sceneTransform();
QPointF mappedPoint = (inheritedMatrix * viewportTransform).map(untransformedAncestor->pos());
// COMBINE
QTransform matrix = QTransform::fromTranslate(mappedPoint.x(), mappedPoint.y());
if (untransformedAncestor->d_ptr->transformData)
matrix = untransformedAncestor->d_ptr->transformData->computedFullTransform(&matrix);
// Then transform and translate all children.
for (int i = 0; i < parents.size(); ++i) {
const QGraphicsItem *parent = parents.at(i);
parent->d_ptr->combineTransformFromParent(&matrix);
}
return matrix;
}
/*!
\since 4.5
Returns a QTransform that maps coordinates from this item to \a other. If
\a ok is not null, and if there is no such transform, the boolean pointed
to by \a ok will be set to false; otherwise it will be set to true.
This transform provides an alternative to the mapToItem() or mapFromItem()
functions, by returning the appropriate transform so that you can map
shapes and coordinates yourself. It also helps you write more efficient
code when repeatedly mapping between the same two items.
\note In rare circumstances, there is no transform that maps between two
items.
\sa mapToItem(), mapFromItem(), deviceTransform()
*/
QTransform QGraphicsItem::itemTransform(const QGraphicsItem *other, bool *ok) const
{
// Catch simple cases first.
if (other == nullptr) {
qWarning("QGraphicsItem::itemTransform: null pointer passed");
return QTransform();
}
if (other == this) {
if (ok)
*ok = true;
return QTransform();
}
QGraphicsItem *parent = d_ptr->parent;
const QGraphicsItem *otherParent = other->d_ptr->parent;
// This is other's child
if (parent == other) {
if (ok)
*ok = true;
QTransform x;
d_ptr->combineTransformFromParent(&x);
return x;
}
// This is other's parent
if (otherParent == this) {
const QPointF &otherPos = other->d_ptr->pos;
if (other->d_ptr->transformData) {
QTransform otherToParent;
other->d_ptr->combineTransformFromParent(&otherToParent);
return otherToParent.inverted(ok);
}
if (ok)
*ok = true;
return QTransform::fromTranslate(-otherPos.x(), -otherPos.y());
}
// Siblings
if (parent == otherParent) {
// COMBINE
const QPointF &itemPos = d_ptr->pos;
const QPointF &otherPos = other->d_ptr->pos;
if (!d_ptr->transformData && !other->d_ptr->transformData) {
QPointF delta = itemPos - otherPos;
if (ok)
*ok = true;
return QTransform::fromTranslate(delta.x(), delta.y());
}
QTransform itemToParent;
d_ptr->combineTransformFromParent(&itemToParent);
QTransform otherToParent;
other->d_ptr->combineTransformFromParent(&otherToParent);
return itemToParent * otherToParent.inverted(ok);
}
// Find the closest common ancestor. If the two items don't share an
// ancestor, then the only way is to combine their scene transforms.
const QGraphicsItem *commonAncestor = commonAncestorItem(other);
if (!commonAncestor) {
d_ptr->ensureSceneTransform();
other->d_ptr->ensureSceneTransform();
return d_ptr->sceneTransform * other->d_ptr->sceneTransform.inverted(ok);
}
// If the two items are cousins (in sibling branches), map both to the
// common ancestor, and combine the two transforms.
bool cousins = other != commonAncestor && this != commonAncestor;
if (cousins) {
bool good = false;
QTransform thisToScene = itemTransform(commonAncestor, &good);
QTransform otherToScene(Qt::Uninitialized);
if (good)
otherToScene = other->itemTransform(commonAncestor, &good);
if (!good) {
if (ok)
*ok = false;
return QTransform();
}
return thisToScene * otherToScene.inverted(ok);
}
// One is an ancestor of the other; walk the chain.
bool parentOfOther = isAncestorOf(other);
const QGraphicsItem *child = parentOfOther ? other : this;
const QGraphicsItem *root = parentOfOther ? this : other;
QTransform x;
const QGraphicsItem *p = child;
do {
p->d_ptr.data()->combineTransformToParent(&x);
} while ((p = p->d_ptr->parent) && p != root);
if (parentOfOther)
return x.inverted(ok);
if (ok)
*ok = true;
return x;
}
#if QT_DEPRECATED_SINCE(5, 13)
QT_WARNING_PUSH
QT_WARNING_DISABLE_DEPRECATED
/*!
\obsolete
Sets the item's affine transformation matrix. This is a subset or the
item's full transformation matrix, and might not represent the item's full
transformation.
Use setTransform() instead.
\sa transform(), {The Graphics View Coordinate System}
*/
void QGraphicsItem::setMatrix(const QMatrix &matrix, bool combine)
{
if (!d_ptr->transformData)
d_ptr->transformData = new QGraphicsItemPrivate::TransformData;
QTransform newTransform(combine ? QTransform(matrix) * d_ptr->transformData->transform : QTransform(matrix));
if (d_ptr->transformData->transform == newTransform)
return;
// Update and set the new transformation.
if (!(d_ptr->flags & ItemSendsGeometryChanges)) {
d_ptr->setTransformHelper(newTransform);
return;
}
// Notify the item that the transformation matrix is changing.
const QVariant newMatrixVariant = QVariant::fromValue<QMatrix>(newTransform.toAffine());
newTransform = QTransform(qvariant_cast<QMatrix>(itemChange(ItemMatrixChange, newMatrixVariant)));
if (d_ptr->transformData->transform == newTransform)
return;
// Update and set the new transformation.
d_ptr->setTransformHelper(newTransform);
// Send post-notification.
itemChange(ItemTransformHasChanged, QVariant::fromValue<QTransform>(newTransform));
}
QT_WARNING_POP
#endif
/*!
\since 4.3
Sets the item's current transformation matrix to \a matrix.
If \a combine is true, then \a matrix is combined with the current matrix;
otherwise, \a matrix \e replaces the current matrix. \a combine is false
by default.
To simplify interaction with items using a transformed view, QGraphicsItem
provides mapTo... and mapFrom... functions that can translate between
items' and the scene's coordinates. For example, you can call mapToScene()
to map an item coordiate to a scene coordinate, or mapFromScene() to map
from scene coordinates to item coordinates.
The transformation matrix is combined with the item's rotation(), scale()
and transformations() into a combined transformation that maps the item's
coordinate system to its parent.
\sa transform(), setRotation(), setScale(), setTransformOriginPoint(), {The Graphics View Coordinate System}, {Transformations}
*/
void QGraphicsItem::setTransform(const QTransform &matrix, bool combine)
{
if (!d_ptr->transformData)
d_ptr->transformData = new QGraphicsItemPrivate::TransformData;
QTransform newTransform(combine ? matrix * d_ptr->transformData->transform : matrix);
if (d_ptr->transformData->transform == newTransform)
return;
// Update and set the new transformation.
if (!(d_ptr->flags & (ItemSendsGeometryChanges | ItemSendsScenePositionChanges))) {
d_ptr->setTransformHelper(newTransform);
if (d_ptr->scenePosDescendants)
d_ptr->sendScenePosChange();
return;
}
// Notify the item that the transformation matrix is changing.
const QVariant newTransformVariant(itemChange(ItemTransformChange,
QVariant::fromValue<QTransform>(newTransform)));
newTransform = qvariant_cast<QTransform>(newTransformVariant);
if (d_ptr->transformData->transform == newTransform)
return;
// Update and set the new transformation.
d_ptr->setTransformHelper(newTransform);
// Send post-notification.
itemChange(ItemTransformHasChanged, newTransformVariant);
d_ptr->sendScenePosChange();
}
#if QT_DEPRECATED_SINCE(5, 13)
/*!
\obsolete
Use resetTransform() instead.
*/
void QGraphicsItem::resetMatrix()
{
resetTransform();
}
#endif
/*!
\since 4.3
Resets this item's transformation matrix to the identity matrix or
all the transformation properties to their default values.
This is equivalent to calling \c setTransform(QTransform()).
\sa setTransform(), transform()
*/
void QGraphicsItem::resetTransform()
{
setTransform(QTransform(), false);
}
/*!
\fn void QGraphicsItem::rotate(qreal angle)
\obsolete
Use
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 20
instead.
Rotates the current item transformation \a angle degrees clockwise around
its origin. To translate around an arbitrary point (x, y), you need to
combine translation and rotation with setTransform().
Example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 6
\sa setTransform(), transform(), scale(), shear(), translate()
*/
/*!
\fn void QGraphicsItem::scale(qreal sx, qreal sy)
\obsolete
Use
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 21
instead.
Scales the current item transformation by (\a sx, \a sy) around its
origin. To scale from an arbitrary point (x, y), you need to combine
translation and scaling with setTransform().
Example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 7
\sa setTransform(), transform()
*/
/*!
\fn void QGraphicsItem::shear(qreal sh, qreal sv)
\obsolete
Use
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 22
instead.
Shears the current item transformation by (\a sh, \a sv).
\sa setTransform(), transform()
*/
/*!
\fn void QGraphicsItem::translate(qreal dx, qreal dy)
\obsolete
Use setPos() or setTransformOriginPoint() instead. For identical
behavior, use
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 23
Translates the current item transformation by (\a dx, \a dy).
If all you want is to move an item, you should call moveBy() or
setPos() instead; this function changes the item's translation,
which is conceptually separate from its position.
\sa setTransform(), transform()
*/
/*!
This virtual function is called twice for all items by the
QGraphicsScene::advance() slot. In the first phase, all items are called
with \a phase == 0, indicating that items on the scene are about to
advance, and then all items are called with \a phase == 1. Reimplement
this function to update your item if you need simple scene-controlled
animation.
The default implementation does nothing.
This function is intended for animations. An alternative is to
multiple-inherit from QObject and QGraphicsItem and use the \l{The Animation
Framework}{Animation Framework}.
\sa QGraphicsScene::advance(), QTimeLine
*/
void QGraphicsItem::advance(int phase)
{
Q_UNUSED(phase);
}
/*!
Returns the Z-value of the item. The Z-value affects the stacking order of
sibling (neighboring) items.
The default Z-value is 0.
\sa setZValue(), {QGraphicsItem#Sorting}{Sorting}, stackBefore(), ItemStacksBehindParent
*/
qreal QGraphicsItem::zValue() const
{
return d_ptr->z;
}
/*!
Sets the Z-value of the item to \a z. The Z value decides the stacking
order of sibling (neighboring) items. A sibling item of high Z value will
always be drawn on top of another sibling item with a lower Z value.
If you restore the Z value, the item's insertion order will decide its
stacking order.
The Z-value does not affect the item's size in any way.
The default Z-value is 0.
\sa zValue(), {QGraphicsItem#Sorting}{Sorting}, stackBefore(), ItemStacksBehindParent
*/
void QGraphicsItem::setZValue(qreal z)
{
const QVariant newZVariant(itemChange(ItemZValueChange, z));
qreal newZ = newZVariant.toReal();
if (newZ == d_ptr->z)
return;
if (d_ptr->scene && d_ptr->scene->d_func()->indexMethod != QGraphicsScene::NoIndex) {
// Z Value has changed, we have to notify the index.
d_ptr->scene->d_func()->index->itemChange(this, ItemZValueChange, &newZ);
}
d_ptr->z = newZ;
if (d_ptr->parent)
d_ptr->parent->d_ptr->needSortChildren = 1;
else if (d_ptr->scene)
d_ptr->scene->d_func()->needSortTopLevelItems = 1;
if (d_ptr->scene)
d_ptr->scene->d_func()->markDirty(this, QRectF(), /*invalidateChildren=*/true);
itemChange(ItemZValueHasChanged, newZVariant);
if (d_ptr->flags & ItemNegativeZStacksBehindParent)
setFlag(QGraphicsItem::ItemStacksBehindParent, z < qreal(0.0));
if (d_ptr->isObject)
emit static_cast<QGraphicsObject *>(this)->zChanged();
}
/*!
\internal
Ensures that the list of children is sorted by insertion order, and that
the siblingIndexes are packed (no gaps), and start at 0.
### This function is almost identical to
QGraphicsScenePrivate::ensureSequentialTopLevelSiblingIndexes().
*/
void QGraphicsItemPrivate::ensureSequentialSiblingIndex()
{
if (!sequentialOrdering) {
std::sort(children.begin(), children.end(), insertionOrder);
sequentialOrdering = 1;
needSortChildren = 1;
}
if (holesInSiblingIndex) {
holesInSiblingIndex = 0;
for (int i = 0; i < children.size(); ++i)
children[i]->d_ptr->siblingIndex = i;
}
}
/*!
\internal
*/
inline void QGraphicsItemPrivate::sendScenePosChange()
{
Q_Q(QGraphicsItem);
if (scene) {
if (flags & QGraphicsItem::ItemSendsScenePositionChanges)
q->itemChange(QGraphicsItem::ItemScenePositionHasChanged, q->scenePos());
if (scenePosDescendants) {
foreach (QGraphicsItem *item, scene->d_func()->scenePosItems) {
if (q->isAncestorOf(item))
item->itemChange(QGraphicsItem::ItemScenePositionHasChanged, item->scenePos());
}
}
}
}
/*!
\since 4.6
Stacks this item before \a sibling, which must be a sibling item (i.e., the
two items must share the same parent item, or must both be toplevel items).
The \a sibling must have the same Z value as this item, otherwise calling
this function will have no effect.
By default, all sibling items are stacked by insertion order (i.e., the
first item you add is drawn before the next item you add). If two items' Z
values are different, then the item with the highest Z value is drawn on
top. When the Z values are the same, the insertion order will decide the
stacking order.
\sa setZValue(), ItemStacksBehindParent, {QGraphicsItem#Sorting}{Sorting}
*/
void QGraphicsItem::stackBefore(const QGraphicsItem *sibling)
{
if (sibling == this)
return;
if (!sibling || d_ptr->parent != sibling->parentItem()) {
qWarning("QGraphicsItem::stackUnder: cannot stack under %p, which must be a sibling", sibling);
return;
}
QList<QGraphicsItem *> *siblings = d_ptr->parent
? &d_ptr->parent->d_ptr->children
: (d_ptr->scene ? &d_ptr->scene->d_func()->topLevelItems : nullptr);
if (!siblings) {
qWarning("QGraphicsItem::stackUnder: cannot stack under %p, which must be a sibling", sibling);
return;
}
// First, make sure that the sibling indexes have no holes. This also
// marks the children list for sorting.
if (d_ptr->parent)
d_ptr->parent->d_ptr->ensureSequentialSiblingIndex();
else
d_ptr->scene->d_func()->ensureSequentialTopLevelSiblingIndexes();
// Only move items with the same Z value, and that need moving.
int siblingIndex = sibling->d_ptr->siblingIndex;
int myIndex = d_ptr->siblingIndex;
if (myIndex >= siblingIndex) {
siblings->move(myIndex, siblingIndex);
// Fixup the insertion ordering.
for (int i = 0; i < siblings->size(); ++i) {
int &index = siblings->at(i)->d_ptr->siblingIndex;
if (i != siblingIndex && index >= siblingIndex && index <= myIndex)
++index;
}
d_ptr->siblingIndex = siblingIndex;
for (int i = 0; i < siblings->size(); ++i) {
int &index = siblings->at(i)->d_ptr->siblingIndex;
if (i != siblingIndex && index >= siblingIndex && index <= myIndex)
siblings->at(i)->d_ptr->siblingOrderChange();
}
d_ptr->siblingOrderChange();
}
}
/*!
Returns the bounding rect of this item's descendants (i.e., its
children, their children, etc.) in local coordinates. The
rectangle will contain all descendants after they have been mapped
to local coordinates. If the item has no children, this function
returns an empty QRectF.
This does not include this item's own bounding rect; it only returns
its descendants' accumulated bounding rect. If you need to include this
item's bounding rect, you can add boundingRect() to childrenBoundingRect()
using QRectF::operator|().
This function is linear in complexity; it determines the size of the
returned bounding rect by iterating through all descendants.
\sa boundingRect(), sceneBoundingRect()
*/
QRectF QGraphicsItem::childrenBoundingRect() const
{
if (!d_ptr->dirtyChildrenBoundingRect)
return d_ptr->childrenBoundingRect;
d_ptr->childrenBoundingRect = QRectF();
d_ptr->childrenBoundingRectHelper(nullptr, &d_ptr->childrenBoundingRect, nullptr);
d_ptr->dirtyChildrenBoundingRect = 0;
return d_ptr->childrenBoundingRect;
}
/*!
\fn virtual QRectF QGraphicsItem::boundingRect() const = 0
This pure virtual function defines the outer bounds of the item as
a rectangle; all painting must be restricted to inside an item's
bounding rect. QGraphicsView uses this to determine whether the
item requires redrawing.
Although the item's shape can be arbitrary, the bounding rect is
always rectangular, and it is unaffected by the items'
transformation.
If you want to change the item's bounding rectangle, you must first call
prepareGeometryChange(). This notifies the scene of the imminent change,
so that it can update its item geometry index; otherwise, the scene will
be unaware of the item's new geometry, and the results are undefined
(typically, rendering artifacts are left within the view).
Reimplement this function to let QGraphicsView determine what
parts of the widget, if any, need to be redrawn.
Note: For shapes that paint an outline / stroke, it is important
to include half the pen width in the bounding rect. It is not
necessary to compensate for antialiasing, though.
Example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 8
\sa boundingRegion(), shape(), contains(), {The Graphics View Coordinate
System}, prepareGeometryChange()
*/
/*!
Returns the bounding rect of this item in scene coordinates, by combining
sceneTransform() with boundingRect().
\sa boundingRect(), {The Graphics View Coordinate System}
*/
QRectF QGraphicsItem::sceneBoundingRect() const
{
// Find translate-only offset
// COMBINE
QPointF offset;
const QGraphicsItem *parentItem = this;
const QGraphicsItemPrivate *itemd;
do {
itemd = parentItem->d_ptr.data();
if (itemd->transformData)
break;
offset += itemd->pos;
} while ((parentItem = itemd->parent));
QRectF br = boundingRect();
br.translate(offset);
if (!parentItem)
return br;
if (parentItem->d_ptr->hasTranslateOnlySceneTransform()) {
br.translate(parentItem->d_ptr->sceneTransform.dx(), parentItem->d_ptr->sceneTransform.dy());
return br;
}
return parentItem->d_ptr->sceneTransform.mapRect(br);
}
/*!
Returns the shape of this item as a QPainterPath in local
coordinates. The shape is used for many things, including collision
detection, hit tests, and for the QGraphicsScene::items() functions.
The default implementation calls boundingRect() to return a simple
rectangular shape, but subclasses can reimplement this function to return
a more accurate shape for non-rectangular items. For example, a round item
may choose to return an elliptic shape for better collision detection. For
example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 9
The outline of a shape can vary depending on the width and style of the
pen used when drawing. If you want to include this outline in the item's
shape, you can create a shape from the stroke using QPainterPathStroker.
This function is called by the default implementations of contains() and
collidesWithPath().
\sa boundingRect(), contains(), prepareGeometryChange(), QPainterPathStroker
*/
QPainterPath QGraphicsItem::shape() const
{
QPainterPath path;
path.addRect(boundingRect());
return path;
}
/*!
Returns \c true if this item is clipped. An item is clipped if it has either
set the \l ItemClipsToShape flag, or if it or any of its ancestors has set
the \l ItemClipsChildrenToShape flag.
Clipping affects the item's appearance (i.e., painting), as well as mouse
and hover event delivery.
\sa clipPath(), shape(), setFlags()
*/
bool QGraphicsItem::isClipped() const
{
Q_D(const QGraphicsItem);
return (d->ancestorFlags & QGraphicsItemPrivate::AncestorClipsChildren)
|| (d->flags & QGraphicsItem::ItemClipsToShape);
}
/*!
\since 4.5
Returns this item's clip path, or an empty QPainterPath if this item is
not clipped. The clip path constrains the item's appearance and
interaction (i.e., restricts the area the item can draw within and receive
events for).
You can enable clipping by setting the ItemClipsToShape or
ItemClipsChildrenToShape flags. The item's clip path is calculated by
intersecting all clipping ancestors' shapes. If the item sets
ItemClipsToShape, the final clip is intersected with the item's own shape.
\note Clipping introduces a performance penalty for all items involved;
you should generally avoid using clipping if you can (e.g., if your items
always draw inside boundingRect() or shape() boundaries, clipping is not
necessary).
\sa isClipped(), shape(), setFlags()
*/
QPainterPath QGraphicsItem::clipPath() const
{
Q_D(const QGraphicsItem);
if (!isClipped())
return QPainterPath();
const QRectF thisBoundingRect(boundingRect());
if (thisBoundingRect.isEmpty())
return QPainterPath();
QPainterPath clip;
// Start with the item's bounding rect.
clip.addRect(thisBoundingRect);
if (d->ancestorFlags & QGraphicsItemPrivate::AncestorClipsChildren) {
const QGraphicsItem *parent = this;
const QGraphicsItem *lastParent = this;
// Intersect any in-between clips starting at the top and moving downwards.
while ((parent = parent->d_ptr->parent)) {
if (parent->d_ptr->flags & ItemClipsChildrenToShape) {
// Map clip to the current parent and intersect with its shape/clipPath
clip = lastParent->itemTransform(parent).map(clip);
clip = clip.intersected(parent->shape());
if (clip.isEmpty())
return clip;
lastParent = parent;
}
if (!(parent->d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorClipsChildren))
break;
}
if (lastParent != this) {
// Map clip back to the item's transform.
// ### what if itemtransform fails
clip = lastParent->itemTransform(this).map(clip);
}
}
if (d->flags & ItemClipsToShape)
clip = clip.intersected(shape());
return clip;
}
/*!
Returns \c true if this item contains \a point, which is in local
coordinates; otherwise, false is returned. It is most often called from
QGraphicsView to determine what item is under the cursor, and for that
reason, the implementation of this function should be as light-weight as
possible.
By default, this function calls shape(), but you can reimplement it in a
subclass to provide a (perhaps more efficient) implementation.
\sa shape(), boundingRect(), collidesWithPath()
*/
bool QGraphicsItem::contains(const QPointF &point) const
{
return isClipped() ? clipPath().contains(point) : shape().contains(point);
}
/*!
Returns \c true if this item collides with \a other; otherwise
returns \c false.
The \a mode is applied to \a other, and the resulting shape or
bounding rectangle is then compared to this item's shape. The
default value for \a mode is Qt::IntersectsItemShape; \a other
collides with this item if it either intersects, contains, or is
contained by this item's shape (see Qt::ItemSelectionMode for
details).
The default implementation is based on shape intersection, and it calls
shape() on both items. Because the complexity of arbitrary shape-shape
intersection grows with an order of magnitude when the shapes are complex,
this operation can be noticably time consuming. You have the option of
reimplementing this function in a subclass of QGraphicsItem to provide a
custom algorithm. This allows you to make use of natural constraints in
the shapes of your own items, in order to improve the performance of the
collision detection. For instance, two untransformed perfectly circular
items' collision can be determined very efficiently by comparing their
positions and radii.
Keep in mind that when reimplementing this function and calling shape() or
boundingRect() on \a other, the returned coordinates must be mapped to
this item's coordinate system before any intersection can take place.
\sa contains(), shape()
*/
bool QGraphicsItem::collidesWithItem(const QGraphicsItem *other, Qt::ItemSelectionMode mode) const
{
if (other == this)
return true;
if (!other)
return false;
// The items share the same clip if their closest clipper is the same, or
// if one clips the other.
bool clips = (d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorClipsChildren);
bool otherClips = (other->d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorClipsChildren);
if (clips || otherClips) {
const QGraphicsItem *closestClipper = isAncestorOf(other) ? this : parentItem();
while (closestClipper && !(closestClipper->flags() & ItemClipsChildrenToShape))
closestClipper = closestClipper->parentItem();
const QGraphicsItem *otherClosestClipper = other->isAncestorOf(this) ? other : other->parentItem();
while (otherClosestClipper && !(otherClosestClipper->flags() & ItemClipsChildrenToShape))
otherClosestClipper = otherClosestClipper->parentItem();
if (closestClipper == otherClosestClipper) {
d_ptr->localCollisionHack = 1;
bool res = collidesWithPath(mapFromItem(other, other->shape()), mode);
d_ptr->localCollisionHack = 0;
return res;
}
}
QPainterPath otherShape = other->isClipped() ? other->clipPath() : other->shape();
return collidesWithPath(mapFromItem(other, otherShape), mode);
}
/*!
Returns \c true if this item collides with \a path.
The collision is determined by \a mode. The default value for \a mode is
Qt::IntersectsItemShape; \a path collides with this item if it either
intersects, contains, or is contained by this item's shape.
Note that this function checks whether the item's shape or
bounding rectangle (depending on \a mode) is contained within \a
path, and not whether \a path is contained within the items shape
or bounding rectangle.
\sa collidesWithItem(), contains(), shape()
*/
bool QGraphicsItem::collidesWithPath(const QPainterPath &path, Qt::ItemSelectionMode mode) const
{
if (path.isEmpty()) {
// No collision with empty paths.
return false;
}
QRectF rectA(boundingRect());
_q_adjustRect(&rectA);
QRectF rectB(path.controlPointRect());
_q_adjustRect(&rectB);
if (!rectA.intersects(rectB)) {
// This we can determine efficiently. If the two rects neither
// intersect nor contain eachother, then the two items do not collide.
return false;
}
// For further testing, we need this item's shape or bounding rect.
QPainterPath thisShape;
if (mode == Qt::IntersectsItemShape || mode == Qt::ContainsItemShape)
thisShape = (isClipped() && !d_ptr->localCollisionHack) ? clipPath() : shape();
else
thisShape.addRect(rectA);
if (thisShape == QPainterPath()) {
// Empty shape? No collision.
return false;
}
// Use QPainterPath boolean operations to determine the collision, O(N*logN).
if (mode == Qt::IntersectsItemShape || mode == Qt::IntersectsItemBoundingRect)
return path.intersects(thisShape);
return path.contains(thisShape);
}
/*!
Returns a list of all items that collide with this item.
The way collisions are detected is determined by applying \a mode
to items that are compared to this item, i.e., each item's shape
or bounding rectangle is checked against this item's shape. The
default value for \a mode is Qt::IntersectsItemShape.
\sa collidesWithItem()
*/
QList<QGraphicsItem *> QGraphicsItem::collidingItems(Qt::ItemSelectionMode mode) const
{
if (d_ptr->scene)
return d_ptr->scene->collidingItems(this, mode);
return QList<QGraphicsItem *>();
}
/*!
\internal
Item obscurity helper function.
Returns \c true if the subrect \a rect of \a item's bounding rect is obscured
by \a other (i.e., \a other's opaque area covers \a item's \a rect
completely. \a other is assumed to already be "on top of" \a item
wrt. stacking order.
*/
static bool qt_QGraphicsItem_isObscured(const QGraphicsItem *item,
const QGraphicsItem *other,
const QRectF &rect)
{
return other->mapToItem(item, other->opaqueArea()).contains(rect);
}
/*!
\overload
\since 4.3
Returns \c true if \a rect is completely obscured by the opaque shape of any
of colliding items above it (i.e., with a higher Z value than this item).
\sa opaqueArea()
*/
bool QGraphicsItem::isObscured(const QRectF &rect) const
{
Q_D(const QGraphicsItem);
if (!d->scene)
return false;
QRectF br = boundingRect();
QRectF testRect = rect.isNull() ? br : rect;
const auto items = d->scene->items(mapToScene(br), Qt::IntersectsItemBoundingRect);
for (QGraphicsItem *item : items) {
if (item == this)
break;
if (qt_QGraphicsItem_isObscured(this, item, testRect))
return true;
}
return false;
}
/*!
\fn bool QGraphicsItem::isObscured(qreal x, qreal y, qreal w, qreal h) const
\overload
\since 4.3
This convenience function is equivalent to calling isObscured(QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
Returns \c true if this item's bounding rect is completely obscured by the
opaque shape of \a item.
The base implementation maps \a item's opaqueArea() to this item's
coordinate system, and then checks if this item's boundingRect() is fully
contained within the mapped shape.
You can reimplement this function to provide a custom algorithm for
determining whether this item is obscured by \a item.
\sa opaqueArea(), isObscured()
*/
bool QGraphicsItem::isObscuredBy(const QGraphicsItem *item) const
{
if (!item)
return false;
return qt_closestItemFirst(item, this)
&& qt_QGraphicsItem_isObscured(this, item, boundingRect());
}
/*!
This virtual function returns a shape representing the area where this
item is opaque. An area is opaque if it is filled using an opaque brush or
color (i.e., not transparent).
This function is used by isObscuredBy(), which is called by underlying
items to determine if they are obscured by this item.
The default implementation returns an empty QPainterPath, indicating that
this item is completely transparent and does not obscure any other items.
\sa isObscuredBy(), isObscured(), shape()
*/
QPainterPath QGraphicsItem::opaqueArea() const
{
return QPainterPath();
}
/*!
\since 4.4
Returns the bounding region for this item. The coordinate space of the
returned region depends on \a itemToDeviceTransform. If you pass an
identity QTransform as a parameter, this function will return a local
coordinate region.
The bounding region describes a coarse outline of the item's visual
contents. Although it's expensive to calculate, it's also more precise
than boundingRect(), and it can help to avoid unnecessary repainting when
an item is updated. This is particularly efficient for thin items (e.g.,
lines or simple polygons). You can tune the granularity for the bounding
region by calling setBoundingRegionGranularity(). The default granularity
is 0; in which the item's bounding region is the same as its bounding
rect.
\a itemToDeviceTransform is the transformation from item coordinates to
device coordinates. If you want this function to return a QRegion in scene
coordinates, you can pass sceneTransform() as an argument.
\sa boundingRegionGranularity()
*/
QRegion QGraphicsItem::boundingRegion(const QTransform &itemToDeviceTransform) const
{
// ### Ideally we would have a better way to generate this region,
// preferably something in the lines of QPainterPath::toRegion(QTransform)
// coupled with a way to generate a painter path from a set of painter
// operations (e.g., QPicture::toPainterPath() or so). The current
// approach generates a bitmap with the size of the item's bounding rect
// in device coordinates, scaled by b.r.granularity, then paints the item
// into the bitmap, converts the result to a QRegion and scales the region
// back to device space with inverse granularity.
qreal granularity = boundingRegionGranularity();
QRect deviceRect = itemToDeviceTransform.mapRect(boundingRect()).toRect();
_q_adjustRect(&deviceRect);
if (granularity == 0.0)
return QRegion(deviceRect);
int pad = 1;
QSize bitmapSize(qMax(1, int(deviceRect.width() * granularity) + pad * 2),
qMax(1, int(deviceRect.height() * granularity) + pad * 2));
QImage mask(bitmapSize, QImage::Format_ARGB32_Premultiplied);
mask.fill(0);
QPainter p(&mask);
p.setRenderHints(QPainter::Antialiasing);
// Transform painter (### this code is from QGraphicsScene::drawItemHelper
// and doesn't work properly with perspective transformations).
QPointF viewOrigo = itemToDeviceTransform.map(QPointF(0, 0));
QPointF offset = viewOrigo - deviceRect.topLeft();
p.scale(granularity, granularity);
p.translate(offset);
p.translate(pad, pad);
p.setWorldTransform(itemToDeviceTransform, true);
p.translate(itemToDeviceTransform.inverted().map(QPointF(0, 0)));
// Render
QStyleOptionGraphicsItem option;
const_cast<QGraphicsItem *>(this)->paint(&p, &option, nullptr);
p.end();
// Transform QRegion back to device space
QTransform unscale = QTransform::fromScale(1 / granularity, 1 / granularity);
QRegion r;
QBitmap colorMask = QBitmap::fromImage(mask.createMaskFromColor(0));
for (const QRect &rect : QRegion(colorMask)) {
QRect xrect = unscale.mapRect(rect).translated(deviceRect.topLeft() - QPoint(pad, pad));
r += xrect.adjusted(-1, -1, 1, 1) & deviceRect;
}
return r;
}
/*!
\since 4.4
Returns the item's bounding region granularity; a value between and
including 0 and 1. The default value is 0 (i.e., the lowest granularity,
where the bounding region corresponds to the item's bounding rectangle).
\omit
### NOTE
\endomit
\sa setBoundingRegionGranularity()
*/
qreal QGraphicsItem::boundingRegionGranularity() const
{
return d_ptr->hasBoundingRegionGranularity
? qvariant_cast<qreal>(d_ptr->extra(QGraphicsItemPrivate::ExtraBoundingRegionGranularity))
: 0;
}
/*!
\since 4.4
Sets the bounding region granularity to \a granularity; a value between
and including 0 and 1. The default value is 0 (i.e., the lowest
granularity, where the bounding region corresponds to the item's bounding
rectangle).
The granularity is used by boundingRegion() to calculate how fine the
bounding region of the item should be. The highest achievable granularity
is 1, where boundingRegion() will return the finest outline possible for
the respective device (e.g., for a QGraphicsView viewport, this gives you
a pixel-perfect bounding region). The lowest possible granularity is
0. The value of \a granularity describes the ratio between device
resolution and the resolution of the bounding region (e.g., a value of
0.25 will provide a region where each chunk corresponds to 4x4 device
units / pixels).
\sa boundingRegionGranularity()
*/
void QGraphicsItem::setBoundingRegionGranularity(qreal granularity)
{
if (granularity < 0.0 || granularity > 1.0) {
qWarning("QGraphicsItem::setBoundingRegionGranularity: invalid granularity %g", granularity);
return;
}
if (granularity == 0.0) {
d_ptr->unsetExtra(QGraphicsItemPrivate::ExtraBoundingRegionGranularity);
d_ptr->hasBoundingRegionGranularity = 0;
return;
}
d_ptr->hasBoundingRegionGranularity = 1;
d_ptr->setExtra(QGraphicsItemPrivate::ExtraBoundingRegionGranularity,
QVariant::fromValue<qreal>(granularity));
}
/*!
\fn virtual void QGraphicsItem::paint(QPainter *painter, const
QStyleOptionGraphicsItem *option, QWidget *widget = 0) = 0
This function, which is usually called by QGraphicsView, paints the
contents of an item in local coordinates.
Reimplement this function in a QGraphicsItem subclass to provide the
item's painting implementation, using \a painter. The \a option parameter
provides style options for the item, such as its state, exposed area and
its level-of-detail hints. The \a widget argument is optional. If
provided, it points to the widget that is being painted on; otherwise, it
is 0. For cached painting, \a widget is always 0.
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 10
The painter's pen is 0-width by default, and its pen is initialized to the
QPalette::Text brush from the paint device's palette. The brush is
initialized to QPalette::Window.
Make sure to constrain all painting inside the boundaries of
boundingRect() to avoid rendering artifacts (as QGraphicsView does not
clip the painter for you). In particular, when QPainter renders the
outline of a shape using an assigned QPen, half of the outline will be
drawn outside, and half inside, the shape you're rendering (e.g., with a
pen width of 2 units, you must draw outlines 1 unit inside
boundingRect()). QGraphicsItem does not support use of cosmetic pens with
a non-zero width.
All painting is done in local coordinates.
\note It is mandatory that an item will always redraw itself in the exact
same way, unless update() was called; otherwise visual artifacts may
occur. In other words, two subsequent calls to paint() must always produce
the same output, unless update() was called between them.
\note Enabling caching for an item does not guarantee that paint()
will be invoked only once by the Graphics View framework,
even without any explicit call to update(). See the documentation of
setCacheMode() for more details.
\sa setCacheMode(), QPen::width(), {Item Coordinates}, ItemUsesExtendedStyleOption
*/
/*!
\internal
Returns \c true if we can discard an update request; otherwise false.
*/
bool QGraphicsItemPrivate::discardUpdateRequest(bool ignoreVisibleBit, bool ignoreDirtyBit,
bool ignoreOpacity) const
{
// No scene, or if the scene is updating everything, means we have nothing
// to do. The only exception is if the scene tracks the growing scene rect.
return !scene
|| (!visible && !ignoreVisibleBit && !this->ignoreVisible)
|| (!ignoreDirtyBit && fullUpdatePending)
|| (!ignoreOpacity && !this->ignoreOpacity && childrenCombineOpacity() && isFullyTransparent());
}
/*!
\internal
*/
int QGraphicsItemPrivate::depth() const
{
if (itemDepth == -1)
const_cast<QGraphicsItemPrivate *>(this)->resolveDepth();
return itemDepth;
}
/*!
\internal
*/
#if QT_CONFIG(graphicseffect)
void QGraphicsItemPrivate::invalidateParentGraphicsEffectsRecursively()
{
QGraphicsItemPrivate *itemPrivate = this;
do {
if (itemPrivate->graphicsEffect) {
itemPrivate->notifyInvalidated = 1;
if (!itemPrivate->updateDueToGraphicsEffect)
static_cast<QGraphicsItemEffectSourcePrivate *>(itemPrivate->graphicsEffect->d_func()->source->d_func())->invalidateCache();
}
} while ((itemPrivate = itemPrivate->parent ? itemPrivate->parent->d_ptr.data() : nullptr));
}
void QGraphicsItemPrivate::invalidateChildGraphicsEffectsRecursively(QGraphicsItemPrivate::InvalidateReason reason)
{
if (!mayHaveChildWithGraphicsEffect)
return;
for (int i = 0; i < children.size(); ++i) {
QGraphicsItemPrivate *childPrivate = children.at(i)->d_ptr.data();
if (reason == OpacityChanged && (childPrivate->flags & QGraphicsItem::ItemIgnoresParentOpacity))
continue;
if (childPrivate->graphicsEffect) {
childPrivate->notifyInvalidated = 1;
static_cast<QGraphicsItemEffectSourcePrivate *>(childPrivate->graphicsEffect->d_func()->source->d_func())->invalidateCache();
}
childPrivate->invalidateChildGraphicsEffectsRecursively(reason);
}
}
#endif // QT_CONFIG(graphicseffect)
/*!
\internal
*/
void QGraphicsItemPrivate::invalidateDepthRecursively()
{
if (itemDepth == -1)
return;
itemDepth = -1;
for (int i = 0; i < children.size(); ++i)
children.at(i)->d_ptr->invalidateDepthRecursively();
}
/*!
\internal
Resolves the stacking depth of this object and all its ancestors.
*/
void QGraphicsItemPrivate::resolveDepth()
{
if (!parent)
itemDepth = 0;
else {
if (parent->d_ptr->itemDepth == -1)
parent->d_ptr->resolveDepth();
itemDepth = parent->d_ptr->itemDepth + 1;
}
}
/*!
\internal
### This function is almost identical to
QGraphicsScenePrivate::registerTopLevelItem().
*/
void QGraphicsItemPrivate::addChild(QGraphicsItem *child)
{
// Remove all holes from the sibling index list. Now the max index
// number is equal to the size of the children list.
ensureSequentialSiblingIndex();
needSortChildren = 1; // ### maybe 0
child->d_ptr->siblingIndex = children.size();
children.append(child);
if (isObject)
emit static_cast<QGraphicsObject *>(q_ptr)->childrenChanged();
}
/*!
\internal
### This function is almost identical to
QGraphicsScenePrivate::unregisterTopLevelItem().
*/
void QGraphicsItemPrivate::removeChild(QGraphicsItem *child)
{
// When removing elements in the middle of the children list,
// there will be a "gap" in the list of sibling indexes (0,1,3,4).
if (!holesInSiblingIndex)
holesInSiblingIndex = child->d_ptr->siblingIndex != children.size() - 1;
if (sequentialOrdering && !holesInSiblingIndex)
children.removeAt(child->d_ptr->siblingIndex);
else
children.removeOne(child);
// NB! Do not use children.removeAt(child->d_ptr->siblingIndex) because
// the child is not guaranteed to be at the index after the list is sorted.
// (see ensureSortedChildren()).
child->d_ptr->siblingIndex = -1;
if (isObject)
emit static_cast<QGraphicsObject *>(q_ptr)->childrenChanged();
}
/*!
\internal
*/
QGraphicsItemCache *QGraphicsItemPrivate::maybeExtraItemCache() const
{
return (QGraphicsItemCache *)qvariant_cast<void *>(extra(ExtraCacheData));
}
/*!
\internal
*/
QGraphicsItemCache *QGraphicsItemPrivate::extraItemCache() const
{
QGraphicsItemCache *c = (QGraphicsItemCache *)qvariant_cast<void *>(extra(ExtraCacheData));
if (!c) {
QGraphicsItemPrivate *that = const_cast<QGraphicsItemPrivate *>(this);
c = new QGraphicsItemCache;
that->setExtra(ExtraCacheData, QVariant::fromValue<void *>(c));
}
return c;
}
/*!
\internal
*/
void QGraphicsItemPrivate::removeExtraItemCache()
{
QGraphicsItemCache *c = (QGraphicsItemCache *)qvariant_cast<void *>(extra(ExtraCacheData));
if (c) {
c->purge();
delete c;
}
unsetExtra(ExtraCacheData);
}
void QGraphicsItemPrivate::updatePaintedViewBoundingRects(bool updateChildren)
{
if (!scene)
return;
for (int i = 0; i < scene->d_func()->views.size(); ++i) {
QGraphicsViewPrivate *viewPrivate = scene->d_func()->views.at(i)->d_func();
QRect rect = paintedViewBoundingRects.value(viewPrivate->viewport);
rect.translate(viewPrivate->dirtyScrollOffset);
viewPrivate->updateRect(rect);
}
if (updateChildren) {
for (int i = 0; i < children.size(); ++i)
children.at(i)->d_ptr->updatePaintedViewBoundingRects(true);
}
}
// Traverses all the ancestors up to the top-level and updates the pointer to
// always point to the top-most item that has a dirty scene transform.
// It then backtracks to the top-most dirty item and start calculating the
// scene transform by combining the item's transform (+pos) with the parent's
// cached scene transform (which we at this point know for sure is valid).
void QGraphicsItemPrivate::ensureSceneTransformRecursive(QGraphicsItem **topMostDirtyItem)
{
Q_ASSERT(topMostDirtyItem);
if (dirtySceneTransform)
*topMostDirtyItem = q_ptr;
if (parent)
parent->d_ptr->ensureSceneTransformRecursive(topMostDirtyItem);
if (*topMostDirtyItem == q_ptr) {
if (!dirtySceneTransform)
return; // OK, neither my ancestors nor I have dirty scene transforms.
*topMostDirtyItem = nullptr;
} else if (*topMostDirtyItem) {
return; // Continue backtrack.
}
// This item and all its descendants have dirty scene transforms.
// We're about to validate this item's scene transform, so we have to
// invalidate all the children; otherwise there's no way for the descendants
// to detect that the ancestor has changed.
invalidateChildrenSceneTransform();
// COMBINE my transform with the parent's scene transform.
updateSceneTransformFromParent();
Q_ASSERT(!dirtySceneTransform);
}
/*!
\internal
*/
void QGraphicsItemPrivate::setSubFocus(QGraphicsItem *rootItem, QGraphicsItem *stopItem)
{
// Update focus child chain. Stop at panels, or if this item
// is hidden, stop at the first item with a visible parent.
QGraphicsItem *parent = rootItem ? rootItem : q_ptr;
if (parent->panel() != q_ptr->panel())
return;
do {
// Clear any existing ancestor's subFocusItem.
if (parent != q_ptr && parent->d_ptr->subFocusItem) {
if (parent->d_ptr->subFocusItem == q_ptr)
break;
parent->d_ptr->subFocusItem->d_ptr->clearSubFocus(nullptr, stopItem);
}
parent->d_ptr->subFocusItem = q_ptr;
parent->d_ptr->subFocusItemChange();
} while (!parent->isPanel() && (parent = parent->d_ptr->parent) && (visible || !parent->d_ptr->visible));
if (scene && !scene->isActive()) {
scene->d_func()->passiveFocusItem = subFocusItem;
scene->d_func()->lastFocusItem = subFocusItem;
}
}
/*!
\internal
*/
void QGraphicsItemPrivate::clearSubFocus(QGraphicsItem *rootItem, QGraphicsItem *stopItem)
{
// Reset sub focus chain.
QGraphicsItem *parent = rootItem ? rootItem : q_ptr;
do {
if (parent->d_ptr->subFocusItem != q_ptr)
break;
parent->d_ptr->subFocusItem = nullptr;
if (parent != stopItem && !parent->isAncestorOf(stopItem))
parent->d_ptr->subFocusItemChange();
} while (!parent->isPanel() && (parent = parent->d_ptr->parent));
}
/*!
\internal
Sets the focusProxy pointer to \nullptr for all items that have this item as their
focusProxy.
*/
void QGraphicsItemPrivate::resetFocusProxy()
{
for (int i = 0; i < focusProxyRefs.size(); ++i)
*focusProxyRefs.at(i) = nullptr;
focusProxyRefs.clear();
}
/*!
\internal
Subclasses can reimplement this function to be notified when subFocusItem
changes.
*/
void QGraphicsItemPrivate::subFocusItemChange()
{
}
/*!
\internal
Subclasses can reimplement this function to be notified when an item
becomes a focusScopeItem (or is no longer a focusScopeItem).
*/
void QGraphicsItemPrivate::focusScopeItemChange(bool isSubFocusItem)
{
Q_UNUSED(isSubFocusItem);
}
/*!
\internal
Subclasses can reimplement this function to be notified when its
siblingIndex order is changed.
*/
void QGraphicsItemPrivate::siblingOrderChange()
{
}
/*!
\internal
Tells us if it is a proxy widget
*/
bool QGraphicsItemPrivate::isProxyWidget() const
{
return false;
}
/*!
Schedules a redraw of the area covered by \a rect in this item. You can
call this function whenever your item needs to be redrawn, such as if it
changes appearance or size.
This function does not cause an immediate paint; instead it schedules a
paint request that is processed by QGraphicsView after control reaches the
event loop. The item will only be redrawn if it is visible in any
associated view.
As a side effect of the item being repainted, other items that overlap the
area \a rect may also be repainted.
If the item is invisible (i.e., isVisible() returns \c false), this function
does nothing.
\sa paint(), boundingRect()
*/
void QGraphicsItem::update(const QRectF &rect)
{
if (rect.isEmpty() && !rect.isNull())
return;
// Make sure we notify effects about invalidated source.
#if QT_CONFIG(graphicseffect)
d_ptr->invalidateParentGraphicsEffectsRecursively();
#endif // QT_CONFIG(graphicseffect)
if (CacheMode(d_ptr->cacheMode) != NoCache) {
// Invalidate cache.
QGraphicsItemCache *cache = d_ptr->extraItemCache();
if (!cache->allExposed) {
if (rect.isNull()) {
cache->allExposed = true;
cache->exposed.clear();
} else {
cache->exposed.append(rect);
}
}
// Only invalidate cache; item is already dirty.
if (d_ptr->fullUpdatePending)
return;
}
if (d_ptr->scene)
d_ptr->scene->d_func()->markDirty(this, rect);
}
/*!
\since 4.4
Scrolls the contents of \a rect by \a dx, \a dy. If \a rect is a null rect
(the default), the item's bounding rect is scrolled.
Scrolling provides a fast alternative to simply redrawing when the
contents of the item (or parts of the item) are shifted vertically or
horizontally. Depending on the current transformation and the capabilities
of the paint device (i.e., the viewport), this operation may consist of
simply moving pixels from one location to another using memmove(). In most
cases this is faster than rerendering the entire area.
After scrolling, the item will issue an update for the newly exposed
areas. If scrolling is not supported (e.g., you are rendering to an OpenGL
viewport, which does not benefit from scroll optimizations), this function
is equivalent to calling update(\a rect).
\b{Note:} Scrolling is only supported when QGraphicsItem::ItemCoordinateCache
is enabled; in all other cases calling this function is equivalent to calling
update(\a rect). If you for sure know that the item is opaque and not overlapped
by other items, you can map the \a rect to viewport coordinates and scroll the
viewport.
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 19
\sa boundingRect()
*/
void QGraphicsItem::scroll(qreal dx, qreal dy, const QRectF &rect)
{
Q_D(QGraphicsItem);
if (dx == 0.0 && dy == 0.0)
return;
if (!d->scene)
return;
// Accelerated scrolling means moving pixels from one location to another
// and only redraw the newly exposed area. The following requirements must
// be fulfilled in order to do that:
//
// 1) Item is opaque.
// 2) Item is not overlapped by other items.
//
// There's (yet) no way to detect whether an item is opaque or not, which means
// we cannot do accelerated scrolling unless the cache is enabled. In case of using
// DeviceCoordinate cache we also have to take the device transform into account in
// order to determine whether we can do accelerated scrolling or not. That's left out
// for simplicity here, but it is definitely something we can consider in the future
// as a performance improvement.
if (d->cacheMode != QGraphicsItem::ItemCoordinateCache
|| !qFuzzyIsNull(dx - int(dx)) || !qFuzzyIsNull(dy - int(dy))) {
update(rect);
return;
}
QGraphicsItemCache *cache = d->extraItemCache();
if (cache->allExposed || cache->fixedSize.isValid()) {
// Cache is either invalidated or item is scaled (see QGraphicsItem::setCacheMode).
update(rect);
return;
}
// Find pixmap in cache.
QPixmap cachedPixmap;
if (!QPixmapCache::find(cache->key, &cachedPixmap)) {
update(rect);
return;
}
QRect scrollRect = (rect.isNull() ? boundingRect() : rect).toAlignedRect();
if (!scrollRect.intersects(cache->boundingRect))
return; // Nothing to scroll.
// Remove from cache to avoid deep copy when modifying.
QPixmapCache::remove(cache->key);
QRegion exposed;
cachedPixmap.scroll(dx, dy, scrollRect.translated(-cache->boundingRect.topLeft()), &exposed);
// Reinsert into cache.
cache->key = QPixmapCache::insert(cachedPixmap);
// Translate the existing expose.
for (int i = 0; i < cache->exposed.size(); ++i) {
QRectF &e = cache->exposed[i];
if (!rect.isNull() && !e.intersects(rect))
continue;
e.translate(dx, dy);
}
// Append newly exposed areas. Note that the exposed region is currently
// in pixmap coordinates, so we have to translate it to item coordinates.
exposed.translate(cache->boundingRect.topLeft());
for (const QRect &exposedRect : exposed)
cache->exposed += exposedRect;
// Trigger update. This will redraw the newly exposed area and make sure
// the pixmap is re-blitted in case there are overlapping items.
d->scene->d_func()->markDirty(this, rect);
}
/*!
\fn void QGraphicsItem::update(qreal x, qreal y, qreal width, qreal height)
\overload
This convenience function is equivalent to calling update(QRectF(\a x, \a
y, \a width, \a height)).
*/
/*!
Maps the point \a point, which is in this item's coordinate system, to \a
item's coordinate system, and returns the mapped coordinate.
If \a item is \nullptr, this function returns the same as mapToScene().
\sa itemTransform(), mapToParent(), mapToScene(), transform(), mapFromItem(), {The Graphics
View Coordinate System}
*/
QPointF QGraphicsItem::mapToItem(const QGraphicsItem *item, const QPointF &point) const
{
if (item)
return itemTransform(item).map(point);
return mapToScene(point);
}
/*!
\fn QPointF QGraphicsItem::mapToItem(const QGraphicsItem *item, qreal x, qreal y) const
\overload
This convenience function is equivalent to calling mapToItem(\a item,
QPointF(\a x, \a y)).
*/
/*!
Maps the point \a point, which is in this item's coordinate system, to its
parent's coordinate system, and returns the mapped coordinate. If the item
has no parent, \a point will be mapped to the scene's coordinate system.
\sa mapToItem(), mapToScene(), transform(), mapFromParent(), {The Graphics
View Coordinate System}
*/
QPointF QGraphicsItem::mapToParent(const QPointF &point) const
{
// COMBINE
if (!d_ptr->transformData)
return point + d_ptr->pos;
return d_ptr->transformToParent().map(point);
}
/*!
\fn QPointF QGraphicsItem::mapToParent(qreal x, qreal y) const
\overload
This convenience function is equivalent to calling mapToParent(QPointF(\a
x, \a y)).
*/
/*!
Maps the point \a point, which is in this item's coordinate system, to the
scene's coordinate system, and returns the mapped coordinate.
\sa mapToItem(), mapToParent(), transform(), mapFromScene(), {The Graphics
View Coordinate System}
*/
QPointF QGraphicsItem::mapToScene(const QPointF &point) const
{
if (d_ptr->hasTranslateOnlySceneTransform())
return QPointF(point.x() + d_ptr->sceneTransform.dx(), point.y() + d_ptr->sceneTransform.dy());
return d_ptr->sceneTransform.map(point);
}
/*!
\fn QPointF QGraphicsItem::mapToScene(qreal x, qreal y) const
\overload
This convenience function is equivalent to calling mapToScene(QPointF(\a
x, \a y)).
*/
/*!
Maps the rectangle \a rect, which is in this item's coordinate system, to
\a item's coordinate system, and returns the mapped rectangle as a polygon.
If \a item is \nullptr, this function returns the same as mapToScene().
\sa itemTransform(), mapToParent(), mapToScene(), mapFromItem(), {The
Graphics View Coordinate System}
*/
QPolygonF QGraphicsItem::mapToItem(const QGraphicsItem *item, const QRectF &rect) const
{
if (item)
return itemTransform(item).map(rect);
return mapToScene(rect);
}
/*!
\fn QPolygonF QGraphicsItem::mapToItem(const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const
\since 4.3
This convenience function is equivalent to calling mapToItem(item, QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
Maps the rectangle \a rect, which is in this item's coordinate system, to
its parent's coordinate system, and returns the mapped rectangle as a
polygon. If the item has no parent, \a rect will be mapped to the scene's
coordinate system.
\sa mapToScene(), mapToItem(), mapFromParent(), {The Graphics View
Coordinate System}
*/
QPolygonF QGraphicsItem::mapToParent(const QRectF &rect) const
{
// COMBINE
if (!d_ptr->transformData)
return rect.translated(d_ptr->pos);
return d_ptr->transformToParent().map(rect);
}
/*!
\fn QPolygonF QGraphicsItem::mapToParent(qreal x, qreal y, qreal w, qreal h) const
\since 4.3
This convenience function is equivalent to calling mapToParent(QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
Maps the rectangle \a rect, which is in this item's coordinate system, to
the scene's coordinate system, and returns the mapped rectangle as a polygon.
\sa mapToParent(), mapToItem(), mapFromScene(), {The Graphics View
Coordinate System}
*/
QPolygonF QGraphicsItem::mapToScene(const QRectF &rect) const
{
if (d_ptr->hasTranslateOnlySceneTransform())
return rect.translated(d_ptr->sceneTransform.dx(), d_ptr->sceneTransform.dy());
return d_ptr->sceneTransform.map(rect);
}
/*!
\fn QPolygonF QGraphicsItem::mapToScene(qreal x, qreal y, qreal w, qreal h) const
\since 4.3
This convenience function is equivalent to calling mapToScene(QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
\since 4.5
Maps the rectangle \a rect, which is in this item's coordinate system, to
\a item's coordinate system, and returns the mapped rectangle as a new
rectangle (i.e., the bounding rectangle of the resulting polygon).
If \a item is \nullptr, this function returns the same as mapRectToScene().
\sa itemTransform(), mapToParent(), mapToScene(), mapFromItem(), {The
Graphics View Coordinate System}
*/
QRectF QGraphicsItem::mapRectToItem(const QGraphicsItem *item, const QRectF &rect) const
{
if (item)
return itemTransform(item).mapRect(rect);
return mapRectToScene(rect);
}
/*!
\fn QRectF QGraphicsItem::mapRectToItem(const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const
\since 4.5
This convenience function is equivalent to calling mapRectToItem(item, QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
\since 4.5
Maps the rectangle \a rect, which is in this item's coordinate system, to
its parent's coordinate system, and returns the mapped rectangle as a new
rectangle (i.e., the bounding rectangle of the resulting polygon).
\sa itemTransform(), mapToParent(), mapToScene(), mapFromItem(), {The
Graphics View Coordinate System}
*/
QRectF QGraphicsItem::mapRectToParent(const QRectF &rect) const
{
// COMBINE
if (!d_ptr->transformData)
return rect.translated(d_ptr->pos);
return d_ptr->transformToParent().mapRect(rect);
}
/*!
\fn QRectF QGraphicsItem::mapRectToParent(qreal x, qreal y, qreal w, qreal h) const
\since 4.5
This convenience function is equivalent to calling mapRectToParent(QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
\since 4.5
Maps the rectangle \a rect, which is in this item's coordinate system, to
the scene coordinate system, and returns the mapped rectangle as a new
rectangle (i.e., the bounding rectangle of the resulting polygon).
\sa itemTransform(), mapToParent(), mapToScene(), mapFromItem(), {The
Graphics View Coordinate System}
*/
QRectF QGraphicsItem::mapRectToScene(const QRectF &rect) const
{
if (d_ptr->hasTranslateOnlySceneTransform())
return rect.translated(d_ptr->sceneTransform.dx(), d_ptr->sceneTransform.dy());
return d_ptr->sceneTransform.mapRect(rect);
}
/*!
\fn QRectF QGraphicsItem::mapRectToScene(qreal x, qreal y, qreal w, qreal h) const
\since 4.5
This convenience function is equivalent to calling mapRectToScene(QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
\since 4.5
Maps the rectangle \a rect, which is in \a item's coordinate system, to
this item's coordinate system, and returns the mapped rectangle as a new
rectangle (i.e., the bounding rectangle of the resulting polygon).
If \a item is \nullptr, this function returns the same as mapRectFromScene().
\sa itemTransform(), mapToParent(), mapToScene(), mapFromItem(), {The
Graphics View Coordinate System}
*/
QRectF QGraphicsItem::mapRectFromItem(const QGraphicsItem *item, const QRectF &rect) const
{
if (item)
return item->itemTransform(this).mapRect(rect);
return mapRectFromScene(rect);
}
/*!
\fn QRectF QGraphicsItem::mapRectFromItem(const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const
\since 4.5
This convenience function is equivalent to calling mapRectFromItem(item, QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
\since 4.5
Maps the rectangle \a rect, which is in this item's parent's coordinate
system, to this item's coordinate system, and returns the mapped rectangle
as a new rectangle (i.e., the bounding rectangle of the resulting
polygon).
\sa itemTransform(), mapToParent(), mapToScene(), mapFromItem(), {The
Graphics View Coordinate System}
*/
QRectF QGraphicsItem::mapRectFromParent(const QRectF &rect) const
{
// COMBINE
if (!d_ptr->transformData)
return rect.translated(-d_ptr->pos);
return d_ptr->transformToParent().inverted().mapRect(rect);
}
/*!
\fn QRectF QGraphicsItem::mapRectFromParent(qreal x, qreal y, qreal w, qreal h) const
\since 4.5
This convenience function is equivalent to calling mapRectFromParent(QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
\since 4.5
Maps the rectangle \a rect, which is in scene coordinates, to this item's
coordinate system, and returns the mapped rectangle as a new rectangle
(i.e., the bounding rectangle of the resulting polygon).
\sa itemTransform(), mapToParent(), mapToScene(), mapFromItem(), {The
Graphics View Coordinate System}
*/
QRectF QGraphicsItem::mapRectFromScene(const QRectF &rect) const
{
if (d_ptr->hasTranslateOnlySceneTransform())
return rect.translated(-d_ptr->sceneTransform.dx(), -d_ptr->sceneTransform.dy());
return d_ptr->sceneTransform.inverted().mapRect(rect);
}
/*!
\fn QRectF QGraphicsItem::mapRectFromScene(qreal x, qreal y, qreal w, qreal h) const
\since 4.5
This convenience function is equivalent to calling mapRectFromScene(QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
Maps the polygon \a polygon, which is in this item's coordinate system, to
\a item's coordinate system, and returns the mapped polygon.
If \a item is \nullptr, this function returns the same as mapToScene().
\sa itemTransform(), mapToParent(), mapToScene(), mapFromItem(), {The
Graphics View Coordinate System}
*/
QPolygonF QGraphicsItem::mapToItem(const QGraphicsItem *item, const QPolygonF &polygon) const
{
if (item)
return itemTransform(item).map(polygon);
return mapToScene(polygon);
}
/*!
Maps the polygon \a polygon, which is in this item's coordinate system, to
its parent's coordinate system, and returns the mapped polygon. If the
item has no parent, \a polygon will be mapped to the scene's coordinate
system.
\sa mapToScene(), mapToItem(), mapFromParent(), {The Graphics View
Coordinate System}
*/
QPolygonF QGraphicsItem::mapToParent(const QPolygonF &polygon) const
{
// COMBINE
if (!d_ptr->transformData)
return polygon.translated(d_ptr->pos);
return d_ptr->transformToParent().map(polygon);
}
/*!
Maps the polygon \a polygon, which is in this item's coordinate system, to
the scene's coordinate system, and returns the mapped polygon.
\sa mapToParent(), mapToItem(), mapFromScene(), {The Graphics View
Coordinate System}
*/
QPolygonF QGraphicsItem::mapToScene(const QPolygonF &polygon) const
{
if (d_ptr->hasTranslateOnlySceneTransform())
return polygon.translated(d_ptr->sceneTransform.dx(), d_ptr->sceneTransform.dy());
return d_ptr->sceneTransform.map(polygon);
}
/*!
Maps the path \a path, which is in this item's coordinate system, to
\a item's coordinate system, and returns the mapped path.
If \a item is \nullptr, this function returns the same as mapToScene().
\sa itemTransform(), mapToParent(), mapToScene(), mapFromItem(), {The
Graphics View Coordinate System}
*/
QPainterPath QGraphicsItem::mapToItem(const QGraphicsItem *item, const QPainterPath &path) const
{
if (item)
return itemTransform(item).map(path);
return mapToScene(path);
}
/*!
Maps the path \a path, which is in this item's coordinate system, to
its parent's coordinate system, and returns the mapped path. If the
item has no parent, \a path will be mapped to the scene's coordinate
system.
\sa mapToScene(), mapToItem(), mapFromParent(), {The Graphics View
Coordinate System}
*/
QPainterPath QGraphicsItem::mapToParent(const QPainterPath &path) const
{
// COMBINE
if (!d_ptr->transformData)
return path.translated(d_ptr->pos);
return d_ptr->transformToParent().map(path);
}
/*!
Maps the path \a path, which is in this item's coordinate system, to
the scene's coordinate system, and returns the mapped path.
\sa mapToParent(), mapToItem(), mapFromScene(), {The Graphics View
Coordinate System}
*/
QPainterPath QGraphicsItem::mapToScene(const QPainterPath &path) const
{
if (d_ptr->hasTranslateOnlySceneTransform())
return path.translated(d_ptr->sceneTransform.dx(), d_ptr->sceneTransform.dy());
return d_ptr->sceneTransform.map(path);
}
/*!
Maps the point \a point, which is in \a item's coordinate system, to this
item's coordinate system, and returns the mapped coordinate.
If \a item is \nullptr, this function returns the same as mapFromScene().
\sa itemTransform(), mapFromParent(), mapFromScene(), transform(), mapToItem(), {The Graphics
View Coordinate System}
*/
QPointF QGraphicsItem::mapFromItem(const QGraphicsItem *item, const QPointF &point) const
{
if (item)
return item->itemTransform(this).map(point);
return mapFromScene(point);
}
/*!
\fn QPointF QGraphicsItem::mapFromItem(const QGraphicsItem *item, qreal x, qreal y) const
\overload
This convenience function is equivalent to calling mapFromItem(\a item,
QPointF(\a x, \a y)).
*/
/*!
Maps the point \a point, which is in this item's parent's coordinate
system, to this item's coordinate system, and returns the mapped
coordinate.
\sa mapFromItem(), mapFromScene(), transform(), mapToParent(), {The Graphics
View Coordinate System}
*/
QPointF QGraphicsItem::mapFromParent(const QPointF &point) const
{
// COMBINE
if (d_ptr->transformData)
return d_ptr->transformToParent().inverted().map(point);
return point - d_ptr->pos;
}
/*!
\fn QPointF QGraphicsItem::mapFromParent(qreal x, qreal y) const
\overload
This convenience function is equivalent to calling
mapFromParent(QPointF(\a x, \a y)).
*/
/*!
Maps the point \a point, which is in this item's scene's coordinate
system, to this item's coordinate system, and returns the mapped
coordinate.
\sa mapFromItem(), mapFromParent(), transform(), mapToScene(), {The Graphics
View Coordinate System}
*/
QPointF QGraphicsItem::mapFromScene(const QPointF &point) const
{
if (d_ptr->hasTranslateOnlySceneTransform())
return QPointF(point.x() - d_ptr->sceneTransform.dx(), point.y() - d_ptr->sceneTransform.dy());
return d_ptr->sceneTransform.inverted().map(point);
}
/*!
\fn QPointF QGraphicsItem::mapFromScene(qreal x, qreal y) const
\overload
This convenience function is equivalent to calling mapFromScene(QPointF(\a
x, \a y)).
*/
/*!
Maps the rectangle \a rect, which is in \a item's coordinate system, to
this item's coordinate system, and returns the mapped rectangle as a
polygon.
If \a item is \nullptr, this function returns the same as mapFromScene()
\sa itemTransform(), mapToItem(), mapFromParent(), transform(), {The Graphics View Coordinate
System}
*/
QPolygonF QGraphicsItem::mapFromItem(const QGraphicsItem *item, const QRectF &rect) const
{
if (item)
return item->itemTransform(this).map(rect);
return mapFromScene(rect);
}
/*!
\fn QPolygonF QGraphicsItem::mapFromItem(const QGraphicsItem *item, qreal x, qreal y, qreal w, qreal h) const
\since 4.3
This convenience function is equivalent to calling mapFromItem(item, QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
Maps the rectangle \a 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.
\sa mapToParent(), mapFromItem(), transform(), {The Graphics View Coordinate
System}
*/
QPolygonF QGraphicsItem::mapFromParent(const QRectF &rect) const
{
// COMBINE
if (!d_ptr->transformData)
return rect.translated(-d_ptr->pos);
return d_ptr->transformToParent().inverted().map(rect);
}
/*!
\fn QPolygonF QGraphicsItem::mapFromParent(qreal x, qreal y, qreal w, qreal h) const
\since 4.3
This convenience function is equivalent to calling mapFromItem(QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
Maps the rectangle \a 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.
\sa mapToScene(), mapFromItem(), transform(), {The Graphics View Coordinate
System}
*/
QPolygonF QGraphicsItem::mapFromScene(const QRectF &rect) const
{
if (d_ptr->hasTranslateOnlySceneTransform())
return rect.translated(-d_ptr->sceneTransform.dx(), -d_ptr->sceneTransform.dy());
return d_ptr->sceneTransform.inverted().map(rect);
}
/*!
\fn QPolygonF QGraphicsItem::mapFromScene(qreal x, qreal y, qreal w, qreal h) const
\since 4.3
This convenience function is equivalent to calling mapFromScene(QRectF(\a x, \a y, \a w, \a h)).
*/
/*!
Maps the polygon \a polygon, which is in \a item's coordinate system, to
this item's coordinate system, and returns the mapped polygon.
If \a item is \nullptr, this function returns the same as mapFromScene().
\sa itemTransform(), mapToItem(), mapFromParent(), transform(), {The
Graphics View Coordinate System}
*/
QPolygonF QGraphicsItem::mapFromItem(const QGraphicsItem *item, const QPolygonF &polygon) const
{
if (item)
return item->itemTransform(this).map(polygon);
return mapFromScene(polygon);
}
/*!
Maps the polygon \a polygon, which is in this item's parent's coordinate
system, to this item's coordinate system, and returns the mapped polygon.
\sa mapToParent(), mapToItem(), transform(), {The Graphics View Coordinate
System}
*/
QPolygonF QGraphicsItem::mapFromParent(const QPolygonF &polygon) const
{
// COMBINE
if (!d_ptr->transformData)
return polygon.translated(-d_ptr->pos);
return d_ptr->transformToParent().inverted().map(polygon);
}
/*!
Maps the polygon \a polygon, which is in this item's scene's coordinate
system, to this item's coordinate system, and returns the mapped polygon.
\sa mapToScene(), mapFromParent(), transform(), {The Graphics View Coordinate
System}
*/
QPolygonF QGraphicsItem::mapFromScene(const QPolygonF &polygon) const
{
if (d_ptr->hasTranslateOnlySceneTransform())
return polygon.translated(-d_ptr->sceneTransform.dx(), -d_ptr->sceneTransform.dy());
return d_ptr->sceneTransform.inverted().map(polygon);
}
/*!
Maps the path \a path, which is in \a item's coordinate system, to
this item's coordinate system, and returns the mapped path.
If \a item is \nullptr, this function returns the same as mapFromScene().
\sa itemTransform(), mapFromParent(), mapFromScene(), mapToItem(), {The
Graphics View Coordinate System}
*/
QPainterPath QGraphicsItem::mapFromItem(const QGraphicsItem *item, const QPainterPath &path) const
{
if (item)
return item->itemTransform(this).map(path);
return mapFromScene(path);
}
/*!
Maps the path \a path, which is in this item's parent's coordinate
system, to this item's coordinate system, and returns the mapped path.
\sa mapFromScene(), mapFromItem(), mapToParent(), {The Graphics View
Coordinate System}
*/
QPainterPath QGraphicsItem::mapFromParent(const QPainterPath &path) const
{
// COMBINE
if (!d_ptr->transformData)
return path.translated(-d_ptr->pos);
return d_ptr->transformToParent().inverted().map(path);
}
/*!
Maps the path \a path, which is in this item's scene's coordinate
system, to this item's coordinate system, and returns the mapped path.
\sa mapFromParent(), mapFromItem(), mapToScene(), {The Graphics View
Coordinate System}
*/
QPainterPath QGraphicsItem::mapFromScene(const QPainterPath &path) const
{
if (d_ptr->hasTranslateOnlySceneTransform())
return path.translated(-d_ptr->sceneTransform.dx(), -d_ptr->sceneTransform.dy());
return d_ptr->sceneTransform.inverted().map(path);
}
/*!
Returns \c true if this item is an ancestor of \a child (i.e., if this item
is \a child's parent, or one of \a child's parent's ancestors).
\sa parentItem()
*/
bool QGraphicsItem::isAncestorOf(const QGraphicsItem *child) const
{
if (!child || child == this)
return false;
if (child->d_ptr->depth() < d_ptr->depth())
return false;
const QGraphicsItem *ancestor = child;
while ((ancestor = ancestor->d_ptr->parent)) {
if (ancestor == this)
return true;
}
return false;
}
/*!
\since 4.4
Returns the closest common ancestor item of this item and \a other,
or \nullptr if either \a other is \nullptr, or there is no common ancestor.
\sa isAncestorOf()
*/
QGraphicsItem *QGraphicsItem::commonAncestorItem(const QGraphicsItem *other) const
{
if (!other)
return nullptr;
if (other == this)
return const_cast<QGraphicsItem *>(this);
const QGraphicsItem *thisw = this;
const QGraphicsItem *otherw = other;
int thisDepth = d_ptr->depth();
int otherDepth = other->d_ptr->depth();
while (thisDepth > otherDepth) {
thisw = thisw->d_ptr->parent;
--thisDepth;
}
while (otherDepth > thisDepth) {
otherw = otherw->d_ptr->parent;
--otherDepth;
}
while (thisw && thisw != otherw) {
thisw = thisw->d_ptr->parent;
otherw = otherw->d_ptr->parent;
}
return const_cast<QGraphicsItem *>(thisw);
}
/*!
\since 4.4
Returns \c true if this item is currently under the mouse cursor in one of
the views; otherwise, false is returned.
\sa QGraphicsScene::views(), QCursor::pos()
*/
bool QGraphicsItem::isUnderMouse() const
{
Q_D(const QGraphicsItem);
if (!d->scene)
return false;
QPoint cursorPos = QCursor::pos();
const auto views = d->scene->views();
for (QGraphicsView *view : views) {
if (contains(mapFromScene(view->mapToScene(view->mapFromGlobal(cursorPos)))))
return true;
}
return false;
}
/*!
Returns this item's custom data for the key \a key as a QVariant.
Custom item data is useful for storing arbitrary properties in any
item. Example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 11
Qt does not use this feature for storing data; it is provided solely
for the convenience of the user.
\sa setData()
*/
QVariant QGraphicsItem::data(int key) const
{
QGraphicsItemCustomDataStore *store = qt_dataStore();
if (!store->data.contains(this))
return QVariant();
return store->data.value(this).value(key);
}
/*!
Sets this item's custom data for the key \a key to \a value.
Custom item data is useful for storing arbitrary properties for any
item. Qt does not use this feature for storing data; it is provided solely
for the convenience of the user.
\sa data()
*/
void QGraphicsItem::setData(int key, const QVariant &value)
{
qt_dataStore()->data[this][key] = value;
}
/*!
\fn T qgraphicsitem_cast(QGraphicsItem *item)
\relates QGraphicsItem
\since 4.2
Returns the given \a item cast to type T if \a item is of type T;
otherwise, \nullptr is returned.
\note To make this function work correctly with custom items, reimplement
the \l{QGraphicsItem::}{type()} function for each custom QGraphicsItem
subclass.
\sa QGraphicsItem::type(), QGraphicsItem::UserType
*/
/*!
Returns the type of an item as an int. All standard graphicsitem classes
are associated with a unique value; see QGraphicsItem::Type. This type
information is used by qgraphicsitem_cast() to distinguish between types.
The default implementation (in QGraphicsItem) returns UserType.
To enable use of qgraphicsitem_cast() with a custom item, reimplement this
function and declare a Type enum value equal to your custom item's type.
Custom items must return a value larger than or equal to UserType (65536).
For example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 1
\sa UserType
*/
int QGraphicsItem::type() const
{
return (int)UserType;
}
/*!
Installs an event filter for this item on \a filterItem, causing
all events for this item to first pass through \a filterItem's
sceneEventFilter() function.
To filter another item's events, install this item as an event filter
for the other item. Example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 12
An item can only filter events for other items in the same
scene. Also, an item cannot filter its own events; instead, you
can reimplement sceneEvent() directly.
Items must belong to a scene for scene event filters to be installed and
used.
\sa removeSceneEventFilter(), sceneEventFilter(), sceneEvent()
*/
void QGraphicsItem::installSceneEventFilter(QGraphicsItem *filterItem)
{
if (!d_ptr->scene) {
qWarning("QGraphicsItem::installSceneEventFilter: event filters can only be installed"
" on items in a scene.");
return;
}
if (d_ptr->scene != filterItem->scene()) {
qWarning("QGraphicsItem::installSceneEventFilter: event filters can only be installed"
" on items in the same scene.");
return;
}
d_ptr->scene->d_func()->installSceneEventFilter(this, filterItem);
}
/*!
Removes an event filter on this item from \a filterItem.
\sa installSceneEventFilter()
*/
void QGraphicsItem::removeSceneEventFilter(QGraphicsItem *filterItem)
{
if (!d_ptr->scene || d_ptr->scene != filterItem->scene())
return;
d_ptr->scene->d_func()->removeSceneEventFilter(this, filterItem);
}
/*!
Filters events for the item \a watched. \a event is the filtered
event.
Reimplementing this function in a subclass makes it possible
for the item to be used as an event filter for other items,
intercepting all the events sent to those items before they are
able to respond.
Reimplementations must return true to prevent further processing of
a given event, ensuring that it will not be delivered to the watched
item, or return false to indicate that the event should be propagated
further by the event system.
\sa installSceneEventFilter()
*/
bool QGraphicsItem::sceneEventFilter(QGraphicsItem *watched, QEvent *event)
{
Q_UNUSED(watched);
Q_UNUSED(event);
return false;
}
/*!
This virtual function receives events to this item. Reimplement
this function to intercept events before they are dispatched to
the specialized event handlers contextMenuEvent(), focusInEvent(),
focusOutEvent(), hoverEnterEvent(), hoverMoveEvent(),
hoverLeaveEvent(), keyPressEvent(), keyReleaseEvent(),
mousePressEvent(), mouseReleaseEvent(), mouseMoveEvent(), and
mouseDoubleClickEvent().
Returns \c true if the event was recognized and handled; otherwise, (e.g., if
the event type was not recognized,) false is returned.
\a event is the intercepted event.
*/
bool QGraphicsItem::sceneEvent(QEvent *event)
{
if (d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorHandlesChildEvents) {
if (event->type() == QEvent::HoverEnter || event->type() == QEvent::HoverLeave
|| event->type() == QEvent::DragEnter || event->type() == QEvent::DragLeave) {
// Hover enter and hover leave events for children are ignored;
// hover move events are forwarded.
return true;
}
QGraphicsItem *handler = this;
do {
handler = handler->d_ptr->parent;
Q_ASSERT(handler);
} while (handler->d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorHandlesChildEvents);
// Forward the event to the closest parent that handles child
// events, mapping existing item-local coordinates to its
// coordinate system.
d_ptr->remapItemPos(event, handler);
handler->sceneEvent(event);
return true;
}
if (event->type() == QEvent::FocusOut) {
focusOutEvent(static_cast<QFocusEvent *>(event));
return true;
}
if (!d_ptr->visible) {
// Eaten
return true;
}
switch (event->type()) {
case QEvent::FocusIn:
focusInEvent(static_cast<QFocusEvent *>(event));
break;
case QEvent::GraphicsSceneContextMenu:
contextMenuEvent(static_cast<QGraphicsSceneContextMenuEvent *>(event));
break;
case QEvent::GraphicsSceneDragEnter:
dragEnterEvent(static_cast<QGraphicsSceneDragDropEvent *>(event));
break;
case QEvent::GraphicsSceneDragMove:
dragMoveEvent(static_cast<QGraphicsSceneDragDropEvent *>(event));
break;
case QEvent::GraphicsSceneDragLeave:
dragLeaveEvent(static_cast<QGraphicsSceneDragDropEvent *>(event));
break;
case QEvent::GraphicsSceneDrop:
dropEvent(static_cast<QGraphicsSceneDragDropEvent *>(event));
break;
case QEvent::GraphicsSceneHoverEnter:
hoverEnterEvent(static_cast<QGraphicsSceneHoverEvent *>(event));
break;
case QEvent::GraphicsSceneHoverMove:
hoverMoveEvent(static_cast<QGraphicsSceneHoverEvent *>(event));
break;
case QEvent::GraphicsSceneHoverLeave:
hoverLeaveEvent(static_cast<QGraphicsSceneHoverEvent *>(event));
break;
case QEvent::GraphicsSceneMouseMove:
mouseMoveEvent(static_cast<QGraphicsSceneMouseEvent *>(event));
break;
case QEvent::GraphicsSceneMousePress:
mousePressEvent(static_cast<QGraphicsSceneMouseEvent *>(event));
break;
case QEvent::GraphicsSceneMouseRelease:
mouseReleaseEvent(static_cast<QGraphicsSceneMouseEvent *>(event));
break;
case QEvent::GraphicsSceneMouseDoubleClick:
mouseDoubleClickEvent(static_cast<QGraphicsSceneMouseEvent *>(event));
break;
case QEvent::GraphicsSceneWheel:
wheelEvent(static_cast<QGraphicsSceneWheelEvent *>(event));
break;
case QEvent::KeyPress: {
QKeyEvent *k = static_cast<QKeyEvent *>(event);
if (k->key() == Qt::Key_Tab || k->key() == Qt::Key_Backtab) {
if (!(k->modifiers() & (Qt::ControlModifier | Qt::AltModifier))) { //### Add MetaModifier?
bool res = false;
if (k->key() == Qt::Key_Backtab
|| (k->key() == Qt::Key_Tab && (k->modifiers() & Qt::ShiftModifier))) {
if (d_ptr->isWidget) {
res = static_cast<QGraphicsWidget *>(this)->focusNextPrevChild(false);
} else if (d_ptr->scene) {
res = d_ptr->scene->focusNextPrevChild(false);
}
} else if (k->key() == Qt::Key_Tab) {
if (d_ptr->isWidget) {
res = static_cast<QGraphicsWidget *>(this)->focusNextPrevChild(true);
} else if (d_ptr->scene) {
res = d_ptr->scene->focusNextPrevChild(true);
}
}
if (!res)
event->ignore();
return true;
}
}
keyPressEvent(static_cast<QKeyEvent *>(event));
break;
}
case QEvent::KeyRelease:
keyReleaseEvent(static_cast<QKeyEvent *>(event));
break;
case QEvent::InputMethod:
inputMethodEvent(static_cast<QInputMethodEvent *>(event));
break;
case QEvent::WindowActivate:
case QEvent::WindowDeactivate:
// Propagate panel activation.
if (d_ptr->scene) {
for (int i = 0; i < d_ptr->children.size(); ++i) {
QGraphicsItem *child = d_ptr->children.at(i);
if (child->isVisible() && !child->isPanel()) {
if (!(child->d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorHandlesChildEvents))
d_ptr->scene->sendEvent(child, event);
}
}
}
break;
default:
return false;
}
return true;
}
/*!
This event handler can be reimplemented in a subclass to process context
menu events. The \a event parameter contains details about the event to
be handled.
If you ignore the event (i.e., by calling QEvent::ignore()), \a event
will propagate to any item beneath this item. If no items accept the
event, it will be ignored by the scene and propagate to the view.
It's common to open a QMenu in response to receiving a context menu
event. Example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 13
The default implementation ignores the event.
\sa sceneEvent()
*/
void QGraphicsItem::contextMenuEvent(QGraphicsSceneContextMenuEvent *event)
{
event->ignore();
}
/*!
This event handler, for event \a event, can be reimplemented to receive
drag enter events for this item. Drag enter events are generated as the
cursor enters the item's area.
By accepting the event (i.e., by calling QEvent::accept()), the item will
accept drop events, in addition to receiving drag move and drag
leave. Otherwise, the event will be ignored and propagate to the item
beneath. If the event is accepted, the item will receive a drag move event
before control goes back to the event loop.
A common implementation of dragEnterEvent accepts or ignores \a event
depending on the associated mime data in \a event. Example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 14
Items do not receive drag and drop events by default; to enable this
feature, call \c setAcceptDrops(true).
The default implementation does nothing.
\sa dropEvent(), dragMoveEvent(), dragLeaveEvent()
*/
void QGraphicsItem::dragEnterEvent(QGraphicsSceneDragDropEvent *event)
{
Q_D(QGraphicsItem);
// binary compatibility workaround between 4.4 and 4.5
if (d->isProxyWidget())
static_cast<QGraphicsProxyWidget*>(this)->dragEnterEvent(event);
}
/*!
This event handler, for event \a event, can be reimplemented to receive
drag leave events for this item. Drag leave events are generated as the
cursor leaves the item's area. Most often you will not need to reimplement
this function, but it can be useful for resetting state in your item
(e.g., highlighting).
Calling QEvent::ignore() or QEvent::accept() on \a event has no effect.
Items do not receive drag and drop events by default; to enable this
feature, call \c setAcceptDrops(true).
The default implementation does nothing.
\sa dragEnterEvent(), dropEvent(), dragMoveEvent()
*/
void QGraphicsItem::dragLeaveEvent(QGraphicsSceneDragDropEvent *event)
{
Q_D(QGraphicsItem);
// binary compatibility workaround between 4.4 and 4.5
if (d->isProxyWidget())
static_cast<QGraphicsProxyWidget*>(this)->dragLeaveEvent(event);
}
/*!
This event handler, for event \a event, can be reimplemented to receive
drag move events for this item. Drag move events are generated as the
cursor moves around inside the item's area. Most often you will not need
to reimplement this function; it is used to indicate that only parts of
the item can accept drops.
Calling QEvent::ignore() or QEvent::accept() on \a event toggles whether
or not the item will accept drops at the position from the event. By
default, \a event is accepted, indicating that the item allows drops at
the specified position.
Items do not receive drag and drop events by default; to enable this
feature, call \c setAcceptDrops(true).
The default implementation does nothing.
\sa dropEvent(), dragEnterEvent(), dragLeaveEvent()
*/
void QGraphicsItem::dragMoveEvent(QGraphicsSceneDragDropEvent *event)
{
Q_D(QGraphicsItem);
// binary compatibility workaround between 4.4 and 4.5
if (d->isProxyWidget())
static_cast<QGraphicsProxyWidget*>(this)->dragMoveEvent(event);
}
/*!
This event handler, for event \a event, can be reimplemented to receive
drop events for this item. Items can only receive drop events if the last
drag move event was accepted.
Calling QEvent::ignore() or QEvent::accept() on \a event has no effect.
Items do not receive drag and drop events by default; to enable this
feature, call \c setAcceptDrops(true).
The default implementation does nothing.
\sa dragEnterEvent(), dragMoveEvent(), dragLeaveEvent()
*/
void QGraphicsItem::dropEvent(QGraphicsSceneDragDropEvent *event)
{
Q_D(QGraphicsItem);
// binary compatibility workaround between 4.4 and 4.5
if (d->isProxyWidget())
static_cast<QGraphicsProxyWidget*>(this)->dropEvent(event);
}
/*!
This event handler, for event \a event, can be reimplemented to receive
focus in events for this item. The default implementation calls
ensureVisible().
\sa focusOutEvent(), sceneEvent(), setFocus()
*/
void QGraphicsItem::focusInEvent(QFocusEvent *event)
{
Q_UNUSED(event);
update();
}
/*!
This event handler, for event \a event, can be reimplemented to receive
focus out events for this item. The default implementation does nothing.
\sa focusInEvent(), sceneEvent(), setFocus()
*/
void QGraphicsItem::focusOutEvent(QFocusEvent *event)
{
Q_UNUSED(event);
update();
}
/*!
This event handler, for event \a event, can be reimplemented to receive
hover enter events for this item. The default implementation calls
update(); otherwise it does nothing.
Calling QEvent::ignore() or QEvent::accept() on \a event has no effect.
\sa hoverMoveEvent(), hoverLeaveEvent(), sceneEvent(), setAcceptHoverEvents()
*/
void QGraphicsItem::hoverEnterEvent(QGraphicsSceneHoverEvent *event)
{
Q_UNUSED(event);
update();
}
/*!
This event handler, for event \a event, can be reimplemented to receive
hover move events for this item. The default implementation does nothing.
Calling QEvent::ignore() or QEvent::accept() on \a event has no effect.
\sa hoverEnterEvent(), hoverLeaveEvent(), sceneEvent(), setAcceptHoverEvents()
*/
void QGraphicsItem::hoverMoveEvent(QGraphicsSceneHoverEvent *event)
{
Q_UNUSED(event);
}
/*!
This event handler, for event \a event, can be reimplemented to receive
hover leave events for this item. The default implementation calls
update(); otherwise it does nothing.
Calling QEvent::ignore() or QEvent::accept() on \a event has no effect.
\sa hoverEnterEvent(), hoverMoveEvent(), sceneEvent(), setAcceptHoverEvents()
*/
void QGraphicsItem::hoverLeaveEvent(QGraphicsSceneHoverEvent *event)
{
Q_UNUSED(event);
update();
}
/*!
This event handler, for event \a event, can be reimplemented to
receive key press events for this item. The default implementation
ignores the event. If you reimplement this handler, the event will by
default be accepted.
Note that key events are only received for items that set the
ItemIsFocusable flag, and that have keyboard input focus.
\sa keyReleaseEvent(), setFocus(), QGraphicsScene::setFocusItem(),
sceneEvent()
*/
void QGraphicsItem::keyPressEvent(QKeyEvent *event)
{
event->ignore();
}
/*!
This event handler, for event \a event, can be reimplemented to receive
key release events for this item. The default implementation
ignores the event. If you reimplement this handler, the event will by
default be accepted.
Note that key events are only received for items that set the
ItemIsFocusable flag, and that have keyboard input focus.
\sa keyPressEvent(), setFocus(), QGraphicsScene::setFocusItem(),
sceneEvent()
*/
void QGraphicsItem::keyReleaseEvent(QKeyEvent *event)
{
event->ignore();
}
/*!
This event handler, for event \a event, can be reimplemented to
receive mouse press events for this item. Mouse press events are
only delivered to items that accept the mouse button that is
pressed. By default, an item accepts all mouse buttons, but you
can change this by calling setAcceptedMouseButtons().
The mouse press event decides which item should become the mouse
grabber (see QGraphicsScene::mouseGrabberItem()). If you do not
reimplement this function, the press event will propagate to any
topmost item beneath this item, and no other mouse events will be
delivered to this item.
If you do reimplement this function, \a event will by default be
accepted (see QEvent::accept()), and this item is then the mouse
grabber. This allows the item to receive future move, release and
doubleclick events. If you call QEvent::ignore() on \a event, this
item will lose the mouse grab, and \a event will propagate to any
topmost item beneath. No further mouse events will be delivered to
this item unless a new mouse press event is received.
The default implementation handles basic item interaction, such as
selection and moving. If you want to keep the base implementation
when reimplementing this function, call
QGraphicsItem::mousePressEvent() in your reimplementation.
The event is \l{QEvent::ignore()}d for items that are neither
\l{QGraphicsItem::ItemIsMovable}{movable} nor
\l{QGraphicsItem::ItemIsSelectable}{selectable}.
\sa mouseMoveEvent(), mouseReleaseEvent(),
mouseDoubleClickEvent(), sceneEvent()
*/
void QGraphicsItem::mousePressEvent(QGraphicsSceneMouseEvent *event)
{
if (event->button() == Qt::LeftButton && (flags() & ItemIsSelectable)) {
bool multiSelect = (event->modifiers() & Qt::ControlModifier) != 0;
if (!multiSelect) {
if (!d_ptr->selected) {
if (QGraphicsScene *scene = d_ptr->scene) {
++scene->d_func()->selectionChanging;
scene->clearSelection();
--scene->d_func()->selectionChanging;
}
setSelected(true);
}
}
} else if (!(flags() & ItemIsMovable)) {
event->ignore();
}
if (d_ptr->isWidget) {
// Qt::Popup closes when you click outside.
QGraphicsWidget *w = static_cast<QGraphicsWidget *>(this);
if ((w->windowFlags() & Qt::Popup) == Qt::Popup) {
event->accept();
if (!w->rect().contains(event->pos()))
w->close();
}
}
}
bool _qt_movableAncestorIsSelected(const QGraphicsItem *item)
{
const QGraphicsItem *parent = item->parentItem();
return parent && (((parent->flags() & QGraphicsItem::ItemIsMovable) && parent->isSelected()) || _qt_movableAncestorIsSelected(parent));
}
bool QGraphicsItemPrivate::movableAncestorIsSelected(const QGraphicsItem *item)
{
const QGraphicsItem *parent = item->d_ptr->parent;
return parent && (((parent->flags() & QGraphicsItem::ItemIsMovable) && parent->isSelected()) || _qt_movableAncestorIsSelected(parent));
}
/*!
This event handler, for event \a event, can be reimplemented to
receive mouse move events for this item. If you do receive this
event, you can be certain that this item also received a mouse
press event, and that this item is the current mouse grabber.
Calling QEvent::ignore() or QEvent::accept() on \a event has no
effect.
The default implementation handles basic item interaction, such as
selection and moving. If you want to keep the base implementation
when reimplementing this function, call
QGraphicsItem::mouseMoveEvent() in your reimplementation.
Please note that mousePressEvent() decides which graphics item it
is that receives mouse events. See the mousePressEvent()
description for details.
\sa mousePressEvent(), mouseReleaseEvent(),
mouseDoubleClickEvent(), sceneEvent()
*/
void QGraphicsItem::mouseMoveEvent(QGraphicsSceneMouseEvent *event)
{
if ((event->buttons() & Qt::LeftButton) && (flags() & ItemIsMovable)) {
// Determine the list of items that need to be moved.
QList<QGraphicsItem *> selectedItems;
QHash<QGraphicsItem *, QPointF> initialPositions;
if (d_ptr->scene) {
selectedItems = d_ptr->scene->selectedItems();
initialPositions = d_ptr->scene->d_func()->movingItemsInitialPositions;
if (initialPositions.isEmpty()) {
for (QGraphicsItem *item : qAsConst(selectedItems))
initialPositions[item] = item->pos();
initialPositions[this] = pos();
}
d_ptr->scene->d_func()->movingItemsInitialPositions = initialPositions;
}
// Find the active view.
QGraphicsView *view = nullptr;
if (event->widget())
view = qobject_cast<QGraphicsView *>(event->widget()->parentWidget());
// Move all selected items
int i = 0;
bool movedMe = false;
while (i <= selectedItems.size()) {
QGraphicsItem *item = nullptr;
if (i < selectedItems.size())
item = selectedItems.at(i);
else
item = this;
if (item == this) {
// Slightly clumsy-looking way to ensure that "this" is part
// of the list of items to move, this is to avoid allocations
// (appending this item to the list of selected items causes a
// detach).
if (movedMe)
break;
movedMe = true;
}
if ((item->flags() & ItemIsMovable) && !QGraphicsItemPrivate::movableAncestorIsSelected(item)) {
QPointF currentParentPos;
QPointF buttonDownParentPos;
if (item->d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorIgnoresTransformations) {
// Items whose ancestors ignore transformations need to
// map screen coordinates to local coordinates, then map
// those to the parent.
QTransform viewToItemTransform = (item->deviceTransform(view->viewportTransform())).inverted();
currentParentPos = mapToParent(viewToItemTransform.map(QPointF(view->mapFromGlobal(event->screenPos()))));
buttonDownParentPos = mapToParent(viewToItemTransform.map(QPointF(view->mapFromGlobal(event->buttonDownScreenPos(Qt::LeftButton)))));
} else if (item->flags() & ItemIgnoresTransformations) {
// Root items that ignore transformations need to
// calculate their diff by mapping viewport coordinates
// directly to parent coordinates.
// COMBINE
QTransform itemTransform;
if (item->d_ptr->transformData)
itemTransform = item->d_ptr->transformData->computedFullTransform();
itemTransform.translate(item->d_ptr->pos.x(), item->d_ptr->pos.y());
QTransform viewToParentTransform = itemTransform
* (item->sceneTransform() * view->viewportTransform()).inverted();
currentParentPos = viewToParentTransform.map(QPointF(view->mapFromGlobal(event->screenPos())));
buttonDownParentPos = viewToParentTransform.map(QPointF(view->mapFromGlobal(event->buttonDownScreenPos(Qt::LeftButton))));
} else {
// All other items simply map from the scene.
currentParentPos = item->mapToParent(item->mapFromScene(event->scenePos()));
buttonDownParentPos = item->mapToParent(item->mapFromScene(event->buttonDownScenePos(Qt::LeftButton)));
}
item->setPos(initialPositions.value(item) + currentParentPos - buttonDownParentPos);
if (item->flags() & ItemIsSelectable)
item->setSelected(true);
}
++i;
}
} else {
event->ignore();
}
}
/*!
This event handler, for event \a event, can be reimplemented to
receive mouse release events for this item.
Calling QEvent::ignore() or QEvent::accept() on \a event has no
effect.
The default implementation handles basic item interaction, such as
selection and moving. If you want to keep the base implementation
when reimplementing this function, call
QGraphicsItem::mouseReleaseEvent() in your reimplementation.
Please note that mousePressEvent() decides which graphics item it
is that receives mouse events. See the mousePressEvent()
description for details.
\sa mousePressEvent(), mouseMoveEvent(), mouseDoubleClickEvent(),
sceneEvent()
*/
void QGraphicsItem::mouseReleaseEvent(QGraphicsSceneMouseEvent *event)
{
if (event->button() == Qt::LeftButton && (flags() & ItemIsSelectable)) {
bool multiSelect = (event->modifiers() & Qt::ControlModifier) != 0;
if (event->scenePos() == event->buttonDownScenePos(Qt::LeftButton)) {
// The item didn't move
if (multiSelect) {
setSelected(!isSelected());
} else {
bool selectionChanged = false;
if (QGraphicsScene *scene = d_ptr->scene) {
++scene->d_func()->selectionChanging;
// Clear everything but this item. Bypass
// QGraphicsScene::clearSelection()'s default behavior by
// temporarily removing this item from the selection list.
if (d_ptr->selected) {
scene->d_func()->selectedItems.remove(this);
foreach (QGraphicsItem *item, scene->d_func()->selectedItems) {
if (item->isSelected()) {
selectionChanged = true;
break;
}
}
}
scene->clearSelection();
if (d_ptr->selected)
scene->d_func()->selectedItems.insert(this);
--scene->d_func()->selectionChanging;
if (selectionChanged)
emit d_ptr->scene->selectionChanged();
}
setSelected(true);
}
}
}
if (d_ptr->scene && !event->buttons())
d_ptr->scene->d_func()->movingItemsInitialPositions.clear();
}
/*!
This event handler, for event \a event, can be reimplemented to
receive mouse doubleclick events for this item.
When doubleclicking an item, the item will first receive a mouse
press event, followed by a release event (i.e., a click), then a
doubleclick event, and finally a release event.
Calling QEvent::ignore() or QEvent::accept() on \a event has no
effect.
The default implementation calls mousePressEvent(). If you want to
keep the base implementation when reimplementing this function,
call QGraphicsItem::mouseDoubleClickEvent() in your
reimplementation.
Note that an item will not receive double click events if it is
neither \l {QGraphicsItem::ItemIsSelectable}{selectable} nor
\l{QGraphicsItem::ItemIsMovable}{movable} (single mouse clicks are
ignored in this case, and that stops the generation of double
clicks).
\sa mousePressEvent(), mouseMoveEvent(), mouseReleaseEvent(), sceneEvent()
*/
void QGraphicsItem::mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event)
{
mousePressEvent(event);
}
/*!
This event handler, for event \a event, can be reimplemented to receive
wheel events for this item. If you reimplement this function, \a event
will be accepted by default.
If you ignore the event, (i.e., by calling QEvent::ignore(),) it will
propagate to any item beneath this item. If no items accept the event, it
will be ignored by the scene, and propagate to the view (e.g., the view's
vertical scroll bar).
The default implementation ignores the event.
\sa sceneEvent()
*/
void QGraphicsItem::wheelEvent(QGraphicsSceneWheelEvent *event)
{
event->ignore();
}
/*!
This event handler, for event \a event, can be reimplemented to receive
input method events for this item. The default implementation ignores the
event.
\sa inputMethodQuery(), sceneEvent()
*/
void QGraphicsItem::inputMethodEvent(QInputMethodEvent *event)
{
event->ignore();
}
/*!
This method is only relevant for input items. It is used by the
input method to query a set of properties of the item to be able
to support complex input method operations, such as support for
surrounding text and reconversions. \a query specifies which
property is queried.
\sa inputMethodEvent(), QInputMethodEvent
*/
QVariant QGraphicsItem::inputMethodQuery(Qt::InputMethodQuery query) const
{
Q_UNUSED(query);
return QVariant();
}
/*!
Returns the current input method hints of this item.
Input method hints are only relevant for input items.
The hints are used by the input method to indicate how it should operate.
For example, if the Qt::ImhNumbersOnly flag is set, the input method may change
its visual components to reflect that only numbers can be entered.
The effect may vary between input method implementations.
\since 4.6
\sa setInputMethodHints(), inputMethodQuery()
*/
Qt::InputMethodHints QGraphicsItem::inputMethodHints() const
{
Q_D(const QGraphicsItem);
return d->imHints;
}
/*!
Sets the current input method hints of this item to \a hints.
\since 4.6
\sa inputMethodHints(), inputMethodQuery()
*/
void QGraphicsItem::setInputMethodHints(Qt::InputMethodHints hints)
{
Q_D(QGraphicsItem);
d->imHints = hints;
if (!hasFocus())
return;
d->scene->d_func()->updateInputMethodSensitivityInViews();
QWidget *fw = QApplication::focusWidget();
if (!fw)
return;
QGuiApplication::inputMethod()->update(Qt::ImHints);
}
/*!
Updates the item's micro focus.
\since 4.7
\sa QInputMethod
*/
void QGraphicsItem::updateMicroFocus()
{
}
/*!
This virtual function is called by QGraphicsItem to notify custom items
that some part of the item's state changes. By reimplementing this
function, you can react to a change, and in some cases (depending on \a
change), adjustments can be made.
\a change is the parameter of the item that is changing. \a value is the
new value; the type of the value depends on \a change.
Example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 15
The default implementation does nothing, and returns \a value.
Note: Certain QGraphicsItem functions cannot be called in a
reimplementation of this function; see the GraphicsItemChange
documentation for details.
\sa GraphicsItemChange
*/
QVariant QGraphicsItem::itemChange(GraphicsItemChange change, const QVariant &value)
{
Q_UNUSED(change);
return value;
}
/*!
\internal
Note: This is provided as a hook to avoid future problems related
to adding virtual functions.
*/
bool QGraphicsItem::supportsExtension(Extension extension) const
{
Q_UNUSED(extension);
return false;
}
/*!
\internal
Note: This is provided as a hook to avoid future problems related
to adding virtual functions.
*/
void QGraphicsItem::setExtension(Extension extension, const QVariant &variant)
{
Q_UNUSED(extension);
Q_UNUSED(variant);
}
/*!
\internal
Note: This is provided as a hook to avoid future problems related
to adding virtual functions.
*/
QVariant QGraphicsItem::extension(const QVariant &variant) const
{
Q_UNUSED(variant);
return QVariant();
}
/*!
\internal
Adds this item to the scene's index. Called in conjunction with
removeFromIndex() to ensure the index bookkeeping is correct when
the item's position, transformation or shape changes.
*/
void QGraphicsItem::addToIndex()
{
if (d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorClipsChildren
|| d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorContainsChildren) {
// ### add to child index only if applicable
return;
}
if (d_ptr->scene)
d_ptr->scene->d_func()->index->addItem(this);
}
/*!
\internal
Removes this item from the scene's index. Called in conjunction
with addToIndex() to ensure the index bookkeeping is correct when
the item's position, transformation or shape changes.
*/
void QGraphicsItem::removeFromIndex()
{
if (d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorClipsChildren
|| d_ptr->ancestorFlags & QGraphicsItemPrivate::AncestorContainsChildren) {
// ### remove from child index only if applicable
return;
}
if (d_ptr->scene)
d_ptr->scene->d_func()->index->removeItem(this);
}
/*!
Prepares the item for a geometry change. Call this function before
changing the bounding rect of an item to keep QGraphicsScene's index up to
date.
prepareGeometryChange() will call update() if this is necessary.
Example:
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 16
\sa boundingRect()
*/
void QGraphicsItem::prepareGeometryChange()
{
if (d_ptr->inDestructor)
return;
if (d_ptr->scene) {
d_ptr->scene->d_func()->dirtyGrowingItemsBoundingRect = true;
d_ptr->geometryChanged = 1;
d_ptr->paintedViewBoundingRectsNeedRepaint = 1;
d_ptr->notifyBoundingRectChanged = !d_ptr->inSetPosHelper;
QGraphicsScenePrivate *scenePrivate = d_ptr->scene->d_func();
scenePrivate->index->prepareBoundingRectChange(this);
scenePrivate->markDirty(this, QRectF(), /*invalidateChildren=*/true, /*force=*/false,
/*ignoreOpacity=*/ false, /*removingItemFromScene=*/ false,
/*updateBoundingRect=*/true);
// For compatibility reasons, we have to update the item's old geometry
// if someone is connected to the changed signal or the scene has no views.
// Note that this has to be done *after* markDirty to ensure that
// _q_processDirtyItems is called before _q_emitUpdated.
if (scenePrivate->isSignalConnected(scenePrivate->changedSignalIndex)
|| scenePrivate->views.isEmpty()) {
if (d_ptr->hasTranslateOnlySceneTransform()) {
d_ptr->scene->update(boundingRect().translated(d_ptr->sceneTransform.dx(),
d_ptr->sceneTransform.dy()));
} else {
d_ptr->scene->update(d_ptr->sceneTransform.mapRect(boundingRect()));
}
}
}
d_ptr->markParentDirty(/*updateBoundingRect=*/true);
}
/*!
\internal
Highlights \a item as selected.
NOTE: This function is a duplicate of qt_graphicsItem_highlightSelected() in
qgraphicssvgitem.cpp!
*/
static void qt_graphicsItem_highlightSelected(
QGraphicsItem *item, QPainter *painter, const QStyleOptionGraphicsItem *option)
{
const QRectF murect = painter->transform().mapRect(QRectF(0, 0, 1, 1));
if (qFuzzyIsNull(qMax(murect.width(), murect.height())))
return;
const QRectF mbrect = painter->transform().mapRect(item->boundingRect());
if (qMin(mbrect.width(), mbrect.height()) < qreal(1.0))
return;
qreal itemPenWidth;
switch (item->type()) {
case QGraphicsEllipseItem::Type:
itemPenWidth = static_cast<QGraphicsEllipseItem *>(item)->pen().widthF();
break;
case QGraphicsPathItem::Type:
itemPenWidth = static_cast<QGraphicsPathItem *>(item)->pen().widthF();
break;
case QGraphicsPolygonItem::Type:
itemPenWidth = static_cast<QGraphicsPolygonItem *>(item)->pen().widthF();
break;
case QGraphicsRectItem::Type:
itemPenWidth = static_cast<QGraphicsRectItem *>(item)->pen().widthF();
break;
case QGraphicsSimpleTextItem::Type:
itemPenWidth = static_cast<QGraphicsSimpleTextItem *>(item)->pen().widthF();
break;
case QGraphicsLineItem::Type:
itemPenWidth = static_cast<QGraphicsLineItem *>(item)->pen().widthF();
break;
default:
itemPenWidth = 1.0;
}
const qreal pad = itemPenWidth / 2;
const qreal penWidth = 0; // cosmetic pen
const QColor fgcolor = option->palette.windowText().color();
const QColor bgcolor( // ensure good contrast against fgcolor
fgcolor.red() > 127 ? 0 : 255,
fgcolor.green() > 127 ? 0 : 255,
fgcolor.blue() > 127 ? 0 : 255);
painter->setPen(QPen(bgcolor, penWidth, Qt::SolidLine));
painter->setBrush(Qt::NoBrush);
painter->drawRect(item->boundingRect().adjusted(pad, pad, -pad, -pad));
painter->setPen(QPen(option->palette.windowText(), 0, Qt::DashLine));
painter->setBrush(Qt::NoBrush);
painter->drawRect(item->boundingRect().adjusted(pad, pad, -pad, -pad));
}
/*!
\class QGraphicsObject
\brief The QGraphicsObject class provides a base class for all graphics items that
require signals, slots and properties.
\since 4.6
\ingroup graphicsview-api
\inmodule QtWidgets
The class extends a QGraphicsItem with QObject's signal/slot and property mechanisms.
It maps many of QGraphicsItem's basic setters and getters to properties and adds notification
signals for many of them.
\section1 Parents and Children
Each graphics object can be constructed with a parent item. This ensures that the
item will be destroyed when its parent item is destroyed. Although QGraphicsObject
inherits from both QObject and QGraphicsItem, you should use the functions provided
by QGraphicsItem, \e not QObject, to manage the relationships between parent and
child items.
The relationships between items can be explored using the parentItem() and childItems()
functions. In the hierarchy of items in a scene, the parentObject() and parentWidget()
functions are the equivalent of the QWidget::parent() and QWidget::parentWidget()
functions for QWidget subclasses.
\sa QGraphicsWidget
*/
/*!
Constructs a QGraphicsObject with \a parent.
*/
QGraphicsObject::QGraphicsObject(QGraphicsItem *parent)
: QGraphicsItem(parent)
{
QGraphicsItem::d_ptr->isObject = true;
}
/*!
\internal
*/
QGraphicsObject::QGraphicsObject(QGraphicsItemPrivate &dd, QGraphicsItem *parent)
: QGraphicsItem(dd, parent)
{
QGraphicsItem::d_ptr->isObject = true;
}
/*!
Destructor.
*/
QGraphicsObject::~QGraphicsObject()
{
}
/*!
\reimp
*/
bool QGraphicsObject::event(QEvent *ev)
{
if (ev->type() == QEvent::StyleAnimationUpdate) {
if (isVisible()) {
ev->accept();
update();
}
return true;
}
return QObject::event(ev);
}
#ifndef QT_NO_GESTURES
/*!
Subscribes the graphics object to the given \a gesture with specific \a flags.
\sa ungrabGesture(), QGestureEvent
*/
void QGraphicsObject::grabGesture(Qt::GestureType gesture, Qt::GestureFlags flags)
{
bool contains = QGraphicsItem::d_ptr->gestureContext.contains(gesture);
QGraphicsItem::d_ptr->gestureContext.insert(gesture, flags);
if (!contains && QGraphicsItem::d_ptr->scene)
QGraphicsItem::d_ptr->scene->d_func()->grabGesture(this, gesture);
}
/*!
Unsubscribes the graphics object from the given \a gesture.
\sa grabGesture(), QGestureEvent
*/
void QGraphicsObject::ungrabGesture(Qt::GestureType gesture)
{
if (QGraphicsItem::d_ptr->gestureContext.remove(gesture) && QGraphicsItem::d_ptr->scene)
QGraphicsItem::d_ptr->scene->d_func()->ungrabGesture(this, gesture);
}
#endif // QT_NO_GESTURES
/*!
Updates the item's micro focus. This is slot for convenience.
\since 4.7
\sa QInputMethod
*/
void QGraphicsObject::updateMicroFocus()
{
QGraphicsItem::updateMicroFocus();
}
void QGraphicsItemPrivate::children_append(QDeclarativeListProperty<QGraphicsObject> *list, QGraphicsObject *item)
{
if (item) {
QGraphicsObject *graphicsObject = static_cast<QGraphicsObject *>(list->object);
if (QGraphicsItemPrivate::get(graphicsObject)->sendParentChangeNotification) {
item->setParentItem(graphicsObject);
} else {
QGraphicsItemPrivate::get(item)->setParentItemHelper(graphicsObject, nullptr, nullptr);
}
}
}
int QGraphicsItemPrivate::children_count(QDeclarativeListProperty<QGraphicsObject> *list)
{
QGraphicsItemPrivate *d = QGraphicsItemPrivate::get(static_cast<QGraphicsObject *>(list->object));
return d->children.count();
}
QGraphicsObject *QGraphicsItemPrivate::children_at(QDeclarativeListProperty<QGraphicsObject> *list, int index)
{
QGraphicsItemPrivate *d = QGraphicsItemPrivate::get(static_cast<QGraphicsObject *>(list->object));
if (index >= 0 && index < d->children.count())
return d->children.at(index)->toGraphicsObject();
else
return nullptr;
}
void QGraphicsItemPrivate::children_clear(QDeclarativeListProperty<QGraphicsObject> *list)
{
QGraphicsItemPrivate *d = QGraphicsItemPrivate::get(static_cast<QGraphicsObject *>(list->object));
int childCount = d->children.count();
if (d->sendParentChangeNotification) {
for (int index = 0; index < childCount; index++)
d->children.at(0)->setParentItem(nullptr);
} else {
for (int index = 0; index < childCount; index++)
QGraphicsItemPrivate::get(d->children.at(0))->setParentItemHelper(nullptr, nullptr, nullptr);
}
}
/*!
Returns a list of this item's children.
The items are sorted by stacking order. This takes into account both the
items' insertion order and their Z-values.
*/
QDeclarativeListProperty<QGraphicsObject> QGraphicsItemPrivate::childrenList()
{
Q_Q(QGraphicsItem);
if (isObject) {
QGraphicsObject *that = static_cast<QGraphicsObject *>(q);
return QDeclarativeListProperty<QGraphicsObject>(that, &children, children_append,
children_count, children_at, children_clear);
} else {
//QGraphicsItem is not supported for this property
return QDeclarativeListProperty<QGraphicsObject>();
}
}
/*!
\internal
Returns the width of the item
Reimplemented by QGraphicsWidget
*/
qreal QGraphicsItemPrivate::width() const
{
return 0;
}
/*!
\internal
Set the width of the item
Reimplemented by QGraphicsWidget
*/
void QGraphicsItemPrivate::setWidth(qreal w)
{
Q_UNUSED(w);
}
/*!
\internal
Reset the width of the item
Reimplemented by QGraphicsWidget
*/
void QGraphicsItemPrivate::resetWidth()
{
}
/*!
\internal
Returns the height of the item
Reimplemented by QGraphicsWidget
*/
qreal QGraphicsItemPrivate::height() const
{
return 0;
}
/*!
\internal
Set the height of the item
Reimplemented by QGraphicsWidget
*/
void QGraphicsItemPrivate::setHeight(qreal h)
{
Q_UNUSED(h);
}
/*!
\internal
Reset the height of the item
Reimplemented by QGraphicsWidget
*/
void QGraphicsItemPrivate::resetHeight()
{
}
/*!
\property QGraphicsObject::children
\since 4.7
\internal
*/
/*!
\property QGraphicsObject::width
\since 4.7
\internal
*/
/*!
\property QGraphicsObject::height
\since 4.7
\internal
*/
/*!
\property QGraphicsObject::parent
\brief the parent of the item
\note The item's parent is set independently of the parent object returned
by QObject::parent().
\sa QGraphicsItem::setParentItem(), QGraphicsItem::parentObject()
*/
/*!
\property QGraphicsObject::opacity
\brief the opacity of the item
\sa QGraphicsItem::setOpacity(), QGraphicsItem::opacity()
*/
/*!
\fn QGraphicsObject::opacityChanged()
This signal gets emitted whenever the opacity of the item changes
\sa QGraphicsItem::opacity()
*/
/*!
\fn QGraphicsObject::parentChanged()
This signal gets emitted whenever the parent of the item changes
*/
/*!
\property QGraphicsObject::pos
\brief the position of the item
Describes the items position.
\sa QGraphicsItem::setPos(), QGraphicsItem::pos()
*/
/*!
\property QGraphicsObject::x
\brief the x position of the item
Describes the items x position.
\sa QGraphicsItem::setX(), setPos()
*/
/*!
\fn QGraphicsObject::xChanged()
This signal gets emitted whenever the x position of the item changes
\sa pos()
*/
/*!
\property QGraphicsObject::y
\brief the y position of the item
Describes the items y position.
\sa QGraphicsItem::setY(), setPos()
*/
/*!
\fn QGraphicsObject::yChanged()
This signal gets emitted whenever the y position of the item changes.
\sa pos()
*/
/*!
\property QGraphicsObject::z
\brief the z value of the item
Describes the items z value.
\sa QGraphicsItem::setZValue(), zValue()
*/
/*!
\fn QGraphicsObject::zChanged()
This signal gets emitted whenever the z value of the item changes.
\sa pos()
*/
/*!
\property QGraphicsObject::rotation
This property holds the rotation of the item in degrees.
This specifies how many degrees to rotate the item around its transformOrigin.
The default rotation is 0 degrees (i.e. not rotated at all).
*/
/*!
\fn QGraphicsObject::rotationChanged()
This signal gets emitted whenever the roation of the item changes.
*/
/*!
\property QGraphicsObject::scale
This property holds the scale of the item.
A scale of less than 1 means the item will be displayed smaller than
normal, and a scale of greater than 1 means the item will be
displayed larger than normal. A negative scale means the item will
be mirrored.
By default, items are displayed at a scale of 1 (i.e. at their
normal size).
Scaling is from the item's transformOrigin.
*/
/*!
\fn void QGraphicsObject::scaleChanged()
This signal is emitted when the scale of the item changes.
*/
/*!
\property QGraphicsObject::enabled
\brief whether the item is enabled or not
This property is declared in QGraphicsItem.
By default, this property is \c true.
\sa QGraphicsItem::isEnabled(), QGraphicsItem::setEnabled()
*/
/*!
\fn void QGraphicsObject::enabledChanged()
This signal gets emitted whenever the item get's enabled or disabled.
\sa isEnabled()
*/
/*!
\property QGraphicsObject::visible
\brief whether the item is visible or not
This property is declared in QGraphicsItem.
By default, this property is \c true.
\sa QGraphicsItem::isVisible(), QGraphicsItem::setVisible()
*/
/*!
\fn QGraphicsObject::visibleChanged()
This signal gets emitted whenever the visibility of the item changes
\sa visible
*/
/*!
\property QGraphicsObject::transformOriginPoint
\brief the transformation origin
This property sets a specific point in the items coordiante system as the
origin for scale and rotation.
\sa scale, rotation, QGraphicsItem::transformOriginPoint()
*/
/*!
\fn void QGraphicsObject::widthChanged()
\internal
*/
/*!
\fn void QGraphicsObject::heightChanged()
\internal
*/
/*!
\fn QGraphicsObject::childrenChanged()
This signal gets emitted whenever the children list changes
\internal
*/
/*!
\property QGraphicsObject::effect
\since 4.7
\brief the effect attached to this item
\sa QGraphicsItem::setGraphicsEffect(), QGraphicsItem::graphicsEffect()
*/
/*!
\class QAbstractGraphicsShapeItem
\brief The QAbstractGraphicsShapeItem class provides a common base for
all path items.
\since 4.2
\ingroup graphicsview-api
\inmodule QtWidgets
This class does not fully implement an item by itself; in particular, it
does not implement boundingRect() and paint(), which are inherited by
QGraphicsItem.
You can subclass this item to provide a simple base implementation of
accessors for the item's pen and brush.
\sa QGraphicsRectItem, QGraphicsEllipseItem, QGraphicsPathItem,
QGraphicsPolygonItem, QGraphicsTextItem, QGraphicsLineItem,
QGraphicsPixmapItem, {Graphics View Framework}
*/
class QAbstractGraphicsShapeItemPrivate : public QGraphicsItemPrivate
{
Q_DECLARE_PUBLIC(QAbstractGraphicsShapeItem)
public:
QBrush brush;
QPen pen;
// Cached bounding rectangle
mutable QRectF boundingRect;
};
/*!
Constructs a QAbstractGraphicsShapeItem. \a parent is passed to
QGraphicsItem's constructor.
*/
QAbstractGraphicsShapeItem::QAbstractGraphicsShapeItem(QGraphicsItem *parent)
: QGraphicsItem(*new QAbstractGraphicsShapeItemPrivate, parent)
{
}
/*!
\internal
*/
QAbstractGraphicsShapeItem::QAbstractGraphicsShapeItem(QAbstractGraphicsShapeItemPrivate &dd, QGraphicsItem *parent)
: QGraphicsItem(dd, parent)
{
}
/*!
Destroys a QAbstractGraphicsShapeItem.
*/
QAbstractGraphicsShapeItem::~QAbstractGraphicsShapeItem()
{
}
/*!
Returns the item's pen. If no pen has been set, this function returns
QPen(), a default black solid line pen with 1 width.
*/
QPen QAbstractGraphicsShapeItem::pen() const
{
Q_D(const QAbstractGraphicsShapeItem);
return d->pen;
}
/*!
Sets the pen for this item to \a pen.
The pen is used to draw the item's outline.
\sa pen()
*/
void QAbstractGraphicsShapeItem::setPen(const QPen &pen)
{
Q_D(QAbstractGraphicsShapeItem);
if (d->pen == pen)
return;
prepareGeometryChange();
d->pen = pen;
d->boundingRect = QRectF();
update();
}
/*!
Returns the item's brush, or an empty brush if no brush has been set.
\sa setBrush()
*/
QBrush QAbstractGraphicsShapeItem::brush() const
{
Q_D(const QAbstractGraphicsShapeItem);
return d->brush;
}
/*!
Sets the item's brush to \a brush.
The item's brush is used to fill the item.
If you use a brush with a QGradient, the gradient
is relative to the item's coordinate system.
\sa brush()
*/
void QAbstractGraphicsShapeItem::setBrush(const QBrush &brush)
{
Q_D(QAbstractGraphicsShapeItem);
if (d->brush == brush)
return;
d->brush = brush;
update();
}
/*!
\reimp
*/
bool QAbstractGraphicsShapeItem::isObscuredBy(const QGraphicsItem *item) const
{
return QGraphicsItem::isObscuredBy(item);
}
/*!
\reimp
*/
QPainterPath QAbstractGraphicsShapeItem::opaqueArea() const
{
Q_D(const QAbstractGraphicsShapeItem);
if (d->brush.isOpaque())
return isClipped() ? clipPath() : shape();
return QGraphicsItem::opaqueArea();
}
/*!
\class QGraphicsPathItem
\brief The QGraphicsPathItem class provides a path item that you
can add to a QGraphicsScene.
\since 4.2
\ingroup graphicsview-api
\inmodule QtWidgets
To set the item's path, pass a QPainterPath to QGraphicsPathItem's
constructor, or call the setPath() function. The path() function
returns the current path.
\image graphicsview-pathitem.png
QGraphicsPathItem uses the path to provide a reasonable
implementation of boundingRect(), shape(), and contains(). The
paint() function draws the path using the item's associated pen
and brush, which you can set by calling the setPen() and
setBrush() functions.
\sa QGraphicsRectItem, QGraphicsEllipseItem, QGraphicsPolygonItem,
QGraphicsTextItem, QGraphicsLineItem, QGraphicsPixmapItem, {Graphics
View Framework}
*/
class QGraphicsPathItemPrivate : public QAbstractGraphicsShapeItemPrivate
{
Q_DECLARE_PUBLIC(QGraphicsPathItem)
public:
QPainterPath path;
};
/*!
Constructs a QGraphicsPath item using \a path as the default path. \a
parent is passed to QAbstractGraphicsShapeItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsPathItem::QGraphicsPathItem(const QPainterPath &path,
QGraphicsItem *parent)
: QAbstractGraphicsShapeItem(*new QGraphicsPathItemPrivate, parent)
{
if (!path.isEmpty())
setPath(path);
}
/*!
Constructs a QGraphicsPath. \a parent is passed to
QAbstractGraphicsShapeItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsPathItem::QGraphicsPathItem(QGraphicsItem *parent)
: QAbstractGraphicsShapeItem(*new QGraphicsPathItemPrivate, parent)
{
}
/*!
Destroys the QGraphicsPathItem.
*/
QGraphicsPathItem::~QGraphicsPathItem()
{
}
/*!
Returns the item's path as a QPainterPath. If no item has been set, an
empty QPainterPath is returned.
\sa setPath()
*/
QPainterPath QGraphicsPathItem::path() const
{
Q_D(const QGraphicsPathItem);
return d->path;
}
/*!
Sets the item's path to be the given \a path.
\sa path()
*/
void QGraphicsPathItem::setPath(const QPainterPath &path)
{
Q_D(QGraphicsPathItem);
if (d->path == path)
return;
prepareGeometryChange();
d->path = path;
d->boundingRect = QRectF();
update();
}
/*!
\reimp
*/
QRectF QGraphicsPathItem::boundingRect() const
{
Q_D(const QGraphicsPathItem);
if (d->boundingRect.isNull()) {
qreal pw = pen().style() == Qt::NoPen ? qreal(0) : pen().widthF();
if (pw == 0.0)
d->boundingRect = d->path.controlPointRect();
else {
d->boundingRect = shape().controlPointRect();
}
}
return d->boundingRect;
}
/*!
\reimp
*/
QPainterPath QGraphicsPathItem::shape() const
{
Q_D(const QGraphicsPathItem);
return qt_graphicsItem_shapeFromPath(d->path, d->pen);
}
/*!
\reimp
*/
bool QGraphicsPathItem::contains(const QPointF &point) const
{
return QAbstractGraphicsShapeItem::contains(point);
}
/*!
\reimp
*/
void QGraphicsPathItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option,
QWidget *widget)
{
Q_D(QGraphicsPathItem);
Q_UNUSED(widget);
painter->setPen(d->pen);
painter->setBrush(d->brush);
painter->drawPath(d->path);
if (option->state & QStyle::State_Selected)
qt_graphicsItem_highlightSelected(this, painter, option);
}
/*!
\reimp
*/
bool QGraphicsPathItem::isObscuredBy(const QGraphicsItem *item) const
{
return QAbstractGraphicsShapeItem::isObscuredBy(item);
}
/*!
\reimp
*/
QPainterPath QGraphicsPathItem::opaqueArea() const
{
return QAbstractGraphicsShapeItem::opaqueArea();
}
/*!
\reimp
*/
int QGraphicsPathItem::type() const
{
return Type;
}
/*!
\internal
*/
bool QGraphicsPathItem::supportsExtension(Extension extension) const
{
Q_UNUSED(extension);
return false;
}
/*!
\internal
*/
void QGraphicsPathItem::setExtension(Extension extension, const QVariant &variant)
{
Q_UNUSED(extension);
Q_UNUSED(variant);
}
/*!
\internal
*/
QVariant QGraphicsPathItem::extension(const QVariant &variant) const
{
Q_UNUSED(variant);
return QVariant();
}
/*!
\class QGraphicsRectItem
\brief The QGraphicsRectItem class provides a rectangle item that you
can add to a QGraphicsScene.
\since 4.2
\ingroup graphicsview-api
\inmodule QtWidgets
To set the item's rectangle, pass a QRectF to QGraphicsRectItem's
constructor, or call the setRect() function. The rect() function
returns the current rectangle.
\image graphicsview-rectitem.png
QGraphicsRectItem uses the rectangle and the pen width to provide
a reasonable implementation of boundingRect(), shape(), and
contains(). The paint() function draws the rectangle using the
item's associated pen and brush, which you can set by calling the
setPen() and setBrush() functions.
\note The rendering of invalid rectangles, such as those with negative
widths or heights, is undefined. If you cannot be sure that you are
using valid rectangles (for example, if you are creating
rectangles using data from an unreliable source) then you should
use QRectF::normalized() to create normalized rectangles, and use
those instead.
\sa QGraphicsPathItem, QGraphicsEllipseItem, QGraphicsPolygonItem,
QGraphicsTextItem, QGraphicsLineItem, QGraphicsPixmapItem, {Graphics
View Framework}
*/
class QGraphicsRectItemPrivate : public QAbstractGraphicsShapeItemPrivate
{
Q_DECLARE_PUBLIC(QGraphicsRectItem)
public:
QRectF rect;
};
/*!
Constructs a QGraphicsRectItem, using \a rect as the default rectangle.
\a parent is passed to QAbstractGraphicsShapeItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsRectItem::QGraphicsRectItem(const QRectF &rect, QGraphicsItem *parent)
: QAbstractGraphicsShapeItem(*new QGraphicsRectItemPrivate, parent)
{
setRect(rect);
}
/*!
\fn QGraphicsRectItem::QGraphicsRectItem(qreal x, qreal y, qreal width, qreal height,
QGraphicsItem *parent)
Constructs a QGraphicsRectItem with a default rectangle defined
by (\a x, \a y) and the given \a width and \a height.
\a parent is passed to QAbstractGraphicsShapeItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsRectItem::QGraphicsRectItem(qreal x, qreal y, qreal w, qreal h,
QGraphicsItem *parent)
: QAbstractGraphicsShapeItem(*new QGraphicsRectItemPrivate, parent)
{
setRect(QRectF(x, y, w, h));
}
/*!
Constructs a QGraphicsRectItem. \a parent is passed to
QAbstractGraphicsShapeItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsRectItem::QGraphicsRectItem(QGraphicsItem *parent)
: QAbstractGraphicsShapeItem(*new QGraphicsRectItemPrivate, parent)
{
}
/*!
Destroys the QGraphicsRectItem.
*/
QGraphicsRectItem::~QGraphicsRectItem()
{
}
/*!
Returns the item's rectangle.
\sa setRect()
*/
QRectF QGraphicsRectItem::rect() const
{
Q_D(const QGraphicsRectItem);
return d->rect;
}
/*!
\fn void QGraphicsRectItem::setRect(const QRectF &rectangle)
Sets the item's rectangle to be the given \a rectangle.
\sa rect()
*/
void QGraphicsRectItem::setRect(const QRectF &rect)
{
Q_D(QGraphicsRectItem);
if (d->rect == rect)
return;
prepareGeometryChange();
d->rect = rect;
d->boundingRect = QRectF();
update();
}
/*!
\fn void QGraphicsRectItem::setRect(qreal x, qreal y, qreal width, qreal height)
\fn void QGraphicsEllipseItem::setRect(qreal x, qreal y, qreal width, qreal height)
Sets the item's rectangle to the rectangle defined by (\a x, \a y)
and the given \a width and \a height.
This convenience function is equivalent to calling \c
{setRect(QRectF(x, y, width, height))}
\sa rect()
*/
/*!
\reimp
*/
QRectF QGraphicsRectItem::boundingRect() const
{
Q_D(const QGraphicsRectItem);
if (d->boundingRect.isNull()) {
qreal halfpw = pen().style() == Qt::NoPen ? qreal(0) : pen().widthF() / 2;
d->boundingRect = d->rect;
if (halfpw > 0.0)
d->boundingRect.adjust(-halfpw, -halfpw, halfpw, halfpw);
}
return d->boundingRect;
}
/*!
\reimp
*/
QPainterPath QGraphicsRectItem::shape() const
{
Q_D(const QGraphicsRectItem);
QPainterPath path;
path.addRect(d->rect);
return qt_graphicsItem_shapeFromPath(path, d->pen);
}
/*!
\reimp
*/
bool QGraphicsRectItem::contains(const QPointF &point) const
{
return QAbstractGraphicsShapeItem::contains(point);
}
/*!
\reimp
*/
void QGraphicsRectItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option,
QWidget *widget)
{
Q_D(QGraphicsRectItem);
Q_UNUSED(widget);
painter->setPen(d->pen);
painter->setBrush(d->brush);
painter->drawRect(d->rect);
if (option->state & QStyle::State_Selected)
qt_graphicsItem_highlightSelected(this, painter, option);
}
/*!
\reimp
*/
bool QGraphicsRectItem::isObscuredBy(const QGraphicsItem *item) const
{
return QAbstractGraphicsShapeItem::isObscuredBy(item);
}
/*!
\reimp
*/
QPainterPath QGraphicsRectItem::opaqueArea() const
{
return QAbstractGraphicsShapeItem::opaqueArea();
}
/*!
\reimp
*/
int QGraphicsRectItem::type() const
{
return Type;
}
/*!
\internal
*/
bool QGraphicsRectItem::supportsExtension(Extension extension) const
{
Q_UNUSED(extension);
return false;
}
/*!
\internal
*/
void QGraphicsRectItem::setExtension(Extension extension, const QVariant &variant)
{
Q_UNUSED(extension);
Q_UNUSED(variant);
}
/*!
\internal
*/
QVariant QGraphicsRectItem::extension(const QVariant &variant) const
{
Q_UNUSED(variant);
return QVariant();
}
/*!
\class QGraphicsEllipseItem
\brief The QGraphicsEllipseItem class provides an ellipse item that you
can add to a QGraphicsScene.
\since 4.2
\ingroup graphicsview-api
\inmodule QtWidgets
QGraphicsEllipseItem respresents an ellipse with a fill and an outline,
and you can also use it for ellipse segments (see startAngle(),
spanAngle()).
\table
\row
\li \inlineimage graphicsview-ellipseitem.png
\li \inlineimage graphicsview-ellipseitem-pie.png
\endtable
To set the item's ellipse, pass a QRectF to QGraphicsEllipseItem's
constructor, or call setRect(). The rect() function returns the
current ellipse geometry.
QGraphicsEllipseItem uses the rect and the pen width to provide a
reasonable implementation of boundingRect(), shape(), and contains(). The
paint() function draws the ellipse using the item's associated pen and
brush, which you can set by calling setPen() and setBrush().
\sa QGraphicsPathItem, QGraphicsRectItem, QGraphicsPolygonItem,
QGraphicsTextItem, QGraphicsLineItem, QGraphicsPixmapItem, {Graphics
View Framework}
*/
class QGraphicsEllipseItemPrivate : public QAbstractGraphicsShapeItemPrivate
{
Q_DECLARE_PUBLIC(QGraphicsEllipseItem)
public:
inline QGraphicsEllipseItemPrivate()
: startAngle(0), spanAngle(360 * 16)
{ }
QRectF rect;
int startAngle;
int spanAngle;
};
/*!
Constructs a QGraphicsEllipseItem using \a rect as the default rectangle.
\a parent is passed to QAbstractGraphicsShapeItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsEllipseItem::QGraphicsEllipseItem(const QRectF &rect, QGraphicsItem *parent)
: QAbstractGraphicsShapeItem(*new QGraphicsEllipseItemPrivate, parent)
{
setRect(rect);
}
/*!
\fn QGraphicsEllipseItem::QGraphicsEllipseItem(qreal x, qreal y, qreal width, qreal height, QGraphicsItem *parent)
\since 4.3
Constructs a QGraphicsEllipseItem using the rectangle defined by (\a x, \a
y) and the given \a width and \a height, as the default rectangle. \a
parent is passed to QAbstractGraphicsShapeItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsEllipseItem::QGraphicsEllipseItem(qreal x, qreal y, qreal w, qreal h,
QGraphicsItem *parent)
: QAbstractGraphicsShapeItem(*new QGraphicsEllipseItemPrivate, parent)
{
setRect(x,y,w,h);
}
/*!
Constructs a QGraphicsEllipseItem. \a parent is passed to
QAbstractGraphicsShapeItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsEllipseItem::QGraphicsEllipseItem(QGraphicsItem *parent)
: QAbstractGraphicsShapeItem(*new QGraphicsEllipseItemPrivate, parent)
{
}
/*!
Destroys the QGraphicsEllipseItem.
*/
QGraphicsEllipseItem::~QGraphicsEllipseItem()
{
}
/*!
Returns the item's ellipse geometry as a QRectF.
\sa setRect(), QPainter::drawEllipse()
*/
QRectF QGraphicsEllipseItem::rect() const
{
Q_D(const QGraphicsEllipseItem);
return d->rect;
}
/*!
Sets the item's ellipse geometry to \a rect. The rectangle's left edge
defines the left edge of the ellipse, and the rectangle's top edge
describes the top of the ellipse. The height and width of the rectangle
describe the height and width of the ellipse.
\sa rect(), QPainter::drawEllipse()
*/
void QGraphicsEllipseItem::setRect(const QRectF &rect)
{
Q_D(QGraphicsEllipseItem);
if (d->rect == rect)
return;
prepareGeometryChange();
d->rect = rect;
d->boundingRect = QRectF();
update();
}
/*!
Returns the start angle for an ellipse segment in 16ths of a degree. This
angle is used together with spanAngle() for representing an ellipse
segment (a pie). By default, the start angle is 0.
\sa setStartAngle(), spanAngle()
*/
int QGraphicsEllipseItem::startAngle() const
{
Q_D(const QGraphicsEllipseItem);
return d->startAngle;
}
/*!
Sets the start angle for an ellipse segment to \a angle, which is in 16ths
of a degree. This angle is used together with spanAngle() for representing
an ellipse segment (a pie). By default, the start angle is 0.
\sa startAngle(), setSpanAngle(), QPainter::drawPie()
*/
void QGraphicsEllipseItem::setStartAngle(int angle)
{
Q_D(QGraphicsEllipseItem);
if (angle != d->startAngle) {
prepareGeometryChange();
d->boundingRect = QRectF();
d->startAngle = angle;
update();
}
}
/*!
Returns the span angle of an ellipse segment in 16ths of a degree. This
angle is used together with startAngle() for representing an ellipse
segment (a pie). By default, this function returns 5760 (360 * 16, a full
ellipse).
\sa setSpanAngle(), startAngle()
*/
int QGraphicsEllipseItem::spanAngle() const
{
Q_D(const QGraphicsEllipseItem);
return d->spanAngle;
}
/*!
Sets the span angle for an ellipse segment to \a angle, which is in 16ths
of a degree. This angle is used together with startAngle() to represent an
ellipse segment (a pie). By default, the span angle is 5760 (360 * 16, a
full ellipse).
\sa spanAngle(), setStartAngle(), QPainter::drawPie()
*/
void QGraphicsEllipseItem::setSpanAngle(int angle)
{
Q_D(QGraphicsEllipseItem);
if (angle != d->spanAngle) {
prepareGeometryChange();
d->boundingRect = QRectF();
d->spanAngle = angle;
update();
}
}
/*!
\reimp
*/
QRectF QGraphicsEllipseItem::boundingRect() const
{
Q_D(const QGraphicsEllipseItem);
if (d->boundingRect.isNull()) {
qreal pw = pen().style() == Qt::NoPen ? qreal(0) : pen().widthF();
if (pw == 0.0 && d->spanAngle == 360 * 16)
d->boundingRect = d->rect;
else
d->boundingRect = shape().controlPointRect();
}
return d->boundingRect;
}
/*!
\reimp
*/
QPainterPath QGraphicsEllipseItem::shape() const
{
Q_D(const QGraphicsEllipseItem);
QPainterPath path;
if (d->rect.isNull())
return path;
if (d->spanAngle != 360 * 16) {
path.moveTo(d->rect.center());
path.arcTo(d->rect, d->startAngle / 16.0, d->spanAngle / 16.0);
} else {
path.addEllipse(d->rect);
}
return qt_graphicsItem_shapeFromPath(path, d->pen);
}
/*!
\reimp
*/
bool QGraphicsEllipseItem::contains(const QPointF &point) const
{
return QAbstractGraphicsShapeItem::contains(point);
}
/*!
\reimp
*/
void QGraphicsEllipseItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option,
QWidget *widget)
{
Q_D(QGraphicsEllipseItem);
Q_UNUSED(widget);
painter->setPen(d->pen);
painter->setBrush(d->brush);
if ((d->spanAngle != 0) && (qAbs(d->spanAngle) % (360 * 16) == 0))
painter->drawEllipse(d->rect);
else
painter->drawPie(d->rect, d->startAngle, d->spanAngle);
if (option->state & QStyle::State_Selected)
qt_graphicsItem_highlightSelected(this, painter, option);
}
/*!
\reimp
*/
bool QGraphicsEllipseItem::isObscuredBy(const QGraphicsItem *item) const
{
return QAbstractGraphicsShapeItem::isObscuredBy(item);
}
/*!
\reimp
*/
QPainterPath QGraphicsEllipseItem::opaqueArea() const
{
return QAbstractGraphicsShapeItem::opaqueArea();
}
/*!
\reimp
*/
int QGraphicsEllipseItem::type() const
{
return Type;
}
/*!
\internal
*/
bool QGraphicsEllipseItem::supportsExtension(Extension extension) const
{
Q_UNUSED(extension);
return false;
}
/*!
\internal
*/
void QGraphicsEllipseItem::setExtension(Extension extension, const QVariant &variant)
{
Q_UNUSED(extension);
Q_UNUSED(variant);
}
/*!
\internal
*/
QVariant QGraphicsEllipseItem::extension(const QVariant &variant) const
{
Q_UNUSED(variant);
return QVariant();
}
/*!
\class QGraphicsPolygonItem
\brief The QGraphicsPolygonItem class provides a polygon item that you
can add to a QGraphicsScene.
\since 4.2
\ingroup graphicsview-api
\inmodule QtWidgets
To set the item's polygon, pass a QPolygonF to
QGraphicsPolygonItem's constructor, or call the setPolygon()
function. The polygon() function returns the current polygon.
\image graphicsview-polygonitem.png
QGraphicsPolygonItem uses the polygon and the pen width to provide
a reasonable implementation of boundingRect(), shape(), and
contains(). The paint() function draws the polygon using the
item's associated pen and brush, which you can set by calling the
setPen() and setBrush() functions.
\sa QGraphicsPathItem, QGraphicsRectItem, QGraphicsEllipseItem,
QGraphicsTextItem, QGraphicsLineItem, QGraphicsPixmapItem, {Graphics
View Framework}
*/
class QGraphicsPolygonItemPrivate : public QAbstractGraphicsShapeItemPrivate
{
Q_DECLARE_PUBLIC(QGraphicsPolygonItem)
public:
inline QGraphicsPolygonItemPrivate()
: fillRule(Qt::OddEvenFill)
{ }
QPolygonF polygon;
Qt::FillRule fillRule;
};
/*!
Constructs a QGraphicsPolygonItem with \a polygon as the default
polygon. \a parent is passed to QAbstractGraphicsShapeItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsPolygonItem::QGraphicsPolygonItem(const QPolygonF &polygon, QGraphicsItem *parent)
: QAbstractGraphicsShapeItem(*new QGraphicsPolygonItemPrivate, parent)
{
setPolygon(polygon);
}
/*!
Constructs a QGraphicsPolygonItem. \a parent is passed to
QAbstractGraphicsShapeItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsPolygonItem::QGraphicsPolygonItem(QGraphicsItem *parent)
: QAbstractGraphicsShapeItem(*new QGraphicsPolygonItemPrivate, parent)
{
}
/*!
Destroys the QGraphicsPolygonItem.
*/
QGraphicsPolygonItem::~QGraphicsPolygonItem()
{
}
/*!
Returns the item's polygon, or an empty polygon if no polygon
has been set.
\sa setPolygon()
*/
QPolygonF QGraphicsPolygonItem::polygon() const
{
Q_D(const QGraphicsPolygonItem);
return d->polygon;
}
/*!
Sets the item's polygon to be the given \a polygon.
\sa polygon()
*/
void QGraphicsPolygonItem::setPolygon(const QPolygonF &polygon)
{
Q_D(QGraphicsPolygonItem);
if (d->polygon == polygon)
return;
prepareGeometryChange();
d->polygon = polygon;
d->boundingRect = QRectF();
update();
}
/*!
Returns the fill rule of the polygon. The default fill rule is
Qt::OddEvenFill.
\sa setFillRule(), QPainterPath::fillRule(), QPainter::drawPolygon()
*/
Qt::FillRule QGraphicsPolygonItem::fillRule() const
{
Q_D(const QGraphicsPolygonItem);
return d->fillRule;
}
/*!
Sets the fill rule of the polygon to \a rule. The default fill rule is
Qt::OddEvenFill.
\sa fillRule(), QPainterPath::fillRule(), QPainter::drawPolygon()
*/
void QGraphicsPolygonItem::setFillRule(Qt::FillRule rule)
{
Q_D(QGraphicsPolygonItem);
if (rule != d->fillRule) {
d->fillRule = rule;
update();
}
}
/*!
\reimp
*/
QRectF QGraphicsPolygonItem::boundingRect() const
{
Q_D(const QGraphicsPolygonItem);
if (d->boundingRect.isNull()) {
qreal pw = pen().style() == Qt::NoPen ? qreal(0) : pen().widthF();
if (pw == 0.0)
d->boundingRect = d->polygon.boundingRect();
else
d->boundingRect = shape().controlPointRect();
}
return d->boundingRect;
}
/*!
\reimp
*/
QPainterPath QGraphicsPolygonItem::shape() const
{
Q_D(const QGraphicsPolygonItem);
QPainterPath path;
path.addPolygon(d->polygon);
return qt_graphicsItem_shapeFromPath(path, d->pen);
}
/*!
\reimp
*/
bool QGraphicsPolygonItem::contains(const QPointF &point) const
{
return QAbstractGraphicsShapeItem::contains(point);
}
/*!
\reimp
*/
void QGraphicsPolygonItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
{
Q_D(QGraphicsPolygonItem);
Q_UNUSED(widget);
painter->setPen(d->pen);
painter->setBrush(d->brush);
painter->drawPolygon(d->polygon, d->fillRule);
if (option->state & QStyle::State_Selected)
qt_graphicsItem_highlightSelected(this, painter, option);
}
/*!
\reimp
*/
bool QGraphicsPolygonItem::isObscuredBy(const QGraphicsItem *item) const
{
return QAbstractGraphicsShapeItem::isObscuredBy(item);
}
/*!
\reimp
*/
QPainterPath QGraphicsPolygonItem::opaqueArea() const
{
return QAbstractGraphicsShapeItem::opaqueArea();
}
/*!
\reimp
*/
int QGraphicsPolygonItem::type() const
{
return Type;
}
/*!
\internal
*/
bool QGraphicsPolygonItem::supportsExtension(Extension extension) const
{
Q_UNUSED(extension);
return false;
}
/*!
\internal
*/
void QGraphicsPolygonItem::setExtension(Extension extension, const QVariant &variant)
{
Q_UNUSED(extension);
Q_UNUSED(variant);
}
/*!
\internal
*/
QVariant QGraphicsPolygonItem::extension(const QVariant &variant) const
{
Q_UNUSED(variant);
return QVariant();
}
/*!
\class QGraphicsLineItem
\brief The QGraphicsLineItem class provides a line item that you can add to a
QGraphicsScene.
\since 4.2
\ingroup graphicsview-api
\inmodule QtWidgets
To set the item's line, pass a QLineF to QGraphicsLineItem's
constructor, or call the setLine() function. The line() function
returns the current line. By default the line is black with a
width of 0, but you can change this by calling setPen().
\image graphicsview-lineitem.png
QGraphicsLineItem uses the line and the pen width to provide a reasonable
implementation of boundingRect(), shape(), and contains(). The paint()
function draws the line using the item's associated pen.
\sa QGraphicsPathItem, QGraphicsRectItem, QGraphicsEllipseItem,
QGraphicsTextItem, QGraphicsPolygonItem, QGraphicsPixmapItem,
{Graphics View Framework}
*/
class QGraphicsLineItemPrivate : public QGraphicsItemPrivate
{
Q_DECLARE_PUBLIC(QGraphicsLineItem)
public:
QLineF line;
QPen pen;
};
/*!
Constructs a QGraphicsLineItem, using \a line as the default line. \a
parent is passed to QGraphicsItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsLineItem::QGraphicsLineItem(const QLineF &line, QGraphicsItem *parent)
: QGraphicsItem(*new QGraphicsLineItemPrivate, parent)
{
setLine(line);
}
/*!
Constructs a QGraphicsLineItem, using the line between (\a x1, \a y1) and
(\a x2, \a y2) as the default line. \a parent is passed to
QGraphicsItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsLineItem::QGraphicsLineItem(qreal x1, qreal y1, qreal x2, qreal y2, QGraphicsItem *parent)
: QGraphicsItem(*new QGraphicsLineItemPrivate, parent)
{
setLine(x1, y1, x2, y2);
}
/*!
Constructs a QGraphicsLineItem. \a parent is passed to QGraphicsItem's
constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsLineItem::QGraphicsLineItem(QGraphicsItem *parent)
: QGraphicsItem(*new QGraphicsLineItemPrivate, parent)
{
}
/*!
Destroys the QGraphicsLineItem.
*/
QGraphicsLineItem::~QGraphicsLineItem()
{
}
/*!
Returns the item's pen, or a black solid 0-width pen if no pen has
been set.
\sa setPen()
*/
QPen QGraphicsLineItem::pen() const
{
Q_D(const QGraphicsLineItem);
return d->pen;
}
/*!
Sets the item's pen to \a pen. If no pen is set, the line will be painted
using a black solid 0-width pen.
\sa pen()
*/
void QGraphicsLineItem::setPen(const QPen &pen)
{
Q_D(QGraphicsLineItem);
if (d->pen == pen)
return;
prepareGeometryChange();
d->pen = pen;
update();
}
/*!
Returns the item's line, or a null line if no line has been set.
\sa setLine()
*/
QLineF QGraphicsLineItem::line() const
{
Q_D(const QGraphicsLineItem);
return d->line;
}
/*!
Sets the item's line to be the given \a line.
\sa line()
*/
void QGraphicsLineItem::setLine(const QLineF &line)
{
Q_D(QGraphicsLineItem);
if (d->line == line)
return;
prepareGeometryChange();
d->line = line;
update();
}
/*!
\fn void QGraphicsLineItem::setLine(qreal x1, qreal y1, qreal x2, qreal y2)
\overload
Sets the item's line to be the line between (\a x1, \a y1) and (\a
x2, \a y2).
This is the same as calling \c {setLine(QLineF(x1, y1, x2, y2))}.
*/
/*!
\reimp
*/
QRectF QGraphicsLineItem::boundingRect() const
{
Q_D(const QGraphicsLineItem);
if (d->pen.widthF() == 0.0) {
const qreal x1 = d->line.p1().x();
const qreal x2 = d->line.p2().x();
const qreal y1 = d->line.p1().y();
const qreal y2 = d->line.p2().y();
qreal lx = qMin(x1, x2);
qreal rx = qMax(x1, x2);
qreal ty = qMin(y1, y2);
qreal by = qMax(y1, y2);
return QRectF(lx, ty, rx - lx, by - ty);
}
return shape().controlPointRect();
}
/*!
\reimp
*/
QPainterPath QGraphicsLineItem::shape() const
{
Q_D(const QGraphicsLineItem);
QPainterPath path;
if (d->line == QLineF())
return path;
path.moveTo(d->line.p1());
path.lineTo(d->line.p2());
return qt_graphicsItem_shapeFromPath(path, d->pen);
}
/*!
\reimp
*/
bool QGraphicsLineItem::contains(const QPointF &point) const
{
return QGraphicsItem::contains(point);
}
/*!
\reimp
*/
void QGraphicsLineItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
{
Q_D(QGraphicsLineItem);
Q_UNUSED(widget);
painter->setPen(d->pen);
painter->drawLine(d->line);
if (option->state & QStyle::State_Selected)
qt_graphicsItem_highlightSelected(this, painter, option);
}
/*!
\reimp
*/
bool QGraphicsLineItem::isObscuredBy(const QGraphicsItem *item) const
{
return QGraphicsItem::isObscuredBy(item);
}
/*!
\reimp
*/
QPainterPath QGraphicsLineItem::opaqueArea() const
{
return QGraphicsItem::opaqueArea();
}
/*!
\reimp
*/
int QGraphicsLineItem::type() const
{
return Type;
}
/*!
\internal
*/
bool QGraphicsLineItem::supportsExtension(Extension extension) const
{
Q_UNUSED(extension);
return false;
}
/*!
\internal
*/
void QGraphicsLineItem::setExtension(Extension extension, const QVariant &variant)
{
Q_UNUSED(extension);
Q_UNUSED(variant);
}
/*!
\internal
*/
QVariant QGraphicsLineItem::extension(const QVariant &variant) const
{
Q_UNUSED(variant);
return QVariant();
}
/*!
\class QGraphicsPixmapItem
\brief The QGraphicsPixmapItem class provides a pixmap item that you can add to
a QGraphicsScene.
\since 4.2
\ingroup graphicsview-api
\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().
\image graphicsview-pixmapitem.png
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.
\sa QGraphicsPathItem, QGraphicsRectItem, QGraphicsEllipseItem,
QGraphicsTextItem, QGraphicsPolygonItem, QGraphicsLineItem,
{Graphics View Framework}
*/
/*!
\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.
*/
extern QPainterPath qt_regionToPath(const QRegion &region);
class QGraphicsPixmapItemPrivate : public QGraphicsItemPrivate
{
Q_DECLARE_PUBLIC(QGraphicsPixmapItem)
public:
QGraphicsPixmapItemPrivate()
: transformationMode(Qt::FastTransformation),
shapeMode(QGraphicsPixmapItem::MaskShape),
hasShape(false)
{}
QPixmap pixmap;
Qt::TransformationMode transformationMode;
QPointF offset;
QGraphicsPixmapItem::ShapeMode shapeMode;
QPainterPath shape;
bool hasShape;
void updateShape()
{
shape = QPainterPath();
switch (shapeMode) {
case QGraphicsPixmapItem::MaskShape: {
QBitmap mask = pixmap.mask();
if (!mask.isNull()) {
shape = qt_regionToPath(QRegion(mask).translated(offset.toPoint()));
break;
}
Q_FALLTHROUGH();
}
case QGraphicsPixmapItem::BoundingRectShape:
shape.addRect(QRectF(offset.x(), offset.y(), pixmap.width(), pixmap.height()));
break;
case QGraphicsPixmapItem::HeuristicMaskShape:
#ifndef QT_NO_IMAGE_HEURISTIC_MASK
shape = qt_regionToPath(QRegion(pixmap.createHeuristicMask()).translated(offset.toPoint()));
#else
shape.addRect(QRectF(offset.x(), offset.y(), pixmap.width(), pixmap.height()));
#endif
break;
}
}
};
/*!
Constructs a QGraphicsPixmapItem, using \a pixmap as the default pixmap.
\a parent is passed to QGraphicsItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsPixmapItem::QGraphicsPixmapItem(const QPixmap &pixmap, QGraphicsItem *parent)
: QGraphicsItem(*new QGraphicsPixmapItemPrivate, parent)
{
setPixmap(pixmap);
}
/*!
Constructs a QGraphicsPixmapItem. \a parent is passed to QGraphicsItem's
constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsPixmapItem::QGraphicsPixmapItem(QGraphicsItem *parent)
: QGraphicsItem(*new QGraphicsPixmapItemPrivate, parent)
{
}
/*!
Destroys the QGraphicsPixmapItem.
*/
QGraphicsPixmapItem::~QGraphicsPixmapItem()
{
}
/*!
Sets the item's pixmap to \a pixmap.
\sa pixmap()
*/
void QGraphicsPixmapItem::setPixmap(const QPixmap &pixmap)
{
Q_D(QGraphicsPixmapItem);
prepareGeometryChange();
d->pixmap = pixmap;
d->hasShape = false;
update();
}
/*!
Returns the item's pixmap, or an invalid QPixmap if no pixmap has been
set.
\sa setPixmap()
*/
QPixmap QGraphicsPixmapItem::pixmap() const
{
Q_D(const QGraphicsPixmapItem);
return d->pixmap;
}
/*!
Returns the transformation mode of the pixmap. The default mode is
Qt::FastTransformation, which provides quick transformation with no
smoothing.
\sa setTransformationMode()
*/
Qt::TransformationMode QGraphicsPixmapItem::transformationMode() const
{
Q_D(const QGraphicsPixmapItem);
return d->transformationMode;
}
/*!
Sets the pixmap item's transformation mode to \a 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.
\sa transformationMode()
*/
void QGraphicsPixmapItem::setTransformationMode(Qt::TransformationMode mode)
{
Q_D(QGraphicsPixmapItem);
if (mode != d->transformationMode) {
d->transformationMode = mode;
update();
}
}
/*!
Returns the pixmap item's \e offset, which defines the point of the
top-left corner of the pixmap, in local coordinates.
\sa setOffset()
*/
QPointF QGraphicsPixmapItem::offset() const
{
Q_D(const QGraphicsPixmapItem);
return d->offset;
}
/*!
Sets the pixmap item's offset to \a offset. QGraphicsPixmapItem will draw
its pixmap using \a offset for its top-left corner.
\sa offset()
*/
void QGraphicsPixmapItem::setOffset(const QPointF &offset)
{
Q_D(QGraphicsPixmapItem);
if (d->offset == offset)
return;
prepareGeometryChange();
d->offset = offset;
d->hasShape = false;
update();
}
/*!
\fn void QGraphicsPixmapItem::setOffset(qreal x, qreal y)
\since 4.3
This convenience function is equivalent to calling setOffset(QPointF(\a x, \a y)).
*/
/*!
\reimp
*/
QRectF QGraphicsPixmapItem::boundingRect() const
{
Q_D(const QGraphicsPixmapItem);
if (d->pixmap.isNull())
return QRectF();
if (d->flags & ItemIsSelectable) {
qreal pw = 1.0;
return QRectF(d->offset, QSizeF(d->pixmap.size()) / d->pixmap.devicePixelRatio()).adjusted(-pw/2, -pw/2, pw/2, pw/2);
} else {
return QRectF(d->offset, QSizeF(d->pixmap.size()) / d->pixmap.devicePixelRatio());
}
}
/*!
\reimp
*/
QPainterPath QGraphicsPixmapItem::shape() const
{
Q_D(const QGraphicsPixmapItem);
if (!d->hasShape) {
QGraphicsPixmapItemPrivate *thatD = const_cast<QGraphicsPixmapItemPrivate *>(d);
thatD->updateShape();
thatD->hasShape = true;
}
return d_func()->shape;
}
/*!
\reimp
*/
bool QGraphicsPixmapItem::contains(const QPointF &point) const
{
return QGraphicsItem::contains(point);
}
/*!
\reimp
*/
void QGraphicsPixmapItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option,
QWidget *widget)
{
Q_D(QGraphicsPixmapItem);
Q_UNUSED(widget);
painter->setRenderHint(QPainter::SmoothPixmapTransform,
(d->transformationMode == Qt::SmoothTransformation));
painter->drawPixmap(d->offset, d->pixmap);
if (option->state & QStyle::State_Selected)
qt_graphicsItem_highlightSelected(this, painter, option);
}
/*!
\reimp
*/
bool QGraphicsPixmapItem::isObscuredBy(const QGraphicsItem *item) const
{
return QGraphicsItem::isObscuredBy(item);
}
/*!
\reimp
*/
QPainterPath QGraphicsPixmapItem::opaqueArea() const
{
return shape();
}
/*!
\reimp
*/
int QGraphicsPixmapItem::type() const
{
return Type;
}
/*!
Returns the item's shape mode. The shape mode describes how
QGraphicsPixmapItem calculates its shape. The default mode is MaskShape.
\sa setShapeMode(), ShapeMode
*/
QGraphicsPixmapItem::ShapeMode QGraphicsPixmapItem::shapeMode() const
{
return d_func()->shapeMode;
}
/*!
Sets the item's shape mode to \a mode. The shape mode describes how
QGraphicsPixmapItem calculates its shape. The default mode is MaskShape.
\sa shapeMode(), ShapeMode
*/
void QGraphicsPixmapItem::setShapeMode(ShapeMode mode)
{
Q_D(QGraphicsPixmapItem);
if (d->shapeMode == mode)
return;
d->shapeMode = mode;
d->hasShape = false;
}
/*!
\internal
*/
bool QGraphicsPixmapItem::supportsExtension(Extension extension) const
{
Q_UNUSED(extension);
return false;
}
/*!
\internal
*/
void QGraphicsPixmapItem::setExtension(Extension extension, const QVariant &variant)
{
Q_UNUSED(extension);
Q_UNUSED(variant);
}
/*!
\internal
*/
QVariant QGraphicsPixmapItem::extension(const QVariant &variant) const
{
Q_UNUSED(variant);
return QVariant();
}
/*!
\class QGraphicsTextItem
\brief The QGraphicsTextItem class provides a text item that you can add to
a QGraphicsScene to display formatted text.
\since 4.2
\ingroup graphicsview-api
\inmodule QtWidgets
If you only need to show plain text in an item, consider using QGraphicsSimpleTextItem
instead.
To set the item's text, pass a QString to QGraphicsTextItem's
constructor, or call setHtml()/setPlainText().
QGraphicsTextItem uses the text's formatted size and the associated font
to provide a reasonable implementation of boundingRect(), shape(),
and contains(). You can set the font by calling setFont().
It is possible to make the item editable by setting the Qt::TextEditorInteraction flag
using setTextInteractionFlags().
The item's preferred text width can be set using setTextWidth() and obtained
using textWidth().
\note In order to align HTML text in the center, the item's text width must be set.
Otherwise, you can call adjustSize() after setting the item's text.
\image graphicsview-textitem.png
\note QGraphicsTextItem accepts \l{QGraphicsItem::acceptHoverEvents()}{hover events}
by default. You can change this with \l{QGraphicsItem::}{setAcceptHoverEvents()}.
\sa QGraphicsSimpleTextItem, QGraphicsPathItem, QGraphicsRectItem,
QGraphicsEllipseItem, QGraphicsPixmapItem, QGraphicsPolygonItem,
QGraphicsLineItem, {Graphics View Framework}
*/
class QGraphicsTextItemPrivate
{
public:
QGraphicsTextItemPrivate()
: control(nullptr), pageNumber(0), useDefaultImpl(false), tabChangesFocus(false), clickCausedFocus(0)
{ }
mutable QWidgetTextControl *control;
QWidgetTextControl *textControl() const;
inline QPointF controlOffset() const
{ return QPointF(0., pageNumber * control->document()->pageSize().height()); }
inline void sendControlEvent(QEvent *e)
{ if (control) control->processEvent(e, controlOffset()); }
void _q_updateBoundingRect(const QSizeF &);
void _q_update(QRectF);
void _q_ensureVisible(QRectF);
bool _q_mouseOnEdge(QGraphicsSceneMouseEvent *);
QRectF boundingRect;
int pageNumber;
bool useDefaultImpl;
bool tabChangesFocus;
uint clickCausedFocus : 1;
QGraphicsTextItem *qq;
};
/*!
Constructs a QGraphicsTextItem, using \a text as the default plain
text. \a parent is passed to QGraphicsItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsTextItem::QGraphicsTextItem(const QString &text, QGraphicsItem *parent)
: QGraphicsObject(*new QGraphicsItemPrivate, parent),
dd(new QGraphicsTextItemPrivate)
{
dd->qq = this;
if (!text.isEmpty())
setPlainText(text);
setAcceptDrops(true);
setAcceptHoverEvents(true);
setFlags(ItemUsesExtendedStyleOption);
}
/*!
Constructs a QGraphicsTextItem. \a parent is passed to QGraphicsItem's
constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsTextItem::QGraphicsTextItem(QGraphicsItem *parent)
: QGraphicsObject(*new QGraphicsItemPrivate, parent),
dd(new QGraphicsTextItemPrivate)
{
dd->qq = this;
setAcceptDrops(true);
setAcceptHoverEvents(true);
setFlag(ItemUsesExtendedStyleOption);
}
/*!
Destroys the QGraphicsTextItem.
*/
QGraphicsTextItem::~QGraphicsTextItem()
{
delete dd;
}
/*!
Returns the item's text converted to HTML, or an empty QString if no text has been set.
\sa setHtml()
*/
QString QGraphicsTextItem::toHtml() const
{
#ifndef QT_NO_TEXTHTMLPARSER
if (dd->control)
return dd->control->toHtml();
#endif
return QString();
}
/*!
Sets the item's text to \a text, assuming that text is HTML formatted. If
the item has keyboard input focus, this function will also call
ensureVisible() to ensure that the text is visible in all viewports.
\sa toHtml(), hasFocus(), QGraphicsSimpleTextItem
*/
void QGraphicsTextItem::setHtml(const QString &text)
{
dd->textControl()->setHtml(text);
}
/*!
Returns the item's text converted to plain text, or an empty QString if no text has been set.
\sa setPlainText()
*/
QString QGraphicsTextItem::toPlainText() const
{
if (dd->control)
return dd->control->toPlainText();
return QString();
}
/*!
Sets the item's text to \a text. If the item has keyboard input focus,
this function will also call ensureVisible() to ensure that the text is
visible in all viewports.
\sa toHtml(), hasFocus()
*/
void QGraphicsTextItem::setPlainText(const QString &text)
{
dd->textControl()->setPlainText(text);
}
/*!
Returns the item's font, which is used to render the text.
\sa setFont()
*/
QFont QGraphicsTextItem::font() const
{
if (!dd->control)
return QFont();
return dd->control->document()->defaultFont();
}
/*!
Sets the font used to render the text item to \a font.
\sa font()
*/
void QGraphicsTextItem::setFont(const QFont &font)
{
dd->textControl()->document()->setDefaultFont(font);
}
/*!
Sets the color for unformatted text to \a col.
*/
void QGraphicsTextItem::setDefaultTextColor(const QColor &col)
{
QWidgetTextControl *c = dd->textControl();
QPalette pal = c->palette();
QColor old = pal.color(QPalette::Text);
pal.setColor(QPalette::Text, col);
c->setPalette(pal);
if (old != col)
update();
}
/*!
Returns the default text color that is used for unformatted text.
*/
QColor QGraphicsTextItem::defaultTextColor() const
{
return dd->textControl()->palette().color(QPalette::Text);
}
/*!
\reimp
*/
QRectF QGraphicsTextItem::boundingRect() const
{
return dd->boundingRect;
}
/*!
\reimp
*/
QPainterPath QGraphicsTextItem::shape() const
{
if (!dd->control)
return QPainterPath();
QPainterPath path;
path.addRect(dd->boundingRect);
return path;
}
/*!
\reimp
*/
bool QGraphicsTextItem::contains(const QPointF &point) const
{
return dd->boundingRect.contains(point);
}
/*!
\reimp
*/
void QGraphicsTextItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option,
QWidget *widget)
{
Q_UNUSED(widget);
if (dd->control) {
painter->save();
QRectF r = option->exposedRect;
painter->translate(-dd->controlOffset());
r.translate(dd->controlOffset());
QTextDocument *doc = dd->control->document();
QTextDocumentLayout *layout = qobject_cast<QTextDocumentLayout *>(doc->documentLayout());
// the layout might need to expand the root frame to
// the viewport if NoWrap is set
if (layout)
layout->setViewport(dd->boundingRect);
dd->control->drawContents(painter, r);
if (layout)
layout->setViewport(QRect());
painter->restore();
}
if (option->state & (QStyle::State_Selected | QStyle::State_HasFocus))
qt_graphicsItem_highlightSelected(this, painter, option);
}
/*!
\reimp
*/
bool QGraphicsTextItem::isObscuredBy(const QGraphicsItem *item) const
{
return QGraphicsItem::isObscuredBy(item);
}
/*!
\reimp
*/
QPainterPath QGraphicsTextItem::opaqueArea() const
{
return QGraphicsItem::opaqueArea();
}
/*!
\reimp
*/
int QGraphicsTextItem::type() const
{
return Type;
}
/*!
Sets the preferred width for the item's text. If the actual text
is wider than the specified width then it will be broken into
multiple lines.
If \a width is set to -1 then the text will not be broken into
multiple lines unless it is enforced through an explicit line
break or a new paragraph.
The default value is -1.
Note that QGraphicsTextItem keeps a QTextDocument internally,
which is used to calculate the text width.
\sa textWidth(), QTextDocument::setTextWidth()
*/
void QGraphicsTextItem::setTextWidth(qreal width)
{
dd->textControl()->setTextWidth(width);
}
/*!
Returns the text width.
The width is calculated with the QTextDocument that
QGraphicsTextItem keeps internally.
\sa setTextWidth(), QTextDocument::textWidth()
*/
qreal QGraphicsTextItem::textWidth() const
{
if (!dd->control)
return -1;
return dd->control->textWidth();
}
/*!
Adjusts the text item to a reasonable size.
*/
void QGraphicsTextItem::adjustSize()
{
if (dd->control)
dd->control->adjustSize();
}
/*!
Sets the text document \a document on the item.
*/
void QGraphicsTextItem::setDocument(QTextDocument *document)
{
dd->textControl()->setDocument(document);
dd->_q_updateBoundingRect(dd->control->size());
}
/*!
Returns the item's text document.
*/
QTextDocument *QGraphicsTextItem::document() const
{
return dd->textControl()->document();
}
/*!
\reimp
*/
bool QGraphicsTextItem::sceneEvent(QEvent *event)
{
QEvent::Type t = event->type();
if (!dd->tabChangesFocus && (t == QEvent::KeyPress || t == QEvent::KeyRelease)) {
int k = ((QKeyEvent *)event)->key();
if (k == Qt::Key_Tab || k == Qt::Key_Backtab) {
dd->sendControlEvent(event);
return true;
}
}
bool result = QGraphicsItem::sceneEvent(event);
// Ensure input context is updated.
switch (event->type()) {
case QEvent::ContextMenu:
case QEvent::FocusIn:
case QEvent::FocusOut:
case QEvent::GraphicsSceneDragEnter:
case QEvent::GraphicsSceneDragLeave:
case QEvent::GraphicsSceneDragMove:
case QEvent::GraphicsSceneDrop:
case QEvent::GraphicsSceneHoverEnter:
case QEvent::GraphicsSceneHoverLeave:
case QEvent::GraphicsSceneHoverMove:
case QEvent::GraphicsSceneMouseDoubleClick:
case QEvent::GraphicsSceneMousePress:
case QEvent::GraphicsSceneMouseMove:
case QEvent::GraphicsSceneMouseRelease:
case QEvent::KeyPress:
case QEvent::KeyRelease:
// Reset the focus widget's input context, regardless
// of how this item gained or lost focus.
if (event->type() == QEvent::FocusIn || event->type() == QEvent::FocusOut) {
QGuiApplication::inputMethod()->reset();
} else {
QGuiApplication::inputMethod()->update(Qt::ImQueryInput);
}
break;
case QEvent::ShortcutOverride:
dd->sendControlEvent(event);
return true;
default:
break;
}
return result;
}
/*!
\reimp
*/
void QGraphicsTextItem::mousePressEvent(QGraphicsSceneMouseEvent *event)
{
if ((QGraphicsItem::d_ptr->flags & (ItemIsSelectable | ItemIsMovable))
&& (event->buttons() & Qt::LeftButton) && dd->_q_mouseOnEdge(event)) {
// User left-pressed on edge of selectable/movable item, use
// base impl.
dd->useDefaultImpl = true;
} else if (event->buttons() == event->button()
&& dd->control->textInteractionFlags() == Qt::NoTextInteraction) {
// User pressed first button on non-interactive item.
dd->useDefaultImpl = true;
}
if (dd->useDefaultImpl) {
QGraphicsItem::mousePressEvent(event);
if (!event->isAccepted())
dd->useDefaultImpl = false;
return;
}
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::mouseMoveEvent(QGraphicsSceneMouseEvent *event)
{
if (dd->useDefaultImpl) {
QGraphicsItem::mouseMoveEvent(event);
return;
}
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::mouseReleaseEvent(QGraphicsSceneMouseEvent *event)
{
if (dd->useDefaultImpl) {
QGraphicsItem::mouseReleaseEvent(event);
if (dd->control->textInteractionFlags() == Qt::NoTextInteraction
&& !event->buttons()) {
// User released last button on non-interactive item.
dd->useDefaultImpl = false;
} else if ((event->buttons() & Qt::LeftButton) == 0) {
// User released the left button on an interactive item.
dd->useDefaultImpl = false;
}
return;
}
QWidget *widget = event->widget();
if (widget && (dd->control->textInteractionFlags() & Qt::TextEditable) && boundingRect().contains(event->pos())) {
qt_widget_private(widget)->handleSoftwareInputPanel(event->button(), dd->clickCausedFocus);
}
dd->clickCausedFocus = 0;
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::mouseDoubleClickEvent(QGraphicsSceneMouseEvent *event)
{
if (dd->useDefaultImpl) {
QGraphicsItem::mouseDoubleClickEvent(event);
return;
}
if (!hasFocus()) {
QGraphicsItem::mouseDoubleClickEvent(event);
return;
}
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::contextMenuEvent(QGraphicsSceneContextMenuEvent *event)
{
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::keyPressEvent(QKeyEvent *event)
{
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::keyReleaseEvent(QKeyEvent *event)
{
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::focusInEvent(QFocusEvent *event)
{
dd->sendControlEvent(event);
if (event->reason() == Qt::MouseFocusReason) {
dd->clickCausedFocus = 1;
}
update();
}
/*!
\reimp
*/
void QGraphicsTextItem::focusOutEvent(QFocusEvent *event)
{
dd->sendControlEvent(event);
update();
}
/*!
\reimp
*/
void QGraphicsTextItem::dragEnterEvent(QGraphicsSceneDragDropEvent *event)
{
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::dragLeaveEvent(QGraphicsSceneDragDropEvent *event)
{
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::dragMoveEvent(QGraphicsSceneDragDropEvent *event)
{
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::dropEvent(QGraphicsSceneDragDropEvent *event)
{
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::inputMethodEvent(QInputMethodEvent *event)
{
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::hoverEnterEvent(QGraphicsSceneHoverEvent *event)
{
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::hoverMoveEvent(QGraphicsSceneHoverEvent *event)
{
dd->sendControlEvent(event);
}
/*!
\reimp
*/
void QGraphicsTextItem::hoverLeaveEvent(QGraphicsSceneHoverEvent *event)
{
dd->sendControlEvent(event);
}
/*!
\reimp
*/
QVariant QGraphicsTextItem::inputMethodQuery(Qt::InputMethodQuery query) const
{
QVariant v;
if (query == Qt::ImHints)
v = int(inputMethodHints());
else if (dd->control)
v = dd->control->inputMethodQuery(query, QVariant());
if (v.userType() == QMetaType::QRectF)
v = v.toRectF().translated(-dd->controlOffset());
else if (v.userType() == QMetaType::QPointF)
v = v.toPointF() - dd->controlOffset();
else if (v.userType() == QMetaType::QRect)
v = v.toRect().translated(-dd->controlOffset().toPoint());
else if (v.userType() == QMetaType::QPoint)
v = v.toPoint() - dd->controlOffset().toPoint();
return v;
}
/*!
\internal
*/
bool QGraphicsTextItem::supportsExtension(Extension extension) const
{
Q_UNUSED(extension);
return false;
}
/*!
\internal
*/
void QGraphicsTextItem::setExtension(Extension extension, const QVariant &variant)
{
Q_UNUSED(extension);
Q_UNUSED(variant);
}
/*!
\internal
*/
QVariant QGraphicsTextItem::extension(const QVariant &variant) const
{
Q_UNUSED(variant);
return QVariant();
}
/*!
\internal
*/
void QGraphicsTextItemPrivate::_q_update(QRectF rect)
{
if (rect.isValid()) {
rect.translate(-controlOffset());
} else {
rect = boundingRect;
}
if (rect.intersects(boundingRect))
qq->update(rect);
}
/*!
\internal
*/
void QGraphicsTextItemPrivate::_q_updateBoundingRect(const QSizeF &size)
{
if (size != boundingRect.size()) {
qq->prepareGeometryChange();
boundingRect.setSize(size);
qq->update();
}
}
/*!
\internal
*/
void QGraphicsTextItemPrivate::_q_ensureVisible(QRectF rect)
{
if (qq->hasFocus()) {
rect.translate(-controlOffset());
qq->ensureVisible(rect, /*xmargin=*/0, /*ymargin=*/0);
}
}
QWidgetTextControl *QGraphicsTextItemPrivate::textControl() const
{
if (!control) {
QGraphicsTextItem *that = const_cast<QGraphicsTextItem *>(qq);
control = new QWidgetTextControl(that);
control->setTextInteractionFlags(Qt::NoTextInteraction);
QObject::connect(control, SIGNAL(updateRequest(QRectF)),
qq, SLOT(_q_update(QRectF)));
QObject::connect(control, SIGNAL(documentSizeChanged(QSizeF)),
qq, SLOT(_q_updateBoundingRect(QSizeF)));
QObject::connect(control, SIGNAL(visibilityRequest(QRectF)),
qq, SLOT(_q_ensureVisible(QRectF)));
QObject::connect(control, SIGNAL(linkActivated(QString)),
qq, SIGNAL(linkActivated(QString)));
QObject::connect(control, SIGNAL(linkHovered(QString)),
qq, SIGNAL(linkHovered(QString)));
const QSizeF pgSize = control->document()->pageSize();
if (pgSize.height() != -1) {
qq->prepareGeometryChange();
that->dd->boundingRect.setSize(pgSize);
qq->update();
} else {
that->dd->_q_updateBoundingRect(control->size());
}
}
return control;
}
/*!
\internal
*/
bool QGraphicsTextItemPrivate::_q_mouseOnEdge(QGraphicsSceneMouseEvent *event)
{
QPainterPath path;
path.addRect(qq->boundingRect());
QPainterPath docPath;
const QTextFrameFormat format = control->document()->rootFrame()->frameFormat();
docPath.addRect(
qq->boundingRect().adjusted(
format.leftMargin(),
format.topMargin(),
-format.rightMargin(),
-format.bottomMargin()));
return path.subtracted(docPath).contains(event->pos());
}
/*!
\fn void QGraphicsTextItem::linkActivated(const QString &link)
This signal is emitted when the user clicks on a link on a text item
that enables Qt::LinksAccessibleByMouse or Qt::LinksAccessibleByKeyboard.
\a link is the link that was clicked.
\sa setTextInteractionFlags()
*/
/*!
\fn void QGraphicsTextItem::linkHovered(const QString &link)
This signal is emitted when the user hovers over a link on a text item
that enables Qt::LinksAccessibleByMouse. \a link is
the link that was hovered over.
\sa setTextInteractionFlags()
*/
/*!
Sets the flags \a flags to specify how the text item should react to user
input.
The default for a QGraphicsTextItem is Qt::NoTextInteraction. This function
also affects the ItemIsFocusable QGraphicsItem flag by setting it if \a flags
is different from Qt::NoTextInteraction and clearing it otherwise.
By default, the text is read-only. To transform the item into an editor,
set the Qt::TextEditable flag.
*/
void QGraphicsTextItem::setTextInteractionFlags(Qt::TextInteractionFlags flags)
{
if (flags == Qt::NoTextInteraction)
setFlags(this->flags() & ~(QGraphicsItem::ItemIsFocusable | QGraphicsItem::ItemAcceptsInputMethod));
else
setFlags(this->flags() | QGraphicsItem::ItemIsFocusable | QGraphicsItem::ItemAcceptsInputMethod);
dd->textControl()->setTextInteractionFlags(flags);
}
/*!
Returns the current text interaction flags.
\sa setTextInteractionFlags()
*/
Qt::TextInteractionFlags QGraphicsTextItem::textInteractionFlags() const
{
if (!dd->control)
return Qt::NoTextInteraction;
return dd->control->textInteractionFlags();
}
/*!
\since 4.5
If \a b is true, the \uicontrol Tab key will cause the widget to change focus;
otherwise, the tab key will insert a tab into the document.
In some occasions text edits should not allow the user to input tabulators
or change indentation using the \uicontrol Tab key, as this breaks the focus
chain. The default is false.
\sa tabChangesFocus(), ItemIsFocusable, textInteractionFlags()
*/
void QGraphicsTextItem::setTabChangesFocus(bool b)
{
dd->tabChangesFocus = b;
}
/*!
\since 4.5
Returns \c true if the \uicontrol Tab key will cause the widget to change focus;
otherwise, false is returned.
By default, this behavior is disabled, and this function will return false.
\sa setTabChangesFocus()
*/
bool QGraphicsTextItem::tabChangesFocus() const
{
return dd->tabChangesFocus;
}
/*!
\property QGraphicsTextItem::openExternalLinks
Specifies whether QGraphicsTextItem should automatically open links using
QDesktopServices::openUrl() instead of emitting the
linkActivated signal.
The default value is false.
*/
void QGraphicsTextItem::setOpenExternalLinks(bool open)
{
dd->textControl()->setOpenExternalLinks(open);
}
bool QGraphicsTextItem::openExternalLinks() const
{
if (!dd->control)
return false;
return dd->control->openExternalLinks();
}
/*!
\property QGraphicsTextItem::textCursor
This property represents the visible text cursor in an editable
text item.
By default, if the item's text has not been set, this property
contains a null text cursor; otherwise it contains a text cursor
placed at the start of the item's document.
*/
void QGraphicsTextItem::setTextCursor(const QTextCursor &cursor)
{
dd->textControl()->setTextCursor(cursor);
}
QTextCursor QGraphicsTextItem::textCursor() const
{
if (!dd->control)
return QTextCursor();
return dd->control->textCursor();
}
class QGraphicsSimpleTextItemPrivate : public QAbstractGraphicsShapeItemPrivate
{
Q_DECLARE_PUBLIC(QGraphicsSimpleTextItem)
public:
inline QGraphicsSimpleTextItemPrivate() {
pen.setStyle(Qt::NoPen);
brush.setStyle(Qt::SolidPattern);
}
QString text;
QFont font;
QRectF boundingRect;
void updateBoundingRect();
};
static QRectF setupTextLayout(QTextLayout *layout)
{
layout->setCacheEnabled(true);
layout->beginLayout();
while (layout->createLine().isValid())
;
layout->endLayout();
qreal maxWidth = 0;
qreal y = 0;
for (int i = 0; i < layout->lineCount(); ++i) {
QTextLine line = layout->lineAt(i);
maxWidth = qMax(maxWidth, line.naturalTextWidth());
line.setPosition(QPointF(0, y));
y += line.height();
}
return QRectF(0, 0, maxWidth, y);
}
void QGraphicsSimpleTextItemPrivate::updateBoundingRect()
{
Q_Q(QGraphicsSimpleTextItem);
QRectF br;
if (text.isEmpty()) {
br = QRectF();
} else {
QString tmp = text;
tmp.replace(QLatin1Char('\n'), QChar::LineSeparator);
QStackTextEngine engine(tmp, font);
QTextLayout layout(&engine);
br = setupTextLayout(&layout);
}
if (br != boundingRect) {
q->prepareGeometryChange();
boundingRect = br;
q->update();
}
}
/*!
\class QGraphicsSimpleTextItem
\brief The QGraphicsSimpleTextItem class provides a simple text path item
that you can add to a QGraphicsScene.
\since 4.2
\ingroup graphicsview-api
\inmodule QtWidgets
To set the item's text, you can either pass a QString to
QGraphicsSimpleTextItem's constructor, or call setText() to change the
text later. To set the text fill color, call setBrush().
The simple text item can have both a fill and an outline; setBrush() will
set the text fill (i.e., text color), and setPen() sets the pen that will
be used to draw the text outline. (The latter can be slow, especially for
complex pens, and items with long text content.) If all you want is to
draw a simple line of text, you should call setBrush() only, and leave the
pen unset; QGraphicsSimpleTextItem's pen is by default Qt::NoPen.
QGraphicsSimpleTextItem uses the text's formatted size and the associated
font to provide a reasonable implementation of boundingRect(), shape(),
and contains(). You can set the font by calling setFont().
QGraphicsSimpleText does not display rich text; instead, you can use
QGraphicsTextItem, which provides full text control capabilities.
\image graphicsview-simpletextitem.png
\sa QGraphicsTextItem, QGraphicsPathItem, QGraphicsRectItem,
QGraphicsEllipseItem, QGraphicsPixmapItem, QGraphicsPolygonItem,
QGraphicsLineItem, {Graphics View Framework}
*/
/*!
Constructs a QGraphicsSimpleTextItem.
\a parent is passed to QGraphicsItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsSimpleTextItem::QGraphicsSimpleTextItem(QGraphicsItem *parent)
: QAbstractGraphicsShapeItem(*new QGraphicsSimpleTextItemPrivate, parent)
{
}
/*!
Constructs a QGraphicsSimpleTextItem, using \a text as the default plain text.
\a parent is passed to QGraphicsItem's constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsSimpleTextItem::QGraphicsSimpleTextItem(const QString &text, QGraphicsItem *parent)
: QAbstractGraphicsShapeItem(*new QGraphicsSimpleTextItemPrivate, parent)
{
setText(text);
}
/*!
Destroys the QGraphicsSimpleTextItem.
*/
QGraphicsSimpleTextItem::~QGraphicsSimpleTextItem()
{
}
/*!
Sets the item's text to \a text. The text will be displayed as
plain text. Newline characters ('\\n') as well as characters of
type QChar::LineSeparator will cause item to break the text into
multiple lines.
*/
void QGraphicsSimpleTextItem::setText(const QString &text)
{
Q_D(QGraphicsSimpleTextItem);
if (d->text == text)
return;
d->text = text;
d->updateBoundingRect();
update();
}
/*!
Returns the item's text.
*/
QString QGraphicsSimpleTextItem::text() const
{
Q_D(const QGraphicsSimpleTextItem);
return d->text;
}
/*!
Sets the font that is used to draw the item's text to \a font.
*/
void QGraphicsSimpleTextItem::setFont(const QFont &font)
{
Q_D(QGraphicsSimpleTextItem);
d->font = font;
d->updateBoundingRect();
}
/*!
Returns the font that is used to draw the item's text.
*/
QFont QGraphicsSimpleTextItem::font() const
{
Q_D(const QGraphicsSimpleTextItem);
return d->font;
}
/*!
\reimp
*/
QRectF QGraphicsSimpleTextItem::boundingRect() const
{
Q_D(const QGraphicsSimpleTextItem);
return d->boundingRect;
}
/*!
\reimp
*/
QPainterPath QGraphicsSimpleTextItem::shape() const
{
Q_D(const QGraphicsSimpleTextItem);
QPainterPath path;
path.addRect(d->boundingRect);
return path;
}
/*!
\reimp
*/
bool QGraphicsSimpleTextItem::contains(const QPointF &point) const
{
Q_D(const QGraphicsSimpleTextItem);
return d->boundingRect.contains(point);
}
/*!
\reimp
*/
void QGraphicsSimpleTextItem::paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget)
{
Q_UNUSED(widget);
Q_D(QGraphicsSimpleTextItem);
painter->setFont(d->font);
QString tmp = d->text;
tmp.replace(QLatin1Char('\n'), QChar::LineSeparator);
QStackTextEngine engine(tmp, d->font);
QTextLayout layout(&engine);
QPen p;
p.setBrush(d->brush);
painter->setPen(p);
if (d->pen.style() == Qt::NoPen && d->brush.style() == Qt::SolidPattern) {
painter->setBrush(Qt::NoBrush);
} else {
QTextLayout::FormatRange range;
range.start = 0;
range.length = layout.text().length();
range.format.setTextOutline(d->pen);
layout.setFormats(QVector<QTextLayout::FormatRange>(1, range));
}
setupTextLayout(&layout);
layout.draw(painter, QPointF(0, 0));
if (option->state & (QStyle::State_Selected | QStyle::State_HasFocus))
qt_graphicsItem_highlightSelected(this, painter, option);
}
/*!
\reimp
*/
bool QGraphicsSimpleTextItem::isObscuredBy(const QGraphicsItem *item) const
{
return QAbstractGraphicsShapeItem::isObscuredBy(item);
}
/*!
\reimp
*/
QPainterPath QGraphicsSimpleTextItem::opaqueArea() const
{
return QAbstractGraphicsShapeItem::opaqueArea();
}
/*!
\reimp
*/
int QGraphicsSimpleTextItem::type() const
{
return Type;
}
/*!
\internal
*/
bool QGraphicsSimpleTextItem::supportsExtension(Extension extension) const
{
Q_UNUSED(extension);
return false;
}
/*!
\internal
*/
void QGraphicsSimpleTextItem::setExtension(Extension extension, const QVariant &variant)
{
Q_UNUSED(extension);
Q_UNUSED(variant);
}
/*!
\internal
*/
QVariant QGraphicsSimpleTextItem::extension(const QVariant &variant) const
{
Q_UNUSED(variant);
return QVariant();
}
/*!
\class QGraphicsItemGroup
\brief The QGraphicsItemGroup class provides a container that treats
a group of items as a single item.
\since 4.2
\ingroup graphicsview-api
\inmodule QtWidgets
A QGraphicsItemGroup is a special type of compound item that
treats itself and all its children as one item (i.e., all events
and geometries for all children are merged together). It's common
to use item groups in presentation tools, when the user wants to
group several smaller items into one big item in order to simplify
moving and copying of items.
If all you want is to store items inside other items, you can use
any QGraphicsItem directly by passing a suitable parent to
setParentItem().
The boundingRect() function of QGraphicsItemGroup returns the
bounding rectangle of all items in the item group.
QGraphicsItemGroup ignores the ItemIgnoresTransformations flag on
its children (i.e., with respect to the geometry of the group
item, the children are treated as if they were transformable).
There are two ways to construct an item group. The easiest and
most common approach is to pass a list of items (e.g., all
selected items) to QGraphicsScene::createItemGroup(), which
returns a new QGraphicsItemGroup item. The other approach is to
manually construct a QGraphicsItemGroup item, add it to the scene
calling QGraphicsScene::addItem(), and then add items to the group
manually, one at a time by calling addToGroup(). To dismantle
("ungroup") an item group, you can either call
QGraphicsScene::destroyItemGroup(), or you can manually remove all
items from the group by calling removeFromGroup().
\snippet code/src_gui_graphicsview_qgraphicsitem.cpp 17
The operation of adding and removing items preserves the items'
scene-relative position and transformation, as opposed to calling
setParentItem(), where only the child item's parent-relative
position and transformation are kept.
The addtoGroup() function reparents the target item to this item
group, keeping the item's position and transformation intact
relative to the scene. Visually, this means that items added via
addToGroup() will remain completely unchanged as a result of this
operation, regardless of the item or the group's current position
or transformation; although the item's position and matrix are
likely to change.
The removeFromGroup() function has similar semantics to
setParentItem(); it reparents the item to the parent item of the
item group. As with addToGroup(), the item's scene-relative
position and transformation remain intact.
\sa QGraphicsItem, {Graphics View Framework}
*/
class QGraphicsItemGroupPrivate : public QGraphicsItemPrivate
{
public:
QRectF itemsBoundingRect;
};
/*!
Constructs a QGraphicsItemGroup. \a parent is passed to QGraphicsItem's
constructor.
\sa QGraphicsScene::addItem()
*/
QGraphicsItemGroup::QGraphicsItemGroup(QGraphicsItem *parent)
: QGraphicsItem(*new QGraphicsItemGroupPrivate, parent)
{
setHandlesChildEvents(true);
}
/*!
Destroys the QGraphicsItemGroup.
*/
QGraphicsItemGroup::~QGraphicsItemGroup()
{
}
/*!
Adds the given \a item and item's child items to this item group.
The item and child items will be reparented to this group, but its
position and transformation relative to the scene will stay intact.
\sa removeFromGroup(), QGraphicsScene::createItemGroup()
*/
void QGraphicsItemGroup::addToGroup(QGraphicsItem *item)
{
Q_D(QGraphicsItemGroup);
if (!item) {
qWarning("QGraphicsItemGroup::addToGroup: cannot add null item");
return;
}
if (item == this) {
qWarning("QGraphicsItemGroup::addToGroup: cannot add a group to itself");
return;
}
// COMBINE
bool ok;
QTransform itemTransform = item->itemTransform(this, &ok);
if (!ok) {
qWarning("QGraphicsItemGroup::addToGroup: could not find a valid transformation from item to group coordinates");
return;
}
QTransform newItemTransform(itemTransform);
item->setPos(mapFromItem(item, 0, 0));
item->setParentItem(this);
// removing position from translation component of the new transform
if (!item->pos().isNull())
newItemTransform *= QTransform::fromTranslate(-item->x(), -item->y());
// removing additional transformations properties applied with itemTransform()
QPointF origin = item->transformOriginPoint();
QMatrix4x4 m;
QList<QGraphicsTransform*> transformList = item->transformations();
for (int i = 0; i < transformList.size(); ++i)
transformList.at(i)->applyTo(&m);
newItemTransform *= m.toTransform().inverted();
newItemTransform.translate(origin.x(), origin.y());
newItemTransform.rotate(-item->rotation());
newItemTransform.scale(1/item->scale(), 1/item->scale());
newItemTransform.translate(-origin.x(), -origin.y());
// ### Expensive, we could maybe use dirtySceneTransform bit for optimization
item->setTransform(newItemTransform);
item->d_func()->setIsMemberOfGroup(true);
prepareGeometryChange();
d->itemsBoundingRect |= itemTransform.mapRect(item->boundingRect() | item->childrenBoundingRect());
update();
}
/*!
Removes the specified \a item from this group. The item will be
reparented to this group's parent item, or to 0 if this group has
no parent. Its position and transformation relative to the scene
will stay intact.
\sa addToGroup(), QGraphicsScene::destroyItemGroup()
*/
void QGraphicsItemGroup::removeFromGroup(QGraphicsItem *item)
{
Q_D(QGraphicsItemGroup);
if (!item) {
qWarning("QGraphicsItemGroup::removeFromGroup: cannot remove null item");
return;
}
QGraphicsItem *newParent = d_ptr->parent;
// COMBINE
bool ok;
QTransform itemTransform;
if (newParent)
itemTransform = item->itemTransform(newParent, &ok);
else
itemTransform = item->sceneTransform();
QPointF oldPos = item->mapToItem(newParent, 0, 0);
item->setParentItem(newParent);
item->setPos(oldPos);
// removing position from translation component of the new transform
if (!item->pos().isNull())
itemTransform *= QTransform::fromTranslate(-item->x(), -item->y());
// removing additional transformations properties applied
// with itemTransform() or sceneTransform()
QPointF origin = item->transformOriginPoint();
QMatrix4x4 m;
QList<QGraphicsTransform*> transformList = item->transformations();
for (int i = 0; i < transformList.size(); ++i)
transformList.at(i)->applyTo(&m);
itemTransform *= m.toTransform().inverted();
itemTransform.translate(origin.x(), origin.y());
itemTransform.rotate(-item->rotation());
itemTransform.scale(1 / item->scale(), 1 / item->scale());
itemTransform.translate(-origin.x(), -origin.y());
// ### Expensive, we could maybe use dirtySceneTransform bit for optimization
item->setTransform(itemTransform);
item->d_func()->setIsMemberOfGroup(item->group() != nullptr);
// ### Quite expensive. But removeFromGroup() isn't called very often.
prepareGeometryChange();
d->itemsBoundingRect = childrenBoundingRect();
}
/*!
\reimp
Returns the bounding rect of this group item, and all its children.
*/
QRectF QGraphicsItemGroup::boundingRect() const
{
Q_D(const QGraphicsItemGroup);
return d->itemsBoundingRect;
}
/*!
\reimp
*/
void QGraphicsItemGroup::paint(QPainter *painter, const QStyleOptionGraphicsItem *option,
QWidget *widget)
{
Q_UNUSED(widget);
if (option->state & QStyle::State_Selected) {
Q_D(QGraphicsItemGroup);
painter->setBrush(Qt::NoBrush);
painter->drawRect(d->itemsBoundingRect);
}
}
/*!
\reimp
*/
bool QGraphicsItemGroup::isObscuredBy(const QGraphicsItem *item) const
{
return QGraphicsItem::isObscuredBy(item);
}
/*!
\reimp
*/
QPainterPath QGraphicsItemGroup::opaqueArea() const
{
return QGraphicsItem::opaqueArea();
}
/*!
\reimp
*/
int QGraphicsItemGroup::type() const
{
return Type;
}
#if QT_CONFIG(graphicseffect)
QRectF QGraphicsItemEffectSourcePrivate::boundingRect(Qt::CoordinateSystem system) const
{
const bool deviceCoordinates = (system == Qt::DeviceCoordinates);
if (!info && deviceCoordinates) {
// Device coordinates without info not yet supported.
qWarning("QGraphicsEffectSource::boundingRect: Not yet implemented, lacking device context");
return QRectF();
}
QRectF rect = item->boundingRect();
if (!item->d_ptr->children.isEmpty())
rect |= item->childrenBoundingRect();
if (deviceCoordinates) {
Q_ASSERT(info->painter);
rect = info->painter->worldTransform().mapRect(rect);
}
return rect;
}
void QGraphicsItemEffectSourcePrivate::draw(QPainter *painter)
{
if (!info) {
qWarning("QGraphicsEffectSource::draw: Can only begin as a result of QGraphicsEffect::draw");
return;
}
Q_ASSERT(item->d_ptr->scene);
QGraphicsScenePrivate *scened = item->d_ptr->scene->d_func();
if (painter == info->painter) {
scened->draw(item, painter, info->viewTransform, info->transformPtr, info->exposedRegion,
info->widget, info->opacity, info->effectTransform, info->wasDirtySceneTransform,
info->drawItem);
} else {
QTransform effectTransform = info->painter->worldTransform().inverted();
effectTransform *= painter->worldTransform();
scened->draw(item, painter, info->viewTransform, info->transformPtr, info->exposedRegion,
info->widget, info->opacity, &effectTransform, info->wasDirtySceneTransform,
info->drawItem);
}
}
// sourceRect must be in the given coordinate system
QRectF QGraphicsItemEffectSourcePrivate::paddedEffectRect(Qt::CoordinateSystem system, QGraphicsEffect::PixmapPadMode mode, const QRectF &sourceRect, bool *unpadded) const
{
QRectF effectRectF;
if (unpadded)
*unpadded = false;
if (mode == QGraphicsEffect::PadToEffectiveBoundingRect) {
if (info) {
QRectF deviceRect = system == Qt::DeviceCoordinates ? sourceRect : info->painter->worldTransform().mapRect(sourceRect);
effectRectF = item->graphicsEffect()->boundingRectFor(deviceRect);
if (unpadded)
*unpadded = (effectRectF.size() == sourceRect.size());
if (info && system == Qt::LogicalCoordinates)
effectRectF = info->painter->worldTransform().inverted().mapRect(effectRectF);
} else {
// no choice but to send a logical coordinate bounding rect to boundingRectFor
effectRectF = item->graphicsEffect()->boundingRectFor(sourceRect);
}
} else if (mode == QGraphicsEffect::PadToTransparentBorder) {
// adjust by 1.5 to account for cosmetic pens
effectRectF = sourceRect.adjusted(-1.5, -1.5, 1.5, 1.5);
} else {
effectRectF = sourceRect;
if (unpadded)
*unpadded = true;
}
return effectRectF;
}
QPixmap QGraphicsItemEffectSourcePrivate::pixmap(Qt::CoordinateSystem system, QPoint *offset,
QGraphicsEffect::PixmapPadMode mode) const
{
const bool deviceCoordinates = (system == Qt::DeviceCoordinates);
if (!info && deviceCoordinates) {
// Device coordinates without info not yet supported.
qWarning("QGraphicsEffectSource::pixmap: Not yet implemented, lacking device context");
return QPixmap();
}
if (!item->d_ptr->scene)
return QPixmap();
QGraphicsScenePrivate *scened = item->d_ptr->scene->d_func();
bool unpadded;
const QRectF sourceRect = boundingRect(system);
QRectF effectRectF = paddedEffectRect(system, mode, sourceRect, &unpadded);
QRect effectRect = effectRectF.toAlignedRect();
if (offset)
*offset = effectRect.topLeft();
bool untransformed = !deviceCoordinates
|| info->painter->worldTransform().type() <= QTransform::TxTranslate;
if (untransformed && unpadded && isPixmap()) {
if (offset)
*offset = boundingRect(system).topLeft().toPoint();
return static_cast<QGraphicsPixmapItem *>(item)->pixmap();
}
if (effectRect.isEmpty())
return QPixmap();
const auto dpr = info ? info->painter->device()->devicePixelRatioF() : 1.0;
QPixmap pixmap(QRectF(effectRectF.topLeft(), effectRectF.size() * dpr).toAlignedRect().size());
pixmap.setDevicePixelRatio(dpr);
pixmap.fill(Qt::transparent);
QPainter pixmapPainter(&pixmap);
pixmapPainter.setRenderHints(info ? info->painter->renderHints() : QPainter::TextAntialiasing);
QTransform effectTransform = QTransform::fromTranslate(-effectRect.x(), -effectRect.y());
if (deviceCoordinates && info->effectTransform)
effectTransform *= *info->effectTransform;
if (!info) {
// Logical coordinates without info.
QTransform sceneTransform = item->sceneTransform();
QTransform newEffectTransform = sceneTransform.inverted();
newEffectTransform *= effectTransform;
scened->draw(item, &pixmapPainter, nullptr, &sceneTransform, nullptr, nullptr, qreal(1.0),
&newEffectTransform, false, true);
} else if (deviceCoordinates) {
// Device coordinates with info.
scened->draw(item, &pixmapPainter, info->viewTransform, info->transformPtr, nullptr,
info->widget, info->opacity, &effectTransform, info->wasDirtySceneTransform,
info->drawItem);
} else {
// Item coordinates with info.
QTransform newEffectTransform = info->transformPtr->inverted();
newEffectTransform *= effectTransform;
scened->draw(item, &pixmapPainter, info->viewTransform, info->transformPtr, nullptr,
info->widget, info->opacity, &newEffectTransform, info->wasDirtySceneTransform,
info->drawItem);
}
pixmapPainter.end();
return pixmap;
}
#endif // QT_CONFIG(graphicseffect)
#ifndef QT_NO_DEBUG_STREAM
static void formatGraphicsItemHelper(QDebug debug, const QGraphicsItem *item)
{
if (const QGraphicsItem *parent = item->parentItem())
debug << ", parent=" << static_cast<const void *>(parent);
debug << ", pos=";
QtDebugUtils::formatQPoint(debug, item->pos());
if (const qreal z = item->zValue())
debug << ", z=" << z;
if (item->flags())
debug << ", flags=" << item->flags();
}
// FIXME: Qt 6: Make this QDebug operator<<(QDebug debug, const QGraphicsItem *item)
QDebug operator<<(QDebug debug, QGraphicsItem *item)
{
QDebugStateSaver saver(debug);
debug.nospace();
if (!item) {
debug << "QGraphicsItem(0)";
return debug;
}
if (QGraphicsObject *o = item->toGraphicsObject())
debug << o->metaObject()->className();
else
debug << "QGraphicsItem";
debug << '(' << static_cast<const void *>(item);
if (const QGraphicsProxyWidget *pw = qgraphicsitem_cast<const QGraphicsProxyWidget *>(item)) {
debug << ", widget=";
if (const QWidget *w = pw->widget()) {
debug << w->metaObject()->className() << '(' << static_cast<const void *>(w);
if (!w->objectName().isEmpty())
debug << ", name=" << w->objectName();
debug << ')';
} else {
debug << "QWidget(0)";
}
}
formatGraphicsItemHelper(debug, item);
debug << ')';
return debug;
}
// FIXME: Qt 6: Make this QDebug operator<<(QDebug debug, const QGraphicsObject *item)
QDebug operator<<(QDebug debug, QGraphicsObject *item)
{
QDebugStateSaver saver(debug);
debug.nospace();
if (!item) {
debug << "QGraphicsObject(0)";
return debug;
}
debug << item->metaObject()->className() << '(' << static_cast<const void *>(item);
if (!item->objectName().isEmpty())
debug << ", name=" << item->objectName();
formatGraphicsItemHelper(debug, item);
debug << ')';
return debug;
}
QDebug operator<<(QDebug debug, QGraphicsItem::GraphicsItemChange change)
{
const char *str = "UnknownChange";
switch (change) {
case QGraphicsItem::ItemChildAddedChange:
str = "ItemChildAddedChange";
break;
case QGraphicsItem::ItemChildRemovedChange:
str = "ItemChildRemovedChange";
break;
case QGraphicsItem::ItemCursorChange:
str = "ItemCursorChange";
break;
case QGraphicsItem::ItemCursorHasChanged:
str = "ItemCursorHasChanged";
break;
case QGraphicsItem::ItemEnabledChange:
str = "ItemEnabledChange";
break;
case QGraphicsItem::ItemEnabledHasChanged:
str = "ItemEnabledHasChanged";
break;
case QGraphicsItem::ItemFlagsChange:
str = "ItemFlagsChange";
break;
case QGraphicsItem::ItemFlagsHaveChanged:
str = "ItemFlagsHaveChanged";
break;
#if QT_DEPRECATED_SINCE(5, 14)
QT_WARNING_PUSH
QT_WARNING_DISABLE_DEPRECATED
case QGraphicsItem::ItemMatrixChange:
str = "ItemMatrixChange";
break;
QT_WARNING_POP
#endif
case QGraphicsItem::ItemParentChange:
str = "ItemParentChange";
break;
case QGraphicsItem::ItemParentHasChanged:
str = "ItemParentHasChanged";
break;
case QGraphicsItem::ItemPositionChange:
str = "ItemPositionChange";
break;
case QGraphicsItem::ItemPositionHasChanged:
str = "ItemPositionHasChanged";
break;
case QGraphicsItem::ItemSceneChange:
str = "ItemSceneChange";
break;
case QGraphicsItem::ItemSceneHasChanged:
str = "ItemSceneHasChanged";
break;
case QGraphicsItem::ItemSelectedChange:
str = "ItemSelectedChange";
break;
case QGraphicsItem::ItemSelectedHasChanged:
str = "ItemSelectedHasChanged";
break;
case QGraphicsItem::ItemToolTipChange:
str = "ItemToolTipChange";
break;
case QGraphicsItem::ItemToolTipHasChanged:
str = "ItemToolTipHasChanged";
break;
case QGraphicsItem::ItemTransformChange:
str = "ItemTransformChange";
break;
case QGraphicsItem::ItemTransformHasChanged:
str = "ItemTransformHasChanged";
break;
case QGraphicsItem::ItemVisibleChange:
str = "ItemVisibleChange";
break;
case QGraphicsItem::ItemVisibleHasChanged:
str = "ItemVisibleHasChanged";
break;
case QGraphicsItem::ItemZValueChange:
str = "ItemZValueChange";
break;
case QGraphicsItem::ItemZValueHasChanged:
str = "ItemZValueHasChanged";
break;
case QGraphicsItem::ItemOpacityChange:
str = "ItemOpacityChange";
break;
case QGraphicsItem::ItemOpacityHasChanged:
str = "ItemOpacityHasChanged";
break;
case QGraphicsItem::ItemScenePositionHasChanged:
str = "ItemScenePositionHasChanged";
break;
case QGraphicsItem::ItemRotationChange:
str = "ItemRotationChange";
break;
case QGraphicsItem::ItemRotationHasChanged:
str = "ItemRotationHasChanged";
break;
case QGraphicsItem::ItemScaleChange:
str = "ItemScaleChange";
break;
case QGraphicsItem::ItemScaleHasChanged:
str = "ItemScaleHasChanged";
break;
case QGraphicsItem::ItemTransformOriginPointChange:
str = "ItemTransformOriginPointChange";
break;
case QGraphicsItem::ItemTransformOriginPointHasChanged:
str = "ItemTransformOriginPointHasChanged";
break;
}
debug << str;
return debug;
}
QDebug operator<<(QDebug debug, QGraphicsItem::GraphicsItemFlag flag)
{
const char *str = "UnknownFlag";
switch (flag) {
case QGraphicsItem::ItemIsMovable:
str = "ItemIsMovable";
break;
case QGraphicsItem::ItemIsSelectable:
str = "ItemIsSelectable";
break;
case QGraphicsItem::ItemIsFocusable:
str = "ItemIsFocusable";
break;
case QGraphicsItem::ItemClipsToShape:
str = "ItemClipsToShape";
break;
case QGraphicsItem::ItemClipsChildrenToShape:
str = "ItemClipsChildrenToShape";
break;
case QGraphicsItem::ItemIgnoresTransformations:
str = "ItemIgnoresTransformations";
break;
case QGraphicsItem::ItemIgnoresParentOpacity:
str = "ItemIgnoresParentOpacity";
break;
case QGraphicsItem::ItemDoesntPropagateOpacityToChildren:
str = "ItemDoesntPropagateOpacityToChildren";
break;
case QGraphicsItem::ItemStacksBehindParent:
str = "ItemStacksBehindParent";
break;
case QGraphicsItem::ItemUsesExtendedStyleOption:
str = "ItemUsesExtendedStyleOption";
break;
case QGraphicsItem::ItemHasNoContents:
str = "ItemHasNoContents";
break;
case QGraphicsItem::ItemSendsGeometryChanges:
str = "ItemSendsGeometryChanges";
break;
case QGraphicsItem::ItemAcceptsInputMethod:
str = "ItemAcceptsInputMethod";
break;
case QGraphicsItem::ItemNegativeZStacksBehindParent:
str = "ItemNegativeZStacksBehindParent";
break;
case QGraphicsItem::ItemIsPanel:
str = "ItemIsPanel";
break;
case QGraphicsItem::ItemIsFocusScope:
str = "ItemIsFocusScope";
break;
case QGraphicsItem::ItemSendsScenePositionChanges:
str = "ItemSendsScenePositionChanges";
break;
case QGraphicsItem::ItemStopsClickFocusPropagation:
str = "ItemStopsClickFocusPropagation";
break;
case QGraphicsItem::ItemStopsFocusHandling:
str = "ItemStopsFocusHandling";
break;
case QGraphicsItem::ItemContainsChildrenInShape:
str = "ItemContainsChildrenInShape";
break;
}
debug << str;
return debug;
}
QDebug operator<<(QDebug debug, QGraphicsItem::GraphicsItemFlags flags)
{
debug << '(';
bool f = false;
for (int i = 0; i < 17; ++i) {
if (flags & (1 << i)) {
if (f)
debug << '|';
f = true;
debug << QGraphicsItem::GraphicsItemFlag(int(flags & (1 << i)));
}
}
debug << ')';
return debug;
}
#endif
QT_END_NAMESPACE
#include "moc_qgraphicsitem.cpp"