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

API reference - Class QXmlLexicalHandler

Notation used in Ruby API documentation

Description: Binding of QXmlLexicalHandler

Public methods

boolcomment(string ch)Method bool QXmlLexicalHandler::comment(const QString &ch)
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
boolendCDATAMethod bool QXmlLexicalHandler::endCDATA()
boolendDTDMethod bool QXmlLexicalHandler::endDTD()
boolendEntity(string name)Method bool QXmlLexicalHandler::endEntity(const QString &name)
[const]stringerrorStringMethod QString QXmlLexicalHandler::errorString()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
boolstartCDATAMethod bool QXmlLexicalHandler::startCDATA()
boolstartDTD(string name,
string publicId,
string systemId)
Method bool QXmlLexicalHandler::startDTD(const QString &name, const QString &publicId, const QString &systemId)
boolstartEntity(string name)Method bool QXmlLexicalHandler::startEntity(const QString &name)

Detailed description

bool comment(string ch)

Description: Method bool QXmlLexicalHandler::comment(const QString &ch)

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 destroy the object

Explicitly destroy the object on C++ side if it was owned by the Ruby interpreter. Subsequent access to this object will throw an exception. If the object is not owned by Ruby, 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.

bool endCDATA

Description: Method bool QXmlLexicalHandler::endCDATA()

bool endDTD

Description: Method bool QXmlLexicalHandler::endDTD()

bool endEntity(string name)

Description: Method bool QXmlLexicalHandler::endEntity(const QString &name)

[const] string errorString

Description: Method QString QXmlLexicalHandler::errorString()

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

bool startCDATA

Description: Method bool QXmlLexicalHandler::startCDATA()

bool startDTD(string name,string publicId,string systemId)

Description: Method bool QXmlLexicalHandler::startDTD(const QString &name, const QString &publicId, const QString &systemId)

bool startEntity(string name)

Description: Method bool QXmlLexicalHandler::startEntity(const QString &name)