Subgroup: Layout
Class: QgsLayoutUndoStack¶
-
class
qgis.core.
QgsLayoutUndoStack
(layout: QgsLayout)¶ Bases:
PyQt5.QtCore.QObject
Constructor for QgsLayoutUndoStack, for the specified parent
layout
.An undo stack for QgsLayouts.
New in version 3.0: Methods
beginCommand
Begins a new undo command for the specified object
.beginMacro
Starts a macro command, with the given descriptive commandText
.blockCommands
Sets whether undo commands for the layout should be temporarily blocked. cancelCommand
Cancels the active command, discarding it without pushing to the undo history. childEvent
connectNotify
customEvent
disconnectNotify
endCommand
Saves final state of an object and pushes the active command to the undo history. endMacro
Ends a macro command. isBlocked
Returns true if undo commands are currently blocked. isSignalConnected
notifyUndoRedoOccurred
Notifies the stack that an undo or redo action occurred for a specified item
.push
Manually pushes a command
to the stack, and takes ownership of the command.receivers
sender
senderSignalIndex
stack
Returns a pointer to the internal QUndoStack. timerEvent
Signals
undoRedoOccurredForItems
Emitted when an undo or redo action has occurred, which affected a set of layout itemUuids
.Attributes
-
beginCommand
(self, object: QgsLayoutUndoObjectInterface, commandText: str, id: int = 0)¶ Begins a new undo command for the specified
object
.This must be followed by a call to endCommand() or cancelCommand() after the desired changes have been made to
object
.The
id
argument can be used to specify an id number for the source event - this is used to determine whether QUndoCommand command compression can apply to the command.See also
See also
-
beginMacro
(self, commandText: str)¶ Starts a macro command, with the given descriptive
commandText
.Any commands added to the stack (either via direct manipulation of stack() or via beginCommand()/endCommand() calls) between a beginMacro() and endMacro() block are collapsed into a single undo command, which will be applied or rolled back in a single step.
See also
-
blockCommands
(self, blocked: bool)¶ Sets whether undo commands for the layout should be temporarily blocked.
If
blocked
is true, subsequent undo commands will be blocked until a follow-up call to blockCommands( false ) is made.Note that calls to blockCommands are stacked, so two calls blocking the commands will take two calls unblocking commands in order to release the block.
See also
-
cancelCommand
(self)¶ Cancels the active command, discarding it without pushing to the undo history.
See also
See also
-
childEvent
()¶
-
connectNotify
()¶
-
customEvent
()¶
-
disconnectNotify
()¶
-
endCommand
(self)¶ Saves final state of an object and pushes the active command to the undo history.
See also
See also
-
endMacro
(self)¶ Ends a macro command. This must be called after beginMacro(), when all child undo commands which form part of the macro have been completed.
Any commands added to the stack (either via direct manipulation of stack() or via beginCommand()/endCommand() calls) between a beginMacro() and endMacro() block are collapsed into a single undo command, which will be applied or rolled back in a single step.
See also
-
isBlocked
(self) → bool¶ Returns true if undo commands are currently blocked.
See also
-
isSignalConnected
()¶
-
notifyUndoRedoOccurred
(self, item: QgsLayoutItem)¶ Notifies the stack that an undo or redo action occurred for a specified
item
.
-
push
(self, command: QUndoCommand)¶ Manually pushes a
command
to the stack, and takes ownership of the command.
-
receivers
()¶
-
sender
()¶
-
senderSignalIndex
()¶
-
stack
(self) → QUndoStack¶ Returns a pointer to the internal QUndoStack.
-
timerEvent
()¶
-
undoRedoOccurredForItems
¶ Emitted when an undo or redo action has occurred, which affected a set of layout
itemUuids
. [signal]
-