Quantum GIS API Documentation  1.8
Public Member Functions | Protected Member Functions | Protected Attributes
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]

List of all members.

Public Member Functions

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

Protected Member Functions

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

Protected Attributes

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

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 21 of file qgscomposeritemcommand.cpp.

Definition at line 26 of file qgscomposeritemcommand.cpp.


Member Function Documentation

QDomDocument QgsComposerItemCommand::afterState ( ) const [inline]

Definition at line 44 of file qgscomposeritemcommand.h.

Referenced by QgsComposerMergeCommand::mergeWith().

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

Definition at line 45 of file qgscomposeritemcommand.cpp.

References mAfterState, and mPreviousState.

Referenced by QgsComposition::endCommand().

QDomDocument QgsComposerItemCommand::previousState ( ) const [inline]

Definition at line 43 of file qgscomposeritemcommand.h.

Replays the command.

Definition at line 35 of file qgscomposeritemcommand.cpp.

References mAfterState, mFirstRun, and restoreState().

void QgsComposerItemCommand::restoreState ( QDomDocument &  stateDoc) const [protected]

Definition at line 71 of file qgscomposeritemcommand.cpp.

References mItem, QgsComposerItem::readXML(), and QgsComposerItem::repaint().

Referenced by redo(), and undo().

void QgsComposerItemCommand::saveState ( QDomDocument &  stateDoc) const [protected]

Definition at line 60 of file qgscomposeritemcommand.cpp.

References mItem, and QgsComposerItem::writeXML().

Referenced by saveAfterState(), and savePreviousState().

Reverses the command.

Definition at line 30 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 55 of file qgscomposeritemcommand.h.

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

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

Definition at line 58 of file qgscomposeritemcommand.h.

Referenced by redo().

Target item of the command.

Definition at line 51 of file qgscomposeritemcommand.h.

Referenced by restoreState(), and saveState().

QDomDocument QgsComposerItemCommand::mPreviousState [protected]

XML that saves the state before executing the command.

Definition at line 53 of file qgscomposeritemcommand.h.

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


The documentation for this class was generated from the following files:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Defines