| Home · All Classes · Modules |
The QGraphicsView class provides a widget for displaying the contents of a QGraphicsScene. More...
Inherits QAbstractScrollArea.
Inherited by QDeclarativeView.
The QGraphicsView class provides a widget for displaying the contents of a QGraphicsScene.
QGraphicsView visualizes the contents of a QGraphicsScene in a scrollable viewport. To create a scene with geometrical items, see QGraphicsScene's documentation. QGraphicsView is part of the Graphics View Framework.
To visualize a scene, you start by constructing a QGraphicsView object, passing the address of the scene you want to visualize to QGraphicsView's constructor. Alternatively, you can call setScene() to set the scene at a later point. After you call show(), the view will by default scroll to the center of the scene and display any items that are visible at this point. For example:
QGraphicsScene scene; scene.addText("Hello, world!"); QGraphicsView view(&scene); view.show();
You can explicitly scroll to any position on the scene by using the scroll bars, or by calling centerOn(). By passing a point to centerOn(), QGraphicsView will scroll its viewport to ensure that the point is centered in the view. An overload is provided for scrolling to a QGraphicsItem, in which case QGraphicsView will see to that the center of the item is centered in the view. If all you want is to ensure that a certain area is visible, (but not necessarily centered,) you can call ensureVisible() instead.
QGraphicsView can be used to visualize a whole scene, or only parts of it. The visualized area is by default detected automatically when the view is displayed for the first time (by calling QGraphicsScene.itemsBoundingRect()). To set the visualized area rectangle yourself, you can call setSceneRect(). This will adjust the scroll bars' ranges appropriately. Note that although the scene supports a virtually unlimited size, the range of the scroll bars will never exceed the range of an integer (INT_MIN, INT_MAX).
QGraphicsView visualizes the scene by calling render(). By default, the items are drawn onto the viewport by using a regular QPainter, and using default render hints. To change the default render hints that QGraphicsView passes to QPainter when painting items, you can call setRenderHints().
By default, QGraphicsView provides a regular QWidget for the viewport widget. You can access this widget by calling viewport(), or you can replace it by calling setViewport(). To render using OpenGL, simply call setViewport(new QGLWidget). QGraphicsView takes ownership of the viewport widget.
QGraphicsView supports affine transformations, using QTransform. You can either pass a matrix to setTransform(), or you can call one of the convenience functions rotate(), scale(), translate() or shear(). The most two common transformations are scaling, which is used to implement zooming, and rotation. QGraphicsView keeps the center of the view fixed during a transformation. Because of the scene alignment (setAligment()), translating the view will have no visual impact.
You can interact with the items on the scene by using the mouse and keyboard. QGraphicsView translates the mouse and key events into scene events, (events that inherit QGraphicsSceneEvent,), and forward them to the visualized scene. In the end, it's the individual item that handles the events and reacts to them. For example, if you click on a selectable item, the item will typically let the scene know that it has been selected, and it will also redraw itself to display a selection rectangle. Similiary, if you click and drag the mouse to move a movable item, it's the item that handles the mouse moves and moves itself. Item interaction is enabled by default, and you can toggle it by calling setInteractive().
You can also provide your own custom scene interaction, by creating a subclass of QGraphicsView, and reimplementing the mouse and key event handlers. To simplify how you programmatically interact with items in the view, QGraphicsView provides the mapping functions mapToScene() and mapFromScene(), and the item accessors items() and itemAt(). These functions allow you to map points, rectangles, polygons and paths between view coordinates and scene coordinates, and to find items on the scene using view coordinates.
This enum describes the flags that you can set for a QGraphicsView's cache mode.
| Constant | Value | Description |
|---|---|---|
| QGraphicsView.CacheNone | 0x0 | All painting is done directly onto the viewport. |
| QGraphicsView.CacheBackground | 0x1 | The background is cached. This affects both custom backgrounds, and backgrounds based on the backgroundBrush property. When this flag is enabled, QGraphicsView will allocate one pixmap with the full size of the viewport. |
The CacheMode type is a typedef for QFlags<CacheModeFlag>. It stores an OR combination of CacheModeFlag values.
See also cacheMode.
This enum describes the default action for the view when pressing and dragging the mouse over the viewport.
| Constant | Value | Description |
|---|---|---|
| QGraphicsView.NoDrag | 0 | Nothing happens; the mouse event is ignored. |
| QGraphicsView.ScrollHandDrag | 1 | The cursor changes into a pointing hand, and dragging the mouse around will scroll the scrolbars. This mode works both in interactive and non-interactive mode. |
| QGraphicsView.RubberBandDrag | 2 | A rubber band will appear. Dragging the mouse will set the rubber band geometry, and all items covered by the rubber band are selected. This mode is disabled for non-interactive views. |
See also dragMode and QGraphicsScene.setSelectionArea().
This enum describes flags that you can enable to improve rendering performance in QGraphicsView. By default, none of these flags are set. Note that setting a flag usually imposes a side effect, and this effect can vary between paint devices and platforms.
| Constant | Value | Description |
|---|---|---|
| QGraphicsView.DontClipPainter | 0x1 | This value is obsolete and has no effect. |
| QGraphicsView.DontSavePainterState | 0x2 | When rendering, QGraphicsView protects the painter state (see QPainter.save()) when rendering the background or foreground, and when rendering each item. This allows you to leave the painter in an altered state (i.e., you can call QPainter.setPen() or QPainter.setBrush() without restoring the state after painting). However, if the items consistently do restore the state, you should enable this flag to prevent QGraphicsView from doing the same. |
| QGraphicsView.DontAdjustForAntialiasing | 0x4 | Disables QGraphicsView's antialiasing auto-adjustment of exposed areas. Items that render antialiased lines on the boundaries of their QGraphicsItem.boundingRect() can end up rendering parts of the line outside. To prevent rendering artifacts, QGraphicsView expands all exposed regions by 2 pixels in all directions. If you enable this flag, QGraphicsView will no longer perform these adjustments, minimizing the areas that require redrawing, which improves performance. A common side effect is that items that do draw with antialiasing can leave painting traces behind on the scene as they are moved. |
| QGraphicsView.IndirectPainting | 0x8 | Since Qt 4.6, restore the old painting algorithm that calls QGraphicsView.drawItems() and QGraphicsScene.drawItems(). To be used only for compatibility with old code. |
This enum was introduced or modified in Qt 4.3.
The OptimizationFlags type is a typedef for QFlags<OptimizationFlag>. It stores an OR combination of OptimizationFlag values.
This enums describe the possible anchors that QGraphicsView can use when the user resizes the view or when the view is transformed.
| Constant | Value | Description |
|---|---|---|
| QGraphicsView.NoAnchor | 0 | No anchor, i.e. the view leaves the scene's position unchanged. |
| QGraphicsView.AnchorViewCenter | 1 | The scene point at the center of the view is used as the anchor. |
| QGraphicsView.AnchorUnderMouse | 2 | The point under the mouse is used as the anchor. |
See also resizeAnchor and transformationAnchor.
This enum describes how QGraphicsView updates its viewport when the scene contents change or are exposed.
| Constant | Value | Description |
|---|---|---|
| QGraphicsView.FullViewportUpdate | 0 | When any visible part of the scene changes or is reexposed, QGraphicsView will update the entire viewport. This approach is fastest when QGraphicsView spends more time figuring out what to draw than it would spend drawing (e.g., when very many small items are repeatedly updated). This is the preferred update mode for viewports that do not support partial updates, such as QGLWidget, and for viewports that need to disable scroll optimization. |
| QGraphicsView.MinimalViewportUpdate | 1 | QGraphicsView will determine the minimal viewport region that requires a redraw, minimizing the time spent drawing by avoiding a redraw of areas that have not changed. This is QGraphicsView's default mode. Although this approach provides the best performance in general, if there are many small visible changes on the scene, QGraphicsView might end up spending more time finding the minimal approach than it will spend drawing. |
| QGraphicsView.SmartViewportUpdate | 2 | QGraphicsView will attempt to find an optimal update mode by analyzing the areas that require a redraw. |
| QGraphicsView.BoundingRectViewportUpdate | 4 | The bounding rectangle of all changes in the viewport will be redrawn. This mode has the advantage that QGraphicsView searches only one region for changes, minimizing time spent determining what needs redrawing. The disadvantage is that areas that have not changed also need to be redrawn. |
| QGraphicsView.NoViewportUpdate | 3 | QGraphicsView will never update its viewport when the scene changes; the user is expected to control all updates. This mode disables all (potentially slow) item visibility testing in QGraphicsView, and is suitable for scenes that either require a fixed frame rate, or where the viewport is otherwise updated externally. |
This enum was introduced or modified in Qt 4.3.
See also viewportUpdateMode.
The parent argument, if not None, causes self to be owned by Qt instead of PyQt.
Constructs a QGraphicsView. parent is passed to QWidget's constructor.
The parent argument, if not None, causes self to be owned by Qt instead of PyQt.
Constructs a QGraphicsView and sets the visualized scene to scene. parent is passed to QWidget's constructor.
Scrolls the contents of the viewport to ensure that the scene coordinate pos, is centered in the view.
Because pos is a floating point coordinate, and the scroll bars operate on integer coordinates, the centering is only an approximation.
Note: If the item is close to or outside the border, it will be visible in the view, but not centered.
See also ensureVisible().
This is an overloaded function.
This function is provided for convenience. It's equivalent to calling centerOn(QPointF(x, y)).
This is an overloaded function.
Scrolls the contents of the viewport to ensure that item is centered in the view.
See also ensureVisible().
Reimplemented from QWidget.contextMenuEvent().
Reimplemented from QWidget.dragEnterEvent().
Reimplemented from QWidget.dragLeaveEvent().
Reimplemented from QWidget.dragMoveEvent().
Draws the background of the scene using painter, before any items and the foreground are drawn. Reimplement this function to provide a custom background for this view.
If all you want is to define a color, texture or gradient for the background, you can call setBackgroundBrush() instead.
All painting is done in scene coordinates. rect is the exposed rectangle.
The default implementation fills rect using the view's backgroundBrush. If no such brush is defined (the default), the scene's drawBackground() function is called instead.
See also drawForeground() and QGraphicsScene.drawBackground().
Draws the foreground of the scene using painter, after the background and all items are drawn. Reimplement this function to provide a custom foreground for this view.
If all you want is to define a color, texture or gradient for the foreground, you can call setForegroundBrush() instead.
All painting is done in scene coordinates. rect is the exposed rectangle.
The default implementation fills rect using the view's foregroundBrush. If no such brush is defined (the default), the scene's drawForeground() function is called instead.
See also drawBackground() and QGraphicsScene.drawForeground().
Reimplemented from QWidget.dropEvent().
Scrolls the contents of the viewport so that the scene rectangle rect is visible, with margins specified in pixels by xmargin and ymargin. If the specified rect cannot be reached, the contents are scrolled to the nearest valid position. The default value for both margins is 50 pixels.
See also centerOn().
This is an overloaded function.
This function is provided for convenience. It's equivalent to calling ensureVisible(QRectF(x, y, w, h), xmargin, ymargin).
This is an overloaded function.
Scrolls the contents of the viewport so that the center of item item is visible, with margins specified in pixels by xmargin and ymargin. If the specified point cannot be reached, the contents are scrolled to the nearest valid position. The default value for both margins is 50 pixels.
See also centerOn().
Reimplemented from QObject.event().
Scales the view matrix and scrolls the scroll bars to ensure that the scene rectangle rect fits inside the viewport. rect must be inside the scene rect; otherwise, fitInView() cannot guarantee that the whole rect is visible.
This function keeps the view's rotation, translation, or shear. The view is scaled according to aspectRatioMode. rect will be centered in the view if it does not fit tightly.
It's common to call fitInView() from inside a reimplementation of resizeEvent(), to ensure that the whole scene, or parts of the scene, scales automatically to fit the new size of the viewport as the view is resized. Note though, that calling fitInView() from inside resizeEvent() can lead to unwanted resize recursion, if the new transformation toggles the automatic state of the scrollbars. You can toggle the scrollbar policies to always on or always off to prevent this (see horizontalScrollBarPolicy() and verticalScrollBarPolicy()).
If rect is empty, or if the viewport is too small, this function will do nothing.
See also setTransform(), ensureVisible(), and centerOn().
This is an overloaded function.
This convenience function is equivalent to calling fitInView(QRectF(x, y, w, h), aspectRatioMode).
See also ensureVisible() and centerOn().
This is an overloaded function.
Ensures that item fits tightly inside the view, scaling the view according to aspectRatioMode.
See also ensureVisible() and centerOn().
Reimplemented from QWidget.focusInEvent().
Reimplemented from QWidget.focusNextPrevChild().
Reimplemented from QWidget.focusOutEvent().
Reimplemented from QWidget.inputMethodEvent().
Reimplemented from QWidget.inputMethodQuery().
This method is also a Qt slot with the C++ signature void invalidateScene(const ::QRectF& = QRectF(), ::QGraphicsScene::SceneLayers = QGraphicsScene.AllLayers).
Invalidates and schedules a redraw of layers inside rect. rect is in scene coordinates. Any cached content for layers inside rect is unconditionally invalidated and redrawn.
You can call this function to notify QGraphicsView of changes to the background or the foreground of the scene. It is commonly used for scenes with tile-based backgrounds to notify changes when QGraphicsView has enabled background caching.
Note that QGraphicsView currently supports background caching only (see QGraphicsView.CacheBackground). This function is equivalent to calling update() if any layer but QGraphicsScene.BackgroundLayer is passed.
See also QGraphicsScene.invalidate() and update().
Returns true if the view is transformed (i.e., a non-identity transform has been assigned, or the scrollbars are adjusted).
This function was introduced in Qt 4.6.
See also setTransform(), horizontalScrollBar(), and verticalScrollBar().
Returns the item at position pos, which is in viewport coordinates. If there are several items at this position, this function returns the topmost item.
Example:
void CustomView.mousePressEvent(QMouseEvent *event) { if (QGraphicsItem *item = itemAt(event->pos())) { qDebug() << "You clicked on item" << item; } else { qDebug() << "You didn't click on an item."; } }
This is an overloaded function.
This function is provided for convenience. It's equivalent to calling itemAt(QPoint(x, y)).
Returns a list of all the items in the associated scene, in descending stacking order (i.e., the first item in the returned list is the uppermost item).
See also QGraphicsScene.items() and Sorting.
Returns a list of all the items at the position pos in the view. The items are listed in descending stacking order (i.e., the first item in the list is the uppermost item, and the last item is the lowermost item). pos is in viewport coordinates.
This function is most commonly called from within mouse event handlers in a subclass in QGraphicsView. pos is in untransformed viewport coordinates, just like QMouseEvent.pos().
void CustomView.mousePressEvent(QMouseEvent *event) { qDebug() << "There are" << items(event->pos()).size() << "items at position" << mapToScene(event->pos()); }
See also QGraphicsScene.items() and Sorting.
This function is provided for convenience. It's equivalent to calling items(QPoint(x, y)).
This convenience function is equivalent to calling items(QRectF(x, y, w, h), mode).
This function was introduced in Qt 4.3.
This is an overloaded function.
Returns a list of all the items that, depending on mode, are either contained by or intersect with rect. rect is in viewport coordinates.
The default value for mode is Qt.IntersectsItemShape; all items whose exact shape intersects with or is contained by rect are returned.
The items are sorted in descending stacking order (i.e., the first item in the returned list is the uppermost item).
See also itemAt(), items(), mapToScene(), and Sorting.
This is an overloaded function.
Returns a list of all the items that, depending on mode, are either contained by or intersect with polygon. polygon is in viewport coordinates.
The default value for mode is Qt.IntersectsItemShape; all items whose exact shape intersects with or is contained by polygon are returned.
The items are sorted by descending stacking order (i.e., the first item in the returned list is the uppermost item).
See also itemAt(), items(), mapToScene(), and Sorting.
This is an overloaded function.
Returns a list of all the items that, depending on mode, are either contained by or intersect with path. path is in viewport coordinates.
The default value for mode is Qt.IntersectsItemShape; all items whose exact shape intersects with or is contained by path are returned.
See also itemAt(), items(), mapToScene(), and Sorting.
Reimplemented from QWidget.keyPressEvent().
Reimplemented from QWidget.keyReleaseEvent().
Returns the scene coordinate point to viewport coordinates.
See also mapToScene().
Returns the scene rectangle rect to a viewport coordinate polygon.
See also mapToScene().
Returns the scene coordinate polygon polygon to a viewport coordinate polygon.
See also mapToScene().
Returns the scene coordinate painter path path to a viewport coordinate painter path.
See also mapToScene().
This function is provided for convenience. It's equivalent to calling mapFromScene(QPointF(x, y)).
This function is provided for convenience. It's equivalent to calling mapFromScene(QRectF(x, y, w, h)).
Returns the viewport coordinate point mapped to scene coordinates.
Note: It can be useful to map the whole rectangle covered by the pixel at point instead of the point itself. To do this, you can call mapToScene(QRect(point, QSize(2, 2))).
See also mapFromScene().
Returns the viewport rectangle rect mapped to a scene coordinate polygon.
See also mapFromScene().
Returns the viewport polygon polygon mapped to a scene coordinate polygon.
See also mapFromScene().
Returns the viewport painter path path mapped to a scene coordinate painter path.
See also mapFromScene().
This function is provided for convenience. It's equivalent to calling mapToScene(QPoint(x, y)).
This function is provided for convenience. It's equivalent to calling mapToScene(QRect(x, y, w, h)).
Returns the current transformation matrix for the view. If no current transformation is set, the identity matrix is returned.
See also setMatrix(), transform(), rotate(), scale(), shear(), and translate().
Reimplemented from QWidget.mouseDoubleClickEvent().
Reimplemented from QWidget.mouseMoveEvent().
Reimplemented from QWidget.mousePressEvent().
Reimplemented from QWidget.mouseReleaseEvent().
Reimplemented from QWidget.paintEvent().
Renders the source rect, which is in view coordinates, from the scene into target, which is in paint device coordinates, using painter. This function is useful for capturing the contents of the view onto a paint device, such as a QImage (e.g., to take a screenshot), or for printing to QPrinter. For example:
QGraphicsScene scene; scene.addItem(... ... QGraphicsView view(&scene); view.show(); ... QPrinter printer(QPrinter.HighResolution); printer.setPageSize(QPrinter.A4); QPainter painter(&printer); // print, fitting the viewport contents into a full page view.render(&painter); // print the upper half of the viewport into the lower. // half of the page. QRect viewport = view.viewport()->rect(); view.render(&painter, QRectF(0, printer.height() / 2, printer.width(), printer.height() / 2), viewport.adjusted(0, 0, 0, -viewport.height() / 2));
If source is a null rect, this function will use viewport()->rect() to determine what to draw. If target is a null rect, the full dimensions of painter's paint device (e.g., for a QPrinter, the page size) will be used.
The source rect contents will be transformed according to aspectRatioMode to fit into the target rect. By default, the aspect ratio is kept, and source is scaled to fit in target.
See also QGraphicsScene.render().
Resets any cached content. Calling this function will clear QGraphicsView's cache. If the current cache mode is CacheNone, this function does nothing.
This function is called automatically for you when the backgroundBrush or QGraphicsScene.backgroundBrush properties change; you only need to call this function if you have reimplemented QGraphicsScene.drawBackground() or QGraphicsView.drawBackground() to draw a custom background, and need to trigger a full redraw.
See also cacheMode().
Resets the view transformation matrix to the identity matrix.
See also resetTransform().
Resets the view transformation to the identity matrix.
See also transform() and setTransform().
Reimplemented from QWidget.resizeEvent().
Rotates the current view transformation angle degrees clockwise.
See also setTransform(), transform(), scale(), shear(), and translate().
Scales the current view transformation by (sx, sy).
See also setTransform(), transform(), rotate(), shear(), and translate().
Returns a pointer to the scene that is currently visualized in the view. If no scene is currently visualized, 0 is returned.
See also setScene().
Reimplemented from QAbstractScrollArea.scrollContentsBy().
Sets the view's current transformation matrix to matrix.
If combine is true, then matrix is combined with the current matrix; otherwise, matrix replaces the current matrix. combine is false by default.
The transformation matrix tranforms the scene into view coordinates. Using the default transformation, provided by the identity matrix, one pixel in the view represents one unit in the scene (e.g., a 10x10 rectangular item is drawn using 10x10 pixels in the view). If a 2x2 scaling matrix is applied, the scene will be drawn in 1:2 (e.g., a 10x10 rectangular item is then drawn using 20x20 pixels in the view).
Example:
QGraphicsScene scene; scene.addText("GraphicsView rotated clockwise"); QGraphicsView view(&scene); view.rotate(90); // the text is rendered with a 90 degree clockwise rotation view.show();
To simplify interation with items using a transformed view, QGraphicsView provides mapTo... and mapFrom... functions that can translate between scene and view coordinates. For example, you can call mapToScene() to map a view coordinate to a floating point scene coordinate, or mapFromScene() to map from floating point scene coordinates to view coordinates.
See also matrix(), setTransform(), rotate(), scale(), shear(), and translate().
Enables flag if enabled is true; otherwise disables flag.
See also optimizationFlags.
If enabled is true, the render hint hint is enabled; otherwise it is disabled.
See also renderHints.
Sets the current scene to scene. If scene is already being viewed, this function does nothing.
When a scene is set on a view, the QGraphicsScene.changed() signal is automatically connected to this view's updateScene() slot, and the view's scroll bars are adjusted to fit the size of the scene.
See also scene().
Sets the view's current transformation matrix to matrix.
If combine is true, then matrix is combined with the current matrix; otherwise, matrix replaces the current matrix. combine is false by default.
The transformation matrix tranforms the scene into view coordinates. Using the default transformation, provided by the identity matrix, one pixel in the view represents one unit in the scene (e.g., a 10x10 rectangular item is drawn using 10x10 pixels in the view). If a 2x2 scaling matrix is applied, the scene will be drawn in 1:2 (e.g., a 10x10 rectangular item is then drawn using 20x20 pixels in the view).
Example:
QGraphicsScene scene; scene.addText("GraphicsView rotated clockwise"); QGraphicsView view(&scene); view.rotate(90); // the text is rendered with a 90 degree clockwise rotation view.show();
To simplify interation with items using a transformed view, QGraphicsView provides mapTo... and mapFrom... functions that can translate between scene and view coordinates. For example, you can call mapToScene() to map a view coordiate to a floating point scene coordinate, or mapFromScene() to map from floating point scene coordinates to view coordinates.
See also transform(), rotate(), scale(), shear(), and translate().
This method is also a Qt slot with the C++ signature void setupViewport( ::QWidget*).
This slot is called by QAbstractScrollArea after setViewport() has been called. Reimplement this function in a subclass of QGraphicsView to initialize the new viewport widget before it is used.
See also setViewport().
Shears the current view transformation by (sh, sv).
See also setTransform(), transform(), rotate(), scale(), and translate().
Reimplemented from QWidget.showEvent().
Reimplemented from QWidget.sizeHint().
Returns the current transformation matrix for the view. If no current transformation is set, the identity matrix is returned.
See also setTransform(), rotate(), scale(), shear(), and translate().
Translates the current view transformation by (dx, dy).
See also setTransform(), transform(), rotate(), and shear().
This method is also a Qt slot with the C++ signature void updateScene(const QList< ::QRectF>&).
Schedules an update of the scene rectangles rects.
See also QGraphicsScene.changed().
This method is also a Qt slot with the C++ signature void updateSceneRect(const ::QRectF&).
Notifies QGraphicsView that the scene's scene rect has changed. rect is the new scene rect. If the view already has an explicitly set scene rect, this function does nothing.
See also sceneRect and QGraphicsScene.sceneRectChanged().
Reimplemented from QAbstractScrollArea.viewportEvent().
Returns a matrix that maps viewport coordinates to scene coordinates.
See also mapToScene() and mapFromScene().
Reimplemented from QWidget.wheelEvent().
| PyQt 4.12.1 for X11 | Copyright © Riverbank Computing Ltd and The Qt Company 2015 | Qt 4.8.7 |