QGIS API Documentation  3.4.3-Madeira (2f64a3c)
Public Member Functions | List of all members
QgsLayoutUndoObjectInterface Class Referenceabstract

Interface for layout objects which support undo/redo commands. More...

#include <qgslayoutundocommand.h>

Inheritance diagram for QgsLayoutUndoObjectInterface:
Inheritance graph
[legend]

Public Member Functions

virtual ~QgsLayoutUndoObjectInterface ()=default
 Destructor for QgsLayoutUndoObjectInterface. More...
 
virtual QgsAbstractLayoutUndoCommandcreateCommand (const QString &text, int id=0, QUndoCommand *parent=nullptr)=0
 Creates a new layout undo command with the specified text and parent. More...
 

Detailed Description

Interface for layout objects which support undo/redo commands.

Since
QGIS 3.0

Definition at line 128 of file qgslayoutundocommand.h.

Constructor & Destructor Documentation

◆ ~QgsLayoutUndoObjectInterface()

virtual QgsLayoutUndoObjectInterface::~QgsLayoutUndoObjectInterface ( )
virtualdefault

Member Function Documentation

◆ createCommand()

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

Implemented in QgsLayout, QgsLayoutItem, QgsLayoutMultiFrame, QgsLayoutItemPage, and QgsLayoutSerializableObject.


The documentation for this class was generated from the following file: