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

API reference - Class QGraphicsLayoutItem

Notation used in Ruby API documentation

Description: Binding of QGraphicsLayoutItem

Class hierarchy: 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.

[const] QRectF contentsRect

Description: Method QRectF QGraphicsLayoutItem::contentsRect()

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] QSizeF effectiveSizeHint(const Qt_SizeHint which,const QSizeF constraint = QSizeF())

Description: Method QSizeF QGraphicsLayoutItem::effectiveSizeHint(Qt::SizeHint which, const QSizeF &constraint)

[const] QRectF geometry

Description: Method QRectF QGraphicsLayoutItem::geometry()

Python specific notes:

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

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

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

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

void geometry=(const QRectF rect)

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

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 QGraphicsLayoutItem::getContentsMargins(double *left, double *top, double *right, double *bottom)

This method can be reimplemented in a derived class.

[const] QGraphicsItem ptr graphicsItem

Description: Method QGraphicsItem *QGraphicsLayoutItem::graphicsItem()

[const] bool isLayout?

Description: Method bool QGraphicsLayoutItem::isLayout()

[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

[const] double maximumHeight

Description: Method double QGraphicsLayoutItem::maximumHeight()

Python specific notes:

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

void maximumHeight=(double height)

Description: Method void QGraphicsLayoutItem::setMaximumHeight(double height)

Python specific notes:

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

[const] QSizeF maximumSize

Description: Method QSizeF QGraphicsLayoutItem::maximumSize()

Python specific notes:

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

void maximumSize=(const QSizeF size)

Description: Method void QGraphicsLayoutItem::setMaximumSize(const QSizeF &size)

Python specific notes:

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

[const] double maximumWidth

Description: Method double QGraphicsLayoutItem::maximumWidth()

Python specific notes:

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

void maximumWidth=(double width)

Description: Method void QGraphicsLayoutItem::setMaximumWidth(double width)

Python specific notes:

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

[const] double minimumHeight

Description: Method double QGraphicsLayoutItem::minimumHeight()

Python specific notes:

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

void minimumHeight=(double height)

Description: Method void QGraphicsLayoutItem::setMinimumHeight(double height)

Python specific notes:

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

[const] QSizeF minimumSize

Description: Method QSizeF QGraphicsLayoutItem::minimumSize()

Python specific notes:

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

void minimumSize=(const QSizeF size)

Description: Method void QGraphicsLayoutItem::setMinimumSize(const QSizeF &size)

Python specific notes:

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

[const] double minimumWidth

Description: Method double QGraphicsLayoutItem::minimumWidth()

Python specific notes:

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

void minimumWidth=(double width)

Description: Method void QGraphicsLayoutItem::setMinimumWidth(double width)

Python specific notes:

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

[static] new QGraphicsLayoutItem new(QGraphicsLayoutItem ptr parent = 0,bool isLayout = false)

Description: Constructor QGraphicsLayoutItem::QGraphicsLayoutItem(QGraphicsLayoutItem *parent, bool isLayout)

This method creates an object of class QGraphicsLayoutItem.

Python specific notes:

This method is the default initializer of the object

[const] bool ownedByLayout

Description: Method bool QGraphicsLayoutItem::ownedByLayout()

[const] QGraphicsLayoutItem ptr parentLayoutItem

Description: Method QGraphicsLayoutItem *QGraphicsLayoutItem::parentLayoutItem()

Python specific notes:

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

void parentLayoutItem=(QGraphicsLayoutItem ptr parent)

Description: Method void QGraphicsLayoutItem::setParentLayoutItem(QGraphicsLayoutItem *parent)

Python specific notes:

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

[const] double preferredHeight

Description: Method double QGraphicsLayoutItem::preferredHeight()

Python specific notes:

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

void preferredHeight=(double height)

Description: Method void QGraphicsLayoutItem::setPreferredHeight(double height)

Python specific notes:

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

[const] QSizeF preferredSize

Description: Method QSizeF QGraphicsLayoutItem::preferredSize()

Python specific notes:

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

void preferredSize=(const QSizeF size)

Description: Method void QGraphicsLayoutItem::setPreferredSize(const QSizeF &size)

Python specific notes:

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

[const] double preferredWidth

Description: Method double QGraphicsLayoutItem::preferredWidth()

Python specific notes:

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

void preferredWidth=(double width)

Description: Method void QGraphicsLayoutItem::setPreferredWidth(double width)

Python specific notes:

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

[virtual] void setGeometry(const QRectF rect)

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

This method can be reimplemented in a derived class.

void setGraphicsItem(QGraphicsItem ptr item)

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

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

void setMaximumHeight(double height)

Description: Method void QGraphicsLayoutItem::setMaximumHeight(double height)

Python specific notes:

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

void setMaximumSize(const QSizeF size)

Description: Method void QGraphicsLayoutItem::setMaximumSize(const QSizeF &size)

Python specific notes:

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

void setMaximumSize(double w,double h)

Description: Method void QGraphicsLayoutItem::setMaximumSize(double w, double h)

void setMaximumWidth(double width)

Description: Method void QGraphicsLayoutItem::setMaximumWidth(double width)

Python specific notes:

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

void setMinimumHeight(double height)

Description: Method void QGraphicsLayoutItem::setMinimumHeight(double height)

Python specific notes:

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

void setMinimumSize(const QSizeF size)

Description: Method void QGraphicsLayoutItem::setMinimumSize(const QSizeF &size)

Python specific notes:

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

void setMinimumSize(double w,double h)

Description: Method void QGraphicsLayoutItem::setMinimumSize(double w, double h)

void setMinimumWidth(double width)

Description: Method void QGraphicsLayoutItem::setMinimumWidth(double width)

Python specific notes:

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

void setOwnedByLayout(bool ownedByLayout)

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

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

void setParentLayoutItem(QGraphicsLayoutItem ptr parent)

Description: Method void QGraphicsLayoutItem::setParentLayoutItem(QGraphicsLayoutItem *parent)

Python specific notes:

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

void setPreferredHeight(double height)

Description: Method void QGraphicsLayoutItem::setPreferredHeight(double height)

Python specific notes:

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

void setPreferredSize(const QSizeF size)

Description: Method void QGraphicsLayoutItem::setPreferredSize(const QSizeF &size)

Python specific notes:

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

void setPreferredSize(double w,double h)

Description: Method void QGraphicsLayoutItem::setPreferredSize(double w, double h)

void setPreferredWidth(double width)

Description: Method void QGraphicsLayoutItem::setPreferredWidth(double width)

Python specific notes:

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

void setSizePolicy(const QSizePolicy policy)

Description: Method void QGraphicsLayoutItem::setSizePolicy(const QSizePolicy &policy)

Python specific notes:

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

void setSizePolicy(const QSizePolicy_Policy hPolicy,const QSizePolicy_Policy vPolicy,const QSizePolicy_ControlType controlType = QSizePolicy::DefaultType)

Description: Method void QGraphicsLayoutItem::setSizePolicy(QSizePolicy::Policy hPolicy, QSizePolicy::Policy vPolicy, QSizePolicy::ControlType controlType)

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

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

This method can be reimplemented in a derived class.

[const] QSizePolicy sizePolicy

Description: Method QSizePolicy QGraphicsLayoutItem::sizePolicy()

Python specific notes:

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

void sizePolicy=(const QSizePolicy policy)

Description: Method void QGraphicsLayoutItem::setSizePolicy(const QSizePolicy &policy)

Python specific notes:

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

[virtual] void updateGeometry

Description: Virtual method void QGraphicsLayoutItem::updateGeometry()

This method can be reimplemented in a derived class.