libs/flake

KoShapeReorderCommand Class Reference

This command allows you to change the zIndex of a number of shapes. More...

#include <KoShapeReorderCommand.h>

Inheritance diagram for KoShapeReorderCommand:

List of all members.

Public Types

enum  MoveShapeType { RaiseShape, LowerShape, BringToFront, SendToBack }

Public Member Functions

 KoShapeReorderCommand (const QList< KoShape * > &shapes, QList< int > &newIndexes, QUndoCommand *parent=0)
void redo ()
void undo ()

Static Public Member Functions

static KoShapeReorderCommandcreateCommand (const QList< KoShape * > &shapes, KoShapeManager *manager, MoveShapeType move, QUndoCommand *parent=0)

Detailed Description

This command allows you to change the zIndex of a number of shapes.

Definition at line 34 of file KoShapeReorderCommand.h.


Member Enumeration Documentation

An enum for defining what kind of reordering to use.

Enumerator:
RaiseShape 

raise the selected shape to the level that it is above the shape that is on top of it.

LowerShape 

Lower the selected shape to the level that it is below the shape that is below it.

BringToFront 

Raise the selected shape to be on top of all shapes.

SendToBack 

Lower the selected shape to be below all other shapes.

Definition at line 47 of file KoShapeReorderCommand.h.


Constructor & Destructor Documentation

KoShapeReorderCommand::KoShapeReorderCommand ( const QList< KoShape * > &  shapes,
QList< int > &  newIndexes,
QUndoCommand parent = 0 
)

Constructor.

Parameters:
shapes the set of objects that are moved.
newIndexes the new indexes for the shapes. this list naturally must have the same amount of items as the shapes set.
parent the parent command used for macro commands

Definition at line 29 of file KoShapeReorderCommand.cpp.


Member Function Documentation

KoShapeReorderCommand * KoShapeReorderCommand::createCommand ( const QList< KoShape * > &  shapes,
KoShapeManager manager,
MoveShapeType  move,
QUndoCommand parent = 0 
) [static]

Create a new KoShapeReorderCommand by calculating the new indexes required to move the shapes according to the move parameter.

Parameters:
shapes all the shapes that should be moved.
manager the shapeManager that contains all the shapes that could have their indexes changed.
move the moving type.
parent the parent command for grouping purposes.
Returns:
command for reording the shapes or 0 if no reordering happend

Definition at line 107 of file KoShapeReorderCommand.cpp.

void KoShapeReorderCommand::redo (  ) 

redo the command

Reimplemented from QUndoCommand.

Definition at line 41 of file KoShapeReorderCommand.cpp.

void KoShapeReorderCommand::undo (  ) 

revert the actions done in redo

Reimplemented from QUndoCommand.

Definition at line 51 of file KoShapeReorderCommand.cpp.


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