QGIS API Documentation  2.99.0-Master (716ff6c)
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)
 
QDomDocument afterState () const
 
bool containsChange () const
 Returns true if previous state and after state are valid and different. More...
 
const QgsComposerMultiFramemultiFrame () const
 
QDomDocument previousState () const
 
void redo () override
 
void saveAfterState ()
 
void savePreviousState ()
 
void undo () override
 

Protected Member Functions

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

Protected Attributes

QDomDocument mAfterState
 
bool mFirstRun
 
QgsComposerMultiFramemMultiFrame = nullptr
 
QDomDocument mPreviousState
 

Detailed Description

Definition at line 31 of file qgscomposermultiframecommand.h.

Constructor & Destructor Documentation

◆ QgsComposerMultiFrameCommand() [1/2]

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

Definition at line 23 of file qgscomposermultiframecommand.cpp.

◆ QgsComposerMultiFrameCommand() [2/2]

QgsComposerMultiFrameCommand::QgsComposerMultiFrameCommand ( )
protected

Definition at line 28 of file qgscomposermultiframecommand.cpp.

Member Function Documentation

◆ afterState()

QDomDocument QgsComposerMultiFrameCommand::afterState ( ) const
inline

Definition at line 43 of file qgscomposermultiframecommand.h.

◆ checkFirstRun()

bool QgsComposerMultiFrameCommand::checkFirstRun ( )
protected

Definition at line 76 of file qgscomposermultiframecommand.cpp.

◆ containsChange()

bool QgsComposerMultiFrameCommand::containsChange ( ) const

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

Definition at line 86 of file qgscomposermultiframecommand.cpp.

◆ multiFrame()

const QgsComposerMultiFrame* QgsComposerMultiFrameCommand::multiFrame ( ) const
inline

Definition at line 48 of file qgscomposermultiframecommand.h.

◆ previousState()

QDomDocument QgsComposerMultiFrameCommand::previousState ( ) const
inline

Definition at line 42 of file qgscomposermultiframecommand.h.

◆ redo()

void QgsComposerMultiFrameCommand::redo ( )
override

Definition at line 37 of file qgscomposermultiframecommand.cpp.

◆ restoreState()

void QgsComposerMultiFrameCommand::restoreState ( QDomDocument &  stateDoc)
protected

Definition at line 67 of file qgscomposermultiframecommand.cpp.

◆ saveAfterState()

void QgsComposerMultiFrameCommand::saveAfterState ( )

Definition at line 51 of file qgscomposermultiframecommand.cpp.

◆ savePreviousState()

void QgsComposerMultiFrameCommand::savePreviousState ( )

Definition at line 46 of file qgscomposermultiframecommand.cpp.

◆ saveState()

void QgsComposerMultiFrameCommand::saveState ( QDomDocument &  stateDoc)
protected

Definition at line 56 of file qgscomposermultiframecommand.cpp.

◆ undo()

void QgsComposerMultiFrameCommand::undo ( )
override

Definition at line 32 of file qgscomposermultiframecommand.cpp.

Member Data Documentation

◆ mAfterState

QDomDocument QgsComposerMultiFrameCommand::mAfterState
protected

Definition at line 54 of file qgscomposermultiframecommand.h.

◆ mFirstRun

bool QgsComposerMultiFrameCommand::mFirstRun
protected

Definition at line 56 of file qgscomposermultiframecommand.h.

◆ mMultiFrame

QgsComposerMultiFrame* QgsComposerMultiFrameCommand::mMultiFrame = nullptr
protected

Definition at line 51 of file qgscomposermultiframecommand.h.

◆ mPreviousState

QDomDocument QgsComposerMultiFrameCommand::mPreviousState
protected

Definition at line 53 of file qgscomposermultiframecommand.h.


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