ROperation

Class in Core Module
Header: #include <src/core/ROperation.h>
Inherits: RRequireHeap, RNonCopyable (private)
Inherited by: RAddObjectsOperation, RChangePropertyOperation, RClickReferencePointOperation, RClipboardOperation, RDeleteAllEntitiesOperation, RDeleteObjectsOperation, RMixedOperation, RMoveReferencePointOperation, RMoveSelectionOperation, RMultiOperation, RScaleSelectionOperation

Description

This abstract class is an interface for all operation implementations.

An operation encapsulates a modification that can be applied to a document. An implementing class might for example implement a move operation that moves all selected entities by a given vector.

Scriptable: This class is available in script environments.

Public Functions

	ROperation(bool undoable=true, RS::EntityType entityTypeFilter=RS::EntityAll)
virtual	~ROperation()
virtual RTransaction	apply(RDocument &document, bool preview=false)=0 = 0 Applies this operation to selection in the given document.
RS::EntityType	getEntityTypeFilter() const
QString	getText() const
int	getTransactionGroup() const
bool	getTransactionType(RTransaction::Type t) const
RTransaction::Types	getTransactionTypes() const
void	setAllowAll(bool on)
void	setAllowInvisible(bool on)
void	setKeepChildren(bool on) Keep child entities (e.g.
void	setRecordAffectedObjects(bool on)
void	setSpatialIndexDisabled(bool on)
void	setText(const QString &t)
void	setTransactionGroup(int g)
void	setTransactionType(RTransaction::Type t, bool on=true)

Protected Attributes

bool	allowAll
bool	allowInvisible
RS::EntityType	entityTypeFilter
bool	keepChildren
bool	recordAffectedObjects
bool	spatialIndexDisabled
QString	text
int	transactionGroup
RTransaction::Types	transactionTypes
bool	undoable

Member Documentation

ROperation

ROperation::ROperation(bool undoable=true, RS::EntityType entityTypeFilter=RS::EntityAll)

inline

~ROperation

virtual ROperation::~ROperation()

virtual inline

apply

virtual RTransaction ROperation::apply(RDocument &document, bool preview=false)=0 = 0

pure virtual

Applies this operation to selection in the given document.

This is used for both previews and the actual apply. In case of a preview, the given document is a temporary document with a storage that is linked to the real document for realistic condiditions for the preview.

Reimplemented in apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply, apply.

getEntityTypeFilter

RS::EntityType ROperation::getEntityTypeFilter() const

inline const

getText

QString ROperation::getText() const

inline const

getTransactionGroup

int ROperation::getTransactionGroup() const

inline const

getTransactionType

bool ROperation::getTransactionType(RTransaction::Type t) const

inline const

getTransactionTypes

RTransaction::Types ROperation::getTransactionTypes() const

inline const

setAllowAll

void ROperation::setAllowAll(bool on)

inline

setAllowInvisible

void ROperation::setAllowInvisible(bool on)

inline

setKeepChildren

void ROperation::setKeepChildren(bool on)

inline

Keep child entities (e.g.

keep block attributes when deleting block references)

setRecordAffectedObjects

void ROperation::setRecordAffectedObjects(bool on)

inline

setSpatialIndexDisabled

void ROperation::setSpatialIndexDisabled(bool on)

inline

setText

void ROperation::setText(const QString &t)

inline

setTransactionGroup

void ROperation::setTransactionGroup(int g)

inline

setTransactionType

void ROperation::setTransactionType(RTransaction::Type t, bool on=true)

inline

allowAll

bool ROperation::allowAll

protected

allowInvisible

bool ROperation::allowInvisible

protected

entityTypeFilter

RS::EntityType ROperation::entityTypeFilter

protected

keepChildren

bool ROperation::keepChildren

protected

recordAffectedObjects

bool ROperation::recordAffectedObjects

protected

spatialIndexDisabled

bool ROperation::spatialIndexDisabled

protected

text

QString ROperation::text

protected

transactionGroup

int ROperation::transactionGroup

protected

transactionTypes

RTransaction::Types ROperation::transactionTypes

protected

undoable

bool ROperation::undoable

protected