QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsComposerMultiFrameCommand Class Reference

#include <qgscomposermultiframecommand.h>

Inheritance diagram for QgsComposerMultiFrameCommand:
Inheritance graph
[legend]

Public Member Functions

 QgsComposerMultiFrameCommand (QgsComposerMultiFrame *multiFrame, const QString &text, QUndoCommand *parent=nullptr)
 
 ~QgsComposerMultiFrameCommand ()
 
QDomDocument afterState () const
 
bool containsChange () const
 Returns true if previous state and after state are valid and different. More...
 
const QgsComposerMultiFrame * multiFrame () const
 
QDomDocument previousState () const
 
void redo () override
 
void saveAfterState ()
 
void savePreviousState ()
 
void undo () override
 
- Public Member Functions inherited from QUndoCommand
 QUndoCommand (QUndoCommand *parent)
 
 QUndoCommand (const QString &text, QUndoCommand *parent)
 
virtual ~QUndoCommand ()
 
QString actionText () const
 
const QUndoCommand * child (int index) const
 
int childCount () const
 
virtual int id () const
 
virtual bool mergeWith (const QUndoCommand *command)
 
void setText (const QString &text)
 
QString text () const
 

Protected Member Functions

 QgsComposerMultiFrameCommand ()
 
bool checkFirstRun ()
 
void restoreState (QDomDocument &stateDoc)
 
void saveState (QDomDocument &stateDoc)
 

Protected Attributes

QDomDocument mAfterState
 
bool mFirstRun
 
QgsComposerMultiFrame * mMultiFrame
 
QDomDocument mPreviousState
 

Detailed Description

Definition at line 29 of file qgscomposermultiframecommand.h.

Constructor & Destructor Documentation

◆ QgsComposerMultiFrameCommand() [1/2]

QgsComposerMultiFrameCommand::QgsComposerMultiFrameCommand ( QgsComposerMultiFrame *  multiFrame,
const QString &  text,
QUndoCommand *  parent = nullptr 
)

Definition at line 22 of file qgscomposermultiframecommand.cpp.

◆ ~QgsComposerMultiFrameCommand()

QgsComposerMultiFrameCommand::~QgsComposerMultiFrameCommand ( )

Definition at line 31 of file qgscomposermultiframecommand.cpp.

◆ QgsComposerMultiFrameCommand() [2/2]

QgsComposerMultiFrameCommand::QgsComposerMultiFrameCommand ( )
protected

Definition at line 27 of file qgscomposermultiframecommand.cpp.

Member Function Documentation

◆ afterState()

QDomDocument QgsComposerMultiFrameCommand::afterState ( ) const
inline

Definition at line 42 of file qgscomposermultiframecommand.h.

◆ checkFirstRun()

bool QgsComposerMultiFrameCommand::checkFirstRun ( )
protected

Definition at line 79 of file qgscomposermultiframecommand.cpp.

◆ containsChange()

bool QgsComposerMultiFrameCommand::containsChange ( ) const

Returns true if previous state and after state are valid and different.

Definition at line 89 of file qgscomposermultiframecommand.cpp.

◆ multiFrame()

const QgsComposerMultiFrame* QgsComposerMultiFrameCommand::multiFrame ( ) const
inline

Definition at line 47 of file qgscomposermultiframecommand.h.

◆ previousState()

QDomDocument QgsComposerMultiFrameCommand::previousState ( ) const
inline

Definition at line 41 of file qgscomposermultiframecommand.h.

◆ redo()

void QgsComposerMultiFrameCommand::redo ( )
overridevirtual

Reimplemented from QUndoCommand.

Definition at line 40 of file qgscomposermultiframecommand.cpp.

◆ restoreState()

void QgsComposerMultiFrameCommand::restoreState ( QDomDocument &  stateDoc)
protected

Definition at line 70 of file qgscomposermultiframecommand.cpp.

◆ saveAfterState()

void QgsComposerMultiFrameCommand::saveAfterState ( )

Definition at line 54 of file qgscomposermultiframecommand.cpp.

◆ savePreviousState()

void QgsComposerMultiFrameCommand::savePreviousState ( )

Definition at line 49 of file qgscomposermultiframecommand.cpp.

◆ saveState()

void QgsComposerMultiFrameCommand::saveState ( QDomDocument &  stateDoc)
protected

Definition at line 59 of file qgscomposermultiframecommand.cpp.

◆ undo()

void QgsComposerMultiFrameCommand::undo ( )
overridevirtual

Reimplemented from QUndoCommand.

Definition at line 35 of file qgscomposermultiframecommand.cpp.

Member Data Documentation

◆ mAfterState

QDomDocument QgsComposerMultiFrameCommand::mAfterState
protected

Definition at line 53 of file qgscomposermultiframecommand.h.

◆ mFirstRun

bool QgsComposerMultiFrameCommand::mFirstRun
protected

Definition at line 55 of file qgscomposermultiframecommand.h.

◆ mMultiFrame

QgsComposerMultiFrame* QgsComposerMultiFrameCommand::mMultiFrame
protected

Definition at line 50 of file qgscomposermultiframecommand.h.

◆ mPreviousState

QDomDocument QgsComposerMultiFrameCommand::mPreviousState
protected

Definition at line 52 of file qgscomposermultiframecommand.h.


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