API reference - Class QXmlDeclHandler
Notation used in Ruby API documentation
Description: Binding of QXmlDeclHandler
Class hierarchy: QXmlDeclHandler
- Public constructors
- Public methods
- Deprecated methods (protected, public, static, non-static and constructors)
- Detailed description
Public constructors
| new QXmlDeclHandler | new | Constructor QXmlDeclHandler::QXmlDeclHandler() |
Public methods
| void | _create | Ensures the C++ object is created | ||
| void | _destroy | Explicitly 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 | _manage | Marks the object as managed by the script side. | ||
| void | _unmanage | Marks the object as no longer owned by the script side. | ||
| void | assign | (const QXmlDeclHandler other) | Assigns another object to self | |
| [virtual] | bool | attributeDecl | (string eName, string aName, string type, string valueDefault, string value) | Virtual method bool QXmlDeclHandler::attributeDecl(const QString &eName, const QString &aName, const QString &type, const QString &valueDefault, const QString &value) |
| [const] | new QXmlDeclHandler ptr | dup | Creates a copy of self | |
| [virtual,const] | string | errorString | Virtual method QString QXmlDeclHandler::errorString() | |
| [virtual] | bool | externalEntityDecl | (string name, string publicId, string systemId) | Virtual method bool QXmlDeclHandler::externalEntityDecl(const QString &name, const QString &publicId, const QString &systemId) |
| [virtual] | bool | internalEntityDecl | (string name, string value) | Virtual method bool QXmlDeclHandler::internalEntityDecl(const QString &name, const QString &value) |
Deprecated methods (protected, public, static, non-static and constructors)
| void | create | Use of this method is deprecated. Use _create instead | ||
| void | destroy | Use of this method is deprecated. Use _destroy instead | ||
| [const] | bool | destroyed? | Use of this method is deprecated. Use _destroyed? instead | |
| [const] | bool | is_const_object? | Use of this method is deprecated. Use _is_const_object? instead |
Detailed description
_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. |
assign | Signature: void assign (const QXmlDeclHandler other) Description: Assigns another object to self |
attributeDecl | Signature: [virtual] bool attributeDecl (string eName,string aName,string type,string valueDefault,string value) Description: Virtual method bool QXmlDeclHandler::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. |
create | Signature: void create Description: Ensures the C++ object is created Use of this method is deprecated. Use _create instead |
destroy | Signature: void destroy Description: Explicitly destroys the object Use of this method is deprecated. Use _destroy instead |
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 |
dup | Signature: [const] new QXmlDeclHandler ptr dup Description: Creates a copy of self |
errorString | Signature: [virtual,const] string errorString Description: Virtual method QString QXmlDeclHandler::errorString() This method can be reimplemented in a derived class. |
externalEntityDecl | Signature: [virtual] bool externalEntityDecl (string name,string publicId,string systemId) Description: Virtual method bool QXmlDeclHandler::externalEntityDecl(const QString &name, const QString &publicId, const QString &systemId) This method can be reimplemented in a derived class. |
internalEntityDecl | Signature: [virtual] bool internalEntityDecl (string name,string value) Description: Virtual method bool QXmlDeclHandler::internalEntityDecl(const QString &name, const QString &value) This method can be reimplemented in a derived class. |
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 |
new | Signature: [static] new QXmlDeclHandler new Description: Constructor QXmlDeclHandler::QXmlDeclHandler() This method creates an object of class QXmlDeclHandler. Python specific notes: |