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

API reference - Class QUndoCommand

Notation used in Ruby API documentation

Description: Binding of QUndoCommand

Class hierarchy: QUndoCommand

Public constructors

new QUndoCommandnewConstructor QUndoCommand::QUndoCommand(QUndoCommand *parent)
new QUndoCommandnew(QUndoCommand ptr parent)Constructor QUndoCommand::QUndoCommand(QUndoCommand *parent)
new QUndoCommandnew(string text)Constructor QUndoCommand::QUndoCommand(const QString &text, QUndoCommand *parent)
new QUndoCommandnew(string text,
QUndoCommand ptr parent)
Constructor QUndoCommand::QUndoCommand(const QString &text, QUndoCommand *parent)

Public methods

[const]const QUndoCommand ptrchild(int index)Method const QUndoCommand * QUndoCommand::child(int index)
[const]intchildCountMethod int QUndoCommand::childCount()
voidcreateEnsures the C++ object is created
voiddestroyExplicitly destroy the object
[const]booldestroyed?Returns a value indicating whether the object was already destroyed
[virtual,const]intidVirtual method int QUndoCommand::id()
[const]boolis_const_object?Returns a value indicating whether the reference is a const reference
[virtual]boolmergeWith(const QUndoCommand ptr other)Virtual method bool QUndoCommand::mergeWith(const QUndoCommand *other)
[virtual]voidredoVirtual method void QUndoCommand::redo()
voidsetText(string text)Method void QUndoCommand::setText(const QString &text)
[const]stringtextMethod QString QUndoCommand::text()
voidtext=(string text)Method void QUndoCommand::setText(const QString &text)
[virtual]voidundoVirtual method void QUndoCommand::undo()

Detailed description

[const] const QUndoCommand ptr child(int index)

Description: Method const QUndoCommand * QUndoCommand::child(int index)

[const] int childCount

Description: Method int QUndoCommand::childCount()

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.

[virtual,const] int id

Description: Virtual method int QUndoCommand::id()

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

This method returns true, if self is a const reference. In that case, only const methods may be called on self.

[virtual] bool mergeWith(const QUndoCommand ptr other)

Description: Virtual method bool QUndoCommand::mergeWith(const QUndoCommand *other)

This method can be reimplemented in a derived class.

[static] new QUndoCommand new

Description: Constructor QUndoCommand::QUndoCommand(QUndoCommand *parent)

This method creates an object of class QUndoCommand.

[static] new QUndoCommand new(QUndoCommand ptr parent)

Description: Constructor QUndoCommand::QUndoCommand(QUndoCommand *parent)

This method creates an object of class QUndoCommand.

[static] new QUndoCommand new(string text)

Description: Constructor QUndoCommand::QUndoCommand(const QString &text, QUndoCommand *parent)

This method creates an object of class QUndoCommand.

[static] new QUndoCommand new(string text,QUndoCommand ptr parent)

Description: Constructor QUndoCommand::QUndoCommand(const QString &text, QUndoCommand *parent)

This method creates an object of class QUndoCommand.

[virtual] void redo

Description: Virtual method void QUndoCommand::redo()

This method can be reimplemented in a derived class.

void setText(string text)

Description: Method void QUndoCommand::setText(const QString &text)

[const] string text

Description: Method QString QUndoCommand::text()

void text=(string text)

Description: Method void QUndoCommand::setText(const QString &text)

[virtual] void undo

Description: Virtual method void QUndoCommand::undo()

This method can be reimplemented in a derived class.