API reference - Class QXmlFormatter

_const_cast

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

atomicValue

Signature: void atomicValue (variant value)

Description: Virtual method void QXmlFormatter::atomicValue(const QVariant &value)

This method can be reimplemented in a derived class.

attribute

Signature: void attribute (const QXmlName name, string value)

Description: Virtual method void QXmlFormatter::attribute(const QXmlName &name, const QStringRef &value)

This method can be reimplemented in a derived class.

characters

Signature: void characters (string value)

Description: Virtual method void QXmlFormatter::characters(const QStringRef &value)

This method can be reimplemented in a derived class.

comment

Signature: void comment (string value)

Description: Virtual method void QXmlFormatter::comment(const QString &value)

This method can be reimplemented in a derived class.

endDocument

Signature: void endDocument

Description: Virtual method void QXmlFormatter::endDocument()

This method can be reimplemented in a derived class.

endElement

Signature: void endElement

Description: Virtual method void QXmlFormatter::endElement()

This method can be reimplemented in a derived class.

endOfSequence

Signature: void endOfSequence

Description: Virtual method void QXmlFormatter::endOfSequence()

This method can be reimplemented in a derived class.

indentationDepth

Signature: [const] int indentationDepth

Description: Method int QXmlFormatter::indentationDepth()

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

indentationDepth=

Signature: void indentationDepth= (int depth)

Description: Method void QXmlFormatter::setIndentationDepth(int depth)

Python specific notes:
The object exposes a writable attribute 'indentationDepth'. This is the setter.

namespaceBinding

Signature: void namespaceBinding (const QXmlName nb)

Description: Virtual method void QXmlFormatter::namespaceBinding(const QXmlName &nb)

This method can be reimplemented in a derived class.

new

Signature: [static] new QXmlFormatter new (const QXmlQuery query, QIODevice ptr outputDevice)

Description: Constructor QXmlFormatter::QXmlFormatter(const QXmlQuery &query, QIODevice *outputDevice)

This method creates an object of class QXmlFormatter.

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

processingInstruction

Signature: void processingInstruction (const QXmlName name, string value)

Description: Virtual method void QXmlFormatter::processingInstruction(const QXmlName &name, const QString &value)

This method can be reimplemented in a derived class.

setIndentationDepth

Signature: void setIndentationDepth (int depth)

Description: Method void QXmlFormatter::setIndentationDepth(int depth)

Python specific notes:
The object exposes a writable attribute 'indentationDepth'. This is the setter.

startDocument

Signature: void startDocument

Description: Virtual method void QXmlFormatter::startDocument()

This method can be reimplemented in a derived class.

startElement

Signature: void startElement (const QXmlName name)

Description: Virtual method void QXmlFormatter::startElement(const QXmlName &name)

This method can be reimplemented in a derived class.

startOfSequence

Signature: void startOfSequence

Description: Virtual method void QXmlFormatter::startOfSequence()

This method can be reimplemented in a derived class.

whitespaceOnly

Signature: void whitespaceOnly (string value)

Description: Virtual method void QXmlFormatter::whitespaceOnly(const QStringRef &value)

This method can be reimplemented in a derived class.