QGraphicsWidget

Inherited by: QGraphicsProxyWidget, QGraphicsWebView

Synopsis

Functions

• def actions ()
• def addAction (action)
• def addActions (actions)
• def adjustSize ()
• def autoFillBackground ()
• def focusPolicy ()
• def focusWidget ()
• def font ()
• def getWindowFrameMargins ()
• def grabShortcut (sequence[, context=Qt.WindowShortcut])
• def insertAction (before, action)
• def insertActions (before, actions)
• def isActiveWindow ()
• def layout ()
• def layoutDirection ()
• def palette ()
• def rect ()
• def releaseShortcut (id)
• def removeAction (action)
• def resize (size)
• def resize (w, h)
• def setAttribute (attribute[, on=true])
• def setAutoFillBackground (enabled)
• def setContentsMargins (left, top, right, bottom)
• def setFocusPolicy (policy)
• def setFont (font)
• def setGeometry (x, y, w, h)
• def setLayout (layout)
• def setLayoutDirection (direction)
• def setPalette (palette)
• def setShortcutAutoRepeat (id[, enabled=true])
• def setShortcutEnabled (id[, enabled=true])
• def setStyle (style)
• def setWindowFlags (wFlags)
• def setWindowFrameMargins (left, top, right, bottom)
• def setWindowTitle (title)
• def size ()
• def style ()
• def testAttribute (attribute)
• def unsetLayoutDirection ()
• def unsetWindowFrameMargins ()
• def windowFlags ()
• def windowFrameGeometry ()
• def windowFrameRect ()
• def windowTitle ()
• def windowType ()

Virtual functions

• def changeEvent (event)
• def closeEvent (event)
• def focusNextPrevChild (next)
• def grabKeyboardEvent (event)
• def grabMouseEvent (event)
• def hideEvent (event)
• def initStyleOption (option)
• def moveEvent (event)
• def paintWindowFrame (painter, option[, widget=None])
• def polishEvent ()
• def propertyChange (propertyName, value)
• def resizeEvent (event)
• def showEvent (event)
• def ungrabKeyboardEvent (event)
• def ungrabMouseEvent (event)
• def windowFrameEvent (e)
• def windowFrameSectionAt (pos)

Slots

• def close ()

Signals

• def geometryChanged ()
• def layoutChanged ()

Static functions

• def setTabOrder (first, second)

Detailed Description

The PySide.QtGui.QGraphicsWidget class is the base class for all widget items in a PySide.QtGui.QGraphicsScene .

PySide.QtGui.QGraphicsWidget is an extended base item that provides extra functionality over PySide.QtGui.QGraphicsItem . It is similar to PySide.QtGui.QWidget in many ways:

• Provides a PySide.QtGui.QGraphicsWidget.palette() , a PySide.QtGui.QGraphicsWidget.font() and a PySide.QtGui.QGraphicsWidget.style() .
• Has a defined PySide.QtGui.QGraphicsLayoutItem.geometry() .
• Supports layouts with PySide.QtGui.QGraphicsWidget.setLayout() and PySide.QtGui.QGraphicsWidget.layout() .
• Supports shortcuts and actions with PySide.QtGui.QGraphicsWidget.grabShortcut() and PySide.QtGui.QGraphicsWidget.insertAction()

Unlike PySide.QtGui.QGraphicsItem , PySide.QtGui.QGraphicsWidget is not an abstract class; you can create instances of a PySide.QtGui.QGraphicsWidget without having to subclass it. This approach is useful for widgets that only serve the purpose of organizing child widgets into a layout.

PySide.QtGui.QGraphicsWidget can be used as a base item for your own custom item if you require advanced input focus handling, e.g., tab focus and activation, or layouts.

Since PySide.QtGui.QGraphicsWidget resembles PySide.QtGui.QWidget and has similar API, it is easier to port a widget from PySide.QtGui.QWidget to PySide.QtGui.QGraphicsWidget , instead of PySide.QtGui.QGraphicsItem .

Note

PySide.QtGui.QWidget -based widgets can be directly embedded into a PySide.QtGui.QGraphicsScene using PySide.QtGui.QGraphicsProxyWidget .

Noticeable differences between PySide.QtGui.QGraphicsWidget and PySide.QtGui.QWidget are:

PySide.QtGui.QGraphicsWidget	PySide.QtGui.QWidget
Coordinates and geometry are defined with qreals (doubles or floats, depending on the platform).	PySide.QtGui.QWidget uses integer geometry ( PySide.QtCore.QPoint , PySide.QtCore.QRect ).
The widget is already visible by default; you do not have to call PySide.QtGui.QGraphicsItem.show() to display the widget.	PySide.QtGui.QWidget is hidden by default until you call PySide.QtGui.QGraphicsItem.show() .
A subset of widget attributes are supported.	All widget attributes are supported.
A top-level item’s style defaults to QGraphicsScene::style	A top-level widget’s style defaults to QApplication::style
Graphics View provides a custom drag and drop framework, different from PySide.QtGui.QWidget .	Standard drag and drop framework.
Widget items do not support modality.	Full modality support.

PySide.QtGui.QGraphicsWidget supports a subset of Qt’s widget attributes, ( Qt.WidgetAttribute ), as shown in the table below. Any attributes not listed in this table are unsupported, or otherwise unused.

Widget Attribute	Usage
Qt.WA_SetLayoutDirection	Set by PySide.QtGui.QGraphicsWidget.setLayoutDirection() , cleared by PySide.QtGui.QGraphicsWidget.unsetLayoutDirection() . You can test this attribute to check if the widget has been explicitly assigned a PySide.QtGui.QGraphicsWidget.layoutDirection() . If the attribute is not set, the PySide.QtGui.QGraphicsWidget.layoutDirection() is inherited.
Qt.WA_RightToLeft	Toggled by PySide.QtGui.QGraphicsWidget.setLayoutDirection() . Inherited from the parent/scene. If set, the widget’s layout will order horizontally arranged widgets from right to left.
Qt.WA_SetStyle	Set and cleared by PySide.QtGui.QGraphicsWidget.setStyle() . If this attribute is set, the widget has been explicitly assigned a style. If it is unset, the widget will use the scene’s or the application’s style.
Qt.WA_Resized	Set by PySide.QtGui.QGraphicsWidget.setGeometry() and PySide.QtGui.QGraphicsWidget.resize() .
Qt.WA_SetPalette	Set by PySide.QtGui.QGraphicsWidget.setPalette() .
Qt.WA_SetFont	Set by PySide.QtGui.QGraphicsWidget.setFont() .
Qt.WA_WindowPropagation	Enables propagation to window widgets.

Although PySide.QtGui.QGraphicsWidget inherits from both PySide.QtCore.QObject and PySide.QtGui.QGraphicsItem , you should use the functions provided by PySide.QtGui.QGraphicsItem , notPySide.QtCore.QObject , to manage the relationships between parent and child items. These functions control the stacking order of items as well as their ownership.

Note

The QObject.parent() should always return 0 for QGraphicsWidgets, but this policy is not strictly defined.

See also

PySide.QtGui.QGraphicsProxyWidget PySide.QtGui.QGraphicsItem Widgets and Layouts

class PySide.QtGui.QGraphicsWidget([parent=None[, wFlags=0]])

Parameters:

• wFlags – PySide.QtCore.Qt.WindowFlags
• parent – PySide.QtGui.QGraphicsItem

PySide.QtGui.QGraphicsWidget.actions()

Return type:

Returns the (possibly empty) list of this widget’s actions.

See also

PySide.QtGui.QGraphicsWidget.insertAction() PySide.QtGui.QGraphicsWidget.removeAction() QWidget.actions() QAction.associatedWidgets() QAction.associatedGraphicsWidgets()

PySide.QtGui.QGraphicsWidget.addAction(action)

Parameters:action – PySide.QtGui.QAction

Appends the action action to this widget’s list of actions.

All QGraphicsWidgets have a list of PySide.QtGui.QAction s, however they can be represented graphically in many different ways. The default use of the PySide.QtGui.QAction list (as returned by PySide.QtGui.QGraphicsWidget.actions() ) is to create a context PySide.QtGui.QMenu .

A PySide.QtGui.QGraphicsWidget should only have one of each action and adding an action it already has will not cause the same action to be in the widget twice.

See also

PySide.QtGui.QGraphicsWidget.removeAction() PySide.QtGui.QGraphicsWidget.insertAction() PySide.QtGui.QGraphicsWidget.actions() QWidget.addAction()

PySide.QtGui.QGraphicsWidget.addActions(actions)

Parameters:actions –

PySide.QtGui.QGraphicsWidget.adjustSize()

Adjusts the size of the widget to its effective preferred size hint.

This function is called implicitly when the item is shown for the first time.

See also

PySide.QtGui.QGraphicsLayoutItem.effectiveSizeHint() Qt.MinimumSize

PySide.QtGui.QGraphicsWidget.autoFillBackground()

Return type:PySide.QtCore.bool

This property holds whether the widget background is filled automatically.

If enabled, this property will cause Qt to fill the background of the widget before invoking the PySide.QtGui.QGraphicsWidget.paint() method. The color used is defined by the QPalette.Window color role from the widget’s palette .

In addition, Windows are always filled with QPalette.Window , unless the WA_OpaquePaintEvent or WA_NoSystemBackground attributes are set.

By default, this property is false.

See also

Qt.WA_OpaquePaintEvent Qt.WA_NoSystemBackground

PySide.QtGui.QGraphicsWidget.changeEvent(event)

Parameters:event – PySide.QtCore.QEvent

This event handler can be reimplemented to handle state changes.

The state being changed in this event can be retrieved through event .

Change events include: QEvent.ActivationChange , QEvent.EnabledChange , QEvent.FontChange , QEvent.StyleChange , QEvent.PaletteChange , QEvent.ParentChange , QEvent.LayoutDirectionChange , and QEvent.ContentsRectChange .

PySide.QtGui.QGraphicsWidget.close()

Return type:PySide.QtCore.bool

Call this function to close the widget.

Returns true if the widget was closed; otherwise returns false. This slot will first send a PySide.QtGui.QCloseEvent to the widget, which may or may not accept the event. If the event was ignored, nothing happens. If the event was accepted, it will PySide.QtGui.QGraphicsItem.hide() the widget.

If the widget has the Qt.WA_DeleteOnClose attribute set it will be deleted.

PySide.QtGui.QGraphicsWidget.closeEvent(event)

Parameters:event – PySide.QtGui.QCloseEvent

This event handler, for event , can be reimplemented in a subclass to receive widget close events. The default implementation accepts the event.

See also

PySide.QtGui.QGraphicsWidget.close() PySide.QtGui.QCloseEvent

PySide.QtGui.QGraphicsWidget.focusNextPrevChild(next)

Parameters:next – PySide.QtCore.bool Return type:PySide.QtCore.bool

Finds a new widget to give the keyboard focus to, as appropriate for Tab and Shift+Tab, and returns true if it can find a new widget; returns false otherwise. If next is true, this function searches forward; if next is false, it searches backward.

Sometimes, you will want to reimplement this function to provide special focus handling for your widget and its subwidgets. For example, a web browser might reimplement it to move its current active link forward or backward, and call the base implementation only when it reaches the last or first link on the page.

Child widgets call PySide.QtGui.QGraphicsWidget.focusNextPrevChild() on their parent widgets, but only the window that contains the child widgets decides where to redirect focus. By reimplementing this function for an object, you gain control of focus traversal for all child widgets.

See also

PySide.QtGui.QGraphicsWidget.focusPolicy()

PySide.QtGui.QGraphicsWidget.focusPolicy()

Return type:PySide.QtCore.Qt.FocusPolicy

This property holds the way the widget accepts keyboard focus.

The focus policy is Qt.TabFocus if the widget accepts keyboard focus by tabbing, Qt.ClickFocus if the widget accepts focus by clicking, Qt.StrongFocus if it accepts both, and Qt.NoFocus (the default) if it does not accept focus at all.

You must enable keyboard focus for a widget if it processes keyboard events. This is normally done from the widget’s constructor. For instance, the PySide.QtGui.QLineEdit constructor calls setFocusPolicy( Qt.StrongFocus ).

If you enable a focus policy (i.e., not Qt.NoFocus ), PySide.QtGui.QGraphicsWidget will automatically enable the ItemIsFocusable flag. Setting Qt.NoFocus on a widget will clear the ItemIsFocusable flag. If the widget currently has keyboard focus, the widget will automatically lose focus.

See also

PySide.QtGui.QGraphicsWidget.focusInEvent() PySide.QtGui.QGraphicsWidget.focusOutEvent() PySide.QtGui.QGraphicsItem.keyPressEvent() PySide.QtGui.QGraphicsItem.keyReleaseEvent() enabled()

PySide.QtGui.QGraphicsWidget.focusWidget()

Return type:PySide.QtGui.QGraphicsWidget

If this widget, a child or descendant of this widget currently has input focus, this function will return a pointer to that widget. If no descendant widget has input focus, 0 is returned.

See also

QGraphicsItem.focusItem() QWidget.focusWidget()

PySide.QtGui.QGraphicsWidget.font()

Return type:PySide.QtGui.QFont

This property holds the widgets’ font.

This property provides the widget’s font.

PySide.QtGui.QFont consists of font properties that have been explicitly defined and properties implicitly inherited from the widget’s parent. Hence, PySide.QtGui.QGraphicsWidget.font() can return a different font compared to the one set with PySide.QtGui.QGraphicsWidget.setFont() . This scheme allows you to define single entries in a font without affecting the font’s inherited entries.

When a widget’s font changes, it resolves its entries against its parent widget. If the widget does not have a parent widget, it resolves its entries against the scene. The widget then sends itself a FontChange event and notifies all its descendants so that they can resolve their fonts as well.

By default, this property contains the application’s default font.

See also

QApplication.font() QGraphicsScene.font QFont.resolve()

PySide.QtGui.QGraphicsWidget.geometryChanged()

PySide.QtGui.QGraphicsWidget.getWindowFrameMargins()

Gets the widget’s window frame margins. The margins are stored in left , top , right and bottom as pointers to qreals. Each argument can be omitted by passing 0.

See also

PySide.QtGui.QGraphicsWidget.setWindowFrameMargins() PySide.QtGui.QGraphicsWidget.windowFrameRect()

PySide.QtGui.QGraphicsWidget.grabKeyboardEvent(event)

Parameters:event – PySide.QtCore.QEvent

This event handler, for event , can be reimplemented in a subclass to receive notifications for QEvent.GrabKeyboard events.

See also

PySide.QtGui.QGraphicsItem.grabKeyboard() PySide.QtGui.QGraphicsItem.grabMouse()

PySide.QtGui.QGraphicsWidget.grabMouseEvent(event)

Parameters:event – PySide.QtCore.QEvent

This event handler, for event , can be reimplemented in a subclass to receive notifications for QEvent.GrabMouse events.

See also

PySide.QtGui.QGraphicsItem.grabMouse() PySide.QtGui.QGraphicsItem.grabKeyboard()

PySide.QtGui.QGraphicsWidget.grabShortcut(sequence[, context=Qt.WindowShortcut])

Parameters:

• sequence – PySide.QtGui.QKeySequence
• context – PySide.QtCore.Qt.ShortcutContext

Return type:

PySide.QtCore.int

PySide.QtGui.QGraphicsWidget.hideEvent(event)

Parameters:event – PySide.QtGui.QHideEvent

This event handler, for Hide events, is delivered after the widget has been hidden, for example, setVisible(false) has been called for the widget or one of its ancestors when the widget was previously shown.

You can reimplement this event handler to detect when your widget is hidden. Calling QEvent.accept() or QEvent.ignore() on event has no effect.

See also

PySide.QtGui.QGraphicsWidget.showEvent() QWidget.hideEvent() ItemVisibleChange

PySide.QtGui.QGraphicsWidget.initStyleOption(option)

Parameters:option – PySide.QtGui.QStyleOption

Populates a style option object for this widget based on its current state, and stores the output in option . The default implementation populates option with the following properties.

Style Option Property	Value
state & QStyle.State_Enabled	Corresponds to QGraphicsItem.isEnabled() .
state & QStyle.State_HasFocus	Corresponds to QGraphicsItem.hasFocus() .
state & QStyle.State_MouseOver	Corresponds to QGraphicsItem.isUnderMouse() .
direction	Corresponds to QGraphicsWidget.layoutDirection() .
rect	Corresponds to QGraphicsWidget.rect() . toRect() .
palette	Corresponds to QGraphicsWidget.palette() .
fontMetrics	Corresponds to PySide.QtGui.QFontMetrics ( QGraphicsWidget.font() ).

Subclasses of PySide.QtGui.QGraphicsWidget should call the base implementation, and then test the type of option using qstyleoption_cast<>() or test QStyleOption.Type before storing widget-specific options.

For example:

class MyGroupBoxWidget (QStyleOptionGroupBox):
    # ...
    def initStyleOption(option):
        QGraphicsWidget.initStyleOption(self, option)
        if isinstance(option, QStyleOptionGroupBox):
            # Add group box specific state.
            box.flat = isFlat()
            # ...

See also

QStyleOption.initFrom()

PySide.QtGui.QGraphicsWidget.insertAction(before, action)

Parameters:

• before – PySide.QtGui.QAction
• action – PySide.QtGui.QAction

Inserts the action action to this widget’s list of actions, before the action before . It appends the action if before is 0 or before is not a valid action for this widget.

A PySide.QtGui.QGraphicsWidget should only have one of each action.

See also

PySide.QtGui.QGraphicsWidget.removeAction() PySide.QtGui.QGraphicsWidget.addAction() PySide.QtGui.QMenu PySide.QtGui.QGraphicsWidget.actions() QWidget.insertActions()

PySide.QtGui.QGraphicsWidget.insertActions(before, actions)

Parameters:

• before – PySide.QtGui.QAction
• actions –

PySide.QtGui.QGraphicsWidget.isActiveWindow()

Return type:PySide.QtCore.bool

Returns true if this widget’s window is in the active window, or if the widget does not have a window but is in an active scene (i.e., a scene that currently has focus).

The active window is the window that either contains a child widget that currently has input focus, or that itself has input focus.

See also

QGraphicsScene.activeWindow() QGraphicsScene.setActiveWindow() PySide.QtGui.QGraphicsItem.isActive()

PySide.QtGui.QGraphicsWidget.layout()

Return type:PySide.QtGui.QGraphicsLayout

This property holds The layout of the widget.

Any existing layout manager is deleted before the new layout is assigned. If layout is 0, the widget is left without a layout. Existing subwidgets’ geometries will remain unaffected.

PySide.QtGui.QGraphicsWidget takes ownership of layout .

All widgets that are currently managed by layout or all of its sublayouts, are automatically reparented to this item. The layout is then invalidated, and the child widget geometries are adjusted according to this item’s PySide.QtGui.QGraphicsLayoutItem.geometry() and contentsMargins(). Children who are not explicitly managed by layout remain unaffected by the layout after it has been assigned to this widget.

If no layout is currently managing this widget, PySide.QtGui.QGraphicsWidget.layout() will return 0.

PySide.QtGui.QGraphicsWidget.layoutChanged()

PySide.QtGui.QGraphicsWidget.layoutDirection()

Return type:PySide.QtCore.Qt.LayoutDirection

This property holds the layout direction for this widget..

This property modifies this widget’s and all of its descendants’ Qt.WA_RightToLeft attribute. It also sets this widget’s Qt.WA_SetLayoutDirection attribute.

The widget’s layout direction determines the order in which the layout manager horizontally arranges subwidgets of this widget. The default value depends on the language and locale of the application, and is typically in the same direction as words are read and written. With Qt.LeftToRight , the layout starts placing subwidgets from the left side of this widget towards the right. Qt.RightToLeft does the opposite - the layout will place widgets starting from the right edge moving towards the left.

Subwidgets inherit their layout direction from the parent. Top-level widget items inherit their layout direction from QGraphicsScene::layoutDirection. If you change a widget’s layout direction by calling PySide.QtGui.QGraphicsWidget.setLayoutDirection() , the widget will send itself a LayoutDirectionChange event, and then propagate the new layout direction to all its descendants.

See also

QWidget.layoutDirection QApplication.layoutDirection

PySide.QtGui.QGraphicsWidget.moveEvent(event)

Parameters:event – PySide.QtGui.QGraphicsSceneMoveEvent

This event handler, for GraphicsSceneMove events, is delivered after the widget has moved (e.g., its local position has changed).

This event is only delivered when the item is moved locally. Calling PySide.QtGui.QGraphicsItem.setTransform() or moving any of the item’s ancestors does not affect the item’s local position.

You can reimplement this event handler to detect when your widget has moved. Calling QEvent.accept() or QEvent.ignore() on event has no effect.

See also

ItemPositionChange ItemPositionHasChanged

PySide.QtGui.QGraphicsWidget.paintWindowFrame(painter, option[, widget=None])

Parameters:

• painter – PySide.QtGui.QPainter
• option – PySide.QtGui.QStyleOptionGraphicsItem
• widget – PySide.QtGui.QWidget

This virtual function is called by PySide.QtGui.QGraphicsScene to draw the window frame for windows using painter , option , and widget , in local coordinates. The base implementation uses the current style to render the frame and title bar.

You can reimplement this function in a subclass of PySide.QtGui.QGraphicsWidget to provide custom rendering of the widget’s window frame.

See also

QGraphicsItem.paint()

PySide.QtGui.QGraphicsWidget.palette()

Return type:PySide.QtGui.QPalette

This property holds the widget’s palette.

This property provides the widget’s palette. The palette provides colors and brushes for color groups (e.g., QPalette.Button ) and states (e.g., QPalette.Inactive ), loosely defining the general look of the widget and its children.

PySide.QtGui.QPalette consists of color groups that have been explicitly defined, and groups that are implicitly inherited from the widget’s parent. Because of this, PySide.QtGui.QGraphicsWidget.palette() can return a different palette than what has been set with PySide.QtGui.QGraphicsWidget.setPalette() . This scheme allows you to define single entries in a palette without affecting the palette’s inherited entries.

When a widget’s palette changes, it resolves its entries against its parent widget, or if it doesn’t have a parent widget, it resolves against the scene. It then sends itself a PaletteChange event, and notifies all its descendants so they can resolve their palettes as well.

By default, this property contains the application’s default palette.

See also

QApplication.palette() QGraphicsScene.palette QPalette.resolve()

PySide.QtGui.QGraphicsWidget.polishEvent()

This event is delivered to the item by the scene at some point after it has been constructed, but before it is shown or otherwise accessed through the scene. You can use this event handler to do last-minute initializations of the widget which require the item to be fully constructed.

The base implementation does nothing.

PySide.QtGui.QGraphicsWidget.propertyChange(propertyName, value)

Parameters:

• propertyName – unicode
• value – object

Return type:

object

This virtual function is used to notify changes to any property (both dynamic properties, and registered with Q_PROPERTY) in the widget. Depending on the property itself, the notification can be delivered before or after the value has changed.

propertyName is the name of the property (e.g., “size” or “font”), and value is the (proposed) new value of the property. The function returns the new value, which may be different from value if the notification supports adjusting the property value. The base implementation simply returns value for any propertyName .

PySide.QtGui.QGraphicsWidget delivers notifications for the following properties:

PySide.QtGui.QGraphicsWidget.layoutDirection()	QGraphicsWidget.layoutDirection
size	QGraphicsWidget.size
font	QGraphicsWidget.font
palette	QGraphicsWidget.palette

See also

PySide.QtGui.QGraphicsWidget.itemChange()

PySide.QtGui.QGraphicsWidget.rect()

Return type:PySide.QtCore.QRectF

Returns the item’s local rect as a PySide.QtCore.QRectF . This function is equivalent to PySide.QtCore.QRectF ( QPointF() , PySide.QtGui.QGraphicsWidget.size() ).

See also

PySide.QtGui.QGraphicsWidget.setGeometry() PySide.QtGui.QGraphicsWidget.resize()

PySide.QtGui.QGraphicsWidget.releaseShortcut(id)

Parameters:id – PySide.QtCore.int

Removes the shortcut with the given id from Qt’s shortcut system. The widget will no longer receive QEvent.Shortcut events for the shortcut’s key sequence (unless it has other shortcuts with the same key sequence).

Warning

You should not normally need to use this function since Qt’s shortcut system removes shortcuts automatically when their parent widget is destroyed. It is best to use PySide.QtGui.QAction or PySide.QtGui.QShortcut to handle shortcuts, since they are easier to use than this low-level function. Note also that this is an expensive operation.

See also

PySide.QtGui.QGraphicsWidget.grabShortcut() PySide.QtGui.QGraphicsWidget.setShortcutEnabled() QWidget.releaseShortcut()

PySide.QtGui.QGraphicsWidget.removeAction(action)

Parameters:action – PySide.QtGui.QAction

Removes the action action from this widget’s list of actions.

See also

PySide.QtGui.QGraphicsWidget.insertAction() PySide.QtGui.QGraphicsWidget.actions() PySide.QtGui.QGraphicsWidget.insertAction() QWidget.removeAction()

PySide.QtGui.QGraphicsWidget.resize(size)

Parameters:size – PySide.QtCore.QSizeF

This property holds the size of the widget.

Calling PySide.QtGui.QGraphicsWidget.resize() resizes the widget to a size bounded by PySide.QtGui.QGraphicsLayoutItem.minimumSize() and PySide.QtGui.QGraphicsLayoutItem.maximumSize() . This property only affects the widget’s width and height (e.g., its right and bottom edges); the widget’s position and top-left corner remains unaffected.

Resizing a widget triggers the widget to immediately receive a GraphicsSceneResize event with the widget’s old and new size. If the widget has a layout assigned when this event arrives, the layout will be activated and it will automatically update any child widgets’s geometry.

This property does not affect any layout of the parent widget. If the widget itself is managed by a parent layout; e.g., it has a parent widget with a layout assigned, that layout will not activate.

By default, this property contains a size with zero width and height.

See also

PySide.QtGui.QGraphicsWidget.setGeometry() PySide.QtGui.QGraphicsSceneResizeEvent PySide.QtGui.QGraphicsLayout

PySide.QtGui.QGraphicsWidget.resize(w, h)

Parameters:

• w – PySide.QtCore.qreal
• h – PySide.QtCore.qreal

This convenience function is equivalent to calling resize( PySide.QtCore.QSizeF (w, h)).

See also

PySide.QtGui.QGraphicsWidget.setGeometry() PySide.QtGui.QGraphicsItem.setTransform()

PySide.QtGui.QGraphicsWidget.resizeEvent(event)

Parameters:event – PySide.QtGui.QGraphicsSceneResizeEvent

This event handler, for GraphicsSceneResize events, is delivered after the widget has been resized (i.e., its local size has changed). event contains both the old and the new size.

This event is only delivered when the widget is resized locally; calling PySide.QtGui.QGraphicsItem.setTransform() on the widget or any of its ancestors or view, does not affect the widget’s local size.

You can reimplement this event handler to detect when your widget has been resized. Calling QEvent.accept() or QEvent.ignore() on event has no effect.

See also

PySide.QtGui.QGraphicsLayoutItem.geometry() PySide.QtGui.QGraphicsWidget.setGeometry()

PySide.QtGui.QGraphicsWidget.setAttribute(attribute[, on=true])

Parameters:

• attribute – PySide.QtCore.Qt.WidgetAttribute
• on – PySide.QtCore.bool

PySide.QtGui.QGraphicsWidget.setAutoFillBackground(enabled)

Parameters:enabled – PySide.QtCore.bool

This property holds whether the widget background is filled automatically.

If enabled, this property will cause Qt to fill the background of the widget before invoking the PySide.QtGui.QGraphicsWidget.paint() method. The color used is defined by the QPalette.Window color role from the widget’s palette .

In addition, Windows are always filled with QPalette.Window , unless the WA_OpaquePaintEvent or WA_NoSystemBackground attributes are set.

By default, this property is false.

See also

Qt.WA_OpaquePaintEvent Qt.WA_NoSystemBackground

PySide.QtGui.QGraphicsWidget.setContentsMargins(left, top, right, bottom)

Parameters:

• left – PySide.QtCore.qreal
• top – PySide.QtCore.qreal
• right – PySide.QtCore.qreal
• bottom – PySide.QtCore.qreal

Sets the widget’s contents margins to left , top , right and bottom .

Contents margins are used by the assigned layout to define the placement of subwidgets and layouts. Margins are particularly useful for widgets that constrain subwidgets to only a section of its own geometry. For example, a group box with a layout will place subwidgets inside its frame, but below the title.

Changing a widget’s contents margins will always trigger an PySide.QtGui.QGraphicsItem.update() , and any assigned layout will be activated automatically. The widget will then receive a ContentsRectChange event.

See also

PySide.QtGui.QGraphicsWidget.getContentsMargins() PySide.QtGui.QGraphicsWidget.setGeometry()

PySide.QtGui.QGraphicsWidget.setFocusPolicy(policy)

Parameters:policy – PySide.QtCore.Qt.FocusPolicy

This property holds the way the widget accepts keyboard focus.

The focus policy is Qt.TabFocus if the widget accepts keyboard focus by tabbing, Qt.ClickFocus if the widget accepts focus by clicking, Qt.StrongFocus if it accepts both, and Qt.NoFocus (the default) if it does not accept focus at all.

You must enable keyboard focus for a widget if it processes keyboard events. This is normally done from the widget’s constructor. For instance, the PySide.QtGui.QLineEdit constructor calls setFocusPolicy( Qt.StrongFocus ).

If you enable a focus policy (i.e., not Qt.NoFocus ), PySide.QtGui.QGraphicsWidget will automatically enable the ItemIsFocusable flag. Setting Qt.NoFocus on a widget will clear the ItemIsFocusable flag. If the widget currently has keyboard focus, the widget will automatically lose focus.

See also

PySide.QtGui.QGraphicsWidget.focusInEvent() PySide.QtGui.QGraphicsWidget.focusOutEvent() PySide.QtGui.QGraphicsItem.keyPressEvent() PySide.QtGui.QGraphicsItem.keyReleaseEvent() enabled()

PySide.QtGui.QGraphicsWidget.setFont(font)

Parameters:font – PySide.QtGui.QFont

This property holds the widgets’ font.

This property provides the widget’s font.

PySide.QtGui.QFont consists of font properties that have been explicitly defined and properties implicitly inherited from the widget’s parent. Hence, PySide.QtGui.QGraphicsWidget.font() can return a different font compared to the one set with PySide.QtGui.QGraphicsWidget.setFont() . This scheme allows you to define single entries in a font without affecting the font’s inherited entries.

When a widget’s font changes, it resolves its entries against its parent widget. If the widget does not have a parent widget, it resolves its entries against the scene. The widget then sends itself a FontChange event and notifies all its descendants so that they can resolve their fonts as well.

By default, this property contains the application’s default font.

See also

QApplication.font() QGraphicsScene.font QFont.resolve()

PySide.QtGui.QGraphicsWidget.setGeometry(x, y, w, h)

Parameters:

• x – PySide.QtCore.qreal
• y – PySide.QtCore.qreal
• w – PySide.QtCore.qreal
• h – PySide.QtCore.qreal

This convenience function is equivalent to calling setGeometry( PySide.QtCore.QRectF ( x , y , w , h )).

See also

PySide.QtGui.QGraphicsLayoutItem.geometry() PySide.QtGui.QGraphicsWidget.resize()

PySide.QtGui.QGraphicsWidget.setLayout(layout)

Parameters:layout – PySide.QtGui.QGraphicsLayout

This property holds The layout of the widget.

Any existing layout manager is deleted before the new layout is assigned. If layout is 0, the widget is left without a layout. Existing subwidgets’ geometries will remain unaffected.

PySide.QtGui.QGraphicsWidget takes ownership of layout .

All widgets that are currently managed by layout or all of its sublayouts, are automatically reparented to this item. The layout is then invalidated, and the child widget geometries are adjusted according to this item’s PySide.QtGui.QGraphicsLayoutItem.geometry() and contentsMargins(). Children who are not explicitly managed by layout remain unaffected by the layout after it has been assigned to this widget.

If no layout is currently managing this widget, PySide.QtGui.QGraphicsWidget.layout() will return 0.

PySide.QtGui.QGraphicsWidget.setLayoutDirection(direction)

Parameters:direction – PySide.QtCore.Qt.LayoutDirection

This property holds the layout direction for this widget..

This property modifies this widget’s and all of its descendants’ Qt.WA_RightToLeft attribute. It also sets this widget’s Qt.WA_SetLayoutDirection attribute.

The widget’s layout direction determines the order in which the layout manager horizontally arranges subwidgets of this widget. The default value depends on the language and locale of the application, and is typically in the same direction as words are read and written. With Qt.LeftToRight , the layout starts placing subwidgets from the left side of this widget towards the right. Qt.RightToLeft does the opposite - the layout will place widgets starting from the right edge moving towards the left.

Subwidgets inherit their layout direction from the parent. Top-level widget items inherit their layout direction from QGraphicsScene::layoutDirection. If you change a widget’s layout direction by calling PySide.QtGui.QGraphicsWidget.setLayoutDirection() , the widget will send itself a LayoutDirectionChange event, and then propagate the new layout direction to all its descendants.

See also

QWidget.layoutDirection QApplication.layoutDirection

PySide.QtGui.QGraphicsWidget.setPalette(palette)

Parameters:palette – PySide.QtGui.QPalette

This property holds the widget’s palette.

This property provides the widget’s palette. The palette provides colors and brushes for color groups (e.g., QPalette.Button ) and states (e.g., QPalette.Inactive ), loosely defining the general look of the widget and its children.

PySide.QtGui.QPalette consists of color groups that have been explicitly defined, and groups that are implicitly inherited from the widget’s parent. Because of this, PySide.QtGui.QGraphicsWidget.palette() can return a different palette than what has been set with PySide.QtGui.QGraphicsWidget.setPalette() . This scheme allows you to define single entries in a palette without affecting the palette’s inherited entries.

When a widget’s palette changes, it resolves its entries against its parent widget, or if it doesn’t have a parent widget, it resolves against the scene. It then sends itself a PaletteChange event, and notifies all its descendants so they can resolve their palettes as well.

By default, this property contains the application’s default palette.

See also

QApplication.palette() QGraphicsScene.palette QPalette.resolve()

PySide.QtGui.QGraphicsWidget.setShortcutAutoRepeat(id[, enabled=true])

Parameters:

• id – PySide.QtCore.int
• enabled – PySide.QtCore.bool

If enabled is true, auto repeat of the shortcut with the given id is enabled; otherwise it is disabled.

See also

PySide.QtGui.QGraphicsWidget.grabShortcut() PySide.QtGui.QGraphicsWidget.releaseShortcut() QWidget.setShortcutAutoRepeat()

PySide.QtGui.QGraphicsWidget.setShortcutEnabled(id[, enabled=true])

Parameters:

• id – PySide.QtCore.int
• enabled – PySide.QtCore.bool

If enabled is true, the shortcut with the given id is enabled; otherwise the shortcut is disabled.

Warning

You should not normally need to use this function since Qt’s shortcut system enables/disables shortcuts automatically as widgets become hidden/visible and gain or lose focus. It is best to use PySide.QtGui.QAction or PySide.QtGui.QShortcut to handle shortcuts, since they are easier to use than this low-level function.

See also

PySide.QtGui.QGraphicsWidget.grabShortcut() PySide.QtGui.QGraphicsWidget.releaseShortcut() QWidget.setShortcutEnabled()

PySide.QtGui.QGraphicsWidget.setStyle(style)

Parameters:style – PySide.QtGui.QStyle

Sets the widget’s style to style . PySide.QtGui.QGraphicsWidget does not take ownership of style .

If no style is assigned, or style is 0, the widget will use QGraphicsScene.style() (if this has been set). Otherwise the widget will use QApplication.style() .

This function sets the Qt.WA_SetStyle attribute if style is not 0; otherwise it clears the attribute.

See also

PySide.QtGui.QGraphicsWidget.style()

static PySide.QtGui.QGraphicsWidget.setTabOrder(first, second)

Parameters:

• first – PySide.QtGui.QGraphicsWidget
• second – PySide.QtGui.QGraphicsWidget

Moves the second widget around the ring of focus widgets so that keyboard focus moves from the first widget to the second widget when the Tab key is pressed.

Note that since the tab order of the second widget is changed, you should order a chain like this:

setTabOrder(a, b) # a to b
setTabOrder(b, c) # a to b to c
setTabOrder(c, d) # a to b to c to d

not like this:

# WRONG
setTabOrder(c, d) # c to d
setTabOrder(a, b) # a to b AND c to d
setTabOrder(b, c) # a to b to c, but not c to d

If first is 0, this indicates that second should be the first widget to receive input focus should the scene gain Tab focus (i.e., the user hits Tab so that focus passes into the scene). If second is 0, this indicates that first should be the first widget to gain focus if the scene gained BackTab focus.

By default, tab order is defined implicitly using widget creation order.

See also

PySide.QtGui.QGraphicsWidget.focusPolicy() Keyboard Focus

PySide.QtGui.QGraphicsWidget.setWindowFlags(wFlags)

Parameters:wFlags – PySide.QtCore.Qt.WindowFlags

This property holds the widget’s window flags.

Window flags are a combination of a window type (e.g., Qt.Dialog ) and several flags giving hints on the behavior of the window. The behavior is platform-dependent.

By default, this property contains no window flags.

Windows are panels. If you set the Qt.Window flag, the ItemIsPanel flag will be set automatically. If you clear the Qt.Window flag, the ItemIsPanel flag is also cleared. Note that the ItemIsPanel flag can be set independently of Qt.Window .

See also

PySide.QtGui.QGraphicsItem.isWindow() PySide.QtGui.QGraphicsItem.isPanel()

PySide.QtGui.QGraphicsWidget.setWindowFrameMargins(left, top, right, bottom)

Parameters:

• left – PySide.QtCore.qreal
• top – PySide.QtCore.qreal
• right – PySide.QtCore.qreal
• bottom – PySide.QtCore.qreal

Sets the widget’s window frame margins to left , top , right and bottom . The default frame margins are provided by the style, and they depend on the current window flags.

If you would like to draw your own window decoration, you can set your own frame margins to override the default margins.

See also

PySide.QtGui.QGraphicsWidget.unsetWindowFrameMargins() PySide.QtGui.QGraphicsWidget.getWindowFrameMargins() PySide.QtGui.QGraphicsWidget.windowFrameRect()

PySide.QtGui.QGraphicsWidget.setWindowTitle(title)

Parameters:title – unicode

This property holds This property holds the window title (caption)..

This property is only used for windows.

By default, if no title has been set, this property contains an empty string.

PySide.QtGui.QGraphicsWidget.showEvent(event)

Parameters:event – PySide.QtGui.QShowEvent

This event handler, for Show events, is delivered before the widget has been shown, for example, setVisible(true) has been called for the widget or one of its ancestors when the widget was previously hidden.

You can reimplement this event handler to detect when your widget is shown. Calling QEvent.accept() or QEvent.ignore() on event has no effect.

See also

PySide.QtGui.QGraphicsWidget.hideEvent() QWidget.showEvent() ItemVisibleChange

PySide.QtGui.QGraphicsWidget.size()

Return type:PySide.QtCore.QSizeF

This property holds the size of the widget.

Calling PySide.QtGui.QGraphicsWidget.resize() resizes the widget to a size bounded by PySide.QtGui.QGraphicsLayoutItem.minimumSize() and PySide.QtGui.QGraphicsLayoutItem.maximumSize() . This property only affects the widget’s width and height (e.g., its right and bottom edges); the widget’s position and top-left corner remains unaffected.

Resizing a widget triggers the widget to immediately receive a GraphicsSceneResize event with the widget’s old and new size. If the widget has a layout assigned when this event arrives, the layout will be activated and it will automatically update any child widgets’s geometry.

This property does not affect any layout of the parent widget. If the widget itself is managed by a parent layout; e.g., it has a parent widget with a layout assigned, that layout will not activate.

By default, this property contains a size with zero width and height.

See also

PySide.QtGui.QGraphicsWidget.setGeometry() PySide.QtGui.QGraphicsSceneResizeEvent PySide.QtGui.QGraphicsLayout

PySide.QtGui.QGraphicsWidget.style()

Return type:PySide.QtGui.QStyle

Returns a pointer to the widget’s style. If this widget does not have any explicitly assigned style, the scene’s style is returned instead. In turn, if the scene does not have any assigned style, this function returns QApplication.style() .

See also

PySide.QtGui.QGraphicsWidget.setStyle()

PySide.QtGui.QGraphicsWidget.testAttribute(attribute)

Parameters:attribute – PySide.QtCore.Qt.WidgetAttribute Return type:PySide.QtCore.bool

PySide.QtGui.QGraphicsWidget.ungrabKeyboardEvent(event)

Parameters:event – PySide.QtCore.QEvent

This event handler, for event , can be reimplemented in a subclass to receive notifications for QEvent.UngrabKeyboard events.

See also

PySide.QtGui.QGraphicsItem.ungrabKeyboard() PySide.QtGui.QGraphicsItem.ungrabMouse()

PySide.QtGui.QGraphicsWidget.ungrabMouseEvent(event)

Parameters:event – PySide.QtCore.QEvent

This event handler, for event , can be reimplemented in a subclass to receive notifications for QEvent.UngrabMouse events.

See also

PySide.QtGui.QGraphicsItem.ungrabMouse() PySide.QtGui.QGraphicsItem.ungrabKeyboard()

PySide.QtGui.QGraphicsWidget.unsetLayoutDirection()

This property holds the layout direction for this widget..

This property modifies this widget’s and all of its descendants’ Qt.WA_RightToLeft attribute. It also sets this widget’s Qt.WA_SetLayoutDirection attribute.

The widget’s layout direction determines the order in which the layout manager horizontally arranges subwidgets of this widget. The default value depends on the language and locale of the application, and is typically in the same direction as words are read and written. With Qt.LeftToRight , the layout starts placing subwidgets from the left side of this widget towards the right. Qt.RightToLeft does the opposite - the layout will place widgets starting from the right edge moving towards the left.

Subwidgets inherit their layout direction from the parent. Top-level widget items inherit their layout direction from QGraphicsScene::layoutDirection. If you change a widget’s layout direction by calling PySide.QtGui.QGraphicsWidget.setLayoutDirection() , the widget will send itself a LayoutDirectionChange event, and then propagate the new layout direction to all its descendants.

See also

QWidget.layoutDirection QApplication.layoutDirection

PySide.QtGui.QGraphicsWidget.unsetWindowFrameMargins()

Resets the window frame margins to the default value, provided by the style.

See also

PySide.QtGui.QGraphicsWidget.setWindowFrameMargins() PySide.QtGui.QGraphicsWidget.getWindowFrameMargins() PySide.QtGui.QGraphicsWidget.windowFrameRect()

PySide.QtGui.QGraphicsWidget.windowFlags()

Return type:PySide.QtCore.Qt.WindowFlags

This property holds the widget’s window flags.

Window flags are a combination of a window type (e.g., Qt.Dialog ) and several flags giving hints on the behavior of the window. The behavior is platform-dependent.

By default, this property contains no window flags.

Windows are panels. If you set the Qt.Window flag, the ItemIsPanel flag will be set automatically. If you clear the Qt.Window flag, the ItemIsPanel flag is also cleared. Note that the ItemIsPanel flag can be set independently of Qt.Window .

See also

PySide.QtGui.QGraphicsItem.isWindow() PySide.QtGui.QGraphicsItem.isPanel()

PySide.QtGui.QGraphicsWidget.windowFrameEvent(e)

Parameters:e – PySide.QtCore.QEvent Return type:PySide.QtCore.bool

This event handler, for event , receives events for the window frame if this widget is a window. Its base implementation provides support for default window frame interaction such as moving, resizing, etc.

You can reimplement this handler in a subclass of PySide.QtGui.QGraphicsWidget to provide your own custom window frame interaction support.

Returns true if event has been recognized and processed; otherwise, returns false.

See also

PySide.QtGui.QGraphicsWidget.event()

PySide.QtGui.QGraphicsWidget.windowFrameGeometry()

Return type:PySide.QtCore.QRectF

Returns the widget’s geometry in parent coordinates including any window frame.

See also

PySide.QtGui.QGraphicsWidget.windowFrameRect() PySide.QtGui.QGraphicsWidget.getWindowFrameMargins() PySide.QtGui.QGraphicsWidget.setWindowFrameMargins()

PySide.QtGui.QGraphicsWidget.windowFrameRect()

Return type:PySide.QtCore.QRectF

Returns the widget’s local rect including any window frame.

See also

PySide.QtGui.QGraphicsWidget.windowFrameGeometry() PySide.QtGui.QGraphicsWidget.getWindowFrameMargins() PySide.QtGui.QGraphicsWidget.setWindowFrameMargins()

PySide.QtGui.QGraphicsWidget.windowFrameSectionAt(pos)

Parameters:pos – PySide.QtCore.QPointF Return type:PySide.QtCore.Qt.WindowFrameSection

Returns the window frame section at position pos , or Qt.NoSection if there is no window frame section at this position.

This function is used in PySide.QtGui.QGraphicsWidget ‘s base implementation for window frame interaction.

You can reimplement this function if you want to customize how a window can be interactively moved or resized. For instance, if you only want to allow a window to be resized by the bottom right corner, you can reimplement this function to return Qt.NoSection for all sections except Qt.BottomRightSection .

See also

PySide.QtGui.QGraphicsWidget.windowFrameEvent() PySide.QtGui.QGraphicsWidget.paintWindowFrame() PySide.QtGui.QGraphicsWidget.windowFrameGeometry()

PySide.QtGui.QGraphicsWidget.windowTitle()

Return type:unicode

This property holds This property holds the window title (caption)..

This property is only used for windows.

By default, if no title has been set, this property contains an empty string.

PySide.QtGui.QGraphicsWidget.windowType()

Return type:PySide.QtCore.Qt.WindowType

Returns the widgets window type.

See also

PySide.QtGui.QGraphicsWidget.windowFlags() PySide.QtGui.QGraphicsItem.isWindow() PySide.QtGui.QGraphicsItem.isPanel()