ModelView::AbstractItemCommand Class Reference

Abstract command interface to manipulate SessionItem in model context. More...

Inheritance diagram for ModelView::AbstractItemCommand:

Classes
struct	AbstractItemCommandImpl

Public Member Functions
	AbstractItemCommand (const AbstractItemCommand &other)=delete
	AbstractItemCommand (SessionItem *receiver)
virtual	~AbstractItemCommand ()
std::string	description () const
	Returns command description. More...
void	execute ()
	Execute command. More...
bool	isObsolete () const
	Returns whether the command is obsolete (which means that it shouldn't be kept in the stack). More...
AbstractItemCommand &	operator= (const AbstractItemCommand &other)=delete
CommandResult	result () const
void	undo ()
	Undo command as it was before execution. More...

Protected Member Functions
SessionItem *	itemFromPath (const Path &path) const
SessionModel *	model () const
Path	pathFromItem (SessionItem *item) const
void	setDescription (const std::string &text)
	Sets command description. More...
void	setObsolete (bool flag)
	Sets command obsolete flag. More...
void	setResult (const CommandResult &command_result)

Private Member Functions
virtual void	execute_command ()=0
virtual void	undo_command ()=0

Private Attributes
std::unique_ptr< AbstractItemCommandImpl >	p_impl

Detailed Description

Abstract command interface to manipulate SessionItem in model context.

Definition at line 31 of file abstractitemcommand.h.

Constructor & Destructor Documentation

AbstractItemCommand() [1/2]

AbstractItemCommand::AbstractItemCommand ( SessionItem *  receiver )

explicit

Definition at line 40 of file abstractitemcommand.cpp.

    : p_impl(std::make_unique<AbstractItemCommand::AbstractItemCommandImpl>(this))
{
    if (!receiver)
        throw std::runtime_error("Invalid item.");
 
    if (!receiver->model())
        throw std::runtime_error("Item doesn't have a model");
 
    p_impl->m_model = receiver->model();
}

References ModelView::SessionItem::model(), and p_impl.

Here is the call graph for this function:

~AbstractItemCommand()

AbstractItemCommand::~AbstractItemCommand ( )

virtualdefault

AbstractItemCommand() [2/2]

ModelView::AbstractItemCommand::AbstractItemCommand ( const AbstractItemCommand &  other )

delete

Member Function Documentation

description()

std::string AbstractItemCommand::description

(

)

const

Returns command description.

Definition at line 87 of file abstractitemcommand.cpp.

{
    return p_impl->m_text;
}

References p_impl.

execute()

void AbstractItemCommand::execute

(

)

Execute command.

Definition at line 56 of file abstractitemcommand.cpp.

{
    if (!p_impl->can_execute())
        throw std::runtime_error("Can't execute the command. Wrong order.");
 
    execute_command();
 
    p_impl->set_after_execute();
}

References execute_command(), and p_impl.

Referenced by TEST_F().

Here is the call graph for this function:

execute_command()

virtual void ModelView::AbstractItemCommand::execute_command ( )

privatepure virtual

Implemented in ModelView::SetValueCommand, ModelView::RemoveItemCommand, ModelView::MoveItemCommand, ModelView::InsertNewItemCommand, and ModelView::CopyItemCommand.

Referenced by execute().

isObsolete()

bool AbstractItemCommand::isObsolete

(

)

const

Returns whether the command is obsolete (which means that it shouldn't be kept in the stack).

Definition at line 80 of file abstractitemcommand.cpp.

{
    return p_impl->m_isObsolete;
}

References p_impl.

Referenced by ModelView::AbstractItemCommand::AbstractItemCommandImpl::can_undo(), and TEST_F().

itemFromPath()

SessionItem * AbstractItemCommand::itemFromPath ( const Path &  path ) const

protected

Definition at line 116 of file abstractitemcommand.cpp.

{
    return Utils::ItemFromPath(*p_impl->m_model, path);
}

References ModelView::Utils::ItemFromPath(), and p_impl.

Referenced by ModelView::CopyItemCommand::execute_command(), ModelView::InsertNewItemCommand::execute_command(), ModelView::MoveItemCommand::execute_command(), ModelView::RemoveItemCommand::execute_command(), ModelView::SetValueCommand::swap_values(), ModelView::CopyItemCommand::undo_command(), ModelView::InsertNewItemCommand::undo_command(), ModelView::MoveItemCommand::undo_command(), and ModelView::RemoveItemCommand::undo_command().

Here is the call graph for this function:

model()

SessionModel * AbstractItemCommand::model ( ) const

protected

Definition at line 121 of file abstractitemcommand.cpp.

{
    return p_impl->m_model;
}

References p_impl.

operator=()

AbstractItemCommand& ModelView::AbstractItemCommand::operator= ( const AbstractItemCommand &  other )

delete

pathFromItem()

Path AbstractItemCommand::pathFromItem ( SessionItem *  item ) const

protected

Definition at line 111 of file abstractitemcommand.cpp.

{
    return Utils::PathFromItem(item);
}

References ModelView::Utils::PathFromItem().

Referenced by ModelView::CopyItemCommand::CopyItemCommand(), ModelView::InsertNewItemCommand::InsertNewItemCommand(), ModelView::MoveItemCommand::MoveItemCommand(), ModelView::RemoveItemCommand::RemoveItemCommand(), ModelView::SetValueCommand::SetValueCommand(), ModelView::MoveItemCommand::execute_command(), and ModelView::MoveItemCommand::undo_command().

Here is the call graph for this function:

result()

CommandResult AbstractItemCommand::result

(

)

const

Definition at line 92 of file abstractitemcommand.cpp.

{
    return p_impl->m_result;
}

References p_impl.

Referenced by ModelView::CopyItemCommand::execute_command(), ModelView::SetValueCommand::swap_values(), and TEST_F().

setDescription()

void AbstractItemCommand::setDescription ( const std::string &  text )

protected

Sets command description.

Definition at line 106 of file abstractitemcommand.cpp.

{
    p_impl->m_text = text;
}

References p_impl.

Referenced by ModelView::CopyItemCommand::CopyItemCommand(), ModelView::MoveItemCommand::MoveItemCommand(), ModelView::RemoveItemCommand::RemoveItemCommand(), ModelView::SetValueCommand::SetValueCommand(), and ModelView::InsertNewItemCommand::execute_command().

setObsolete()

void AbstractItemCommand::setObsolete ( bool  flag )

protected

Sets command obsolete flag.

Definition at line 99 of file abstractitemcommand.cpp.

{
    p_impl->m_isObsolete = flag;
}

References p_impl.

Referenced by ModelView::CopyItemCommand::execute_command(), ModelView::InsertNewItemCommand::execute_command(), ModelView::RemoveItemCommand::execute_command(), and ModelView::SetValueCommand::swap_values().

setResult()

void AbstractItemCommand::setResult ( const CommandResult &  command_result )

protected

Definition at line 126 of file abstractitemcommand.cpp.

{
    p_impl->m_result = command_result;
}

References p_impl.

Referenced by ModelView::CopyItemCommand::CopyItemCommand(), ModelView::InsertNewItemCommand::InsertNewItemCommand(), ModelView::MoveItemCommand::MoveItemCommand(), ModelView::RemoveItemCommand::RemoveItemCommand(), ModelView::SetValueCommand::SetValueCommand(), ModelView::CopyItemCommand::execute_command(), ModelView::InsertNewItemCommand::execute_command(), ModelView::RemoveItemCommand::execute_command(), ModelView::SetValueCommand::swap_values(), ModelView::CopyItemCommand::undo_command(), and ModelView::InsertNewItemCommand::undo_command().

undo()

void AbstractItemCommand::undo

(

)

Undo command as it was before execution.

Definition at line 68 of file abstractitemcommand.cpp.

{
    if (!p_impl->can_undo())
        throw std::runtime_error("Can't undo the command. Wrong order.");
 
    undo_command();
 
    p_impl->set_after_undo();
}

References p_impl, and undo_command().

Referenced by TEST_F().

Here is the call graph for this function:

undo_command()

virtual void ModelView::AbstractItemCommand::undo_command ( )

privatepure virtual

Implemented in ModelView::SetValueCommand, ModelView::RemoveItemCommand, ModelView::MoveItemCommand, ModelView::InsertNewItemCommand, and ModelView::CopyItemCommand.

Referenced by undo().

Member Data Documentation

p_impl

std::unique_ptr<AbstractItemCommandImpl> ModelView::AbstractItemCommand::p_impl

private

Definition at line 62 of file abstractitemcommand.h.

Referenced by AbstractItemCommand(), description(), execute(), isObsolete(), itemFromPath(), model(), result(), setDescription(), setObsolete(), setResult(), and undo().

---

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

• /home/www/ba/mvvm/model/mvvm/commands/abstractitemcommand.h
• /home/www/ba/mvvm/model/mvvm/commands/abstractitemcommand.cpp