ModelView::SessionItem Class Reference

The main object representing an editable/displayable/serializable entity. More...

Inheritance diagram for ModelView::SessionItem:

Public Member Functions
	SessionItem (const SessionItem &)=delete
	SessionItem (model_type modelType=Constants::BaseType)
virtual	~SessionItem ()
std::vector< SessionItem * >	children () const
	Returns vector of children formed from all chidlren from all tags. More...
int	childrenCount () const
	Returns total number of children in all tags. More...
template<typename T >
T	data (int role=ItemDataRole::DATA) const
	Returns data of given type T for given role. More...
virtual std::string	displayName () const
	Returns display name. More...
std::string	editorType () const
	Returns editor type. More...
SessionItem *	getItem (const std::string &tag, int row=0) const
	Returns item at given row of given tag. More...
std::vector< SessionItem * >	getItems (const std::string &tag) const
	Returns all children stored at given tag. More...
bool	hasData (int role=ItemDataRole::DATA) const
	Returns true if item has data on board with given role. More...
std::string	identifier () const
	Returns unique identifier. More...
bool	insertItem (SessionItem *item, const TagRow &tagrow)
	Insert item into given tag under the given row. More...
bool	isEditable () const
	Returns true if this item has editable flag set. More...
bool	isEnabled () const
	Returns true if this item has enabled flag set. More...
template<typename T >
T *	item (const std::string &tag) const
	Returns first item under given tag casted to a specified type. More...
int	itemCount (const std::string &tag) const
	Returns number of items in given tag. More...
SessionItemData *	itemData ()
	Returns pointer to item's data container (non-const version). More...
const SessionItemData *	itemData () const
	Returns pointer to item's data container (const version). More...
template<typename T = SessionItem>
std::vector< T * >	items (const std::string &tag) const
	Returns all items under given tag casted to specific type. More...
SessionItemTags *	itemTags ()
	Returns pointer to internal collection of tag-registered items (non-const version). More...
const SessionItemTags *	itemTags () const
	Returns pointer to internal collection of tag-registered items (const version). More...
ItemMapper *	mapper ()
	Returns item mapper. Allows subscribing to various events happening to the item. More...
SessionModel *	model () const
	Returns the model to which given item belongs to. More...
model_type	modelType () const
	Returns item's model type. More...
SessionItem &	operator= (const SessionItem &)=delete
SessionItem *	parent () const
	Returns parent item. Will return nullptr if item doesn't have a parent. More...
template<typename T >
T	property (const std::string &tag) const
	Returns data stored in property item. More...
void	registerTag (const TagInfo &tagInfo, bool set_as_default=false)
	Registers tag to hold items under given name. More...
template<typename T >
bool	setData (const T &value, int role=ItemDataRole::DATA, bool direct=false)
	Sets data for a given role. More...
virtual SessionItem *	setDisplayName (const std::string &name)
	Sets display name (fluent interface). More...
SessionItem *	setEditable (bool value)
	Sets editable flag to given value (fluent interface). More...
SessionItem *	setEditorType (const std::string &editor_type)
	Sets editor type (fluent interface). More...
SessionItem *	setEnabled (bool value)
	Sets enabled flag to given value (fluent interface). More...
void	setProperty (const std::string &tag, const char *value)
	Sets value to property item (specialized for special "const char *" case). More...
template<typename T >
void	setProperty (const std::string &tag, const T &value)
	Sets value to property item. More...
SessionItem *	setToolTip (const std::string &tooltip)
	Sets item tooltip (fluent interface). More...
TagRow	tagRow () const
	Returns TagRow of this item under which it is accessible through its parent. More...
TagRow	tagRowOfItem (const SessionItem *item) const
	Returns pair of tag and row corresponding to given item. More...
SessionItem *	takeItem (const TagRow &tagrow)
	Removes item from given row from given tag, returns it to the caller. More...
std::string	toolTip () const
	Returns item tooltip, if exists. More...

Private Member Functions
virtual void	activate ()
Variant	data_internal (int role) const
	Returns data for given role. More...
bool	set_data_internal (const Variant &value, int role, bool direct)
	Sets the data for given role. Method invented to hide implementaiton details. More...
void	setAppearanceFlag (int flag, bool value)
void	setDataAndTags (std::unique_ptr< SessionItemData > data, std::unique_ptr< SessionItemTags > tags)
void	setModel (SessionModel *model)
void	setParent (SessionItem *parent)

Private Attributes
std::unique_ptr< SessionItemImpl >	p_impl

Friends
class	JsonItemConverter
class	SessionModel

Detailed Description

The main object representing an editable/displayable/serializable entity.

Serves as a construction element (node) of SessionModel to represent all the data of GUI application.

Definition at line 38 of file sessionitem.h.

Constructor & Destructor Documentation

SessionItem() [1/2]

SessionItem::SessionItem ( model_type  modelType = Constants::BaseType )

explicit

Definition at line 62 of file sessionitem.cpp.

                                             : p_impl(std::make_unique<SessionItemImpl>(this))
{
    p_impl->m_modelType = std::move(modelType);
    setData(UniqueIdGenerator::generate(), ItemDataRole::IDENTIFIER);
    setData(p_impl->m_modelType, ItemDataRole::DISPLAY);
}

References ModelView::ItemDataRole::DISPLAY, ModelView::UniqueIdGenerator::generate(), ModelView::ItemDataRole::IDENTIFIER, modelType(), p_impl, and setData().

Here is the call graph for this function:

~SessionItem()

SessionItem::~SessionItem ( )

virtual

Definition at line 69 of file sessionitem.cpp.

{
    if (p_impl->m_mapper)
        p_impl->m_mapper->callOnItemDestroy();
 
    if (p_impl->m_model)
        p_impl->m_model->unregisterFromPool(this);
}

References p_impl.

SessionItem() [2/2]

ModelView::SessionItem::SessionItem ( const SessionItem &  )

delete

Member Function Documentation

activate()

virtual void ModelView::SessionItem::activate ( )

inlineprivatevirtual

Reimplemented in ToyItems::LatticeItem, ModelView::VectorItem, and gui2::MultiLayerItem.

Definition at line 123 of file sessionitem.h.

{}

Referenced by ModelView::SessionModel::registerInPool().

children()

std::vector< SessionItem * > SessionItem::children

(

)

const

Returns vector of children formed from all chidlren from all tags.

Definition at line 159 of file sessionitem.cpp.

{
    return p_impl->m_tags->allitems();
}

References p_impl.

Referenced by gui2::SLDElementController::buildSLD(), ModelView::Utils::ChildAt(), ModelView::AllChildrenStrategy::children(), childrenCount(), gui2::SLDElementController::getIdentifierVector(), ModelView::Utils::IndexOfChild(), ModelView::Utils::iterate(), ModelView::Utils::iterate_if(), gui2::MaterialModel::material_data(), ModelView::JsonItemConverter::JsonItemConverterImpl::populate_item(), setModel(), ModelView::Utils::SinglePropertyItems(), TEST_F(), ModelView::JsonModelConverter::to_json(), ModelView::Utils::TopItems(), and ModelView::Utils::TopLevelItems().

childrenCount()

int SessionItem::childrenCount

(

)

const

Returns total number of children in all tags.

Definition at line 152 of file sessionitem.cpp.

{
    return static_cast<int>(children().size());
}

References children().

Referenced by gui2::SLDElementController::buildSLD(), ModelView::ContainerItem::empty(), gui2::SLDElementController::getIdentifierVector(), ModelView::ContainerItem::size(), and TEST_F().

Here is the call graph for this function:

data()

template<typename T >

T SessionItem::data ( int  role = ItemDataRole::DATA ) const

inline

Returns data of given type T for given role.

Definition at line 148 of file sessionitem.h.

{
    return data_internal(role).value<T>();
}

References data_internal().

Referenced by ModelView::Utils::CheckStateRole(), ModelView::PointwiseAxisItem::create(), ModelView::ViewItem::ViewItemImpl::data(), ModelView::SessionModel::data(), ModelView::Utils::DecorationRole(), property(), ModelView::PointwiseAxisItem::range(), ModelView::Data2DItem::setContent(), setDataAndTags(), ModelView::PointwiseAxisItem::setParameters(), ModelView::Data1DItem::setValues(), and TEST_F().

Here is the call graph for this function:

data_internal()

Variant SessionItem::data_internal ( int  role ) const

private

Returns data for given role.

Method invented to hide implementaiton details and avoid placing sessionitemdata.h into 'sessionitem.h' header.

Definition at line 343 of file sessionitem.cpp.

{
    return p_impl->m_data->data(role);
}

References p_impl.

Referenced by data().

displayName()

std::string SessionItem::displayName ( ) const

virtual

Returns display name.

Reimplemented in ModelView::CompoundItem.

Definition at line 94 of file sessionitem.cpp.

{
    return data<std::string>(ItemDataRole::DISPLAY);
}

References ModelView::ItemDataRole::DISPLAY.

Referenced by gui2::Utils::CreateProperty(), ModelView::CompoundItem::displayName(), and TEST_F().

editorType()

std::string SessionItem::editorType

(

)

const

Returns editor type.

Definition at line 314 of file sessionitem.cpp.

{
    return hasData(ItemDataRole::EDITORTYPE) ? data<std::string>(ItemDataRole::EDITORTYPE)
                                             : std::string();
}

References ModelView::ItemDataRole::EDITORTYPE, and hasData().

Referenced by ModelView::RoleDependentEditorFactory::createItemEditor(), and TEST_F().

Here is the call graph for this function:

getItem()

SessionItem * SessionItem::getItem	(	const std::string &	tag,
		int	row = 0
	)		const

Returns item at given row of given tag.

Definition at line 173 of file sessionitem.cpp.

{
    return p_impl->m_tags->getItem({tag, row});
}

References p_impl.

Referenced by ModelView::GraphViewportPlotController::GraphViewportPlotControllerImpl::add_controller_for_item(), ModelView::GroupItem::currentItem(), ModelView::Data2DItem::insert_axis(), ModelView::ViewModelController::ViewModelControllerImpl::insert_view(), item(), ModelView::ViewModelController::onAboutToRemoveItem(), property(), ModelView::GraphViewportPlotController::GraphViewportPlotControllerImpl::remove_controller_for_item(), ModelView::Data1DItem::setAxis(), setProperty(), TEST_F(), and ToyItems::LatticeItem::update_appearance().

getItems()

std::vector< SessionItem * > SessionItem::getItems

(

const std::string &

tag

)

const

Returns all children stored at given tag.

Definition at line 180 of file sessionitem.cpp.

{
    return p_impl->m_tags->getItems(tag);
}

References p_impl.

Referenced by items(), and TEST_F().

hasData()

bool SessionItem::hasData

(

int

role = ItemDataRole::DATA

)

const

Returns true if item has data on board with given role.

Definition at line 131 of file sessionitem.cpp.

{
    return p_impl->m_data->hasData(role);
}

References p_impl.

Referenced by editorType(), TEST_F(), toolTip(), and ModelView::Utils::ToolTipRole().

identifier()

std::string SessionItem::identifier

(

)

const

Returns unique identifier.

Definition at line 87 of file sessionitem.cpp.

{
    return data<std::string>(ItemDataRole::IDENTIFIER);
}

References ModelView::ItemDataRole::IDENTIFIER.

Referenced by gui2::Utils::CreateProperty(), gui2::MaterialBaseItem::external_property(), gui2::ExperimentalScanItem::graphItem(), ModelView::ItemManager::registerInPool(), and TEST_F().

insertItem()

bool SessionItem::insertItem	(	SessionItem *	item,
		const TagRow &	tagrow
	)

Insert item into given tag under the given row.

Definition at line 216 of file sessionitem.cpp.

{
    // think of passing unique_ptr directly
 
    if (!item)
        throw std::runtime_error("SessionItem::insertItem() -> Invalid item.");
 
    if (item->parent())
        throw std::runtime_error("SessionItem::insertItem() -> Existing parent.");
 
    if (item->model())
        throw std::runtime_error("SessionItem::insertItem() -> Existing model.");
 
    auto result = p_impl->m_tags->insertItem(item, tagrow);
    if (result) {
        item->setParent(this);
        item->setModel(model());
 
        if (p_impl->m_model) {
            // FIXME think of actual_tagrow removal if input tag,row will be always valid
            auto actual_tagrow = tagRowOfItem(item);
            p_impl->m_model->mapper()->callOnItemInserted(this, actual_tagrow);
        }
    }
 
    return result;
}

References item(), model(), p_impl, and tagRowOfItem().

Referenced by ModelView::CompoundItem::addProperty(), ModelView::GroupItem::init_group(), ModelView::Data2DItem::insert_axis(), ModelView::Data1DItem::setAxis(), and TEST_F().

Here is the call graph for this function:

isEditable()

bool SessionItem::isEditable

(

)

const

Returns true if this item has editable flag set.

The data value of an editable item normally can be changed when it appears in trees and tables.

Definition at line 267 of file sessionitem.cpp.

{
    return appearance(*this) & Appearance::EDITABLE;
}

References ModelView::EDITABLE.

Referenced by TEST_F().

isEnabled()

bool SessionItem::isEnabled

(

)

const

Returns true if this item has enabled flag set.

Enabled items appear in normal color, disabled items are grayed out.

Definition at line 283 of file sessionitem.cpp.

{
    return appearance(*this) & Appearance::ENABLED;
}

References ModelView::ENABLED.

Referenced by ModelView::PropertyFlatView::PropertyFlatViewImpl::create_label(), TEST_F(), and ModelView::Utils::TextColorRole().

item()

template<typename T >

T * SessionItem::item ( const std::string &  tag ) const

inline

Returns first item under given tag casted to a specified type.

Returns nullptr, if item doesn't exist. If item exists but can't be casted will throw.

Definition at line 156 of file sessionitem.h.

{
    if (auto item = getItem(tag); item) {
        T* tag_item = dynamic_cast<T*>(item);
        if (!tag_item)
            throw std::runtime_error("Can't cast an item to given type");
        return tag_item;
    }
    return nullptr;
}

References getItem().

Referenced by ModelView::ViewportAxisPlotController::AxesPlotControllerImpl::init_axis(), insertItem(), items(), gui2::Utils::SetDifference(), ModelView::GraphItem::setFromGraphItem(), ModelView::LinkedItem::setLink(), ModelView::ColorMapViewportPlotController::ColorMapViewportPlotControllerImpl::setup_components(), tagRowOfItem(), TEST_F(), gui2::SLDElementController::updateRoughnessFromView(), and gui2::JobModel::updateSpecularData().

Here is the call graph for this function:

itemCount()

int SessionItem::itemCount

(

const std::string &

tag

)

const

Returns number of items in given tag.

Definition at line 166 of file sessionitem.cpp.

{
    return p_impl->m_tags->itemCount(tag);
}

References p_impl.

Referenced by ModelView::MoveItemCommand::MoveItemCommand(), ModelView::CommandService::copyItem(), ModelView::CommandService::insertNewItem(), ModelView::Utils::MoveDown(), and ModelView::CommandService::moveItem().

itemData() [1/2]

SessionItemData * SessionItem::itemData

(

)

Returns pointer to item's data container (non-const version).

Definition at line 145 of file sessionitem.cpp.

{
    return const_cast<SessionItemData*>(static_cast<const SessionItem*>(this)->itemData());
}

Referenced by ModelView::JsonItemConverter::JsonItemConverterImpl::item_to_json(), ModelView::JsonItemConverter::JsonItemConverterImpl::populate_item(), and TEST_F().

itemData() [2/2]

const SessionItemData * SessionItem::itemData

(

)

const

Returns pointer to item's data container (const version).

Definition at line 138 of file sessionitem.cpp.

{
    return p_impl->m_data.get();
}

References p_impl.

items()

template<typename T >

std::vector< T * > SessionItem::items

(

const std::string &

tag

)

const

Returns all items under given tag casted to specific type.

Definition at line 169 of file sessionitem.h.

{
    std::vector<T*> result;
    for (auto item : getItems(tag))
        if (auto casted = dynamic_cast<T*>(item); casted)
            result.push_back(casted);
    return result;
}

References getItems(), and item().

Referenced by TEST_F().

Here is the call graph for this function:

itemTags() [1/2]

SessionItemTags * SessionItem::itemTags

(

)

Returns pointer to internal collection of tag-registered items (non-const version).

Definition at line 209 of file sessionitem.cpp.

{
    return const_cast<SessionItemTags*>(static_cast<const SessionItem*>(this)->itemTags());
}

Referenced by ModelView::Utils::HasTag(), ModelView::Utils::IsSinglePropertyTag(), ModelView::JsonItemConverter::JsonItemConverterImpl::item_to_json(), ModelView::JsonItemConverter::JsonItemConverterImpl::populate_item(), ModelView::Utils::RegisteredTags(), TEST(), and TEST_F().

itemTags() [2/2]

const SessionItemTags * SessionItem::itemTags

(

)

const

Returns pointer to internal collection of tag-registered items (const version).

Definition at line 195 of file sessionitem.cpp.

{
    return p_impl->m_tags.get();
}

References p_impl.

mapper()

ItemMapper * SessionItem::mapper

(

)

Returns item mapper. Allows subscribing to various events happening to the item.

Definition at line 383 of file sessionitem.cpp.

{
    if (!p_impl->m_mapper)
        p_impl->m_mapper = std::make_unique<ItemMapper>(this);
    return p_impl->m_mapper.get();
}

References p_impl.

Referenced by MockWidgetForItem::~MockWidgetForItem(), gui2::MultiLayerItem::activate(), ModelView::VectorItem::activate(), ToyItems::LatticeItem::activate(), gui2::LayerElementController::connectToModel(), gui2::LayerElementController::disconnectFormModel(), and MockWidgetForItem::setItem().

model()

SessionModel * SessionItem::model

(

)

const

Returns the model to which given item belongs to.

Will return nullptr if item doesn't have a model.

Definition at line 110 of file sessionitem.cpp.

{
    return p_impl->m_model;
}

References p_impl.

Referenced by ModelView::AbstractItemCommand::AbstractItemCommand(), ModelView::CopyItemCommand::CopyItemCommand(), ModelView::ItemMapper::ItemMapper(), ModelView::RemoveItemCommand::RemoveItemCommand(), ModelView::Utils::BeginMacros(), ModelView::CommandService::copyItem(), InsertNewItemCommandTest::create_command(), ModelView::Utils::DeleteItemFromModel(), ModelView::Utils::EndMacros(), ModelView::LinkedItem::get(), gui2::ExperimentalScanItem::graphItem(), insertItem(), ModelView::Utils::MoveDown(), ModelView::CommandService::moveItem(), ModelView::Utils::MoveUp(), ModelView::Utils::PathFromItem(), ModelView::CommandService::removeItem(), set_data_internal(), ModelView::Data1DItem::setAxis(), ModelView::PropertyFlatView::setItem(), ModelView::PropertyTreeView::setItem(), setModel(), ModelView::ViewModelController::setRootSessionItem(), TEST_F(), and gui2::MultiLayerItem::update_layer_appearance().

modelType()

model_type SessionItem::modelType

(

)

const

Returns item's model type.

Definition at line 80 of file sessionitem.cpp.

{
    return p_impl->m_modelType;
}

References p_impl.

Referenced by ModelView::CopyItemCommand::CopyItemCommand(), SessionItem(), ModelView::Utils::CopyNumber(), ModelView::SessionItemContainer::is_valid_item(), ModelView::JsonItemConverter::JsonItemConverterImpl::item_to_json(), ModelView::JsonItemConverter::JsonItemConverterImpl::populate_item(), and TEST_F().

operator=()

SessionItem& ModelView::SessionItem::operator= ( const SessionItem &  )

delete

parent()

SessionItem * SessionItem::parent

(

)

const

Returns parent item. Will return nullptr if item doesn't have a parent.

Definition at line 117 of file sessionitem.cpp.

{
    return p_impl->m_parent;
}

References p_impl.

Referenced by ModelView::MoveItemCommand::MoveItemCommand(), gui2::MaterialModel::cloneMaterial(), ModelView::Utils::CopyNumber(), gui2::Utils::CreateProperty(), ModelView::Utils::DeleteItemFromModel(), ModelView::Utils::FindNextItemToSelect(), ModelView::Utils::FindNextSibling(), ModelView::Utils::FindPreviousSibling(), ModelView::Utils::IsItemAncestor(), gui2::ExperimentalDataModel::mergeCanvases(), ModelView::Utils::MoveDown(), ModelView::Utils::MoveUp(), ModelView::ItemMapper::ItemMapperImpl::nestlingDepth(), ModelView::Utils::PathFromItem(), ModelView::ItemMapper::ItemMapperImpl::processDataChange(), gui2::ExperimentalDataModel::removeCanvas(), gui2::ExperimentalDataModel::removeGraph(), setParent(), tagRow(), TEST_F(), gui2::MultiLayerItem::update_layer_appearance(), and gui2::SLDElementController::updateToView().

property()

template<typename T >

T SessionItem::property ( const std::string &  tag ) const

inline

Returns data stored in property item.

Property is single item registered under certain tag via CompoundItem::addProperty method.

Definition at line 181 of file sessionitem.h.

{
    return getItem(tag)->data<T>();
}

References data(), and getItem().

Referenced by ToyItems::LatticeItem::activate(), ModelView::CompoundItem::addProperty(), gui2::LayerElementController::firstSegmentHandleRect(), gui2::LayerElementController::leftHandleMoved(), gui2::LayerElementController::leftRoughnessHandleRect(), gui2::LayerElementController::leftRoughnessPath(), gui2::LayerElementController::rightHandleMoved(), gui2::LayerElementController::rightRoughnessHandleRect(), gui2::LayerElementController::rightRoughnessPath(), gui2::LayerElementController::secondSegmentHandleRect(), gui2::LayerElementController::setLayerAbove(), gui2::LayerElementController::setRoughnessInLimits(), gui2::LayerElementController::sideSegmentMoved(), gui2::LayerElementController::sideSegmentRect(), TEST_F(), gui2::LayerElementController::topSegmentRect(), ModelView::ColorMapPlotController::ColorMapPlotControllerImpl::update_gradient(), ModelView::PenController::PenControllerImpl::update_graph_from_item(), ModelView::ColorMapPlotController::ColorMapPlotControllerImpl::update_interpolation(), ModelView::AxisTitleController::AxisTitleControllerImpl::updateAxisFromItem(), ModelView::ViewportAxisPlotController::AxesPlotControllerImpl::updateLowerRange(), gui2::LayerElementController::updateRoughness(), gui2::SLDElementController::updateToView(), and ModelView::ViewportAxisPlotController::AxesPlotControllerImpl::updateUpperRange().

Here is the call graph for this function:

registerTag()

void SessionItem::registerTag	(	const TagInfo &	tagInfo,
		bool	set_as_default = false
	)

Registers tag to hold items under given name.

Definition at line 202 of file sessionitem.cpp.

{
    p_impl->m_tags->registerTag(tagInfo, set_as_default);
}

References p_impl.

Referenced by ModelView::ColorMapViewportItem::ColorMapViewportItem(), ModelView::ContainerItem::ContainerItem(), ModelView::Data1DItem::Data1DItem(), ModelView::Data2DItem::Data2DItem(), ModelView::GraphViewportItem::GraphViewportItem(), ModelView::GroupItem::GroupItem(), ToyItems::LayerItem::LayerItem(), gui2::MaterialContainerItem::MaterialContainerItem(), gui2::MultiLayerItem::MultiLayerItem(), ToyItems::MultiLayerItem::MultiLayerItem(), ModelView::CompoundItem::addProperty(), TEST(), and TEST_F().

set_data_internal()

bool SessionItem::set_data_internal ( const Variant &  value, int  role, bool  direct  )

private

Sets the data for given role. Method invented to hide implementaiton details.

Definition at line 331 of file sessionitem.cpp.

{
    // If model is present, and undo stack is enabled, will forward request to the model
    // (unless user explicitely asks for direct processing via direct=true flag).
    const bool act_through_model = !direct && model() && model()->undoStack();
    return act_through_model ? model()->setData(this, value, role)
                             : p_impl->do_setData(value, role);
}

References model(), p_impl, ModelView::SessionModel::setData(), and ModelView::SessionModel::undoStack().

Referenced by setData().

Here is the call graph for this function:

setAppearanceFlag()

void SessionItem::setAppearanceFlag ( int  flag, bool  value  )

private

Definition at line 367 of file sessionitem.cpp.

{
    int flags = appearance(*this);
    if (value)
        flags |= flag;
    else
        flags &= ~flag;
 
    // By setting data with internal method we are bypassing the model, and so undo/redo.
    // So current convention is to not invoke undo when changing appearance properties.
    // Shall we change it?
    p_impl->do_setData(flags, ItemDataRole::APPEARANCE);
}

References ModelView::ItemDataRole::APPEARANCE, and p_impl.

Referenced by setEditable(), and setEnabled().

setData()

template<typename T >

bool SessionItem::setData ( const T &  value, int  role = ItemDataRole::DATA, bool  direct = false  )

inline

Sets data for a given role.

When extra parameter direct is false (default case), will act through the model to register command in undo/redo framework (if enabled) and so allow later undo.

Definition at line 141 of file sessionitem.h.

{
    return set_data_internal(Variant::fromValue(value), role, direct);
}

References set_data_internal().

Referenced by gui2::CanvasItem::CanvasItem(), ModelView::GroupItem::GroupItem(), ModelView::LinkedItem::LinkedItem(), ModelView::PointwiseAxisItem::PointwiseAxisItem(), SessionItem(), ModelView::GroupItem::init_group(), ModelView::JsonItemConverter::JsonItemConverterImpl::populate_item(), ModelView::Data2DItem::setContent(), ModelView::GroupItem::setCurrentIndex(), setDisplayName(), setEditorType(), ModelView::PropertyItem::setLimits(), ModelView::LinkedItem::setLink(), ModelView::PointwiseAxisItem::setParameters(), setProperty(), setToolTip(), TEST_F(), and ModelView::VectorItem::update_label().

Here is the call graph for this function:

setDataAndTags()

void SessionItem::setDataAndTags ( std::unique_ptr< SessionItemData >  data, std::unique_ptr< SessionItemTags >  tags  )

private

Definition at line 390 of file sessionitem.cpp.

{
    p_impl->m_data = std::move(data);
    p_impl->m_tags = std::move(tags);
}

References data(), and p_impl.

Referenced by ModelView::JsonItemConverter::JsonItemConverterImpl::populate_item().

Here is the call graph for this function:

setDisplayName()

SessionItem * SessionItem::setDisplayName ( const std::string &  name )

virtual

Sets display name (fluent interface).

Reimplemented in ModelView::PropertyItem.

Definition at line 101 of file sessionitem.cpp.

{
    setData(name, ItemDataRole::DISPLAY);
    return this;
}

References ModelView::ItemDataRole::DISPLAY, RealSpace::Particles::name(), and setData().

Referenced by ModelView::ColorMapItem::ColorMapItem(), ModelView::GraphItem::GraphItem(), ModelView::ViewportAxisItem::ViewportAxisItem(), ModelView::PropertyItem::setDisplayName(), and TEST_F().

Here is the call graph for this function:

setEditable()

SessionItem * SessionItem::setEditable

(

bool

value

)

Sets editable flag to given value (fluent interface).

Definition at line 274 of file sessionitem.cpp.

{
    setAppearanceFlag(Appearance::EDITABLE, value);
    return this;
}

References ModelView::EDITABLE, and setAppearanceFlag().

Referenced by ModelView::LinkedItem::LinkedItem(), ModelView::PointwiseAxisItem::PointwiseAxisItem(), ModelView::VectorItem::VectorItem(), and TEST_F().

Here is the call graph for this function:

setEditorType()

SessionItem * SessionItem::setEditorType

(

const std::string &

editor_type

)

Sets editor type (fluent interface).

Allows creating custom editors in the cells of Qt trees and tables.

Definition at line 323 of file sessionitem.cpp.

{
    setData(editor_type, ItemDataRole::EDITORTYPE);
    return this;
}

References ModelView::ItemDataRole::EDITORTYPE, and setData().

Referenced by TEST_F().

Here is the call graph for this function:

setEnabled()

SessionItem * SessionItem::setEnabled

(

bool

value

)

Sets enabled flag to given value (fluent interface).

Definition at line 290 of file sessionitem.cpp.

{
    setAppearanceFlag(Appearance::ENABLED, value);
    return this;
}

References ModelView::ENABLED, and setAppearanceFlag().

Referenced by TEST_F().

Here is the call graph for this function:

setModel()

void SessionItem::setModel ( SessionModel *  model )

private

Definition at line 353 of file sessionitem.cpp.

{
    if (p_impl->m_model)
        p_impl->m_model->unregisterFromPool(this);
 
    p_impl->m_model = model;
 
    if (p_impl->m_model)
        p_impl->m_model->registerInPool(this);
 
    for (auto child : children())
        child->setModel(model);
}

References children(), model(), and p_impl.

Here is the call graph for this function:

setParent()

void SessionItem::setParent ( SessionItem *  parent )

private

Definition at line 348 of file sessionitem.cpp.

{
    p_impl->m_parent = parent;
}

References p_impl, and parent().

Here is the call graph for this function:

setProperty() [1/2]

void SessionItem::setProperty ( const std::string &  tag, const char *  value  )

inline

Sets value to property item (specialized for special "const char *" case).

Property is single item registered under certain tag via CompoundItem::addProperty method, the value will be assigned to it's data role.

Definition at line 199 of file sessionitem.h.

{
    setProperty(tag, std::string(value));
}

References setProperty().

Here is the call graph for this function:

setProperty() [2/2]

template<typename T >

void SessionItem::setProperty ( const std::string &  tag, const T &  value  )

inline

Sets value to property item.

Property is single item registered under certain tag via CompoundItem::addProperty method, the value will be assigned to it's data role.

Definition at line 190 of file sessionitem.h.

{
    getItem(tag)->setData(value);
}

References getItem(), and setData().

Referenced by gui2::CanvasItem::CanvasItem(), gui2::LayerElementController::connectToModel(), gui2::SLDMaterialItem::set_properties(), ModelView::ViewportAxisItem::set_range(), ModelView::Data1DItem::setErrors(), ModelView::GraphItem::setFromGraphItem(), gui2::ExperimentalScanItem::setGraphItem(), gui2::LayerElementController::setLayerAbove(), ModelView::PenItem::setNamedColor(), ModelView::FixedBinAxisItem::setParameters(), setProperty(), gui2::LayerElementController::setRoughnessInLimits(), ModelView::PenItem::setSelected(), ModelView::Data1DItem::setValues(), gui2::LayerElementController::sideSegmentMoved(), TEST_F(), gui2::LayerElementController::topSegmentMoved(), gui2::SLDElementController::updateRoughnessFromView(), gui2::SLDElementController::updateSLDFromView(), gui2::SLDElementController::updateThicknessFromView(), and gui2::SLDElementController::updateToView().

Here is the call graph for this function:

setToolTip()

SessionItem * SessionItem::setToolTip

(

const std::string &

tooltip

)

Sets item tooltip (fluent interface).

Definition at line 306 of file sessionitem.cpp.

{
    setData(tooltip, ItemDataRole::TOOLTIP);
    return this;
}

References setData(), and ModelView::ItemDataRole::TOOLTIP.

Referenced by TEST_F().

Here is the call graph for this function:

tagRow()

TagRow SessionItem::tagRow

(

)

const

Returns TagRow of this item under which it is accessible through its parent.

Definition at line 124 of file sessionitem.cpp.

{
    return parent() ? parent()->tagRowOfItem(this) : TagRow();
}

References parent(), and tagRowOfItem().

Referenced by ModelView::MoveItemCommand::MoveItemCommand(), gui2::MaterialModel::cloneMaterial(), ModelView::Utils::DeleteItemFromModel(), ModelView::Utils::FindNextSibling(), gui2::ExperimentalDataModel::mergeCanvases(), ModelView::Utils::MoveDown(), ModelView::Utils::MoveUp(), gui2::ExperimentalDataModel::removeCanvas(), gui2::ExperimentalDataModel::removeGraph(), and TEST_F().

Here is the call graph for this function:

tagRowOfItem()

TagRow SessionItem::tagRowOfItem

(

const SessionItem *

item

)

const

Returns pair of tag and row corresponding to given item.

Returns {"", -1} if given item doesn't belong to children.

Definition at line 188 of file sessionitem.cpp.

{
    return p_impl->m_tags->tagRowOfItem(item);
}

References item(), and p_impl.

Referenced by ModelView::Utils::FindPreviousSibling(), insertItem(), ModelView::ItemMapper::ItemMapperImpl::processDataChange(), ModelView::Utils::SinglePropertyItems(), tagRow(), TEST_F(), and ModelView::Utils::TopLevelItems().

Here is the call graph for this function:

takeItem()

SessionItem * SessionItem::takeItem

(

const TagRow &

tagrow

)

Removes item from given row from given tag, returns it to the caller.

Definition at line 246 of file sessionitem.cpp.

{
    if (!p_impl->m_tags->canTakeItem(tagrow))
        return nullptr;
 
    if (p_impl->m_model)
        p_impl->m_model->mapper()->callOnItemAboutToBeRemoved(this, tagrow);
 
    auto result = p_impl->m_tags->takeItem(tagrow);
    result->setParent(nullptr);
    result->setModel(nullptr);
    // FIXME remaining problem is that ItemMapper still looking to the model
    if (p_impl->m_model)
        p_impl->m_model->mapper()->callOnItemRemoved(this, tagrow);
 
    return result;
}

References p_impl.

Referenced by ModelView::Data2DItem::insert_axis(), and TEST_F().

toolTip()

std::string SessionItem::toolTip

(

)

const

Returns item tooltip, if exists.

Definition at line 298 of file sessionitem.cpp.

{
    return hasData(ItemDataRole::TOOLTIP) ? data<std::string>(ItemDataRole::TOOLTIP)
                                          : std::string();
}

References hasData(), and ModelView::ItemDataRole::TOOLTIP.

Referenced by TEST_F(), and ModelView::Utils::ToolTipRole().

Here is the call graph for this function:

Friends And Related Function Documentation

JsonItemConverter

friend class JsonItemConverter

friend

Definition at line 122 of file sessionitem.h.

SessionModel

friend class SessionModel

friend

Definition at line 121 of file sessionitem.h.

Member Data Documentation

p_impl

std::unique_ptr<SessionItemImpl> ModelView::SessionItem::p_impl

private

Definition at line 134 of file sessionitem.h.

Referenced by SessionItem(), ~SessionItem(), children(), data_internal(), getItem(), getItems(), hasData(), insertItem(), itemCount(), itemData(), itemTags(), mapper(), model(), modelType(), parent(), registerTag(), set_data_internal(), setAppearanceFlag(), setDataAndTags(), setModel(), setParent(), tagRowOfItem(), and takeItem().

---

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

• /home/www/ba/mvvm/model/mvvm/model/sessionitem.h
• /home/www/ba/mvvm/model/mvvm/model/sessionitem.cpp