Skip to content

PythonQt.QtGui.QUndoGroup · declarations 001

Back to PythonQt.QtGui.QUndoGroup

activeStack

activeStack() -> Any

X.activeStack() -> PythonQt.QtGui.QUndoStack

Supplemental documentation: Qt 5 reference:

QUndoStack *QUndoGroup::activeStack() const

Returns the active stack of this group.

If none of the stacks are active, or if the group is empty, this function returns nullptr.

See also setActiveStack() and QUndoStack::setActive().

Upstream PySide2 reference signatures (binding differences may apply):

activeStack(self) -> PySide2.QtWidgets.QUndoStack

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#activeStack

activeStackChanged

activeStackChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QUndoGroup.activeStackChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QUndoGroup::activeStackChanged(QUndoStack *stack)

This signal is emitted whenever the active stack of the group changes. This can happen when setActiveStack() or QUndoStack::setActive() is called, or when the active stack is removed form the group. stack is the new active stack. If no stack is active, stack is 0.

See also setActiveStack() and QUndoStack::setActive().

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#activeStackChanged

addStack

addStack(stack: Any) -> None

X.addStack(stack)

Supplemental documentation: Qt 5 reference:

void QUndoGroup::addStack(QUndoStack *stack)

Adds stack to this group. The group does not take ownership of the stack. Another way of adding a stack to a group is by specifying the group as the stack's parent QObject in QUndoStack::QUndoStack(). In this case, the stack is deleted when the group is deleted, in the usual manner of QObjects.

See also removeStack(), stacks(), and QUndoStack::QUndoStack().

Upstream PySide2 reference signatures (binding differences may apply):

addStack(self, stack: PySide2.QtWidgets.QUndoStack) -> None

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#addStack

canRedo

canRedo() -> bool

X.canRedo() -> bool

Supplemental documentation: Qt 5 reference:

bool QUndoGroup::canRedo() const

Returns the value of the active stack's QUndoStack::canRedo().

If none of the stacks are active, or if the group is empty, this function returns false.

See also canUndo() and setActiveStack().

Upstream PySide2 reference signatures (binding differences may apply):

canRedo(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#canRedo

canRedoChanged

canRedoChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QUndoGroup.canRedoChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QUndoGroup::canRedoChanged(bool canRedo)

This signal is emitted whenever the active stack emits QUndoStack::canRedoChanged() or the active stack changes.

canRedo is the new state, or false if the active stack is 0.

See also QUndoStack::canRedoChanged() and setActiveStack().

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#canRedoChanged

canUndo

canUndo() -> bool

X.canUndo() -> bool

Supplemental documentation: Qt 5 reference:

bool QUndoGroup::canUndo() const

Returns the value of the active stack's QUndoStack::canUndo().

If none of the stacks are active, or if the group is empty, this function returns false.

See also canRedo() and setActiveStack().

Upstream PySide2 reference signatures (binding differences may apply):

canUndo(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#canUndo

canUndoChanged

canUndoChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QUndoGroup.canUndoChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QUndoGroup::canUndoChanged(bool canUndo)

This signal is emitted whenever the active stack emits QUndoStack::canUndoChanged() or the active stack changes.

canUndo is the new state, or false if the active stack is 0.

See also QUndoStack::canUndoChanged() and setActiveStack().

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#canUndoChanged

cleanChanged

cleanChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QUndoGroup.cleanChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QUndoGroup::cleanChanged(bool clean)

This signal is emitted whenever the active stack emits QUndoStack::cleanChanged() or the active stack changes.

clean is the new state, or true if the active stack is 0.

See also QUndoStack::cleanChanged() and setActiveStack().

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#cleanChanged

createRedoAction

createRedoAction(parent: Any, prefix: str) -> Any

X.createRedoAction(parent, prefix) -> PythonQt.QtGui.QAction

Supplemental documentation: Qt 5 reference:

QAction *QUndoGroup::createRedoAction(QObject *parent, const QString \&prefix \= QString()) const

Creates an redo QAction object with parent parent.

Triggering this action will cause a call to QUndoStack::redo() on the active stack. The text of this action will always be the text of the command which will be redone in the next call to redo(), prefixed by prefix. If there is no command available for redo, if the group is empty or if none of the stacks are active, this action will be disabled.

If prefix is empty, the default template "Redo %1" is used instead of prefix. Before Qt 4.8, the prefix "Redo" was used by default.

See also createUndoAction(), canRedo(), and QUndoCommand::text().

Upstream PySide2 reference signatures (binding differences may apply):

createRedoAction(self, parent: PySide2.QtCore.QObject, prefix: str=...) -> PySide2.QtWidgets.QAction

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#createRedoAction

createUndoAction

createUndoAction(parent: Any, prefix: str) -> Any

X.createUndoAction(parent, prefix) -> PythonQt.QtGui.QAction

Supplemental documentation: Qt 5 reference:

QAction *QUndoGroup::createUndoAction(QObject *parent, const QString \&prefix \= QString()) const

Creates an undo QAction object with parent parent.

Triggering this action will cause a call to QUndoStack::undo() on the active stack. The text of this action will always be the text of the command which will be undone in the next call to undo(), prefixed by prefix. If there is no command available for undo, if the group is empty or if none of the stacks are active, this action will be disabled.

If prefix is empty, the default template "Undo %1" is used instead of prefix. Before Qt 4.8, the prefix "Undo" was used by default.

See also createRedoAction(), canUndo(), and QUndoCommand::text().

Upstream PySide2 reference signatures (binding differences may apply):

createUndoAction(self, parent: PySide2.QtCore.QObject, prefix: str=...) -> PySide2.QtWidgets.QAction

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#createUndoAction

destroyed

destroyed(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QUndoGroup.destroyed; argument details are not documented.

indexChanged

indexChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QUndoGroup.indexChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QUndoGroup::indexChanged(int idx)

This signal is emitted whenever the active stack emits QUndoStack::indexChanged() or the active stack changes.

idx is the new current index, or 0 if the active stack is 0.

See also QUndoStack::indexChanged() and setActiveStack().

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#indexChanged

isClean

isClean() -> bool

X.isClean() -> bool

Supplemental documentation: Qt 5 reference:

bool QUndoGroup::isClean() const

Returns the value of the active stack's QUndoStack::isClean().

If none of the stacks are active, or if the group is empty, this function returns true.

See also setActiveStack().

Upstream PySide2 reference signatures (binding differences may apply):

isClean(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#isClean

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QUndoGroup.objectNameChanged; argument details are not documented.

redo

redo() -> None

X.redo()

Supplemental documentation: Qt 5 reference:

[slot] void QUndoGroup::redo()

Calls QUndoStack::redo() on the active stack.

If none of the stacks are active, or if the group is empty, this function does nothing.

See also undo(), canRedo(), and setActiveStack().

Upstream PySide2 reference signatures (binding differences may apply):

redo(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#redo

redoText

redoText() -> str

X.redoText() -> str

Supplemental documentation: Qt 5 reference:

QString QUndoGroup::redoText() const

Returns the value of the active stack's QUndoStack::redoText().

If none of the stacks are active, or if the group is empty, this function returns an empty string.

See also undoText() and setActiveStack().

Upstream PySide2 reference signatures (binding differences may apply):

redoText(self) -> str

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#redoText

redoTextChanged

redoTextChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QUndoGroup.redoTextChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QUndoGroup::redoTextChanged(const QString \&redoText)

This signal is emitted whenever the active stack emits QUndoStack::redoTextChanged() or the active stack changes.

redoText is the new state, or an empty string if the active stack is 0.

See also QUndoStack::redoTextChanged() and setActiveStack().

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#redoTextChanged

removeStack

removeStack(stack: Any) -> None

X.removeStack(stack)

Supplemental documentation: Qt 5 reference:

void QUndoGroup::removeStack(QUndoStack *stack)

Removes stack from this group. If the stack was the active stack in the group, the active stack becomes 0.

See also addStack(), stacks(), and QUndoStack::\~QUndoStack().

Upstream PySide2 reference signatures (binding differences may apply):

removeStack(self, stack: PySide2.QtWidgets.QUndoStack) -> None

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#removeStack

setActiveStack

setActiveStack(stack: Any) -> None

X.setActiveStack(stack)

Supplemental documentation: Qt 5 reference:

[slot] void QUndoGroup::setActiveStack(QUndoStack *stack)

Sets the active stack of this group to stack.

If the stack is not a member of this group, this function does nothing.

Synonymous with calling QUndoStack::setActive() on stack.

The actions returned by createUndoAction() and createRedoAction() will now behave in the same way as those returned by stack's QUndoStack::createUndoAction() and QUndoStack::createRedoAction().

See also QUndoStack::setActive() and activeStack().

Upstream PySide2 reference signatures (binding differences may apply):

setActiveStack(self, stack: PySide2.QtWidgets.QUndoStack) -> None

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#setActiveStack

stacks

stacks() -> tuple

X.stacks() -> tuple

Supplemental documentation: Qt 5 reference:

QList\<QUndoStack *> QUndoGroup::stacks() const

Returns a list of stacks in this group.

See also addStack() and removeStack().

Upstream PySide2 reference signatures (binding differences may apply):

stacks(self) -> typing.List[PySide2.QtWidgets.QUndoStack]

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#stacks

undo

undo() -> None

X.undo()

Supplemental documentation: Qt 5 reference:

[slot] void QUndoGroup::undo()

Calls QUndoStack::undo() on the active stack.

If none of the stacks are active, or if the group is empty, this function does nothing.

See also redo(), canUndo(), and setActiveStack().

Upstream PySide2 reference signatures (binding differences may apply):

undo(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#undo

undoText

undoText() -> str

X.undoText() -> str

Supplemental documentation: Qt 5 reference:

QString QUndoGroup::undoText() const

Returns the value of the active stack's QUndoStack::undoText().

If none of the stacks are active, or if the group is empty, this function returns an empty string.

See also redoText() and setActiveStack().

Upstream PySide2 reference signatures (binding differences may apply):

undoText(self) -> str

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#undoText

undoTextChanged

undoTextChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtGui.QUndoGroup.undoTextChanged; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QUndoGroup::undoTextChanged(const QString \&undoText)

This signal is emitted whenever the active stack emits QUndoStack::undoTextChanged() or the active stack changes.

undoText is the new state, or an empty string if the active stack is 0.

See also QUndoStack::undoTextChanged() and setActiveStack().

Source: https://doc.qt.io/archives/qt-5.15/qundogroup.html#undoTextChanged