KLayout Manual: Main Index » Class Index » API reference - Class QGraphicsLinearLayout

API reference - Class QGraphicsLinearLayout

Notation used in Ruby API documentation

Description: Binding of QGraphicsLinearLayout

Class hierarchy: QGraphicsLinearLayout » QGraphicsLayout » QGraphicsLayoutItem

• Public constructors
• Public methods
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Protected methods (static, non-static and constructors)

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

Detailed description

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.

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.

[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.

[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.

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.

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.

void addChildLayoutItem(QGraphicsLayoutItem ptr layoutItem)

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

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

void addItem(QGraphicsLayoutItem ptr item)

Description: Method void QGraphicsLinearLayout::addItem(QGraphicsLayoutItem *item)

void addStretch(int stretch = 1)

Description: Method void QGraphicsLinearLayout::addStretch(int stretch)

[const] Qt_QFlags_AlignmentFlag alignment(QGraphicsLayoutItem ptr item)

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

[virtual,const] int count

Description: Virtual method int QGraphicsLinearLayout::count()

This method can be reimplemented in a derived class.

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[const] bool destroyed?

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

Use of this method is deprecated. Use _destroyed? instead

[const] void dump(int indent = 0)

Description: Method void QGraphicsLinearLayout::dump(int indent)

void geometry=(const QRectF rect)

Description: Method void QGraphicsLinearLayout::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.

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

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

This method can be reimplemented in a derived class.

void insertItem(int index,QGraphicsLayoutItem ptr item)

Description: Method void QGraphicsLinearLayout::insertItem(int index, QGraphicsLayoutItem *item)

void insertStretch(int index,int stretch = 1)

Description: Method void QGraphicsLinearLayout::insertStretch(int index, int stretch)

[virtual] void invalidate

Description: Virtual method void QGraphicsLinearLayout::invalidate()

This method can be reimplemented in a derived class.

[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

[virtual,const] QGraphicsLayoutItem ptr itemAt(int index)

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

This method can be reimplemented in a derived class.

[const] double itemSpacing(int index)

Description: Method double QGraphicsLinearLayout::itemSpacing(int index)

[static] new QGraphicsLinearLayout new(QGraphicsLayoutItem ptr parent = 0)

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

This method creates an object of class QGraphicsLinearLayout.

Python specific notes:

This method is the default initializer of the object

[static] new QGraphicsLinearLayout new(const Qt_Orientation orientation,QGraphicsLayoutItem ptr parent = 0)

Description: Constructor QGraphicsLinearLayout::QGraphicsLinearLayout(Qt::Orientation orientation, QGraphicsLayoutItem *parent)

This method creates an object of class QGraphicsLinearLayout.

Python specific notes:

This method is the default initializer of the object

[const] Qt_Orientation orientation

Description: Method Qt::Orientation QGraphicsLinearLayout::orientation()

Python specific notes:

The object exposes a readable attribute 'orientation'. This is the getter.

void orientation=(const Qt_Orientation orientation)

Description: Method void QGraphicsLinearLayout::setOrientation(Qt::Orientation orientation)

Python specific notes:

The object exposes a writable attribute 'orientation'. This is the setter.

[virtual] void removeAt(int index)

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

This method can be reimplemented in a derived class.

void removeItem(QGraphicsLayoutItem ptr item)

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

void setAlignment(QGraphicsLayoutItem ptr item,const Qt_QFlags_AlignmentFlag alignment)

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

[virtual] void setGeometry(const QRectF rect)

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

This method can be reimplemented in a derived class.

void setGraphicsItem(QGraphicsItem ptr item)

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

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

void setItemSpacing(int index,double spacing)

Description: Method void QGraphicsLinearLayout::setItemSpacing(int index, double spacing)

void setOrientation(const Qt_Orientation orientation)

Description: Method void QGraphicsLinearLayout::setOrientation(Qt::Orientation orientation)

Python specific notes:

The object exposes a writable attribute 'orientation'. This is the setter.

void setOwnedByLayout(bool ownedByLayout)

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

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

void setSpacing(double spacing)

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

Python specific notes:

The object exposes a writable attribute 'spacing'. This is the setter.

void setStretchFactor(QGraphicsLayoutItem ptr item,int stretch)

Description: Method void QGraphicsLinearLayout::setStretchFactor(QGraphicsLayoutItem *item, int stretch)

[virtual,const] QSizeF sizeHint(const Qt_SizeHint which,const QSizeF constraint)

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

This method can be reimplemented in a derived class.

[const] double spacing

Description: Method double QGraphicsLinearLayout::spacing()

Python specific notes:

The object exposes a readable attribute 'spacing'. This is the getter.

void spacing=(double spacing)

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

Python specific notes:

The object exposes a writable attribute 'spacing'. This is the setter.

[const] int stretchFactor(QGraphicsLayoutItem ptr item)

Description: Method int QGraphicsLinearLayout::stretchFactor(QGraphicsLayoutItem *item)

[virtual] void updateGeometry

Description: Virtual method void QGraphicsLinearLayout::updateGeometry()

This method can be reimplemented in a derived class.

[virtual] void widgetEvent(QEvent ptr e)

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

This method can be reimplemented in a derived class.