KLayout 0.29.8 (2024-10-28 63dd591e5) [master]

API reference - Class QGraphicsGridLayout

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QGraphicsGridLayout

Class hierarchy: QGraphicsGridLayout » QGraphicsLayout » QGraphicsLayoutItem

Public constructors

new QGraphicsGridLayoutnew(QGraphicsLayoutItem ptr parent = nullptr)Constructor QGraphicsGridLayout::QGraphicsGridLayout(QGraphicsLayoutItem *parent)

Public methods

[const]QGraphicsGridLayout ptr_const_castReturns a non-const reference to self.
void_createEnsures the C++ object is created
void_destroyExplicitly destroys the object
[const]bool_destroyed?Returns a value indicating whether the object was already destroyed
[const]bool_is_const_object?Returns a value indicating whether the reference is a const reference
void_manageMarks the object as managed by the script side.
void_unmanageMarks the object as no longer owned by the script side.
voidaddItem(QGraphicsLayoutItem ptr item,
int row,
int column,
int rowSpan,
int columnSpan,
Qt_QFlags_AlignmentFlag alignment = Qt::Alignment())
Method void QGraphicsGridLayout::addItem(QGraphicsLayoutItem *item, int row, int column, int rowSpan, int columnSpan, QFlags<Qt::AlignmentFlag> alignment)
voidaddItem(QGraphicsLayoutItem ptr item,
int row,
int column,
Qt_QFlags_AlignmentFlag alignment = Qt::Alignment())
Method void QGraphicsGridLayout::addItem(QGraphicsLayoutItem *item, int row, int column, QFlags<Qt::AlignmentFlag> alignment)
[const]Qt_QFlags_AlignmentFlagalignment(QGraphicsLayoutItem ptr item)Method QFlags<Qt::AlignmentFlag> QGraphicsGridLayout::alignment(QGraphicsLayoutItem *item)
[const]Qt_QFlags_AlignmentFlagcolumnAlignment(int column)Method QFlags<Qt::AlignmentFlag> QGraphicsGridLayout::columnAlignment(int column)
[const]intcolumnCountMethod int QGraphicsGridLayout::columnCount()
[const]doublecolumnMaximumWidth(int column)Method double QGraphicsGridLayout::columnMaximumWidth(int column)
[const]doublecolumnMinimumWidth(int column)Method double QGraphicsGridLayout::columnMinimumWidth(int column)
[const]doublecolumnPreferredWidth(int column)Method double QGraphicsGridLayout::columnPreferredWidth(int column)
[const]doublecolumnSpacing(int column)Method double QGraphicsGridLayout::columnSpacing(int column)
[const]intcolumnStretchFactor(int column)Method int QGraphicsGridLayout::columnStretchFactor(int column)
[const]intcountVirtual method int QGraphicsGridLayout::count()
voidgeometry=(const QRectF rect)Method void QGraphicsGridLayout::setGeometry(const QRectF &rect)
[const]voidgetContentsMargins(double ptr left,
double ptr top,
double ptr right,
double ptr bottom)
Virtual method void QGraphicsGridLayout::getContentsMargins(double *left, double *top, double *right, double *bottom)
[const]doublehorizontalSpacingMethod double QGraphicsGridLayout::horizontalSpacing()
voidhorizontalSpacing=(double spacing)Method void QGraphicsGridLayout::setHorizontalSpacing(double spacing)
voidinvalidateVirtual method void QGraphicsGridLayout::invalidate()
[const]QGraphicsLayoutItem ptritemAt(int index)Virtual method QGraphicsLayoutItem *QGraphicsGridLayout::itemAt(int index)
voidremoveAt(int index)Virtual method void QGraphicsGridLayout::removeAt(int index)
voidremoveItem(QGraphicsLayoutItem ptr item)Method void QGraphicsGridLayout::removeItem(QGraphicsLayoutItem *item)
[const]Qt_QFlags_AlignmentFlagrowAlignment(int row)Method QFlags<Qt::AlignmentFlag> QGraphicsGridLayout::rowAlignment(int row)
[const]introwCountMethod int QGraphicsGridLayout::rowCount()
[const]doublerowMaximumHeight(int row)Method double QGraphicsGridLayout::rowMaximumHeight(int row)
[const]doublerowMinimumHeight(int row)Method double QGraphicsGridLayout::rowMinimumHeight(int row)
[const]doublerowPreferredHeight(int row)Method double QGraphicsGridLayout::rowPreferredHeight(int row)
[const]doublerowSpacing(int row)Method double QGraphicsGridLayout::rowSpacing(int row)
[const]introwStretchFactor(int row)Method int QGraphicsGridLayout::rowStretchFactor(int row)
voidsetAlignment(QGraphicsLayoutItem ptr item,
Qt_QFlags_AlignmentFlag alignment)
Method void QGraphicsGridLayout::setAlignment(QGraphicsLayoutItem *item, QFlags<Qt::AlignmentFlag> alignment)
voidsetColumnAlignment(int column,
Qt_QFlags_AlignmentFlag alignment)
Method void QGraphicsGridLayout::setColumnAlignment(int column, QFlags<Qt::AlignmentFlag> alignment)
voidsetColumnFixedWidth(int column,
double width)
Method void QGraphicsGridLayout::setColumnFixedWidth(int column, double width)
voidsetColumnMaximumWidth(int column,
double width)
Method void QGraphicsGridLayout::setColumnMaximumWidth(int column, double width)
voidsetColumnMinimumWidth(int column,
double width)
Method void QGraphicsGridLayout::setColumnMinimumWidth(int column, double width)
voidsetColumnPreferredWidth(int column,
double width)
Method void QGraphicsGridLayout::setColumnPreferredWidth(int column, double width)
voidsetColumnSpacing(int column,
double spacing)
Method void QGraphicsGridLayout::setColumnSpacing(int column, double spacing)
voidsetColumnStretchFactor(int column,
int stretch)
Method void QGraphicsGridLayout::setColumnStretchFactor(int column, int stretch)
voidsetGeometry(const QRectF rect)Virtual method void QGraphicsGridLayout::setGeometry(const QRectF &rect)
voidsetHorizontalSpacing(double spacing)Method void QGraphicsGridLayout::setHorizontalSpacing(double spacing)
voidsetRowAlignment(int row,
Qt_QFlags_AlignmentFlag alignment)
Method void QGraphicsGridLayout::setRowAlignment(int row, QFlags<Qt::AlignmentFlag> alignment)
voidsetRowFixedHeight(int row,
double height)
Method void QGraphicsGridLayout::setRowFixedHeight(int row, double height)
voidsetRowMaximumHeight(int row,
double height)
Method void QGraphicsGridLayout::setRowMaximumHeight(int row, double height)
voidsetRowMinimumHeight(int row,
double height)
Method void QGraphicsGridLayout::setRowMinimumHeight(int row, double height)
voidsetRowPreferredHeight(int row,
double height)
Method void QGraphicsGridLayout::setRowPreferredHeight(int row, double height)
voidsetRowSpacing(int row,
double spacing)
Method void QGraphicsGridLayout::setRowSpacing(int row, double spacing)
voidsetRowStretchFactor(int row,
int stretch)
Method void QGraphicsGridLayout::setRowStretchFactor(int row, int stretch)
voidsetSpacing(double spacing)Method void QGraphicsGridLayout::setSpacing(double spacing)
voidsetVerticalSpacing(double spacing)Method void QGraphicsGridLayout::setVerticalSpacing(double spacing)
[const]QSizeFsizeHint(const Qt_SizeHint which,
const QSizeF constraint)
Virtual method QSizeF QGraphicsGridLayout::sizeHint(Qt::SizeHint which, const QSizeF &constraint)
voidupdateGeometryVirtual method void QGraphicsGridLayout::updateGeometry()
[const]doubleverticalSpacingMethod double QGraphicsGridLayout::verticalSpacing()
voidverticalSpacing=(double spacing)Method void QGraphicsGridLayout::setVerticalSpacing(double spacing)
voidwidgetEvent(QEvent ptr e)Virtual method void QGraphicsGridLayout::widgetEvent(QEvent *e)

Protected methods (static, non-static and constructors)

voidaddChildLayoutItem(QGraphicsLayoutItem ptr layoutItem)Method void QGraphicsGridLayout::addChildLayoutItem(QGraphicsLayoutItem *layoutItem)
voidsetGraphicsItem(QGraphicsItem ptr item)Method void QGraphicsGridLayout::setGraphicsItem(QGraphicsItem *item)
voidsetOwnedByLayout(bool ownedByLayout)Method void QGraphicsGridLayout::setOwnedByLayout(bool ownedByLayout)

Deprecated methods (protected, public, static, non-static and constructors)

voidcreateUse of this method is deprecated. Use _create instead
voiddestroyUse of this method is deprecated. Use _destroy instead
[const]booldestroyed?Use of this method is deprecated. Use _destroyed? instead
[const]boolis_const_object?Use of this method is deprecated. Use _is_const_object? instead

Detailed description

_const_cast

Signature: [const] QGraphicsGridLayout ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

_create

Signature: void _create

Description: Ensures the C++ object is created

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

_destroy

Signature: void _destroy

Description: Explicitly destroys the object

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

_destroyed?

Signature: [const] bool _destroyed?

Description: Returns a value indicating whether the object was already destroyed

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

_is_const_object?

Signature: [const] bool _is_const_object?

Description: Returns a value indicating whether the reference is a const reference

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

_manage

Signature: void _manage

Description: Marks the object as managed by the script side.

After calling this method on an object, the script side will be responsible for the management of the object. This method may be called if an object is returned from a C++ function and the object is known not to be owned by any C++ instance. If necessary, the script side may delete the object if the script's reference is no longer required.

Usually it's not required to call this method. It has been introduced in version 0.24.

_unmanage

Signature: void _unmanage

Description: Marks the object as no longer owned by the script side.

Calling this method will make this object no longer owned by the script's memory management. Instead, the object must be managed in some other way. Usually this method may be called if it is known that some C++ object holds and manages this object. Technically speaking, this method will turn the script's reference into a weak reference. After the script engine decides to delete the reference, the object itself will still exist. If the object is not managed otherwise, memory leaks will occur.

Usually it's not required to call this method. It has been introduced in version 0.24.

addChildLayoutItem

Signature: void addChildLayoutItem (QGraphicsLayoutItem ptr layoutItem)

Description: Method void QGraphicsGridLayout::addChildLayoutItem(QGraphicsLayoutItem *layoutItem)

This method is protected and can only be called from inside a derived class.

addItem

(1) Signature: void addItem (QGraphicsLayoutItem ptr item, int row, int column, int rowSpan, int columnSpan, Qt_QFlags_AlignmentFlag alignment = Qt::Alignment())

Description: Method void QGraphicsGridLayout::addItem(QGraphicsLayoutItem *item, int row, int column, int rowSpan, int columnSpan, QFlags<Qt::AlignmentFlag> alignment)

(2) Signature: void addItem (QGraphicsLayoutItem ptr item, int row, int column, Qt_QFlags_AlignmentFlag alignment = Qt::Alignment())

Description: Method void QGraphicsGridLayout::addItem(QGraphicsLayoutItem *item, int row, int column, QFlags<Qt::AlignmentFlag> alignment)

alignment

Signature: [const] Qt_QFlags_AlignmentFlag alignment (QGraphicsLayoutItem ptr item)

Description: Method QFlags<Qt::AlignmentFlag> QGraphicsGridLayout::alignment(QGraphicsLayoutItem *item)

columnAlignment

Signature: [const] Qt_QFlags_AlignmentFlag columnAlignment (int column)

Description: Method QFlags<Qt::AlignmentFlag> QGraphicsGridLayout::columnAlignment(int column)

columnCount

Signature: [const] int columnCount

Description: Method int QGraphicsGridLayout::columnCount()

columnMaximumWidth

Signature: [const] double columnMaximumWidth (int column)

Description: Method double QGraphicsGridLayout::columnMaximumWidth(int column)

columnMinimumWidth

Signature: [const] double columnMinimumWidth (int column)

Description: Method double QGraphicsGridLayout::columnMinimumWidth(int column)

columnPreferredWidth

Signature: [const] double columnPreferredWidth (int column)

Description: Method double QGraphicsGridLayout::columnPreferredWidth(int column)

columnSpacing

Signature: [const] double columnSpacing (int column)

Description: Method double QGraphicsGridLayout::columnSpacing(int column)

columnStretchFactor

Signature: [const] int columnStretchFactor (int column)

Description: Method int QGraphicsGridLayout::columnStretchFactor(int column)

count

Signature: [const] int count

Description: Virtual method int QGraphicsGridLayout::count()

This method can be reimplemented in a derived class.

create

Signature: void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

Use this method to ensure the C++ object is created, for example to ensure that resources are allocated. Usually C++ objects are created on demand and not necessarily when the script object is created.

destroy

Signature: void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

Explicitly destroys the object on C++ side if it was owned by the script interpreter. Subsequent access to this object will throw an exception. If the object is not owned by the script, this method will do nothing.

destroyed?

Signature: [const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

This method returns true, if the object was destroyed, either explicitly or by the C++ side. The latter may happen, if the object is owned by a C++ object which got destroyed itself.

geometry=

Signature: void geometry= (const QRectF rect)

Description: Method void QGraphicsGridLayout::setGeometry(const QRectF &rect)

This is a reimplementation of QGraphicsLayoutItem::setGeometry

Python specific notes:
The object exposes a writable attribute 'geometry'. This is the setter.

getContentsMargins

Signature: [const] void getContentsMargins (double ptr left, double ptr top, double ptr right, double ptr bottom)

Description: Virtual method void QGraphicsGridLayout::getContentsMargins(double *left, double *top, double *right, double *bottom)

This method can be reimplemented in a derived class.

horizontalSpacing

Signature: [const] double horizontalSpacing

Description: Method double QGraphicsGridLayout::horizontalSpacing()

Python specific notes:
The object exposes a readable attribute 'horizontalSpacing'. This is the getter.

horizontalSpacing=

Signature: void horizontalSpacing= (double spacing)

Description: Method void QGraphicsGridLayout::setHorizontalSpacing(double spacing)

Python specific notes:
The object exposes a writable attribute 'horizontalSpacing'. This is the setter.

invalidate

Signature: void invalidate

Description: Virtual method void QGraphicsGridLayout::invalidate()

This method can be reimplemented in a derived class.

is_const_object?

Signature: [const] bool is_const_object?

Description: Returns a value indicating whether the reference is a const reference

Use of this method is deprecated. Use _is_const_object? instead

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

itemAt

Signature: [const] QGraphicsLayoutItem ptr itemAt (int index)

Description: Virtual method QGraphicsLayoutItem *QGraphicsGridLayout::itemAt(int index)

This method can be reimplemented in a derived class.

new

Signature: [static] new QGraphicsGridLayout new (QGraphicsLayoutItem ptr parent = nullptr)

Description: Constructor QGraphicsGridLayout::QGraphicsGridLayout(QGraphicsLayoutItem *parent)

This method creates an object of class QGraphicsGridLayout.

Python specific notes:
This method is the default initializer of the object.

removeAt

Signature: void removeAt (int index)

Description: Virtual method void QGraphicsGridLayout::removeAt(int index)

This method can be reimplemented in a derived class.

removeItem

Signature: void removeItem (QGraphicsLayoutItem ptr item)

Description: Method void QGraphicsGridLayout::removeItem(QGraphicsLayoutItem *item)

rowAlignment

Signature: [const] Qt_QFlags_AlignmentFlag rowAlignment (int row)

Description: Method QFlags<Qt::AlignmentFlag> QGraphicsGridLayout::rowAlignment(int row)

rowCount

Signature: [const] int rowCount

Description: Method int QGraphicsGridLayout::rowCount()

rowMaximumHeight

Signature: [const] double rowMaximumHeight (int row)

Description: Method double QGraphicsGridLayout::rowMaximumHeight(int row)

rowMinimumHeight

Signature: [const] double rowMinimumHeight (int row)

Description: Method double QGraphicsGridLayout::rowMinimumHeight(int row)

rowPreferredHeight

Signature: [const] double rowPreferredHeight (int row)

Description: Method double QGraphicsGridLayout::rowPreferredHeight(int row)

rowSpacing

Signature: [const] double rowSpacing (int row)

Description: Method double QGraphicsGridLayout::rowSpacing(int row)

rowStretchFactor

Signature: [const] int rowStretchFactor (int row)

Description: Method int QGraphicsGridLayout::rowStretchFactor(int row)

setAlignment

Signature: void setAlignment (QGraphicsLayoutItem ptr item, Qt_QFlags_AlignmentFlag alignment)

Description: Method void QGraphicsGridLayout::setAlignment(QGraphicsLayoutItem *item, QFlags<Qt::AlignmentFlag> alignment)

setColumnAlignment

Signature: void setColumnAlignment (int column, Qt_QFlags_AlignmentFlag alignment)

Description: Method void QGraphicsGridLayout::setColumnAlignment(int column, QFlags<Qt::AlignmentFlag> alignment)

setColumnFixedWidth

Signature: void setColumnFixedWidth (int column, double width)

Description: Method void QGraphicsGridLayout::setColumnFixedWidth(int column, double width)

setColumnMaximumWidth

Signature: void setColumnMaximumWidth (int column, double width)

Description: Method void QGraphicsGridLayout::setColumnMaximumWidth(int column, double width)

setColumnMinimumWidth

Signature: void setColumnMinimumWidth (int column, double width)

Description: Method void QGraphicsGridLayout::setColumnMinimumWidth(int column, double width)

setColumnPreferredWidth

Signature: void setColumnPreferredWidth (int column, double width)

Description: Method void QGraphicsGridLayout::setColumnPreferredWidth(int column, double width)

setColumnSpacing

Signature: void setColumnSpacing (int column, double spacing)

Description: Method void QGraphicsGridLayout::setColumnSpacing(int column, double spacing)

setColumnStretchFactor

Signature: void setColumnStretchFactor (int column, int stretch)

Description: Method void QGraphicsGridLayout::setColumnStretchFactor(int column, int stretch)

setGeometry

Signature: void setGeometry (const QRectF rect)

Description: Virtual method void QGraphicsGridLayout::setGeometry(const QRectF &rect)

This method can be reimplemented in a derived class.

setGraphicsItem

Signature: void setGraphicsItem (QGraphicsItem ptr item)

Description: Method void QGraphicsGridLayout::setGraphicsItem(QGraphicsItem *item)

This method is protected and can only be called from inside a derived class.

setHorizontalSpacing

Signature: void setHorizontalSpacing (double spacing)

Description: Method void QGraphicsGridLayout::setHorizontalSpacing(double spacing)

Python specific notes:
The object exposes a writable attribute 'horizontalSpacing'. This is the setter.

setOwnedByLayout

Signature: void setOwnedByLayout (bool ownedByLayout)

Description: Method void QGraphicsGridLayout::setOwnedByLayout(bool ownedByLayout)

This method is protected and can only be called from inside a derived class.

setRowAlignment

Signature: void setRowAlignment (int row, Qt_QFlags_AlignmentFlag alignment)

Description: Method void QGraphicsGridLayout::setRowAlignment(int row, QFlags<Qt::AlignmentFlag> alignment)

setRowFixedHeight

Signature: void setRowFixedHeight (int row, double height)

Description: Method void QGraphicsGridLayout::setRowFixedHeight(int row, double height)

setRowMaximumHeight

Signature: void setRowMaximumHeight (int row, double height)

Description: Method void QGraphicsGridLayout::setRowMaximumHeight(int row, double height)

setRowMinimumHeight

Signature: void setRowMinimumHeight (int row, double height)

Description: Method void QGraphicsGridLayout::setRowMinimumHeight(int row, double height)

setRowPreferredHeight

Signature: void setRowPreferredHeight (int row, double height)

Description: Method void QGraphicsGridLayout::setRowPreferredHeight(int row, double height)

setRowSpacing

Signature: void setRowSpacing (int row, double spacing)

Description: Method void QGraphicsGridLayout::setRowSpacing(int row, double spacing)

setRowStretchFactor

Signature: void setRowStretchFactor (int row, int stretch)

Description: Method void QGraphicsGridLayout::setRowStretchFactor(int row, int stretch)

setSpacing

Signature: void setSpacing (double spacing)

Description: Method void QGraphicsGridLayout::setSpacing(double spacing)

setVerticalSpacing

Signature: void setVerticalSpacing (double spacing)

Description: Method void QGraphicsGridLayout::setVerticalSpacing(double spacing)

Python specific notes:
The object exposes a writable attribute 'verticalSpacing'. This is the setter.

sizeHint

Signature: [const] QSizeF sizeHint (const Qt_SizeHint which, const QSizeF constraint)

Description: Virtual method QSizeF QGraphicsGridLayout::sizeHint(Qt::SizeHint which, const QSizeF &constraint)

This method can be reimplemented in a derived class.

updateGeometry

Signature: void updateGeometry

Description: Virtual method void QGraphicsGridLayout::updateGeometry()

This method can be reimplemented in a derived class.

verticalSpacing

Signature: [const] double verticalSpacing

Description: Method double QGraphicsGridLayout::verticalSpacing()

Python specific notes:
The object exposes a readable attribute 'verticalSpacing'. This is the getter.

verticalSpacing=

Signature: void verticalSpacing= (double spacing)

Description: Method void QGraphicsGridLayout::setVerticalSpacing(double spacing)

Python specific notes:
The object exposes a writable attribute 'verticalSpacing'. This is the setter.

widgetEvent

Signature: void widgetEvent (QEvent ptr e)

Description: Virtual method void QGraphicsGridLayout::widgetEvent(QEvent *e)

This method can be reimplemented in a derived class.