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

API reference - Class QGraphicsAnchorLayout

Notation used in Ruby API documentation

Module: QtWidgets

Description: Binding of QGraphicsAnchorLayout

Class hierarchy: QGraphicsAnchorLayout » QGraphicsLayout » QGraphicsLayoutItem

Public constructors

new QGraphicsAnchorLayoutnew(QGraphicsLayoutItem ptr parent = nullptr)Constructor QGraphicsAnchorLayout::QGraphicsAnchorLayout(QGraphicsLayoutItem *parent)

Public methods

[const]QGraphicsAnchorLayout 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.
QGraphicsAnchor ptraddAnchor(QGraphicsLayoutItem ptr firstItem,
const Qt_AnchorPoint firstEdge,
QGraphicsLayoutItem ptr secondItem,
const Qt_AnchorPoint secondEdge)
Method QGraphicsAnchor *QGraphicsAnchorLayout::addAnchor(QGraphicsLayoutItem *firstItem, Qt::AnchorPoint firstEdge, QGraphicsLayoutItem *secondItem, Qt::AnchorPoint secondEdge)
voidaddAnchors(QGraphicsLayoutItem ptr firstItem,
QGraphicsLayoutItem ptr secondItem,
Qt_QFlags_Orientation orientations = Qt::Horizontal | Qt::Vertical)
Method void QGraphicsAnchorLayout::addAnchors(QGraphicsLayoutItem *firstItem, QGraphicsLayoutItem *secondItem, QFlags<Qt::Orientation> orientations)
voidaddCornerAnchors(QGraphicsLayoutItem ptr firstItem,
const Qt_Corner firstCorner,
QGraphicsLayoutItem ptr secondItem,
const Qt_Corner secondCorner)
Method void QGraphicsAnchorLayout::addCornerAnchors(QGraphicsLayoutItem *firstItem, Qt::Corner firstCorner, QGraphicsLayoutItem *secondItem, Qt::Corner secondCorner)
QGraphicsAnchor ptranchor(QGraphicsLayoutItem ptr firstItem,
const Qt_AnchorPoint firstEdge,
QGraphicsLayoutItem ptr secondItem,
const Qt_AnchorPoint secondEdge)
Method QGraphicsAnchor *QGraphicsAnchorLayout::anchor(QGraphicsLayoutItem *firstItem, Qt::AnchorPoint firstEdge, QGraphicsLayoutItem *secondItem, Qt::AnchorPoint secondEdge)
[const]intcountVirtual method int QGraphicsAnchorLayout::count()
voidgeometry=(const QRectF rect)Method void QGraphicsAnchorLayout::setGeometry(const QRectF &rect)
[const]voidgetContentsMargins(double ptr left,
double ptr top,
double ptr right,
double ptr bottom)
Virtual method void QGraphicsAnchorLayout::getContentsMargins(double *left, double *top, double *right, double *bottom)
[const]doublehorizontalSpacingMethod double QGraphicsAnchorLayout::horizontalSpacing()
voidhorizontalSpacing=(double spacing)Method void QGraphicsAnchorLayout::setHorizontalSpacing(double spacing)
voidinvalidateVirtual method void QGraphicsAnchorLayout::invalidate()
[const]QGraphicsLayoutItem ptritemAt(int index)Virtual method QGraphicsLayoutItem *QGraphicsAnchorLayout::itemAt(int index)
voidremoveAt(int index)Virtual method void QGraphicsAnchorLayout::removeAt(int index)
voidsetGeometry(const QRectF rect)Virtual method void QGraphicsAnchorLayout::setGeometry(const QRectF &rect)
voidsetHorizontalSpacing(double spacing)Method void QGraphicsAnchorLayout::setHorizontalSpacing(double spacing)
voidsetSpacing(double spacing)Method void QGraphicsAnchorLayout::setSpacing(double spacing)
voidsetVerticalSpacing(double spacing)Method void QGraphicsAnchorLayout::setVerticalSpacing(double spacing)
voidupdateGeometryVirtual method void QGraphicsAnchorLayout::updateGeometry()
[const]doubleverticalSpacingMethod double QGraphicsAnchorLayout::verticalSpacing()
voidverticalSpacing=(double spacing)Method void QGraphicsAnchorLayout::setVerticalSpacing(double spacing)
voidwidgetEvent(QEvent ptr e)Virtual method void QGraphicsAnchorLayout::widgetEvent(QEvent *e)

Protected methods (static, non-static and constructors)

voidaddChildLayoutItem(QGraphicsLayoutItem ptr layoutItem)Method void QGraphicsAnchorLayout::addChildLayoutItem(QGraphicsLayoutItem *layoutItem)
voidsetGraphicsItem(QGraphicsItem ptr item)Method void QGraphicsAnchorLayout::setGraphicsItem(QGraphicsItem *item)
voidsetOwnedByLayout(bool ownedByLayout)Method void QGraphicsAnchorLayout::setOwnedByLayout(bool ownedByLayout)
[const]QSizeFsizeHint(const Qt_SizeHint which,
const QSizeF constraint)
Virtual method QSizeF QGraphicsAnchorLayout::sizeHint(Qt::SizeHint which, const QSizeF &constraint)

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] QGraphicsAnchorLayout 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.

addAnchor

Signature: QGraphicsAnchor ptr addAnchor (QGraphicsLayoutItem ptr firstItem, const Qt_AnchorPoint firstEdge, QGraphicsLayoutItem ptr secondItem, const Qt_AnchorPoint secondEdge)

Description: Method QGraphicsAnchor *QGraphicsAnchorLayout::addAnchor(QGraphicsLayoutItem *firstItem, Qt::AnchorPoint firstEdge, QGraphicsLayoutItem *secondItem, Qt::AnchorPoint secondEdge)

addAnchors

Signature: void addAnchors (QGraphicsLayoutItem ptr firstItem, QGraphicsLayoutItem ptr secondItem, Qt_QFlags_Orientation orientations = Qt::Horizontal | Qt::Vertical)

Description: Method void QGraphicsAnchorLayout::addAnchors(QGraphicsLayoutItem *firstItem, QGraphicsLayoutItem *secondItem, QFlags<Qt::Orientation> orientations)

addChildLayoutItem

Signature: void addChildLayoutItem (QGraphicsLayoutItem ptr layoutItem)

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

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

addCornerAnchors

Signature: void addCornerAnchors (QGraphicsLayoutItem ptr firstItem, const Qt_Corner firstCorner, QGraphicsLayoutItem ptr secondItem, const Qt_Corner secondCorner)

Description: Method void QGraphicsAnchorLayout::addCornerAnchors(QGraphicsLayoutItem *firstItem, Qt::Corner firstCorner, QGraphicsLayoutItem *secondItem, Qt::Corner secondCorner)

anchor

Signature: QGraphicsAnchor ptr anchor (QGraphicsLayoutItem ptr firstItem, const Qt_AnchorPoint firstEdge, QGraphicsLayoutItem ptr secondItem, const Qt_AnchorPoint secondEdge)

Description: Method QGraphicsAnchor *QGraphicsAnchorLayout::anchor(QGraphicsLayoutItem *firstItem, Qt::AnchorPoint firstEdge, QGraphicsLayoutItem *secondItem, Qt::AnchorPoint secondEdge)

count

Signature: [const] int count

Description: Virtual method int QGraphicsAnchorLayout::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 QGraphicsAnchorLayout::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 QGraphicsAnchorLayout::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 QGraphicsAnchorLayout::horizontalSpacing()

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

horizontalSpacing=

Signature: void horizontalSpacing= (double spacing)

Description: Method void QGraphicsAnchorLayout::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 QGraphicsAnchorLayout::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 *QGraphicsAnchorLayout::itemAt(int index)

This method can be reimplemented in a derived class.

new

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

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

This method creates an object of class QGraphicsAnchorLayout.

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

removeAt

Signature: void removeAt (int index)

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

This method can be reimplemented in a derived class.

setGeometry

Signature: void setGeometry (const QRectF rect)

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

This method can be reimplemented in a derived class.

setGraphicsItem

Signature: void setGraphicsItem (QGraphicsItem ptr item)

Description: Method void QGraphicsAnchorLayout::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 QGraphicsAnchorLayout::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 QGraphicsAnchorLayout::setOwnedByLayout(bool ownedByLayout)

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

setSpacing

Signature: void setSpacing (double spacing)

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

setVerticalSpacing

Signature: void setVerticalSpacing (double spacing)

Description: Method void QGraphicsAnchorLayout::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 QGraphicsAnchorLayout::sizeHint(Qt::SizeHint which, const QSizeF &constraint)

This method can be reimplemented in a derived class.

updateGeometry

Signature: void updateGeometry

Description: Virtual method void QGraphicsAnchorLayout::updateGeometry()

This method can be reimplemented in a derived class.

verticalSpacing

Signature: [const] double verticalSpacing

Description: Method double QGraphicsAnchorLayout::verticalSpacing()

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

verticalSpacing=

Signature: void verticalSpacing= (double spacing)

Description: Method void QGraphicsAnchorLayout::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 QGraphicsAnchorLayout::widgetEvent(QEvent *e)

This method can be reimplemented in a derived class.