PySide6.QtWidgets.QGraphicsLayoutItem

class QGraphicsLayoutItem

The QGraphicsLayoutItem class can be inherited to allow your custom items to be managed by layouts. More…

Inherited by: QGraphicsLayout, QGraphicsLinearLayout, QGraphicsGridLayout, QGraphicsAnchorLayout, QGraphicsWidget, QGraphicsProxyWidget, QLegend, QChart, QPolarChart

Synopsis

Methods

Virtual methods

Note

This documentation may contain snippets that were automatically translated from C++ to Python. We always welcome contributions to the snippet translation. If you see an issue with the translation, you can also let us know by creating a ticket on https:/bugreports.qt.io/projects/PYSIDE

Detailed Description

QGraphicsLayoutItem is an abstract class that defines a set of virtual functions describing sizes, size policies, and size hints for any object arranged by QGraphicsLayout . The API contains functions relevant for both the item itself and for the user of the item as most of QGraphicsLayoutItem ‘s functions are also part of the subclass’ public API.

In most cases, existing layout-aware classes such as QGraphicsWidget and QGraphicsLayout already provide the functionality you require. However, subclassing these classes will enable you to create both graphical elements that work well with layouts ( QGraphicsWidget ) or custom layouts ( QGraphicsLayout ).

Subclassing QGraphicsLayoutItem

If you create a subclass of QGraphicsLayoutItem and reimplement its virtual functions, you will enable the layout to resize and position your item along with other QGraphicsLayoutItems including QGraphicsWidget and QGraphicsLayout .

You can start by reimplementing important functions: the protected sizeHint() function, as well as the public setGeometry() function. If you want your items to be aware of immediate geometry changes, you can also reimplement updateGeometry() .

The geometry, size hint, and size policy affect the item’s size and position. Calling setGeometry() will always resize and reposition the item immediately. Normally, this function is called by QGraphicsLayout after the layout has been activated, but it can also be called by the item’s user at any time.

The sizeHint() function returns the item’ minimum, preferred and maximum size hints. You can override these properties by calling setMinimumSize() , setPreferredSize() or setMaximumSize() . You can also use functions such as setMinimumWidth() or setMaximumHeight() to set only the width or height component if desired.

The effectiveSizeHint() function, on the other hand, returns a size hint for any given Qt::SizeHint, and guarantees that the returned size is bound to the minimum and maximum sizes and size hints. You can set the item’s vertical and horizontal size policy by calling setSizePolicy() . The sizePolicy property is used by the layout system to describe how this item prefers to grow or shrink.

Nesting QGraphicsLayoutItems

QGraphicsLayoutItems can be nested within other QGraphicsLayoutItems, similar to layouts that can contain sublayouts. This is done either by passing a QGraphicsLayoutItem pointer to QGraphicsLayoutItem ‘s protected constructor, or by calling setParentLayoutItem() . The parentLayoutItem() function returns a pointer to the item’s layoutItem parent. If the item’s parent is None or if the parent does not inherit from QGraphicsItem , the parentLayoutItem() function then returns None. isLayout() returns true if the QGraphicsLayoutItem subclass is itself a layout, or false otherwise.

Qt uses QGraphicsLayoutItem to provide layout functionality in the Graphics View Framework , but in the future its use may spread throughout Qt itself.

__init__([parent=None[, isLayout=false]])
Parameters:

Constructs the QGraphicsLayoutItem object. parent becomes the object’s parent. If isLayout is true the item is a layout, otherwise isLayout is false.

contentsRect()
Return type:

QRectF

Returns the contents rect in local coordinates.

The contents rect defines the subrectangle used by an associated layout when arranging subitems. This function is a convenience function that adjusts the item’s geometry() by its contents margins. Note that getContentsMargins() is a virtual function that you can reimplement to return the item’s contents margins.

effectiveSizeHint(which[, constraint=QSizeF()])
Parameters:
Return type:

QSizeF

Returns the effective size hint for this QGraphicsLayoutItem .

which is the size hint in question. constraint is an optional argument that defines a special constrain when calculating the effective size hint. By default, constraint is QSizeF(-1, -1), which means there is no constraint to the size hint.

If you want to specify the widget’s size hint for a given width or height, you can provide the fixed dimension in constraint. This is useful for widgets that can grow only either vertically or horizontally, and need to set either their width or their height to a special value.

For example, a text paragraph item fit into a column width of 200 may grow vertically. You can pass QSizeF(200, -1) as a constraint to get a suitable minimum, preferred and maximum height).

You can adjust the effective size hint by reimplementing sizeHint() in a QGraphicsLayoutItem subclass, or by calling one of the following functions: setMinimumSize() , setPreferredSize , or setMaximumSize() (or a combination of both).

This function caches each of the size hints and guarantees that sizeHint() will be called only once for each value of which - unless constraint is not specified and updateGeometry() has been called.

See also

sizeHint()

geometry()
Return type:

QRectF

Returns the item’s geometry (e.g., position and size) as a QRectF. This function is equivalent to QRectF(pos(), size()).

See also

setGeometry()

getContentsMargins()
Return type:

PyObject

This virtual function provides the left, top, right and bottom contents margins for this QGraphicsLayoutItem . The default implementation assumes all contents margins are 0. The parameters point to values stored in qreals. If any of the pointers is None, that value will not be updated.

graphicsItem()
Return type:

QGraphicsItem

Returns the QGraphicsItem that this layout item represents. For QGraphicsWidget it will return itself. For custom items it can return an aggregated value.

isEmpty()
Return type:

bool

Returns true if this item is empty, i.e whether it has no content and should not occupy any space.

The default implementation returns true true if the item has been hidden, unless its size policy has retainSizeWhenHidden set to true

See also

sizePolicy()

isLayout()
Return type:

bool

Returns true if this QGraphicsLayoutItem is a layout (e.g., is inherited by an object that arranges other QGraphicsLayoutItem objects); otherwise returns false.

See also

QGraphicsLayout

maximumHeight()
Return type:

float

Returns the maximum height.

maximumSize()
Return type:

QSizeF

Returns the maximum size.

maximumWidth()
Return type:

float

Returns the maximum width.

minimumHeight()
Return type:

float

Returns the minimum height.

minimumSize()
Return type:

QSizeF

Returns the minimum size.

minimumWidth()
Return type:

float

Returns the minimum width.

ownedByLayout()
Return type:

bool

Returns whether a layout should delete this item in its destructor. If its true, then the layout will delete it. If its false, then it is assumed that another object has the ownership of it, and the layout won’t delete this item.

If the item inherits both QGraphicsItem and QGraphicsLayoutItem (such as QGraphicsWidget does) the item is really part of two ownership hierarchies. This property informs what the layout should do with its child items when it is destructed. In the case of QGraphicsWidget , it is preferred that when the layout is deleted it won’t delete its children (since they are also part of the graphics item hierarchy).

By default this value is initialized to false in QGraphicsLayoutItem , but it is overridden by QGraphicsLayout to return true. This is because QGraphicsLayout is not normally part of the QGraphicsItem hierarchy, so the parent layout should delete it. Subclasses might override this default behaviour by calling setOwnedByLayout (true).

parentLayoutItem()
Return type:

QGraphicsLayoutItem

Returns the parent of this QGraphicsLayoutItem , or None if there is no parent, or if the parent does not inherit from QGraphicsLayoutItem ( QGraphicsLayoutItem is often used through multiple inheritance with QObject-derived classes).

preferredHeight()
Return type:

float

Returns the preferred height.

preferredSize()
Return type:

QSizeF

Returns the preferred size.

preferredWidth()
Return type:

float

Returns the preferred width.

setGeometry(rect)
Parameters:

rect – QRectF

This virtual function sets the geometry of the QGraphicsLayoutItem to rect, which is in parent coordinates (e.g., the top-left corner of rect is equivalent to the item’s position in parent coordinates).

You must reimplement this function in a subclass of QGraphicsLayoutItem to receive geometry updates. The layout will call this function when it does a rearrangement.

If rect is outside of the bounds of minimumSize and maximumSize , it will be adjusted to its closest size so that it is within the legal bounds.

See also

geometry()

setGraphicsItem(item)
Parameters:

item – QGraphicsItem

If the QGraphicsLayoutItem represents a QGraphicsItem , and it wants to take advantage of the automatic reparenting capabilities of QGraphicsLayout it should set this value. Note that if you delete item and not delete the layout item, you are responsible of calling setGraphicsItem(None) in order to avoid having a dangling pointer.

See also

graphicsItem()

setMaximumHeight(height)
Parameters:

height – float

Sets the maximum height to height.

setMaximumSize(size)
Parameters:

size – QSizeF

Sets the maximum size to size. This property overrides sizeHint() for Qt::MaximumSize and ensures that effectiveSizeHint() will never return a size larger than size. In order to unset the maximum size, use an invalid size.

setMaximumSize(w, h)
Parameters:

  • w – float

  • h – float

This convenience function is equivalent to calling setMaximumSize (QSizeF(w, h)).

setMaximumWidth(width)
Parameters:

width – float

Sets the maximum width to width.

setMinimumHeight(height)
Parameters:

height – float

Sets the minimum height to height.

setMinimumSize(size)
Parameters:

size – QSizeF

Sets the minimum size to size. This property overrides sizeHint() for Qt::MinimumSize and ensures that effectiveSizeHint() will never return a size smaller than size. In order to unset the minimum size, use an invalid size.

setMinimumSize(w, h)
Parameters:

  • w – float

  • h – float

This convenience function is equivalent to calling setMinimumSize (QSizeF(w, h)).

setMinimumWidth(width)
Parameters:

width – float

Sets the minimum width to width.

setOwnedByLayout(ownedByLayout)
Parameters:

ownedByLayout – bool

Sets whether a layout should delete this item in its destructor or not. ownership must be true to in order for the layout to delete it.

See also

ownedByLayout()

setParentLayoutItem(parent)
Parameters:

parent – QGraphicsLayoutItem

Sets the parent of this QGraphicsLayoutItem to parent.

setPreferredHeight(height)
Parameters:

height – float

Sets the preferred height to height.

setPreferredSize(size)
Parameters:

size – QSizeF

Sets the preferred size to size. This property overrides sizeHint() for Qt::PreferredSize and provides the default value for effectiveSizeHint() . In order to unset the preferred size, use an invalid size.

setPreferredSize(w, h)
Parameters:

  • w – float

  • h – float

This convenience function is equivalent to calling setPreferredSize (QSizeF(w, h)).

setPreferredWidth(width)
Parameters:

width – float

Sets the preferred width to width.

setSizePolicy(policy)
Parameters:

policy – QSizePolicy

Sets the size policy to policy. The size policy describes how the item should grow horizontally and vertically when arranged in a layout.

QGraphicsLayoutItem ‘s default size policy is ( Fixed , Fixed , DefaultType ), but it is common for subclasses to change the default. For example, QGraphicsWidget defaults to ( Preferred , Preferred , DefaultType ).

setSizePolicy(hPolicy, vPolicy[, controlType=QSizePolicy.DefaultType])
Parameters:

This is an overloaded function.

This function is equivalent to calling setSizePolicy ( QSizePolicy (hPolicy, vPolicy, controlType)).

abstract sizeHint(which[, constraint=QSizeF()])
Parameters:
Return type:

QSizeF

This pure virtual function returns the size hint for which of the QGraphicsLayoutItem , using the width or height of constraint to constrain the output.

Reimplement this function in a subclass of QGraphicsLayoutItem to provide the necessary size hints for your items.

sizePolicy()
Return type:

QSizePolicy

Returns the current size policy.

updateGeometry()

This virtual function discards any cached size hint information. You should always call this function if you change the return value of the sizeHint() function. Subclasses must always call the base implementation when reimplementing this function.