API reference - Class QXmlDefaultHandler

Notation used in Ruby API documentation

Description: Binding of QXmlDefaultHandler

Class hierarchy: QXmlDefaultHandler » QXmlContentHandler

Public constructors

new QXmlDefaultHandlernewConstructor QXmlDefaultHandler::QXmlDefaultHandler()

Public methods

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.
[const]const QXmlContentHandler ptrasConstQXmlContentHandlerDelivers the base class interface QXmlContentHandler of QXmlDefaultHandler
[const]const QXmlDTDHandler ptrasConstQXmlDTDHandlerDelivers the base class interface QXmlDTDHandler of QXmlDefaultHandler
[const]const QXmlDeclHandler ptrasConstQXmlDeclHandlerDelivers the base class interface QXmlDeclHandler of QXmlDefaultHandler
[const]const QXmlEntityResolver ptrasConstQXmlEntityResolverDelivers the base class interface QXmlEntityResolver of QXmlDefaultHandler
[const]const QXmlErrorHandler ptrasConstQXmlErrorHandlerDelivers the base class interface QXmlErrorHandler of QXmlDefaultHandler
[const]const QXmlLexicalHandler ptrasConstQXmlLexicalHandlerDelivers the base class interface QXmlLexicalHandler of QXmlDefaultHandler
QXmlContentHandler ptrasQXmlContentHandlerDelivers the base class interface QXmlContentHandler of QXmlDefaultHandler
QXmlDTDHandler ptrasQXmlDTDHandlerDelivers the base class interface QXmlDTDHandler of QXmlDefaultHandler
QXmlDeclHandler ptrasQXmlDeclHandlerDelivers the base class interface QXmlDeclHandler of QXmlDefaultHandler
QXmlEntityResolver ptrasQXmlEntityResolverDelivers the base class interface QXmlEntityResolver of QXmlDefaultHandler
QXmlErrorHandler ptrasQXmlErrorHandlerDelivers the base class interface QXmlErrorHandler of QXmlDefaultHandler
QXmlLexicalHandler ptrasQXmlLexicalHandlerDelivers the base class interface QXmlLexicalHandler of QXmlDefaultHandler
[virtual]boolattributeDecl(string eName,
string aName,
string type,
string valueDefault,
string value)
Virtual method bool QXmlDefaultHandler::attributeDecl(const QString &eName, const QString &aName, const QString &type, const QString &valueDefault, const QString &value)
[virtual]boolcharacters(string ch)Virtual method bool QXmlDefaultHandler::characters(const QString &ch)
[virtual]boolcomment(string ch)Virtual method bool QXmlDefaultHandler::comment(const QString &ch)
[virtual]boolendCDATAVirtual method bool QXmlDefaultHandler::endCDATA()
[virtual]boolendDTDVirtual method bool QXmlDefaultHandler::endDTD()
[virtual]boolendDocumentVirtual method bool QXmlDefaultHandler::endDocument()
[virtual]boolendElement(string namespaceURI,
string localName,
string qName)
Virtual method bool QXmlDefaultHandler::endElement(const QString &namespaceURI, const QString &localName, const QString &qName)
[virtual]boolendEntity(string name)Virtual method bool QXmlDefaultHandler::endEntity(const QString &name)
[virtual]boolendPrefixMapping(string prefix)Virtual method bool QXmlDefaultHandler::endPrefixMapping(const QString &prefix)
[virtual]boolerror(const QXmlParseException exception)Virtual method bool QXmlDefaultHandler::error(const QXmlParseException &exception)
[virtual,const]stringerrorStringVirtual method QString QXmlDefaultHandler::errorString()
[virtual]boolexternalEntityDecl(string name,
string publicId,
string systemId)
Virtual method bool QXmlDefaultHandler::externalEntityDecl(const QString &name, const QString &publicId, const QString &systemId)
[virtual]boolfatalError(const QXmlParseException exception)Virtual method bool QXmlDefaultHandler::fatalError(const QXmlParseException &exception)
[virtual]boolignorableWhitespace(string ch)Virtual method bool QXmlDefaultHandler::ignorableWhitespace(const QString &ch)
[virtual]boolinternalEntityDecl(string name,
string value)
Virtual method bool QXmlDefaultHandler::internalEntityDecl(const QString &name, const QString &value)
[virtual]boolnotationDecl(string name,
string publicId,
string systemId)
Virtual method bool QXmlDefaultHandler::notationDecl(const QString &name, const QString &publicId, const QString &systemId)
[virtual]boolprocessingInstruction(string target,
string data)
Virtual method bool QXmlDefaultHandler::processingInstruction(const QString &target, const QString &data)
[virtual]voidsetDocumentLocator(QXmlLocator ptr locator)Virtual method void QXmlDefaultHandler::setDocumentLocator(QXmlLocator *locator)
[virtual]boolskippedEntity(string name)Virtual method bool QXmlDefaultHandler::skippedEntity(const QString &name)
[virtual]boolstartCDATAVirtual method bool QXmlDefaultHandler::startCDATA()
[virtual]boolstartDTD(string name,
string publicId,
string systemId)
Virtual method bool QXmlDefaultHandler::startDTD(const QString &name, const QString &publicId, const QString &systemId)
[virtual]boolstartDocumentVirtual method bool QXmlDefaultHandler::startDocument()
[virtual]boolstartElement(string namespaceURI,
string localName,
string qName,
const QXmlAttributes atts)
Virtual method bool QXmlDefaultHandler::startElement(const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts)
[virtual]boolstartEntity(string name)Virtual method bool QXmlDefaultHandler::startEntity(const QString &name)
[virtual]boolstartPrefixMapping(string prefix,
string uri)
Virtual method bool QXmlDefaultHandler::startPrefixMapping(const QString &prefix, const QString &uri)
[virtual]boolunparsedEntityDecl(string name,
string publicId,
string systemId,
string notationName)
Virtual method bool QXmlDefaultHandler::unparsedEntityDecl(const QString &name, const QString &publicId, const QString &systemId, const QString &notationName)
[virtual]boolwarning(const QXmlParseException exception)Virtual method bool QXmlDefaultHandler::warning(const QXmlParseException &exception)

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

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] const QXmlContentHandler ptr asConstQXmlContentHandler

Description: Delivers the base class interface QXmlContentHandler of QXmlDefaultHandler

Class QXmlDefaultHandler is derived from multiple base classes. This method delivers the QXmlContentHandler base class aspect.

Use this version if you have a const reference.

[const] const QXmlDTDHandler ptr asConstQXmlDTDHandler

Description: Delivers the base class interface QXmlDTDHandler of QXmlDefaultHandler

Class QXmlDefaultHandler is derived from multiple base classes. This method delivers the QXmlDTDHandler base class aspect.

Use this version if you have a const reference.

[const] const QXmlDeclHandler ptr asConstQXmlDeclHandler

Description: Delivers the base class interface QXmlDeclHandler of QXmlDefaultHandler

Class QXmlDefaultHandler is derived from multiple base classes. This method delivers the QXmlDeclHandler base class aspect.

Use this version if you have a const reference.

[const] const QXmlEntityResolver ptr asConstQXmlEntityResolver

Description: Delivers the base class interface QXmlEntityResolver of QXmlDefaultHandler

Class QXmlDefaultHandler is derived from multiple base classes. This method delivers the QXmlEntityResolver base class aspect.

Use this version if you have a const reference.

[const] const QXmlErrorHandler ptr asConstQXmlErrorHandler

Description: Delivers the base class interface QXmlErrorHandler of QXmlDefaultHandler

Class QXmlDefaultHandler is derived from multiple base classes. This method delivers the QXmlErrorHandler base class aspect.

Use this version if you have a const reference.

[const] const QXmlLexicalHandler ptr asConstQXmlLexicalHandler

Description: Delivers the base class interface QXmlLexicalHandler of QXmlDefaultHandler

Class QXmlDefaultHandler is derived from multiple base classes. This method delivers the QXmlLexicalHandler base class aspect.

Use this version if you have a const reference.

QXmlContentHandler ptr asQXmlContentHandler

Description: Delivers the base class interface QXmlContentHandler of QXmlDefaultHandler

Class QXmlDefaultHandler is derived from multiple base classes. This method delivers the QXmlContentHandler base class aspect.

QXmlDTDHandler ptr asQXmlDTDHandler

Description: Delivers the base class interface QXmlDTDHandler of QXmlDefaultHandler

Class QXmlDefaultHandler is derived from multiple base classes. This method delivers the QXmlDTDHandler base class aspect.

QXmlDeclHandler ptr asQXmlDeclHandler

Description: Delivers the base class interface QXmlDeclHandler of QXmlDefaultHandler

Class QXmlDefaultHandler is derived from multiple base classes. This method delivers the QXmlDeclHandler base class aspect.

QXmlEntityResolver ptr asQXmlEntityResolver

Description: Delivers the base class interface QXmlEntityResolver of QXmlDefaultHandler

Class QXmlDefaultHandler is derived from multiple base classes. This method delivers the QXmlEntityResolver base class aspect.

QXmlErrorHandler ptr asQXmlErrorHandler

Description: Delivers the base class interface QXmlErrorHandler of QXmlDefaultHandler

Class QXmlDefaultHandler is derived from multiple base classes. This method delivers the QXmlErrorHandler base class aspect.

QXmlLexicalHandler ptr asQXmlLexicalHandler

Description: Delivers the base class interface QXmlLexicalHandler of QXmlDefaultHandler

Class QXmlDefaultHandler is derived from multiple base classes. This method delivers the QXmlLexicalHandler base class aspect.

[virtual] bool attributeDecl(string eName,string aName,string type,string valueDefault,string value)

Description: Virtual method bool QXmlDefaultHandler::attributeDecl(const QString &eName, const QString &aName, const QString &type, const QString &valueDefault, const QString &value)

This method can be reimplemented in a derived class.

[virtual] bool characters(string ch)

Description: Virtual method bool QXmlDefaultHandler::characters(const QString &ch)

This method can be reimplemented in a derived class.

[virtual] bool comment(string ch)

Description: Virtual method bool QXmlDefaultHandler::comment(const QString &ch)

This method can be reimplemented in a derived class.

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

[virtual] bool endCDATA

Description: Virtual method bool QXmlDefaultHandler::endCDATA()

This method can be reimplemented in a derived class.

[virtual] bool endDTD

Description: Virtual method bool QXmlDefaultHandler::endDTD()

This method can be reimplemented in a derived class.

[virtual] bool endDocument

Description: Virtual method bool QXmlDefaultHandler::endDocument()

This method can be reimplemented in a derived class.

[virtual] bool endElement(string namespaceURI,string localName,string qName)

Description: Virtual method bool QXmlDefaultHandler::endElement(const QString &namespaceURI, const QString &localName, const QString &qName)

This method can be reimplemented in a derived class.

[virtual] bool endEntity(string name)

Description: Virtual method bool QXmlDefaultHandler::endEntity(const QString &name)

This method can be reimplemented in a derived class.

[virtual] bool endPrefixMapping(string prefix)

Description: Virtual method bool QXmlDefaultHandler::endPrefixMapping(const QString &prefix)

This method can be reimplemented in a derived class.

[virtual] bool error(const QXmlParseException exception)

Description: Virtual method bool QXmlDefaultHandler::error(const QXmlParseException &exception)

This method can be reimplemented in a derived class.

[virtual,const] string errorString

Description: Virtual method QString QXmlDefaultHandler::errorString()

This method can be reimplemented in a derived class.

[virtual] bool externalEntityDecl(string name,string publicId,string systemId)

Description: Virtual method bool QXmlDefaultHandler::externalEntityDecl(const QString &name, const QString &publicId, const QString &systemId)

This method can be reimplemented in a derived class.

[virtual] bool fatalError(const QXmlParseException exception)

Description: Virtual method bool QXmlDefaultHandler::fatalError(const QXmlParseException &exception)

This method can be reimplemented in a derived class.

[virtual] bool ignorableWhitespace(string ch)

Description: Virtual method bool QXmlDefaultHandler::ignorableWhitespace(const QString &ch)

This method can be reimplemented in a derived class.

[virtual] bool internalEntityDecl(string name,string value)

Description: Virtual method bool QXmlDefaultHandler::internalEntityDecl(const QString &name, const QString &value)

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

[static] new QXmlDefaultHandler new

Description: Constructor QXmlDefaultHandler::QXmlDefaultHandler()

This method creates an object of class QXmlDefaultHandler.

Python specific notes:

This method is the default initializer of the object

[virtual] bool notationDecl(string name,string publicId,string systemId)

Description: Virtual method bool QXmlDefaultHandler::notationDecl(const QString &name, const QString &publicId, const QString &systemId)

This method can be reimplemented in a derived class.

[virtual] bool processingInstruction(string target,string data)

Description: Virtual method bool QXmlDefaultHandler::processingInstruction(const QString &target, const QString &data)

This method can be reimplemented in a derived class.

[virtual] void setDocumentLocator(QXmlLocator ptr locator)

Description: Virtual method void QXmlDefaultHandler::setDocumentLocator(QXmlLocator *locator)

This method can be reimplemented in a derived class.

[virtual] bool skippedEntity(string name)

Description: Virtual method bool QXmlDefaultHandler::skippedEntity(const QString &name)

This method can be reimplemented in a derived class.

[virtual] bool startCDATA

Description: Virtual method bool QXmlDefaultHandler::startCDATA()

This method can be reimplemented in a derived class.

[virtual] bool startDTD(string name,string publicId,string systemId)

Description: Virtual method bool QXmlDefaultHandler::startDTD(const QString &name, const QString &publicId, const QString &systemId)

This method can be reimplemented in a derived class.

[virtual] bool startDocument

Description: Virtual method bool QXmlDefaultHandler::startDocument()

This method can be reimplemented in a derived class.

[virtual] bool startElement(string namespaceURI,string localName,string qName,const QXmlAttributes atts)

Description: Virtual method bool QXmlDefaultHandler::startElement(const QString &namespaceURI, const QString &localName, const QString &qName, const QXmlAttributes &atts)

This method can be reimplemented in a derived class.

[virtual] bool startEntity(string name)

Description: Virtual method bool QXmlDefaultHandler::startEntity(const QString &name)

This method can be reimplemented in a derived class.

[virtual] bool startPrefixMapping(string prefix,string uri)

Description: Virtual method bool QXmlDefaultHandler::startPrefixMapping(const QString &prefix, const QString &uri)

This method can be reimplemented in a derived class.

[virtual] bool unparsedEntityDecl(string name,string publicId,string systemId,string notationName)

Description: Virtual method bool QXmlDefaultHandler::unparsedEntityDecl(const QString &name, const QString &publicId, const QString &systemId, const QString &notationName)

This method can be reimplemented in a derived class.

[virtual] bool warning(const QXmlParseException exception)

Description: Virtual method bool QXmlDefaultHandler::warning(const QXmlParseException &exception)

This method can be reimplemented in a derived class.