lc::operation::DocumentOperation Class Reference

#include <documentoperation.h>

Inheritance diagram for lc::operation::DocumentOperation:

Collaboration diagram for lc::operation::DocumentOperation:

Public Member Functions
	DocumentOperation (Document_SPtr document, const std::string &description)
Document_SPtr	document () const
virtual void	execute ()
	execute this operation More...
virtual	~DocumentOperation ()
Public Member Functions inherited from lc::operation::Undoable
	Undoable (const std::string &text)
	Name of this operartion. More...
virtual	~Undoable ()
virtual void	undo () const =0
	Undo a given operation. More...
virtual void	redo () const =0
	Redo a given operation. More...
virtual std::string	text ()
	Name of the operation. More...

Protected Member Functions
virtual void	processInternal ()=0

Private Member Functions
void	process ()
virtual void	start () const
virtual void	finnish () const

Private Attributes
Document_SPtr	_document

Friends
class	lc::Document
class	Builder

Detailed Description

An operation is a grouped set of 'things' we can do on a document Only one operation can run at a time because the document needs to get locked during an operation.

Parameters

document

Definition at line 23 of file documentoperation.h.

Constructor & Destructor Documentation

DocumentOperation::DocumentOperation	(	Document_SPtr	document,
		const std::string &	description
	)

Definition at line 7 of file documentoperation.cpp.

                                                                                         :
    Undoable(description),
    _document(document) {
}

virtual lc::operation::DocumentOperation::~DocumentOperation ( )

inlinevirtual

Definition at line 36 of file documentoperation.h.

{}

Member Function Documentation

std::shared_ptr< Document > DocumentOperation::document

(

)

const

Definition at line 12 of file documentoperation.cpp.

                                                          {
    return _document;
}

void DocumentOperation::execute ( )

virtual

execute this operation

Definition at line 20 of file documentoperation.cpp.

                                {
    _document->execute(shared_from_this());
}

virtual void lc::operation::DocumentOperation::finnish ( ) const

inlineprivatevirtual

This function will get called when the process of this operation is finished

Definition at line 53 of file documentoperation.h.

{};

void DocumentOperation::process ( )

private

This function gets called when an operation starts and when the document is locked for you so you can do your work

Definition at line 16 of file documentoperation.cpp.

                                {
    processInternal();
}

virtual void lc::operation::DocumentOperation::processInternal ( )

protectedpure virtual

This function gets called when an operation starts and when the document is locked for you so you can do your work

Implemented in lc::operation::ReplaceLinePattern, lc::operation::ReplaceLayer, lc::operation::EntityBuilder, lc::operation::ReplaceBlock, lc::operation::RemoveLinePattern, lc::operation::RemoveLayer, lc::operation::RemoveBlock, lc::operation::Builder, lc::operation::AddLinePattern, lc::operation::AddLayer, and lc::operation::AddBlock.

virtual void lc::operation::DocumentOperation::start ( ) const

inlineprivatevirtual

This function will get called when the process of this operation starts

Definition at line 48 of file documentoperation.h.

{};

Friends And Related Function Documentation

friend class Builder

friend

Definition at line 25 of file documentoperation.h.

friend class lc::Document

friend

Definition at line 24 of file documentoperation.h.

Member Data Documentation

Document_SPtr lc::operation::DocumentOperation::_document

private

Definition at line 53 of file documentoperation.h.

---

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

• lckernel/cad/operations/documentoperation.h
• lckernel/cad/operations/documentoperation.cpp