ModelView::CompoundItem Class Reference

Complex item holding mixed SessionItem types (single properties and other CompountItems). More...

Inheritance diagram for ModelView::CompoundItem:

Collaboration diagram for ModelView::CompoundItem:

Public Member Functions
	CompoundItem (const std::string &modelType=Constants::CompoundItemType)
template<typename T = PropertyItem>
T *	addProperty (const std::string &name)
	Adds property item of given type. More...
PropertyItem *	addProperty (const std::string &name, const char *value)
	Register char property. Special case to turn it into std::string. More...
template<typename V >
PropertyItem *	addProperty (const std::string &name, const V &value)
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...
std::string	displayName () const override
	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 *	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

Detailed Description

Complex item holding mixed SessionItem types (single properties and other CompountItems).

Definition at line 28 of file compounditem.h.

Constructor & Destructor Documentation

CompoundItem()

CompoundItem::CompoundItem

(

const std::string &

modelType = Constants::CompoundItemType

)

Definition at line 27 of file compounditem.cpp.

: SessionItem(modelType) {}

Member Function Documentation

activate()

virtual void ModelView::SessionItem::activate ( )

inlineprivatevirtualinherited

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

Definition at line 123 of file sessionitem.h.

{}

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

addProperty() [1/3]

template<typename T >

T * ModelView::CompoundItem::addProperty

(

const std::string &

name

)

Adds property item of given type.

Definition at line 43 of file compounditem.h.

{
    T* property = new T;
    registerTag(TagInfo::propertyTag(name, property->modelType()));
    property->setDisplayName(name);
    insertItem(property, {name, 0});
    return property;
}

References ModelView::SessionItem::insertItem(), RealSpace::Particles::name(), ModelView::SessionItem::property(), ModelView::TagInfo::propertyTag(), and ModelView::SessionItem::registerTag().

Referenced by ToyItems::AnysoPyramidItem::AnysoPyramidItem(), ModelView::ColorMapItem::ColorMapItem(), ToyItems::CylinderItem::CylinderItem(), ModelView::Data1DItem::Data1DItem(), gui2::ExperimentalScanItem::ExperimentalScanItem(), ModelView::FixedBinAxisItem::FixedBinAxisItem(), ModelView::GraphItem::GraphItem(), ToyItems::LatticeItem::LatticeItem(), gui2::LayerElementItem::LayerElementItem(), gui2::LayerItem::LayerItem(), ToyItems::LayerItem::LayerItem(), gui2::MaterialBaseItem::MaterialBaseItem(), gui2::MultiLayerItem::MultiLayerItem(), ModelView::PenItem::PenItem(), gui2::QSpecScanItem::QSpecScanItem(), gui2::RoughnessItem::RoughnessItem(), gui2::SLDMaterialItem::SLDMaterialItem(), gui2::SpecularBeamItem::SpecularBeamItem(), ToyItems::SphereItem::SphereItem(), ModelView::TextItem::TextItem(), ModelView::VectorItem::VectorItem(), ModelView::ViewportAxisItem::ViewportAxisItem(), addProperty(), gui2::MaterialBaseItem::init_magnetic_field(), ModelView::BasicAxisItem::register_min_max(), TEST(), and TEST_F().

Here is the call graph for this function:

addProperty() [2/3]

PropertyItem * ModelView::CompoundItem::addProperty ( const std::string &  name, const char *  value  )

inline

Register char property. Special case to turn it into std::string.

Definition at line 52 of file compounditem.h.

{
    return addProperty(name, std::string(value));
}

References addProperty(), and RealSpace::Particles::name().

Here is the call graph for this function:

addProperty() [3/3]

template<typename V >

PropertyItem * ModelView::CompoundItem::addProperty	(	const std::string &	name,
		const V &	value
	)

Definition at line 58 of file compounditem.h.

{
    auto property = new PropertyItem;
    registerTag(TagInfo::propertyTag(name, property->modelType()));
    property->setDisplayName(name);
    property->setData(value);
 
    if constexpr (std::is_floating_point_v<V>)
        property->setData(RealLimits::limitless(), ItemDataRole::LIMITS);
 
    insertItem(property, {name, 0});
    return property;
}

References ModelView::SessionItem::insertItem(), ModelView::RealLimits::limitless(), ModelView::ItemDataRole::LIMITS, RealSpace::Particles::name(), ModelView::SessionItem::property(), ModelView::TagInfo::propertyTag(), and ModelView::SessionItem::registerTag().

Here is the call graph for this function:

children()

std::vector< SessionItem * > SessionItem::children ( ) const

inherited

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

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

childrenCount()

int SessionItem::childrenCount ( ) const

inherited

Returns total number of children in all tags.

Definition at line 152 of file sessionitem.cpp.

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

References ModelView::SessionItem::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

inlineinherited

Returns data of given type T for given role.

Definition at line 148 of file sessionitem.h.

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

References ModelView::SessionItem::data_internal().

Referenced by ModelView::Utils::CheckStateRole(), ModelView::PointwiseAxisItem::create(), ModelView::ViewItem::ViewItemImpl::data(), ModelView::SessionModel::data(), ModelView::Utils::DecorationRole(), ModelView::SessionItem::property(), ModelView::PointwiseAxisItem::range(), ModelView::Data2DItem::setContent(), ModelView::SessionItem::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

privateinherited

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

Referenced by ModelView::SessionItem::data().

displayName()

std::string CompoundItem::displayName ( ) const

overridevirtual

Returns display name.

Reimplemented from ModelView::SessionItem.

Definition at line 29 of file compounditem.cpp.

{
    if (has_custom_display_name(this))
        return SessionItem::displayName();
 
    int copy_number = Utils::CopyNumber(this);
    return copy_number != -1 ? SessionItem::displayName() + std::to_string(copy_number)
                             : SessionItem::displayName();
}

References ModelView::Utils::CopyNumber(), and ModelView::SessionItem::displayName().

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

Here is the call graph for this function:

editorType()

std::string SessionItem::editorType ( ) const

inherited

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 ModelView::SessionItem::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

inherited

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

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

getItems()

std::vector< SessionItem * > SessionItem::getItems ( const std::string &  tag ) const

inherited

Returns all children stored at given tag.

Definition at line 180 of file sessionitem.cpp.

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

References ModelView::SessionItem::p_impl.

Referenced by ModelView::SessionItem::items(), and TEST_F().

hasData()

bool SessionItem::hasData ( int  role = ItemDataRole::DATA ) const

inherited

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

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

identifier()

std::string SessionItem::identifier ( ) const

inherited

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  )

inherited

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 ModelView::SessionItem::item(), ModelView::SessionItem::model(), ModelView::SessionItem::p_impl, and ModelView::SessionItem::tagRowOfItem().

Referenced by 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

inherited

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

inherited

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

inlineinherited

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 ModelView::SessionItem::getItem().

Referenced by ModelView::ViewportAxisPlotController::AxesPlotControllerImpl::init_axis(), ModelView::SessionItem::insertItem(), ModelView::SessionItem::items(), gui2::Utils::SetDifference(), ModelView::GraphItem::setFromGraphItem(), ModelView::LinkedItem::setLink(), ModelView::ColorMapViewportPlotController::ColorMapViewportPlotControllerImpl::setup_components(), ModelView::SessionItem::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

inherited

Returns number of items in given tag.

Definition at line 166 of file sessionitem.cpp.

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

References ModelView::SessionItem::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 ( )

inherited

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

inherited

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

Definition at line 138 of file sessionitem.cpp.

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

References ModelView::SessionItem::p_impl.

items()

template<typename T >

std::vector< T * > SessionItem::items ( const std::string &  tag ) const

inherited

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 ModelView::SessionItem::getItems(), and ModelView::SessionItem::item().

Referenced by TEST_F().

Here is the call graph for this function:

itemTags() [1/2]

SessionItemTags * SessionItem::itemTags ( )

inherited

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

inherited

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

mapper()

ItemMapper * SessionItem::mapper ( )

inherited

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 ModelView::SessionItem::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

inherited

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 ModelView::SessionItem::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(), ModelView::SessionItem::insertItem(), ModelView::Utils::MoveDown(), ModelView::CommandService::moveItem(), ModelView::Utils::MoveUp(), ModelView::Utils::PathFromItem(), ModelView::CommandService::removeItem(), ModelView::SessionItem::set_data_internal(), ModelView::Data1DItem::setAxis(), ModelView::PropertyFlatView::setItem(), ModelView::PropertyTreeView::setItem(), ModelView::SessionItem::setModel(), ModelView::ViewModelController::setRootSessionItem(), TEST_F(), and gui2::MultiLayerItem::update_layer_appearance().

modelType()

model_type SessionItem::modelType ( ) const

inherited

Returns item's model type.

Definition at line 80 of file sessionitem.cpp.

{
    return p_impl->m_modelType;
}

References ModelView::SessionItem::p_impl.

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

parent()

SessionItem * SessionItem::parent ( ) const

inherited

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 ModelView::SessionItem::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(), ModelView::SessionItem::setParent(), ModelView::SessionItem::tagRow(), TEST_F(), gui2::MultiLayerItem::update_layer_appearance(), and gui2::SLDElementController::updateToView().

property()

template<typename T >

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

inlineinherited

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 ModelView::SessionItem::data(), and ModelView::SessionItem::getItem().

Referenced by ToyItems::LatticeItem::activate(), 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  )

inherited

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 ModelView::SessionItem::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(), addProperty(), TEST(), and TEST_F().

set_data_internal()

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

privateinherited

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 ModelView::SessionItem::model(), ModelView::SessionItem::p_impl, ModelView::SessionModel::setData(), and ModelView::SessionModel::undoStack().

Referenced by ModelView::SessionItem::setData().

Here is the call graph for this function:

setAppearanceFlag()

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

privateinherited

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

Referenced by ModelView::SessionItem::setEditable(), and ModelView::SessionItem::setEnabled().

setData()

template<typename T >

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

inlineinherited

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 ModelView::SessionItem::set_data_internal().

Referenced by gui2::CanvasItem::CanvasItem(), ModelView::GroupItem::GroupItem(), ModelView::LinkedItem::LinkedItem(), ModelView::PointwiseAxisItem::PointwiseAxisItem(), ModelView::SessionItem::SessionItem(), ModelView::GroupItem::init_group(), ModelView::JsonItemConverter::JsonItemConverterImpl::populate_item(), ModelView::Data2DItem::setContent(), ModelView::GroupItem::setCurrentIndex(), ModelView::SessionItem::setDisplayName(), ModelView::SessionItem::setEditorType(), ModelView::PropertyItem::setLimits(), ModelView::LinkedItem::setLink(), ModelView::PointwiseAxisItem::setParameters(), ModelView::SessionItem::setProperty(), ModelView::SessionItem::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  )

privateinherited

Definition at line 390 of file sessionitem.cpp.

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

References ModelView::SessionItem::data(), and ModelView::SessionItem::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 )

virtualinherited

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 ModelView::SessionItem::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 )

inherited

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 ModelView::SessionItem::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 )

inherited

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 ModelView::SessionItem::setData().

Referenced by TEST_F().

Here is the call graph for this function:

setEnabled()

SessionItem * SessionItem::setEnabled ( bool  value )

inherited

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 ModelView::SessionItem::setAppearanceFlag().

Referenced by TEST_F().

Here is the call graph for this function:

setModel()

void SessionItem::setModel ( SessionModel *  model )

privateinherited

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 ModelView::SessionItem::children(), ModelView::SessionItem::model(), and ModelView::SessionItem::p_impl.

Here is the call graph for this function:

setParent()

void SessionItem::setParent ( SessionItem *  parent )

privateinherited

Definition at line 348 of file sessionitem.cpp.

{
    p_impl->m_parent = parent;
}

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

Here is the call graph for this function:

setProperty() [1/2]

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

inlineinherited

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 ModelView::SessionItem::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  )

inlineinherited

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 ModelView::SessionItem::getItem(), and ModelView::SessionItem::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(), ModelView::SessionItem::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 )

inherited

Sets item tooltip (fluent interface).

Definition at line 306 of file sessionitem.cpp.

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

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

Referenced by TEST_F().

Here is the call graph for this function:

tagRow()

TagRow SessionItem::tagRow ( ) const

inherited

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 ModelView::SessionItem::parent(), and ModelView::SessionItem::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

inherited

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

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

Here is the call graph for this function:

takeItem()

SessionItem * SessionItem::takeItem ( const TagRow &  tagrow )

inherited

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

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

toolTip()

std::string SessionItem::toolTip ( ) const

inherited

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 ModelView::SessionItem::hasData(), and ModelView::ItemDataRole::TOOLTIP.

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

Here is the call graph for this function:

Member Data Documentation

p_impl

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

privateinherited

Definition at line 134 of file sessionitem.h.

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

---

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

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