API reference - Class QXmlAttributes

Notation used in Ruby API documentation

Module: QtXml

Description: Binding of QXmlAttributes

Class hierarchy: QXmlAttributes

Public constructors

new QXmlAttributesnewConstructor QXmlAttributes::QXmlAttributes()

Public methods

void_assign(const QXmlAttributes other)Assigns another object 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]new QXmlAttributes ptr_dupCreates a copy of self
[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.
voidappend(string qName,
string uri,
string localPart,
string value)
Method void QXmlAttributes::append(const QString &qName, const QString &uri, const QString &localPart, const QString &value)
voidassign(const QXmlAttributes other)Assigns another object to self
voidclearMethod void QXmlAttributes::clear()
[const]intcountMethod int QXmlAttributes::count()
[const]new QXmlAttributes ptrdupCreates a copy of self
[const]intindex(string qName)Method int QXmlAttributes::index(const QString &qName)
[const]intindex(string uri,
string localPart)
Method int QXmlAttributes::index(const QString &uri, const QString &localPart)
[const]intlengthMethod int QXmlAttributes::length()
[const]stringlocalName(int index)Method QString QXmlAttributes::localName(int index)
[const]stringqName(int index)Method QString QXmlAttributes::qName(int index)
[const]stringtype(int index)Method QString QXmlAttributes::type(int index)
[const]stringtype(string qName)Method QString QXmlAttributes::type(const QString &qName)
[const]stringtype(string uri,
string localName)
Method QString QXmlAttributes::type(const QString &uri, const QString &localName)
[const]stringuri(int index)Method QString QXmlAttributes::uri(int index)
[const]stringvalue(int index)Method QString QXmlAttributes::value(int index)
[const]stringvalue(string qName)Method QString QXmlAttributes::value(const QString &qName)
[const]stringvalue(string uri,
string localName)
Method QString QXmlAttributes::value(const QString &uri, const QString &localName)

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

_assign

Signature: void _assign (const QXmlAttributes other)

Description: Assigns another object to self

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

_dup

Signature: [const] new QXmlAttributes ptr _dup

Description: Creates a copy of self

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

append

Signature: 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)

assign

Signature: void assign (const QXmlAttributes other)

Description: Assigns another object to self

clear

Signature: void clear

Description: Method void QXmlAttributes::clear()

count

Signature: [const] int count

Description: Method int QXmlAttributes::count()

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.

dup

Signature: [const] new QXmlAttributes ptr dup

Description: Creates a copy of self

Python specific notes:
This method also implements '__copy__' and '__deepcopy__'.

index

(1) Signature: [const] int index (string qName)

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

(2) Signature: [const] int index (string uri, string localPart)

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

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.

length

Signature: [const] int length

Description: Method int QXmlAttributes::length()

localName

Signature: [const] string localName (int index)

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

new

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

qName

Signature: [const] string qName (int index)

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

type

(1) Signature: [const] string type (int index)

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

(2) Signature: [const] string type (string qName)

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

(3) Signature: [const] string type (string uri, string localName)

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

uri

Signature: [const] string uri (int index)

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

value

(1) Signature: [const] string value (int index)

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

(2) Signature: [const] string value (string qName)

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

(3) Signature: [const] string value (string uri, string localName)

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