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

API reference - Class QUndoStack

Notation used in Ruby API documentation

Description: Binding of QUndoStack

Class hierarchy: QUndoStack » QObject

• Public constructors
• Public methods
• Public static methods and constants
• Protected methods (static, non-static and constructors)
• Deprecated methods (protected, public, static, non-static and constructors)
• Detailed description

Public constructors

Public methods

Public static methods and constants

Protected methods (static, non-static and constructors)

Deprecated methods (protected, public, static, non-static and constructors)

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] bool active

Description: Method bool QUndoStack::isActive()

Python specific notes:

The object exposes a readable attribute 'active'. This is the getter.

void active=(bool active = true)

Description: Method void QUndoStack::setActive(bool active)

Python specific notes:

The object exposes a writable attribute 'active'. This is the setter.

void beginMacro(string text)

Description: Method void QUndoStack::beginMacro(const QString &text)

[const] bool canRedo

Description: Method bool QUndoStack::canRedo()

[event] void canRedoChanged(bool canRedo)

Description: Signal declaration for QUndoStack::canRedoChanged(bool canRedo)

You can bind a procedure to this signal.

[const] bool canUndo

Description: Method bool QUndoStack::canUndo()

[event] void canUndoChanged(bool canUndo)

Description: Signal declaration for QUndoStack::canUndoChanged(bool canUndo)

You can bind a procedure to this signal.

[virtual] void childEvent(QChildEvent ptr arg1)

Description: Virtual method void QUndoStack::childEvent(QChildEvent *)

This method can be reimplemented in a derived class.

[event] void cleanChanged(bool clean)

Description: Signal declaration for QUndoStack::cleanChanged(bool clean)

You can bind a procedure to this signal.

[const] int cleanIndex

Description: Method int QUndoStack::cleanIndex()

void clear

Description: Method void QUndoStack::clear()

[const] const QUndoCommand ptr command(int index)

Description: Method const QUndoCommand *QUndoStack::command(int index)

[const] int count

Description: Method int QUndoStack::count()

void create

Description: Ensures the C++ object is created

Use of this method is deprecated. Use _create instead

[const] QAction ptr createRedoAction(QObject ptr parent,string prefix = QString())

Description: Method QAction *QUndoStack::createRedoAction(QObject *parent, const QString &prefix)

[const] QAction ptr createUndoAction(QObject ptr parent,string prefix = QString())

Description: Method QAction *QUndoStack::createUndoAction(QObject *parent, const QString &prefix)

[virtual] void customEvent(QEvent ptr arg1)

Description: Virtual method void QUndoStack::customEvent(QEvent *)

This method can be reimplemented in a derived class.

void destroy

Description: Explicitly destroys the object

Use of this method is deprecated. Use _destroy instead

[event] void destroyed(QObject ptr arg1)

Description: Signal declaration for QUndoStack::destroyed(QObject *)

You can bind a procedure to this signal.

[const] bool destroyed?

Description: Returns a value indicating whether the object was already destroyed

Use of this method is deprecated. Use _destroyed? instead

[virtual] void disconnectNotify(string signal)

Description: Virtual method void QUndoStack::disconnectNotify(const char *signal)

This method can be reimplemented in a derived class.

void endMacro

Description: Method void QUndoStack::endMacro()

[virtual] bool event(QEvent ptr arg1)

Description: Virtual method bool QUndoStack::event(QEvent *)

This method can be reimplemented in a derived class.

[virtual] bool eventFilter(QObject ptr arg1,QEvent ptr arg2)

Description: Virtual method bool QUndoStack::eventFilter(QObject *, QEvent *)

This method can be reimplemented in a derived class.

[const] int index

Description: Method int QUndoStack::index()

Python specific notes:

The object exposes a readable attribute 'index'. This is the getter.

void index=(int idx)

Description: Method void QUndoStack::setIndex(int idx)

Python specific notes:

The object exposes a writable attribute 'index'. This is the setter.

[event] void indexChanged(int idx)

Description: Signal declaration for QUndoStack::indexChanged(int idx)

You can bind a procedure to this signal.

[const] bool isActive?

Description: Method bool QUndoStack::isActive()

Python specific notes:

The object exposes a readable attribute 'active'. This is the getter.

[const] bool isClean?

Description: Method bool QUndoStack::isClean()

[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 QUndoStack new(QObject ptr parent = 0)

Description: Constructor QUndoStack::QUndoStack(QObject *parent)

This method creates an object of class QUndoStack.

Python specific notes:

This method is the default initializer of the object

void push(QUndoCommand ptr cmd)

Description: Method void QUndoStack::push(QUndoCommand *cmd)

[const] int receivers(string signal)

Description: Method int QUndoStack::receivers(const char *signal)

This method is protected and can only be called from inside a derived class.

void redo

Description: Method void QUndoStack::redo()

[const] string redoText

Description: Method QString QUndoStack::redoText()

[event] void redoTextChanged(string redoText)

Description: Signal declaration for QUndoStack::redoTextChanged(const QString &redoText)

You can bind a procedure to this signal.

[const] QObject ptr sender

Description: Method QObject *QUndoStack::sender()

This method is protected and can only be called from inside a derived class.

void setActive(bool active = true)

Description: Method void QUndoStack::setActive(bool active)

Python specific notes:

The object exposes a writable attribute 'active'. This is the setter.

void setClean

Description: Method void QUndoStack::setClean()

void setIndex(int idx)

Description: Method void QUndoStack::setIndex(int idx)

Python specific notes:

The object exposes a writable attribute 'index'. This is the setter.

void setUndoLimit(int limit)

Description: Method void QUndoStack::setUndoLimit(int limit)

Python specific notes:

The object exposes a writable attribute 'undoLimit'. This is the setter.

[static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

[const] string text(int idx)

Description: Method QString QUndoStack::text(int idx)

[virtual] void timerEvent(QTimerEvent ptr arg1)

Description: Virtual method void QUndoStack::timerEvent(QTimerEvent *)

This method can be reimplemented in a derived class.

[static] string tr(string s,string c = 0)

Description: Static method QString QUndoStack::tr(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string tr(string s,string c,int n)

Description: Static method QString QUndoStack::tr(const char *s, const char *c, int n)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c = 0)

Description: Static method QString QUndoStack::trUtf8(const char *s, const char *c)

This method is static and can be called without an instance.

[static] string trUtf8(string s,string c,int n)

Description: Static method QString QUndoStack::trUtf8(const char *s, const char *c, int n)

This method is static and can be called without an instance.

void undo

Description: Method void QUndoStack::undo()

[const] int undoLimit

Description: Method int QUndoStack::undoLimit()

Python specific notes:

The object exposes a readable attribute 'undoLimit'. This is the getter.

void undoLimit=(int limit)

Description: Method void QUndoStack::setUndoLimit(int limit)

Python specific notes:

The object exposes a writable attribute 'undoLimit'. This is the setter.

[const] string undoText

Description: Method QString QUndoStack::undoText()

[event] void undoTextChanged(string undoText)

Description: Signal declaration for QUndoStack::undoTextChanged(const QString &undoText)

You can bind a procedure to this signal.