Slic3r::GUI::ParamsModel Class Reference

#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/EditGCodeDialog.hpp>

Inheritance diagram for Slic3r::GUI::ParamsModel:

Collaboration diagram for Slic3r::GUI::ParamsModel:

Public Member Functions
	ParamsModel ()
	~ParamsModel () override=default
void	SetAssociatedControl (wxDataViewCtrl *ctrl)
wxDataViewItem	AppendGroup (const wxString &group_name, const std::string &icon_name)
wxDataViewItem	AppendSubGroup (wxDataViewItem parent, const wxString &sub_group_name, const std::string &icon_name)
wxDataViewItem	AppendParam (wxDataViewItem parent, ParamType param_type, const std::string &param_key)
wxDataViewItem	Delete (const wxDataViewItem &item)
wxString	GetParamName (wxDataViewItem item)
std::string	GetParamKey (wxDataViewItem item)
std::string	GetTopLevelCategory (wxDataViewItem item)
void	RefreshSearch (const wxString &search_text)
void	FinishSearch ()
void	Clear ()
wxDataViewItem	GetParent (const wxDataViewItem &item) const override
unsigned int	GetChildren (const wxDataViewItem &parent, wxDataViewItemArray &array) const override
unsigned int	GetColumnCount () const override
wxString	GetColumnType (unsigned int col) const override
void	GetValue (wxVariant &variant, const wxDataViewItem &item, unsigned int col) const override
bool	SetValue (const wxVariant &variant, const wxDataViewItem &item, unsigned int col) override
bool	IsContainer (const wxDataViewItem &item) const override
bool	HasContainerColumns (const wxDataViewItem &WXUNUSED(item)) const override

Private Attributes
ParamsNodePtrArray	m_group_nodes
wxDataViewCtrl *	m_ctrl { nullptr }
bool	m_currently_searching {false}

Detailed Description

Constructor & Destructor Documentation

ParamsModel()

Slic3r::GUI::ParamsModel::ParamsModel

(

)

{
}

~ParamsModel()

Slic3r::GUI::ParamsModel::~ParamsModel ( )

overridedefault

Member Function Documentation

AppendGroup()

wxDataViewItem Slic3r::GUI::ParamsModel::AppendGroup	(	const wxString &	group_name,
		const std::string &	icon_name )

{
    m_group_nodes.emplace_back(std::make_unique<ParamsNode>(group_name, icon_name, m_ctrl));
 
    wxDataViewItem parent(nullptr);
    wxDataViewItem child((void*)m_group_nodes.back().get());
 
    ItemAdded(parent, child);
    m_ctrl->Expand(parent);
    return child;
}

References m_ctrl, and m_group_nodes.

AppendParam()

wxDataViewItem Slic3r::GUI::ParamsModel::AppendParam	(	wxDataViewItem	parent,
		ParamType	param_type,
		const std::string &	param_key )

{
    ParamsNode* parent_node = static_cast<ParamsNode*>(parent.GetID());
    if (!parent_node)
        return wxDataViewItem(0);
 
    parent_node->Append(std::make_unique<ParamsNode>(parent_node, param_type, param_key, m_ctrl));
 
    const wxDataViewItem  child_item((void*)parent_node->GetChildren().back().get());
 
    ItemAdded(parent, child_item);
    return child_item;
}

References Slic3r::GUI::ParamsNode::Append(), Slic3r::GUI::ParamsNode::GetChildren(), and m_ctrl.

Here is the call graph for this function:

AppendSubGroup()

wxDataViewItem Slic3r::GUI::ParamsModel::AppendSubGroup	(	wxDataViewItem	parent,
		const wxString &	sub_group_name,
		const std::string &	icon_name )

{
    ParamsNode* parent_node = static_cast<ParamsNode*>(parent.GetID());
    if (!parent_node)
        return wxDataViewItem(0);
 
    parent_node->Append(std::make_unique<ParamsNode>(parent_node, sub_group_name, icon_name, m_ctrl));
    const wxDataViewItem  sub_group_item((void*)parent_node->GetChildren().back().get());
 
    ItemAdded(parent, sub_group_item);
    return sub_group_item;
}

References Slic3r::GUI::ParamsNode::Append(), Slic3r::GUI::ParamsNode::GetChildren(), and m_ctrl.

Here is the call graph for this function:

Clear()

void Slic3r::GUI::ParamsModel::Clear

(

)

{
    while (!m_group_nodes.empty())
        Delete(wxDataViewItem(m_group_nodes.back().get()));
}

References Delete(), and m_group_nodes.

Here is the call graph for this function:

Delete()

wxDataViewItem Slic3r::GUI::ParamsModel::Delete

(

const wxDataViewItem &

item

)

{
    auto ret_item = wxDataViewItem(nullptr);
    ParamsNode* node = static_cast<ParamsNode*>(item.GetID());
    if (!node)      // happens if item.IsOk()==false
        return ret_item;
    const bool is_item_enabled = node->IsEnabled();
 
    // first remove the node from the parent's array of children;
    // NOTE: m_group_nodes is only a vector of _pointers_
    //       thus removing the node from it doesn't result in freeing it
    ParamsNodePtrArray& children = node->GetChildren();
    // Delete all children
    while (!children.empty())
        Delete(wxDataViewItem(children.back().get()));
 
    auto node_parent = node->GetParent();
 
    ParamsNodePtrArray& parents_children = node_parent ? node_parent->GetChildren() : m_group_nodes;
    auto it = find_if(parents_children.begin(), parents_children.end(),
                                                   [node](std::unique_ptr<ParamsNode>& child) { return child.get() == node; });
    assert(it != parents_children.end());
    it = parents_children.erase(it);
 
    if (it != parents_children.end())
        ret_item = wxDataViewItem(it->get());
 
    wxDataViewItem parent(node_parent);
    // set m_container to FALSE if parent has no child
    if (node_parent) {
#ifndef __WXGTK__
        if (node_parent->GetChildren().empty())
            node_parent->SetContainer(false);
#endif //__WXGTK__
        ret_item = parent;
    }
 
    // Orca: notify enabled item only, because disabled items have already been removed from UI,
    // so attempt to notify it cases a crash.
    if (is_item_enabled) {
        // notify control
        ItemDeleted(parent, item);
    }
    return ret_item;
}

References Delete(), Slic3r::GUI::ParamsNode::GetChildren(), Slic3r::GUI::ParamsNode::GetParent(), Slic3r::GUI::ParamsNode::IsEnabled(), and m_group_nodes.

Referenced by Clear(), and Delete().

Here is the call graph for this function:

Here is the caller graph for this function:

FinishSearch()

void Slic3r::GUI::ParamsModel::FinishSearch

(

)

{
    RefreshSearch("");
    Cleared();
    if (m_currently_searching) {
        for (const auto& node : m_group_nodes)
            node->FinishSearch();
        m_currently_searching = false;
    }
}

References m_currently_searching, m_group_nodes, and RefreshSearch().

Here is the call graph for this function:

GetChildren()

unsigned int Slic3r::GUI::ParamsModel::GetChildren ( const wxDataViewItem & parent, wxDataViewItemArray & array ) const

override

{
    ParamsNode* parent_node = (ParamsNode*)parent.GetID();
 
    if (parent_node == nullptr) {
        for (const auto& group : m_group_nodes)
            if (group->IsEnabled())
                array.Add(wxDataViewItem((void*)group.get()));
    }
    else  {
        const ParamsNodePtrArray& children = parent_node->GetChildren();
        for (const std::unique_ptr<ParamsNode>& child : children)
            if (child->IsEnabled())
                array.Add(wxDataViewItem((void*)child.get()));
    }
 
    return array.Count();
}

References Slic3r::GUI::ParamsNode::GetChildren(), and m_group_nodes.

Here is the call graph for this function:

GetColumnCount()

unsigned int Slic3r::GUI::ParamsModel::GetColumnCount ( ) const

override

{ return 1; }

GetColumnType()

wxString Slic3r::GUI::ParamsModel::GetColumnType ( unsigned int col ) const

override

                                                              {
#ifdef __linux__
    return wxT("wxDataViewIconText");
#else
    return wxT("DataViewBitmapText");
#endif
}

GetParamKey()

std::string Slic3r::GUI::ParamsModel::GetParamKey

(

wxDataViewItem

item

)

{
    if (item.IsOk()) {
        ParamsNode* node = static_cast<ParamsNode*>(item.GetID());
        return node->param_key;
    }
    return std::string();
}

References Slic3r::GUI::ParamsNode::param_key.

GetParamName()

wxString Slic3r::GUI::ParamsModel::GetParamName

(

wxDataViewItem

item

)

{
    if (item.IsOk()) {
        ParamsNode* node = static_cast<ParamsNode*>(item.GetID());
        if (node->IsParamNode())
            return node->text;
    }
    return wxEmptyString;
}

References Slic3r::GUI::ParamsNode::IsParamNode(), and Slic3r::GUI::ParamsNode::text.

Here is the call graph for this function:

GetParent()

wxDataViewItem Slic3r::GUI::ParamsModel::GetParent ( const wxDataViewItem & item ) const

override

{
    // the invisible root node has no parent
    if (!item.IsOk())
        return wxDataViewItem(nullptr);
 
    ParamsNode* node = static_cast<ParamsNode*>(item.GetID());
 
    if (node->IsGroupNode())
        return wxDataViewItem(nullptr);
 
    return wxDataViewItem((void*)node->GetParent());
}

References Slic3r::GUI::ParamsNode::GetParent(), and Slic3r::GUI::ParamsNode::IsGroupNode().

Here is the call graph for this function:

GetTopLevelCategory()

std::string Slic3r::GUI::ParamsModel::GetTopLevelCategory

(

wxDataViewItem

item

)

{
    if (item.IsOk()) {
        ParamsNode* node = static_cast<ParamsNode*>(item.GetID());
        while (!node->IsGroupNode())
            node = node->GetParent();
        return node->text.ToStdString();
    }
    return std::string();
}

References Slic3r::GUI::ParamsNode::GetParent(), Slic3r::GUI::ParamsNode::IsGroupNode(), and Slic3r::GUI::ParamsNode::text.

Here is the call graph for this function:

GetValue()

void Slic3r::GUI::ParamsModel::GetValue ( wxVariant & variant, const wxDataViewItem & item, unsigned int col ) const

override

{
    assert(item.IsOk());
 
    ParamsNode* node = static_cast<ParamsNode*>(item.GetID());
    if (col == (unsigned int)0)
#ifdef __linux__
//        variant << wxDataViewIconText(node->GetFormattedText(), get_bmp_bundle(node->icon_name)->GetIconFor(m_ctrl->GetParent())); //TODO: update to bundle with wx update
    {
        wxIcon icon;
        icon.CopyFromBitmap(create_scaled_bitmap(node->icon_name, m_ctrl->GetParent()));
        variant << wxDataViewIconText(node->GetFormattedText(), icon);
    }
#else
//        variant << DataViewBitmapText(node->GetFormattedText(), get_bmp_bundle(node->icon_name)->GetBitmapFor(m_ctrl->GetParent())); //TODO: update to bundle with wx update
        variant << DataViewBitmapText(node->GetFormattedText(), create_scaled_bitmap(node->icon_name, m_ctrl->GetParent()));
#endif //__linux__
    else
        wxLogError("DiffModel::GetValue: wrong column %d", col);
}

References create_scaled_bitmap(), Slic3r::GUI::ParamsNode::GetFormattedText(), Slic3r::GUI::ParamsNode::icon_name, and m_ctrl.

Here is the call graph for this function:

HasContainerColumns()

bool Slic3r::GUI::ParamsModel::HasContainerColumns ( const wxDataViewItem & WXUNUSEDitem ) const

inlineoverride

{ return true; }

IsContainer()

bool Slic3r::GUI::ParamsModel::IsContainer ( const wxDataViewItem & item ) const

override

{
    // the invisble root node can have children
    if (!item.IsOk())
        return true;
 
    ParamsNode* node = static_cast<ParamsNode*>(item.GetID());
    return node->IsContainer();
}

References Slic3r::GUI::ParamsNode::IsContainer().

Here is the call graph for this function:

RefreshSearch()

void Slic3r::GUI::ParamsModel::RefreshSearch

(

const wxString &

search_text

)

{
    if (!m_currently_searching) { // if not currently searching, save expansion state for all items
        for (const auto& node : m_group_nodes)
            node->StartSearch();
        m_currently_searching = true;
    }
 
    for (const auto& node : m_group_nodes)
        node->RefreshSearch(search_text); //Enable/Disable node based on search
 
    Cleared(); //Reload the model into the control
 
    for (const auto& node : m_group_nodes) // (re)expand all
        m_ctrl->ExpandChildren(wxDataViewItem(node.get()));
}

References m_ctrl, m_currently_searching, and m_group_nodes.

Referenced by FinishSearch().

Here is the caller graph for this function:

SetAssociatedControl()

void Slic3r::GUI::ParamsModel::SetAssociatedControl ( wxDataViewCtrl * ctrl )

inline

{ m_ctrl = ctrl; }

References m_ctrl.

SetValue()

bool Slic3r::GUI::ParamsModel::SetValue ( const wxVariant & variant, const wxDataViewItem & item, unsigned int col )

override

{
    assert(item.IsOk());
 
    ParamsNode* node = static_cast<ParamsNode*>(item.GetID());
    if (col == (unsigned int)0) {
#ifdef __linux__
        wxDataViewIconText data;
        data << variant;
        node->icon = data.GetIcon();
#else
        DataViewBitmapText data;
        data << variant;
        node->icon = data.GetBitmap();
#endif
        node->text = data.GetText();
        return true;
    }
 
    wxLogError("DiffModel::SetValue: wrong column");
    return false;
}

References Slic3r::GUI::ParamsNode::icon, and Slic3r::GUI::ParamsNode::text.

Member Data Documentation

m_ctrl

wxDataViewCtrl* Slic3r::GUI::ParamsModel::m_ctrl { nullptr }

private

{ nullptr };

Referenced by AppendGroup(), AppendParam(), AppendSubGroup(), GetValue(), RefreshSearch(), and SetAssociatedControl().

m_currently_searching

bool Slic3r::GUI::ParamsModel::m_currently_searching {false}

private

{false};

Referenced by FinishSearch(), and RefreshSearch().

m_group_nodes

ParamsNodePtrArray Slic3r::GUI::ParamsModel::m_group_nodes

private

Referenced by AppendGroup(), Clear(), Delete(), FinishSearch(), GetChildren(), and RefreshSearch().

---

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

• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/EditGCodeDialog.hpp
• /home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/EditGCodeDialog.cpp