API reference - Class QUndoStack

_const_cast

Signature: [const] QUndoStack ptr _const_cast

Description: Returns a non-const reference to self.

Basically, this method allows turning a const object reference to a non-const one. This method is provided as last resort to remove the constness from an object. Usually there is a good reason for a const object reference, so using this method may have undesired side effects.

This method has been introduced in version 0.29.6.

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

active

Signature: [const] bool active

Description: Method bool QUndoStack::isActive()

Python specific notes:
The object exposes a readable attribute 'active'. This is the getter.

active=

Signature: 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.

beginMacro

Signature: void beginMacro (string text)

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

canRedo

Signature: [const] bool canRedo

Description: Method bool QUndoStack::canRedo()

Python specific notes:
The object exposes a readable attribute 'canRedo'. This is the getter.

canRedoChanged

Signature: [signal] void canRedoChanged (bool canRedo)

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

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'canRedoChanged'. This is the getter.
The object exposes a writable attribute 'canRedoChanged'. This is the setter.

canUndo

Signature: [const] bool canUndo

Description: Method bool QUndoStack::canUndo()

Python specific notes:
The object exposes a readable attribute 'canUndo'. This is the getter.

canUndoChanged

Signature: [signal] void canUndoChanged (bool canUndo)

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

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'canUndoChanged'. This is the getter.
The object exposes a writable attribute 'canUndoChanged'. This is the setter.

childEvent

Signature: void childEvent (QChildEvent ptr event)

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

This method can be reimplemented in a derived class.

clean

Signature: [const] bool clean

Description: Method bool QUndoStack::isClean()

Python specific notes:
The object exposes a readable attribute 'clean'. This is the getter.

cleanChanged

Signature: [signal] void cleanChanged (bool clean)

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

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'cleanChanged'. This is the getter.
The object exposes a writable attribute 'cleanChanged'. This is the setter.

cleanIndex

Signature: [const] int cleanIndex

Description: Method int QUndoStack::cleanIndex()

clear

Signature: void clear

Description: Method void QUndoStack::clear()

command

Signature: [const] const QUndoCommand ptr command (int index)

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

count

Signature: [const] int count

Description: Method int QUndoStack::count()

createRedoAction

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

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

createUndoAction

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

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

Signature: [signal] void destroyed (QObject ptr arg1)

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

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'destroyed'. This is the getter.
The object exposes a writable attribute 'destroyed'. This is the setter.

disconnectNotify

Signature: void disconnectNotify (const QMetaMethod signal)

Description: Virtual method void QUndoStack::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_canRedoChanged

Signature: void emit_canRedoChanged (bool canRedo)

Description: Emitter for signal void QUndoStack::canRedoChanged(bool canRedo)

Call this method to emit this signal.

emit_canUndoChanged

Signature: void emit_canUndoChanged (bool canUndo)

Description: Emitter for signal void QUndoStack::canUndoChanged(bool canUndo)

Call this method to emit this signal.

emit_cleanChanged

Signature: void emit_cleanChanged (bool clean)

Description: Emitter for signal void QUndoStack::cleanChanged(bool clean)

Call this method to emit this signal.

emit_destroyed

Signature: void emit_destroyed (QObject ptr arg1 = nullptr)

Description: Emitter for signal void QUndoStack::destroyed(QObject *)

Call this method to emit this signal.

emit_indexChanged

Signature: void emit_indexChanged (int idx)

Description: Emitter for signal void QUndoStack::indexChanged(int idx)

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

Description: Emitter for signal void QUndoStack::objectNameChanged(const QString &objectName)

Call this method to emit this signal.

emit_redoTextChanged

Signature: void emit_redoTextChanged (string redoText)

Description: Emitter for signal void QUndoStack::redoTextChanged(const QString &redoText)

Call this method to emit this signal.

emit_undoTextChanged

Signature: void emit_undoTextChanged (string undoText)

Description: Emitter for signal void QUndoStack::undoTextChanged(const QString &undoText)

Call this method to emit this signal.

endMacro

Signature: void endMacro

Description: Method void QUndoStack::endMacro()

event

Signature: bool event (QEvent ptr event)

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

This method can be reimplemented in a derived class.

eventFilter

Signature: bool eventFilter (QObject ptr watched, QEvent ptr event)

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

This method can be reimplemented in a derived class.

index

Signature: [const] int index

Description: Method int QUndoStack::index()

Python specific notes:
The object exposes a readable attribute 'index'. This is the getter.

index=

Signature: 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.

indexChanged

Signature: [signal] void indexChanged (int idx)

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

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'indexChanged'. This is the getter.
The object exposes a writable attribute 'indexChanged'. This is the setter.

isActive?

Signature: [const] bool isActive?

Description: Method bool QUndoStack::isActive()

Python specific notes:
The object exposes a readable attribute 'active'. This is the getter.

isClean?

Signature: [const] bool isClean?

Description: Method bool QUndoStack::isClean()

Python specific notes:
The object exposes a readable attribute 'clean'. This is the getter.

isSignalConnected

Signature: [const] bool isSignalConnected (const QMetaMethod signal)

Description: Method bool QUndoStack::isSignalConnected(const QMetaMethod &signal)

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

new

Signature: [static] new QUndoStack new (QObject ptr parent = nullptr)

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.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QUndoStack::objectNameChanged(const QString &objectName)

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'objectNameChanged'. This is the getter.
The object exposes a writable attribute 'objectNameChanged'. This is the setter.

push

Signature: void push (QUndoCommand ptr cmd)

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

receivers

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

redo

Signature: void redo

Description: Method void QUndoStack::redo()

redoText

Signature: [const] string redoText

Description: Method QString QUndoStack::redoText()

Python specific notes:
The object exposes a readable attribute 'redoText'. This is the getter.

redoTextChanged

Signature: [signal] void redoTextChanged (string redoText)

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

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'redoTextChanged'. This is the getter.
The object exposes a writable attribute 'redoTextChanged'. This is the setter.

resetClean

Signature: void resetClean

Description: Method void QUndoStack::resetClean()

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QUndoStack::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QUndoStack::senderSignalIndex()

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

setActive

Signature: 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.

setClean

Signature: void setClean

Description: Method void QUndoStack::setClean()

setIndex

Signature: 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.

setUndoLimit

Signature: 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.

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

text

Signature: [const] string text (int idx)

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

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

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

This method can be reimplemented in a derived class.

tr

Signature: [static] string tr (string s, string c = nullptr, int n = -1)

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.

trUtf8

Signature: [static] string trUtf8 (string s, string c = nullptr, int n = -1)

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.

undo

Signature: void undo

Description: Method void QUndoStack::undo()

undoLimit

Signature: [const] int undoLimit

Description: Method int QUndoStack::undoLimit()

Python specific notes:
The object exposes a readable attribute 'undoLimit'. This is the getter.

undoLimit=

Signature: 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.

undoText

Signature: [const] string undoText

Description: Method QString QUndoStack::undoText()

Python specific notes:
The object exposes a readable attribute 'undoText'. This is the getter.

undoTextChanged

Signature: [signal] void undoTextChanged (string undoText)

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

You can bind a procedure to this signal.

Python specific notes:
The object exposes a readable attribute 'undoTextChanged'. This is the getter.
The object exposes a writable attribute 'undoTextChanged'. This is the setter.