ModelView::SetValueCommand Class Reference

Command for unddo/redo framework to set the data of SessionItem. More...

Inheritance diagram for ModelView::SetValueCommand:

Collaboration diagram for ModelView::SetValueCommand:

Classes
struct	SetValueCommandImpl

Public Member Functions
	SetValueCommand (SessionItem *item, Variant value, int role)
	~SetValueCommand () override
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...
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
void	execute_command () override
void	swap_values ()
void	undo_command () override

Private Attributes
std::unique_ptr< SetValueCommandImpl >	p_impl

Detailed Description

Command for unddo/redo framework to set the data of SessionItem.

Definition at line 27 of file setvaluecommand.h.

Constructor & Destructor Documentation

SetValueCommand()

SetValueCommand::SetValueCommand	(	SessionItem *	item,
		Variant	value,
		int	role
	)

Definition at line 37 of file setvaluecommand.cpp.

    : AbstractItemCommand(item)
    , p_impl(std::make_unique<SetValueCommandImpl>(std::move(value), role))
{
    setResult(false);
 
    setDescription(generate_description(p_impl->m_value.toString().toStdString(), role));
    p_impl->m_item_path = pathFromItem(item);
}

References p_impl, ModelView::AbstractItemCommand::pathFromItem(), ModelView::AbstractItemCommand::setDescription(), and ModelView::AbstractItemCommand::setResult().

Here is the call graph for this function:

~SetValueCommand()

SetValueCommand::~SetValueCommand ( )

overridedefault

Member Function Documentation

description()

std::string AbstractItemCommand::description ( ) const

inherited

Returns command description.

Definition at line 87 of file abstractitemcommand.cpp.

{
    return p_impl->m_text;
}

References ModelView::AbstractItemCommand::p_impl.

execute()

void AbstractItemCommand::execute ( )

inherited

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 ModelView::AbstractItemCommand::execute_command(), and ModelView::AbstractItemCommand::p_impl.

Referenced by TEST_F().

Here is the call graph for this function:

execute_command()

void SetValueCommand::execute_command ( )

overrideprivatevirtual

Implements ModelView::AbstractItemCommand.

Definition at line 54 of file setvaluecommand.cpp.

{
    swap_values();
}

References swap_values().

Here is the call graph for this function:

isObsolete()

bool AbstractItemCommand::isObsolete ( ) const

inherited

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 ModelView::AbstractItemCommand::p_impl.

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

itemFromPath()

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

protectedinherited

Definition at line 116 of file abstractitemcommand.cpp.

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

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

Referenced by ModelView::CopyItemCommand::execute_command(), ModelView::InsertNewItemCommand::execute_command(), ModelView::MoveItemCommand::execute_command(), ModelView::RemoveItemCommand::execute_command(), 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

protectedinherited

Definition at line 121 of file abstractitemcommand.cpp.

{
    return p_impl->m_model;
}

References ModelView::AbstractItemCommand::p_impl.

pathFromItem()

Path AbstractItemCommand::pathFromItem ( SessionItem *  item ) const

protectedinherited

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(), SetValueCommand(), ModelView::MoveItemCommand::execute_command(), and ModelView::MoveItemCommand::undo_command().

Here is the call graph for this function:

result()

CommandResult AbstractItemCommand::result ( ) const

inherited

Definition at line 92 of file abstractitemcommand.cpp.

{
    return p_impl->m_result;
}

References ModelView::AbstractItemCommand::p_impl.

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

setDescription()

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

protectedinherited

Sets command description.

Definition at line 106 of file abstractitemcommand.cpp.

{
    p_impl->m_text = text;
}

References ModelView::AbstractItemCommand::p_impl.

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

setObsolete()

void AbstractItemCommand::setObsolete ( bool  flag )

protectedinherited

Sets command obsolete flag.

Definition at line 99 of file abstractitemcommand.cpp.

{
    p_impl->m_isObsolete = flag;
}

References ModelView::AbstractItemCommand::p_impl.

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

setResult()

void AbstractItemCommand::setResult ( const CommandResult &  command_result )

protectedinherited

Definition at line 126 of file abstractitemcommand.cpp.

{
    p_impl->m_result = command_result;
}

References ModelView::AbstractItemCommand::p_impl.

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

swap_values()

void SetValueCommand::swap_values ( )

private

Definition at line 59 of file setvaluecommand.cpp.

{
    auto item = itemFromPath(p_impl->m_item_path);
    auto old = item->data<Variant>(p_impl->m_role);
    auto result = item->setData(p_impl->m_value, p_impl->m_role, /*direct*/ true);
    setResult(result);
    setObsolete(!result);
    p_impl->m_value = old;
}

References ModelView::AbstractItemCommand::itemFromPath(), p_impl, ModelView::AbstractItemCommand::result(), ModelView::AbstractItemCommand::setObsolete(), and ModelView::AbstractItemCommand::setResult().

Referenced by execute_command(), and undo_command().

Here is the call graph for this function:

undo()

void AbstractItemCommand::undo ( )

inherited

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 ModelView::AbstractItemCommand::p_impl, and ModelView::AbstractItemCommand::undo_command().

Referenced by TEST_F().

Here is the call graph for this function:

undo_command()

void SetValueCommand::undo_command ( )

overrideprivatevirtual

Implements ModelView::AbstractItemCommand.

Definition at line 49 of file setvaluecommand.cpp.

{
    swap_values();
}

References swap_values().

Here is the call graph for this function:

Member Data Documentation

p_impl

std::unique_ptr<SetValueCommandImpl> ModelView::SetValueCommand::p_impl

private

Definition at line 38 of file setvaluecommand.h.

Referenced by SetValueCommand(), and swap_values().

---

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

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