QgsLayoutUndoObjectInterface class

Interface for layout objects which support undo/redo commands.

Contents

Derived classes

class QgsLayout
Base class for layouts, which can contain items such as maps, labels, scalebars, etc.
class QgsLayoutItem
Base class for graphical items within a QgsLayout.
class QgsLayoutMultiFrame
Abstract base class for layout items with the ability to distribute the content to several frames (QgsLayoutFrame items).
class QgsLayoutSerializableObject
An interface for layout objects which can be stored and read from DOM elements.

Constructors, destructors, conversion operators

~QgsLayoutUndoObjectInterface() defaulted virtual
Destructor for QgsLayoutUndoObjectInterface.

Public functions

auto createCommand(const QString& text, int id = 0, QUndoCommand* parent = nullptr) -> QgsAbstractLayoutUndoCommand* pure virtual
Creates a new layout undo command with the specified text and parent.

Function documentation

QgsAbstractLayoutUndoCommand* QgsLayoutUndoObjectInterface::createCommand(const QString& text, int id = 0, QUndoCommand* parent = nullptr) pure virtual

Creates a new layout undo command with the specified text and parent.

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.