API reference - Class QUndoGroup

_const_cast

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

activeStack

Signature: [const] QUndoStack ptr activeStack

Description: Method QUndoStack *QUndoGroup::activeStack()

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

activeStack=

Signature: void activeStack= (QUndoStack ptr stack)

Description: Method void QUndoGroup::setActiveStack(QUndoStack *stack)

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

activeStackChanged

Signature: [signal] void activeStackChanged (QUndoStack ptr stack)

Description: Signal declaration for QUndoGroup::activeStackChanged(QUndoStack *stack)

You can bind a procedure to this signal.

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

addStack

Signature: void addStack (QUndoStack ptr stack)

Description: Method void QUndoGroup::addStack(QUndoStack *stack)

canRedo

Signature: [const] bool canRedo

Description: Method bool QUndoGroup::canRedo()

canRedoChanged

Signature: [signal] void canRedoChanged (bool canRedo)

Description: Signal declaration for QUndoGroup::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 QUndoGroup::canUndo()

canUndoChanged

Signature: [signal] void canUndoChanged (bool canUndo)

Description: Signal declaration for QUndoGroup::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 QUndoGroup::childEvent(QChildEvent *event)

This method can be reimplemented in a derived class.

cleanChanged

Signature: [signal] void cleanChanged (bool clean)

Description: Signal declaration for QUndoGroup::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.

createRedoAction

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

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

createUndoAction

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

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

customEvent

Signature: void customEvent (QEvent ptr event)

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

This method can be reimplemented in a derived class.

destroyed

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

Description: Signal declaration for QUndoGroup::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 QUndoGroup::disconnectNotify(const QMetaMethod &signal)

This method can be reimplemented in a derived class.

emit_activeStackChanged

Signature: void emit_activeStackChanged (QUndoStack ptr stack)

Description: Emitter for signal void QUndoGroup::activeStackChanged(QUndoStack *stack)

Call this method to emit this signal.

emit_canRedoChanged

Signature: void emit_canRedoChanged (bool canRedo)

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

Call this method to emit this signal.

emit_canUndoChanged

Signature: void emit_canUndoChanged (bool canUndo)

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

Call this method to emit this signal.

emit_cleanChanged

Signature: void emit_cleanChanged (bool clean)

Description: Emitter for signal void QUndoGroup::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 QUndoGroup::destroyed(QObject *)

Call this method to emit this signal.

emit_indexChanged

Signature: void emit_indexChanged (int idx)

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

Call this method to emit this signal.

emit_objectNameChanged

Signature: void emit_objectNameChanged (string objectName)

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

Call this method to emit this signal.

emit_redoTextChanged

Signature: void emit_redoTextChanged (string redoText)

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

Call this method to emit this signal.

emit_undoTextChanged

Signature: void emit_undoTextChanged (string undoText)

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

Call this method to emit this signal.

event

Signature: bool event (QEvent ptr event)

Description: Virtual method bool QUndoGroup::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 QUndoGroup::eventFilter(QObject *watched, QEvent *event)

This method can be reimplemented in a derived class.

indexChanged

Signature: [signal] void indexChanged (int idx)

Description: Signal declaration for QUndoGroup::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.

isClean?

Signature: [const] bool isClean?

Description: Method bool QUndoGroup::isClean()

isSignalConnected

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

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

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

new

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

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

This method creates an object of class QUndoGroup.

Python specific notes:
This method is the default initializer of the object.

objectNameChanged

Signature: [signal] void objectNameChanged (string objectName)

Description: Signal declaration for QUndoGroup::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.

receivers

Signature: [const] int receivers (string signal)

Description: Method int QUndoGroup::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 QUndoGroup::redo()

redoText

Signature: [const] string redoText

Description: Method QString QUndoGroup::redoText()

redoTextChanged

Signature: [signal] void redoTextChanged (string redoText)

Description: Signal declaration for QUndoGroup::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.

removeStack

Signature: void removeStack (QUndoStack ptr stack)

Description: Method void QUndoGroup::removeStack(QUndoStack *stack)

sender

Signature: [const] QObject ptr sender

Description: Method QObject *QUndoGroup::sender()

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

senderSignalIndex

Signature: [const] int senderSignalIndex

Description: Method int QUndoGroup::senderSignalIndex()

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

setActiveStack

Signature: void setActiveStack (QUndoStack ptr stack)

Description: Method void QUndoGroup::setActiveStack(QUndoStack *stack)

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

stacks

Signature: [const] QUndoStack ptr[] stacks

Description: Method QList<QUndoStack*> QUndoGroup::stacks()

staticMetaObject

Signature: [static] QMetaObject staticMetaObject

Description: Obtains the static MetaObject for this class.

timerEvent

Signature: void timerEvent (QTimerEvent ptr event)

Description: Virtual method void QUndoGroup::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 QUndoGroup::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 QUndoGroup::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 QUndoGroup::undo()

undoText

Signature: [const] string undoText

Description: Method QString QUndoGroup::undoText()

undoTextChanged

Signature: [signal] void undoTextChanged (string undoText)

Description: Signal declaration for QUndoGroup::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.