QWidget -based widgets, for example, a
QFontComboBox , or even
QFileDialog , into
QGraphicsScene . It forwards events between the two objects and translates between
QWidget ‘s integer-based geometry and
QGraphicsWidget ‘s qreal-based geometry.
QGraphicsProxyWidget supports all core features of
QWidget , including tab focus, keyboard input, Drag & Drop, and popups. You can also embed complex widgets, e.g., widgets with subwidgets.
if __name__ == "__main__": app = QApplication() tabWidget = QTabWidget() scene = QGraphicsScene() proxy = scene.addWidget(tabWidget) view = QGraphicsView(scene) view.show() sys.exit(app.exec())
QGraphicsProxyWidget takes care of automatically embedding popup children of embedded widgets through creating a child proxy for each popup. This means that when an embedded
QComboBox shows its popup list, a new
QGraphicsProxyWidget is created automatically, embedding the popup, and positioning it correctly. This only works if the popup is child of the embedded widget (for example
setMenu() requires the
QMenu instance to be child of the
Embedding a Widget with QGraphicsProxyWidget¶
There are two ways to embed a widget using
QGraphicsProxyWidget . The most common way is to pass a widget pointer to
addWidget() together with any relevant
WindowFlags . This function returns a pointer to a
QGraphicsProxyWidget . You can then choose to reparent or position either the proxy, or the embedded widget itself.
For example, in the code snippet below, we embed a group box into the proxy:
groupBox = QGroupBox("Contact Details") numberLabel = QLabel("Telephone number") numberEdit = QLineEdit() layout = QFormLayout() layout.addRow(numberLabel, numberEdit) groupBox.setLayout(layout) scene = QGraphicsScene() proxy = scene.addWidget(groupBox) view = QGraphicsView(scene) view.show()
The image below is the output obtained with its contents margin and contents rect labeled.
Alternatively, you can start by creating a new
QGraphicsProxyWidget item, and then call
setWidget() to embed a
QWidget later. The
widget() function returns a pointer to the embedded widget.
QGraphicsProxyWidget shares ownership with
QWidget , so if either of the two widgets are destroyed, the other widget will be automatically destroyed as well.
Synchronizing Widget States¶
QGraphicsProxyWidget keeps its state in sync with the embedded widget. For example, if the proxy is hidden or disabled, the embedded widget will be hidden or disabled as well, and vice versa. When the widget is embedded by calling addWidget(),
QGraphicsProxyWidget copies the state from the widget into the proxy, and after that, the two will stay synchronized where possible. By default, when you embed a widget into a proxy, both the widget and the proxy will be visible because a
QGraphicsWidget is visible when created (you do not have to call ). If you explicitly hide the embedded widget, the proxy will also become invisible.
scene = QGraphicsScene() edit = QLineEdit() proxy = scene.addWidget(edit) edit.isVisible() # returns true proxy.isVisible() # also returns true edit.hide() edit.isVisible() # returns false proxy.isVisible() # also returns false
QGraphicsProxyWidget maintains symmetry for the following states:
The explicit state is also symmetric.
Geometry is only guaranteed to be symmetric while the embedded widget is visible.
The embedded widget overrides the proxy widget cursor. The proxy cursor changes depending on which embedded subwidget is currently under the mouse.
All size hint functionality from the embedded widget is forwarded by the proxy.
Updated once by
Updated once by
QGraphicsScene keeps the embedded widget in a special state that prevents it from disturbing other widgets (both embedded and not embedded) while the widget is embedded. In this state, the widget may differ slightly in behavior from when it is not embedded.
This class is provided for convenience when bridging QWidgets and QGraphicsItems, it should not be used for high-performance scenarios. In particular, embedding widgets into a scene that is then displayed through a
QGraphicsView that uses an OpenGL viewport will not work for all combinations.
- class PySide6.QtWidgets.QGraphicsProxyWidget([parent=None[, wFlags=Qt.WindowFlags()]])¶
Constructs a new QGraphicsProxy widget.
wFlags are passed to
QGraphicsItem ‘s constructor.
Creates a proxy widget for the given
child of the widget contained in this proxy.
This function makes it possible to acquire proxies for non top-level widgets. For instance, you can embed a dialog, and then transform only one of its widgets.
If the widget is already embedded, return the existing proxy widget.
widget into this proxy widget. The embedded widget must reside exclusively either inside or outside of Graphics View. You cannot embed a widget as long as it is is visible elsewhere in the UI, at the same time.
widget must be a top-level widget whose parent is
When the widget is embedded, its state (e.g., visible, enabled, geometry, size hints) is copied into the proxy widget. If the embedded widget is explicitly hidden or disabled, the proxy widget will become explicitly hidden or disabled after embedding is complete. The class documentation has a full overview over the shared state.
QGraphicsProxyWidget ‘s window flags determine whether the widget, after embedding, will be given window decorations or not.
After this function returns,
QGraphicsProxyWidget will keep its state synchronized with that of
widget whenever possible.
If a widget is already embedded by this proxy when this function is called, that widget will first be automatically unembedded. Passing
None for the
widget argument will only unembed the widget, and the ownership of the currently embedded widget will be passed on to the caller. Every child widget that are embedded will also be embedded and their proxy widget destroyed.
Note that widgets with the
WA_PaintOnScreen widget attribute set and widgets that wrap an external application or controller cannot be embedded. Examples are
QOpenGLWidget and QAxWidget.
If no widget is embedded,
widget is not a descendant of the embedded widget, this function returns an empty
Returns a pointer to the embedded widget.
© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.