API reference - Class QXmlReader

Notation used in Ruby API documentation

Description: Binding of QXmlReader

Class hierarchy: QXmlReader

Public constructors

new QXmlReadernewConstructor QXmlReader::QXmlReader()

Public methods

[virtual,const]QXmlDTDHandler ptrDTDHandlerVirtual method QXmlDTDHandler *QXmlReader::DTDHandler()
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]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.
voidassign(const QXmlReader other)Assigns another object to self
[virtual,const]QXmlContentHandler ptrcontentHandlerVirtual method QXmlContentHandler *QXmlReader::contentHandler()
voidcontentHandler=(QXmlContentHandler ptr handler)Method void QXmlReader::setContentHandler(QXmlContentHandler *handler)
[virtual,const]QXmlDeclHandler ptrdeclHandlerVirtual method QXmlDeclHandler *QXmlReader::declHandler()
voiddeclHandler=(QXmlDeclHandler ptr handler)Method void QXmlReader::setDeclHandler(QXmlDeclHandler *handler)
[const]new QXmlReader ptrdupCreates a copy of self
[virtual,const]QXmlEntityResolver ptrentityResolverVirtual method QXmlEntityResolver *QXmlReader::entityResolver()
voidentityResolver=(QXmlEntityResolver ptr handler)Method void QXmlReader::setEntityResolver(QXmlEntityResolver *handler)
[virtual,const]QXmlErrorHandler ptrerrorHandlerVirtual method QXmlErrorHandler *QXmlReader::errorHandler()
voiderrorHandler=(QXmlErrorHandler ptr handler)Method void QXmlReader::setErrorHandler(QXmlErrorHandler *handler)
[virtual,const]boolfeature(string name,
bool ptr ok)
Virtual method bool QXmlReader::feature(const QString &name, bool *ok)
[virtual,const]boolhasFeature(string name)Virtual method bool QXmlReader::hasFeature(const QString &name)
[virtual,const]boolhasProperty(string name)Virtual method bool QXmlReader::hasProperty(const QString &name)
[virtual,const]QXmlLexicalHandler ptrlexicalHandlerVirtual method QXmlLexicalHandler *QXmlReader::lexicalHandler()
voidlexicalHandler=(QXmlLexicalHandler ptr handler)Method void QXmlReader::setLexicalHandler(QXmlLexicalHandler *handler)
[virtual]boolparse(const QXmlInputSource input)Virtual method bool QXmlReader::parse(const QXmlInputSource &input)
[virtual]boolparse(const QXmlInputSource ptr input)Virtual method bool QXmlReader::parse(const QXmlInputSource *input)
[virtual,const]void *property(string name,
bool ptr ok)
Virtual method void *QXmlReader::property(const QString &name, bool *ok)
[virtual]voidsetContentHandler(QXmlContentHandler ptr handler)Virtual method void QXmlReader::setContentHandler(QXmlContentHandler *handler)
[virtual]voidsetDTDHandler(QXmlDTDHandler ptr handler)Virtual method void QXmlReader::setDTDHandler(QXmlDTDHandler *handler)
[virtual]voidsetDeclHandler(QXmlDeclHandler ptr handler)Virtual method void QXmlReader::setDeclHandler(QXmlDeclHandler *handler)
[virtual]voidsetEntityResolver(QXmlEntityResolver ptr handler)Virtual method void QXmlReader::setEntityResolver(QXmlEntityResolver *handler)
[virtual]voidsetErrorHandler(QXmlErrorHandler ptr handler)Virtual method void QXmlReader::setErrorHandler(QXmlErrorHandler *handler)
[virtual]voidsetFeature(string name,
bool value)
Virtual method void QXmlReader::setFeature(const QString &name, bool value)
[virtual]voidsetLexicalHandler(QXmlLexicalHandler ptr handler)Virtual method void QXmlReader::setLexicalHandler(QXmlLexicalHandler *handler)
[virtual]voidsetProperty(string name,
void * value)
Virtual method void QXmlReader::setProperty(const QString &name, void *value)

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

[virtual,const] QXmlDTDHandler ptr DTDHandler

Description: Virtual method QXmlDTDHandler *QXmlReader::DTDHandler()

This method can be reimplemented in a derived class.

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 assign(const QXmlReader other)

Description: Assigns another object to self

[virtual,const] QXmlContentHandler ptr contentHandler

Description: Virtual method QXmlContentHandler *QXmlReader::contentHandler()

This method can be reimplemented in a derived class.

void contentHandler=(QXmlContentHandler ptr handler)

Description: Method void QXmlReader::setContentHandler(QXmlContentHandler *handler)

Python specific notes:

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

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[virtual,const] QXmlDeclHandler ptr declHandler

Description: Virtual method QXmlDeclHandler *QXmlReader::declHandler()

This method can be reimplemented in a derived class.

void declHandler=(QXmlDeclHandler ptr handler)

Description: Method void QXmlReader::setDeclHandler(QXmlDeclHandler *handler)

Python specific notes:

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

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 QXmlReader ptr dup

Description: Creates a copy of self

[virtual,const] QXmlEntityResolver ptr entityResolver

Description: Virtual method QXmlEntityResolver *QXmlReader::entityResolver()

This method can be reimplemented in a derived class.

void entityResolver=(QXmlEntityResolver ptr handler)

Description: Method void QXmlReader::setEntityResolver(QXmlEntityResolver *handler)

Python specific notes:

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

[virtual,const] QXmlErrorHandler ptr errorHandler

Description: Virtual method QXmlErrorHandler *QXmlReader::errorHandler()

This method can be reimplemented in a derived class.

void errorHandler=(QXmlErrorHandler ptr handler)

Description: Method void QXmlReader::setErrorHandler(QXmlErrorHandler *handler)

Python specific notes:

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

[virtual,const] bool feature(string name,bool ptr ok)

Description: Virtual method bool QXmlReader::feature(const QString &name, bool *ok)

This method can be reimplemented in a derived class.

[virtual,const] bool hasFeature(string name)

Description: Virtual method bool QXmlReader::hasFeature(const QString &name)

This method can be reimplemented in a derived class.

[virtual,const] bool hasProperty(string name)

Description: Virtual method bool QXmlReader::hasProperty(const QString &name)

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] QXmlLexicalHandler ptr lexicalHandler

Description: Virtual method QXmlLexicalHandler *QXmlReader::lexicalHandler()

This method can be reimplemented in a derived class.

void lexicalHandler=(QXmlLexicalHandler ptr handler)

Description: Method void QXmlReader::setLexicalHandler(QXmlLexicalHandler *handler)

Python specific notes:

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

[static] new QXmlReader new

Description: Constructor QXmlReader::QXmlReader()

This method creates an object of class QXmlReader.

Python specific notes:

This method is the default initializer of the object

[virtual] bool parse(const QXmlInputSource input)

Description: Virtual method bool QXmlReader::parse(const QXmlInputSource &input)

This method can be reimplemented in a derived class.

[virtual] bool parse(const QXmlInputSource ptr input)

Description: Virtual method bool QXmlReader::parse(const QXmlInputSource *input)

This method can be reimplemented in a derived class.

[virtual,const] void * property(string name,bool ptr ok)

Description: Virtual method void *QXmlReader::property(const QString &name, bool *ok)

This method can be reimplemented in a derived class.

[virtual] void setContentHandler(QXmlContentHandler ptr handler)

Description: Virtual method void QXmlReader::setContentHandler(QXmlContentHandler *handler)

This method can be reimplemented in a derived class.

[virtual] void setDTDHandler(QXmlDTDHandler ptr handler)

Description: Virtual method void QXmlReader::setDTDHandler(QXmlDTDHandler *handler)

This method can be reimplemented in a derived class.

[virtual] void setDeclHandler(QXmlDeclHandler ptr handler)

Description: Virtual method void QXmlReader::setDeclHandler(QXmlDeclHandler *handler)

This method can be reimplemented in a derived class.

[virtual] void setEntityResolver(QXmlEntityResolver ptr handler)

Description: Virtual method void QXmlReader::setEntityResolver(QXmlEntityResolver *handler)

This method can be reimplemented in a derived class.

[virtual] void setErrorHandler(QXmlErrorHandler ptr handler)

Description: Virtual method void QXmlReader::setErrorHandler(QXmlErrorHandler *handler)

This method can be reimplemented in a derived class.

[virtual] void setFeature(string name,bool value)

Description: Virtual method void QXmlReader::setFeature(const QString &name, bool value)

This method can be reimplemented in a derived class.

[virtual] void setLexicalHandler(QXmlLexicalHandler ptr handler)

Description: Virtual method void QXmlReader::setLexicalHandler(QXmlLexicalHandler *handler)

This method can be reimplemented in a derived class.

[virtual] void setProperty(string name,void * value)

Description: Virtual method void QXmlReader::setProperty(const QString &name, void *value)

This method can be reimplemented in a derived class.