QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
QgsComposerItemCommand Class Reference

Undo command to undo/redo all composer item related changes. More...

#include <qgscomposeritemcommand.h>

Inheritance diagram for QgsComposerItemCommand:
Inheritance graph
[legend]
Collaboration diagram for QgsComposerItemCommand:
Collaboration graph
[legend]

Public Member Functions

 QgsComposerItemCommand (QgsComposerItem *item, const QString &text, QUndoCommand *parent=0)
 
virtual ~QgsComposerItemCommand ()
 
void undo ()
 Reverses the command. More...
 
void redo ()
 Replays the command. More...
 
void savePreviousState ()
 Saves current item state as previous state. More...
 
void saveAfterState ()
 Saves current item state as after state. More...
 
QDomDocument previousState () const
 
QDomDocument afterState () const
 
bool containsChange () const
 Returns true if previous state and after state are valid and different. More...
 
const QgsComposerItemitem () const
 

Protected Member Functions

void saveState (QDomDocument &stateDoc) const
 
void restoreState (QDomDocument &stateDoc) const
 

Protected Attributes

QgsComposerItemmItem
 Target item of the command. More...
 
QDomDocument mPreviousState
 XML that saves the state before executing the command. More...
 
QDomDocument mAfterState
 XML containing the state after executing the command. More...
 
bool mFirstRun
 Flag to prevent the first redo() if the command is pushed to the undo stack. More...
 

Detailed Description

Undo command to undo/redo all composer item related changes.

Definition at line 27 of file qgscomposeritemcommand.h.

Constructor & Destructor Documentation

QgsComposerItemCommand::QgsComposerItemCommand ( QgsComposerItem item,
const QString &  text,
QUndoCommand *  parent = 0 
)

Definition at line 22 of file qgscomposeritemcommand.cpp.

QgsComposerItemCommand::~QgsComposerItemCommand ( )
virtual

Definition at line 27 of file qgscomposeritemcommand.cpp.

Member Function Documentation

QDomDocument QgsComposerItemCommand::afterState ( ) const
inline

Definition at line 44 of file qgscomposeritemcommand.h.

Referenced by QgsComposerMergeCommand::mergeWith().

bool QgsComposerItemCommand::containsChange ( ) const

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

Definition at line 46 of file qgscomposeritemcommand.cpp.

References mAfterState, and mPreviousState.

Referenced by QgsComposition::endCommand().

const QgsComposerItem* QgsComposerItemCommand::item ( ) const
inline

Definition at line 49 of file qgscomposeritemcommand.h.

Referenced by QgsComposerMergeCommand::mergeWith().

QDomDocument QgsComposerItemCommand::previousState ( ) const
inline

Definition at line 43 of file qgscomposeritemcommand.h.

void QgsComposerItemCommand::redo ( )

Replays the command.

Definition at line 36 of file qgscomposeritemcommand.cpp.

References mAfterState, mFirstRun, and restoreState().

void QgsComposerItemCommand::restoreState ( QDomDocument &  stateDoc) const
protected
void QgsComposerItemCommand::saveAfterState ( )
void QgsComposerItemCommand::savePreviousState ( )
void QgsComposerItemCommand::saveState ( QDomDocument &  stateDoc) const
protected

Definition at line 61 of file qgscomposeritemcommand.cpp.

References mItem, and QgsComposerObject::writeXML().

Referenced by saveAfterState(), and savePreviousState().

void QgsComposerItemCommand::undo ( )

Reverses the command.

Definition at line 31 of file qgscomposeritemcommand.cpp.

References mPreviousState, and restoreState().

Member Data Documentation

QDomDocument QgsComposerItemCommand::mAfterState
protected

XML containing the state after executing the command.

Definition at line 57 of file qgscomposeritemcommand.h.

Referenced by containsChange(), QgsComposerMergeCommand::mergeWith(), redo(), and saveAfterState().

bool QgsComposerItemCommand::mFirstRun
protected

Flag to prevent the first redo() if the command is pushed to the undo stack.

Definition at line 60 of file qgscomposeritemcommand.h.

Referenced by redo().

QgsComposerItem* QgsComposerItemCommand::mItem
protected

Target item of the command.

Definition at line 53 of file qgscomposeritemcommand.h.

Referenced by QgsComposerMergeCommand::mergeWith(), restoreState(), and saveState().

QDomDocument QgsComposerItemCommand::mPreviousState
protected

XML that saves the state before executing the command.

Definition at line 55 of file qgscomposeritemcommand.h.

Referenced by containsChange(), savePreviousState(), and undo().


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