kspread

KSpread::AbstractRegionCommand

KSpread::AbstractRegionCommand Class Reference

Abstract base class for all region related operations. More...

#include <AbstractRegionCommand.h>

Inheritance diagram for KSpread::AbstractRegionCommand:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 AbstractRegionCommand (QUndoCommand *parent=0)
virtual ~AbstractRegionCommand ()
virtual bool execute (KoCanvasBase *canvas=0)
virtual void redo ()
void setRegisterUndo (bool registerUndo)
virtual void setReverse (bool reverse)
void setSheet (Sheet *sheet)
Sheet * sheet () const
virtual void undo ()

Protected Member Functions

bool isApproved () const
virtual bool mainProcessing ()
virtual bool postProcessing ()
virtual bool preProcessing ()
virtual bool process (Element *)

Protected Attributes

bool m_checkLock: 1
bool m_firstrun: 1
bool m_register: 1
bool m_reverse: 1
Sheet * m_sheet
bool m_success: 1

Detailed Description

Abstract base class for all region related operations.

Definition at line 37 of file AbstractRegionCommand.h.

Constructor & Destructor Documentation

AbstractRegionCommand::AbstractRegionCommand ( QUndoCommand *  parent = 0  ) 

Constructor.

Definition at line 55 of file AbstractRegionCommand.cpp.

AbstractRegionCommand::~AbstractRegionCommand (  )  [virtual]

Destructor.

Definition at line 67 of file AbstractRegionCommand.cpp.

Member Function Documentation

bool AbstractRegionCommand::execute ( KoCanvasBase *  canvas = 0  )  [virtual]

Executes the actual operation and adds the manipulator to the undo history, if desired.

Returns:
true if the command was executed successfully
false if the command fails, was already executed once or is not approved
See also:
setRegisterUndo, isApproved

Definition at line 71 of file AbstractRegionCommand.cpp.

bool AbstractRegionCommand::isApproved (  )  const [protected]

Checks all cells, that should be processed, for protection and matrix locks.

Returns:
true if execution is approved
false otherwise

Definition at line 131 of file AbstractRegionCommand.cpp.

bool AbstractRegionCommand::mainProcessing (  )  [protected, virtual]

Processes the region.

Calls process(Element*).

Reimplemented in KSpread::AutoFillCommand, KSpread::AutoFormatCommand, KSpread::BorderColorCommand, KSpread::CommentCommand, KSpread::CondtionCommand, KSpread::AbstractDataManipulator, KSpread::DeleteCommand, KSpread::IndentationCommand, KSpread::NamedAreaCommand, KSpread::PrecisionCommand, KSpread::StyleCommand, and KSpread::ValidityCommand.

Definition at line 165 of file AbstractRegionCommand.cpp.

virtual bool KSpread::AbstractRegionCommand::postProcessing (  )  [inline, protected, virtual]

Postprocessing of the region.

Reimplemented in KSpread::BorderColorCommand, KSpread::CSVDataCommand, KSpread::AbstractDataManipulator, KSpread::ShiftManipulator, KSpread::IndentationCommand, KSpread::MergeCommand, KSpread::NamedAreaCommand, KSpread::PrecisionCommand, KSpread::HideShowManipulator, KSpread::InsertDeleteColumnManipulator, KSpread::InsertDeleteRowManipulator, KSpread::SortManipulator, and KSpread::StyleCommand.

Definition at line 111 of file AbstractRegionCommand.h.

virtual bool KSpread::AbstractRegionCommand::preProcessing (  )  [inline, protected, virtual]

Preprocessing of the region.

Reimplemented in KSpread::AutoFormatCommand, KSpread::BorderColorCommand, KSpread::CSVDataCommand, KSpread::AbstractDataManipulator, KSpread::DataManipulator, KSpread::MergeCommand, KSpread::NamedAreaCommand, KSpread::AdjustColumnRowManipulator, KSpread::HideShowManipulator, KSpread::SortManipulator, and KSpread::StyleCommand.

Definition at line 101 of file AbstractRegionCommand.h.

virtual bool KSpread::AbstractRegionCommand::process ( Element *   )  [inline, protected, virtual]

Processes element , a Region::Point or a Region::Range .

Invoked by mainProcessing() .

Reimplemented in KSpread::AutoFormatCommand, KSpread::CommentCommand, KSpread::CondtionCommand, KSpread::AbstractDataManipulator, KSpread::AbstractDFManipulator, KSpread::DataManipulator, KSpread::ShiftManipulator, KSpread::DeleteCommand, KSpread::MergeCommand, KSpread::ResizeColumnManipulator, KSpread::ResizeRowManipulator, KSpread::AdjustColumnRowManipulator, KSpread::HideShowManipulator, KSpread::InsertDeleteColumnManipulator, KSpread::InsertDeleteRowManipulator, KSpread::SortManipulator, KSpread::StyleCommand, and KSpread::ValidityCommand.

Definition at line 96 of file AbstractRegionCommand.h.

void AbstractRegionCommand::redo (  )  [virtual]

Executes the actual operation.

Reimplemented from QUndoCommand.

Reimplemented in KSpread::ApplyFilterCommand, KSpread::AutoFilterCommand, and KSpread::DefinePrintRangeCommand.

Definition at line 85 of file AbstractRegionCommand.cpp.

void KSpread::AbstractRegionCommand::setRegisterUndo ( bool  registerUndo  )  [inline]

If registerUndo is true , this manipulator registers an undo operation for the document.

Definition at line 89 of file AbstractRegionCommand.h.

virtual void KSpread::AbstractRegionCommand::setReverse ( bool  reverse  )  [inline, virtual]

Sets reverse mode to reverse .

See also:
redo
undo

Reimplemented in KSpread::ShiftManipulator, KSpread::IndentationCommand, KSpread::MergeCommand, KSpread::NamedAreaCommand, KSpread::PrecisionCommand, KSpread::InsertDeleteColumnManipulator, and KSpread::InsertDeleteRowManipulator.

Definition at line 83 of file AbstractRegionCommand.h.

void KSpread::AbstractRegionCommand::setSheet ( Sheet *  sheet  )  [inline]

Sets sheet to be the Sheet to work on.

Definition at line 58 of file AbstractRegionCommand.h.

Sheet* KSpread::AbstractRegionCommand::sheet (  )  const [inline]
Returns:
the Sheet this AbstractRegionCommand works on

Definition at line 53 of file AbstractRegionCommand.h.

void AbstractRegionCommand::undo (  )  [virtual]

Executes the actual operation in reverse order.

Reimplemented from QUndoCommand.

Reimplemented in KSpread::ApplyFilterCommand, KSpread::AutoFilterCommand, and KSpread::DefinePrintRangeCommand.

Definition at line 124 of file AbstractRegionCommand.cpp.

Member Data Documentation

bool KSpread::AbstractRegionCommand::m_checkLock [protected]

Definition at line 126 of file AbstractRegionCommand.h.

bool KSpread::AbstractRegionCommand::m_firstrun [protected]

Definition at line 123 of file AbstractRegionCommand.h.

bool KSpread::AbstractRegionCommand::m_register [protected]

Definition at line 124 of file AbstractRegionCommand.h.

bool KSpread::AbstractRegionCommand::m_reverse [protected]

Definition at line 122 of file AbstractRegionCommand.h.

Sheet* KSpread::AbstractRegionCommand::m_sheet [protected]

Definition at line 121 of file AbstractRegionCommand.h.

bool KSpread::AbstractRegionCommand::m_success [protected]

Definition at line 125 of file AbstractRegionCommand.h.

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