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

API reference - Class QDomComment

Notation used in Ruby API documentation

Description: Binding of QDomComment

Class hierarchy: QDomComment » QDomCharacterData » QDomNode

Public constructors

new QDomCommentnewConstructor QDomComment::QDomComment()
new QDomCommentnew(const QDomComment x)Constructor QDomComment::QDomComment(const QDomComment &x)

Public methods

QDomCommentassign(const QDomComment arg1)Method QDomComment & QDomComment::operator=(const QDomComment &)
[const]voidassign(const QDomComment other)Assign the contents of another object to self
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[const]QDomCommentdupCreates a copy of self
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[const]QDomNode_NodeTypenodeTypeMethod QDomNode::NodeType QDomComment::nodeType()

Detailed description

QDomComment assign(const QDomComment arg1)

Description: Method QDomComment & QDomComment::operator=(const QDomComment &)

[const] void assign(const QDomComment other)

Description: Assign the contents of another object to self

This method assigns the contents of another object to self. This is a deep copy that does not only copy the reference but the actual content.

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.

[const] QDomComment dup

Description: Creates a copy of self

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

[static] new QDomComment new

Description: Constructor QDomComment::QDomComment()

This method creates an object of class QDomComment.

[static] new QDomComment new(const QDomComment x)

Description: Constructor QDomComment::QDomComment(const QDomComment &x)

This method creates an object of class QDomComment.

[const] QDomNode_NodeType nodeType

Description: Method QDomNode::NodeType QDomComment::nodeType()