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

API reference - Class QXmlAttributes

Notation used in Ruby API documentation

Description: Binding of QXmlAttributes

Class hierarchy: QXmlAttributes

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

Public constructors

Public methods

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 append(string qName,string uri,string localPart,string value)

Description: Method void QXmlAttributes::append(const QString &qName, const QString &uri, const QString &localPart, const QString &value)

void assign(const QXmlAttributes other)

Description: Assigns another object to self

void clear

Description: Method void QXmlAttributes::clear()

[const] int count

Description: Method int QXmlAttributes::count()

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] new QXmlAttributes ptr dup

Description: Creates a copy of self

[const] int index(string qName)

Description: Method int QXmlAttributes::index(const QString &qName)

[const] int index(string uri,string localPart)

Description: Method int QXmlAttributes::index(const QString &uri, const QString &localPart)

[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] int length

Description: Method int QXmlAttributes::length()

[const] string localName(int index)

Description: Method QString QXmlAttributes::localName(int index)

[static] new QXmlAttributes new

Description: Constructor QXmlAttributes::QXmlAttributes()

This method creates an object of class QXmlAttributes.

Python specific notes:

This method is the default initializer of the object

[const] string qName(int index)

Description: Method QString QXmlAttributes::qName(int index)

[const] string type(int index)

Description: Method QString QXmlAttributes::type(int index)

[const] string type(string qName)

Description: Method QString QXmlAttributes::type(const QString &qName)

[const] string type(string uri,string localName)

Description: Method QString QXmlAttributes::type(const QString &uri, const QString &localName)

[const] string uri(int index)

Description: Method QString QXmlAttributes::uri(int index)

[const] string value(int index)

Description: Method QString QXmlAttributes::value(int index)

[const] string value(string qName)

Description: Method QString QXmlAttributes::value(const QString &qName)

[const] string value(string uri,string localName)

Description: Method QString QXmlAttributes::value(const QString &uri, const QString &localName)