Slic3r::GUI::ParamsNode Class Reference

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

Collaboration diagram for Slic3r::GUI::ParamsNode:

Public Member Functions
	ParamsNode (const wxString &group_name, const std::string &icon_name, wxDataViewCtrl *ctrl)
	ParamsNode (ParamsNode *parent, const wxString &sub_group_name, const std::string &icon_name, wxDataViewCtrl *ctrl)
	ParamsNode (ParamsNode *parent, ParamType param_type, const std::string &param_key, wxDataViewCtrl *ctrl)
wxString	GetFormattedText ()
bool	IsContainer () const
bool	IsGroupNode () const
bool	IsParamNode () const
void	SetContainer (bool is_container)
bool	IsEnabled ()
void	Enable (bool enable=true)
void	Disable ()
void	StartSearch ()
void	RefreshSearch (const wxString &search_text)
void	FinishSearch ()
ParamsNode *	GetParent ()
ParamsNodePtrArray &	GetChildren ()
wxDataViewItemArray	GetEnabledChildren ()
void	Append (std::unique_ptr< ParamsNode > child)

Public Attributes
wxBitmap	icon
std::string	icon_name
std::string	param_key
wxString	text

Private Attributes
ParamsNode *	m_parent { nullptr }
ParamsNodePtrArray	m_children
wxDataViewCtrl *	m_ctrl
ParamType	m_param_type { ParamType::Undef }
bool	m_container { true }
bool	m_expanded_before_search {false}
bool	m_enabled {true}
bool	m_bold {false}
std::unique_ptr< std::pair< int, int > >	m_highlight_index {nullptr}

Detailed Description

Constructor & Destructor Documentation

ParamsNode() [1/3]

Slic3r::GUI::ParamsNode::ParamsNode	(	const wxString &	group_name,
		const std::string &	icon_name,
		wxDataViewCtrl *	ctrl )

: icon_name(icon_name)
, text(group_name)
, m_ctrl(ctrl)
, m_bold(true)
{
}

References icon_name, m_bold, m_ctrl, and text.

Referenced by ParamsNode(), ParamsNode(), and GetParent().

Here is the caller graph for this function:

ParamsNode() [2/3]

Slic3r::GUI::ParamsNode::ParamsNode	(	ParamsNode *	parent,
		const wxString &	sub_group_name,
		const std::string &	icon_name,
		wxDataViewCtrl *	ctrl )

    : m_parent(parent)
    , icon_name(icon_name)
    , text(sub_group_name)
    , m_ctrl(ctrl)
    , m_bold(true)
{
}

References ParamsNode(), icon_name, m_bold, m_ctrl, m_parent, and text.

Here is the call graph for this function:

ParamsNode() [3/3]

Slic3r::GUI::ParamsNode::ParamsNode	(	ParamsNode *	parent,
		ParamType	param_type,
		const std::string &	param_key,
		wxDataViewCtrl *	ctrl )

    : m_parent(parent)
    , m_param_type(param_type)
    , m_container(false)
    , param_key(param_key)
    , m_ctrl(ctrl)
{
    text = from_u8(param_key);
    if (param_type == ParamType::Vector)
        text += "[]";
    else if (param_type == ParamType::FilamentVector)
        text += "[current_extruder]";
 
    icon_name = ParamsInfo.at(param_type);
}

References ParamsNode(), Slic3r::GUI::FilamentVector, Slic3r::GUI::from_u8(), icon_name, m_container, m_ctrl, m_param_type, m_parent, param_key, Slic3r::GUI::ParamsInfo, text, and Slic3r::GUI::Vector.

Here is the call graph for this function:

Member Function Documentation

Append()

void Slic3r::GUI::ParamsNode::Append ( std::unique_ptr< ParamsNode > child )

inline

{ m_children.emplace_back(std::move(child)); }

References m_children.

Referenced by Slic3r::GUI::ParamsModel::AppendParam(), and Slic3r::GUI::ParamsModel::AppendSubGroup().

Here is the caller graph for this function:

Disable()

void Slic3r::GUI::ParamsNode::Disable ( )

inline

{ Enable(false); }

References Slic3r::Enable.

Referenced by RefreshSearch().

Here is the caller graph for this function:

Enable()

void Slic3r::GUI::ParamsNode::Enable ( bool enable = true )

inline

{ m_enabled = enable; }

References m_enabled.

FinishSearch()

void Slic3r::GUI::ParamsNode::FinishSearch

(

)

{
    Enable();
    m_highlight_index.reset();
    const wxDataViewItem item(this);
    if (!GetChildren().empty())
        for (const auto& child : GetChildren())
            child->FinishSearch();
    m_expanded_before_search ? m_ctrl->Expand(item) : m_ctrl->Collapse(item);
}

References Slic3r::empty(), Slic3r::Enable, GetChildren(), m_ctrl, m_expanded_before_search, and m_highlight_index.

Here is the call graph for this function:

GetChildren()

ParamsNodePtrArray & Slic3r::GUI::ParamsNode::GetChildren ( )

inline

{ return m_children; }

References m_children.

Referenced by Slic3r::GUI::ParamsModel::AppendParam(), Slic3r::GUI::ParamsModel::AppendSubGroup(), Slic3r::GUI::ParamsModel::Delete(), FinishSearch(), Slic3r::GUI::ParamsModel::GetChildren(), RefreshSearch(), and StartSearch().

Here is the caller graph for this function:

GetEnabledChildren()

wxDataViewItemArray Slic3r::GUI::ParamsNode::GetEnabledChildren

(

)

                                                   {
    wxDataViewItemArray array;
    for (const std::unique_ptr<ParamsNode>& child : m_children)
        if (child->IsEnabled())
            array.Add(wxDataViewItem(child.get()));
    return array;
}

References m_children.

Referenced by RefreshSearch().

Here is the caller graph for this function:

GetFormattedText()

wxString Slic3r::GUI::ParamsNode::GetFormattedText

(

)

{
    wxString formatted_text(text);
    if (m_highlight_index) {
        wxString substr = formatted_text.substr(m_highlight_index->first, m_highlight_index->second);
        formatted_text  = formatted_text.Remove(m_highlight_index->first, m_highlight_index->second);
        highlight(substr);
        formatted_text.insert(m_highlight_index->first, substr);
    }
 
    if (m_bold)
        make_bold(formatted_text);
 
    return formatted_text;
}

References Slic3r::GUI::highlight(), m_bold, m_highlight_index, Slic3r::GUI::make_bold(), and text.

Referenced by Slic3r::GUI::ParamsModel::GetValue().

Here is the call graph for this function:

Here is the caller graph for this function:

GetParent()

ParamsNode * Slic3r::GUI::ParamsNode::GetParent ( )

inline

{ return m_parent; }

References ParamsNode(), and m_parent.

Referenced by Slic3r::GUI::ParamsModel::Delete(), Slic3r::GUI::ParamsModel::GetParent(), and Slic3r::GUI::ParamsModel::GetTopLevelCategory().

Here is the call graph for this function:

Here is the caller graph for this function:

IsContainer()

bool Slic3r::GUI::ParamsNode::IsContainer ( ) const

inline

{ return m_container; }

References m_container.

Referenced by Slic3r::GUI::ParamsModel::IsContainer().

Here is the caller graph for this function:

IsEnabled()

bool Slic3r::GUI::ParamsNode::IsEnabled ( )

inline

{ return m_enabled; }

References m_enabled.

Referenced by Slic3r::GUI::ParamsModel::Delete().

Here is the caller graph for this function:

IsGroupNode()

bool Slic3r::GUI::ParamsNode::IsGroupNode ( ) const

inline

{ return m_parent == nullptr; }

References m_parent.

Referenced by Slic3r::GUI::ParamsModel::GetParent(), and Slic3r::GUI::ParamsModel::GetTopLevelCategory().

Here is the caller graph for this function:

IsParamNode()

bool Slic3r::GUI::ParamsNode::IsParamNode ( ) const

inline

{ return m_param_type != ParamType::Undef; }

References m_param_type, and Slic3r::GUI::Undef.

Referenced by Slic3r::GUI::ParamsModel::GetParamName(), and RefreshSearch().

Here is the caller graph for this function:

RefreshSearch()

void Slic3r::GUI::ParamsNode::RefreshSearch

(

const wxString &

search_text

)

{
    if (!GetChildren().empty())
        for (auto& child : GetChildren())
            child->RefreshSearch(search_text);
 
    if (GetEnabledChildren().empty())
        if (auto pos = text.find(search_text); IsParamNode() && pos != wxString::npos) {
            m_highlight_index = make_unique<std::pair<int, int>>(pos, search_text.Len());
            Enable();
        } else {
            Disable();
        }
    else
        Enable();
}

References Disable(), Slic3r::empty(), Slic3r::Enable, GetChildren(), GetEnabledChildren(), IsParamNode(), m_highlight_index, Slic3r::make_unique(), and text.

Here is the call graph for this function:

SetContainer()

void Slic3r::GUI::ParamsNode::SetContainer ( bool is_container )

inline

{ m_container = is_container; }

References m_container.

StartSearch()

void Slic3r::GUI::ParamsNode::StartSearch

(

)

{
    const wxDataViewItem item(this);
    m_expanded_before_search = m_ctrl->IsExpanded(item);
    if (!GetChildren().empty())
        for (const auto& child : GetChildren())
            child->StartSearch();
}

References Slic3r::empty(), GetChildren(), m_ctrl, and m_expanded_before_search.

Here is the call graph for this function:

Member Data Documentation

icon

wxBitmap Slic3r::GUI::ParamsNode::icon

Referenced by Slic3r::GUI::ParamsModel::SetValue().

icon_name

std::string Slic3r::GUI::ParamsNode::icon_name

Referenced by ParamsNode(), ParamsNode(), ParamsNode(), and Slic3r::GUI::ParamsModel::GetValue().

m_bold

bool Slic3r::GUI::ParamsNode::m_bold {false}

private

{false};

Referenced by ParamsNode(), ParamsNode(), and GetFormattedText().

m_children

ParamsNodePtrArray Slic3r::GUI::ParamsNode::m_children

private

Referenced by Append(), GetChildren(), and GetEnabledChildren().

m_container

bool Slic3r::GUI::ParamsNode::m_container { true }

private

{ true };

Referenced by ParamsNode(), IsContainer(), and SetContainer().

m_ctrl

wxDataViewCtrl* Slic3r::GUI::ParamsNode::m_ctrl

private

Referenced by ParamsNode(), ParamsNode(), ParamsNode(), FinishSearch(), and StartSearch().

m_enabled

bool Slic3r::GUI::ParamsNode::m_enabled {true}

private

{true};

Referenced by Enable(), and IsEnabled().

m_expanded_before_search

bool Slic3r::GUI::ParamsNode::m_expanded_before_search {false}

private

{false};

Referenced by FinishSearch(), and StartSearch().

m_highlight_index

std::unique_ptr<std::pair<int, int> > Slic3r::GUI::ParamsNode::m_highlight_index {nullptr}

private

{nullptr};

Referenced by FinishSearch(), GetFormattedText(), and RefreshSearch().

m_param_type

ParamType Slic3r::GUI::ParamsNode::m_param_type { ParamType::Undef }

private

{ ParamType::Undef };

Referenced by ParamsNode(), and IsParamNode().

m_parent

ParamsNode* Slic3r::GUI::ParamsNode::m_parent { nullptr }

private

{ nullptr };

Referenced by ParamsNode(), ParamsNode(), GetParent(), and IsGroupNode().

param_key

std::string Slic3r::GUI::ParamsNode::param_key

Referenced by ParamsNode(), and Slic3r::GUI::ParamsModel::GetParamKey().

text

wxString Slic3r::GUI::ParamsNode::text

Referenced by ParamsNode(), ParamsNode(), ParamsNode(), GetFormattedText(), Slic3r::GUI::ParamsModel::GetParamName(), Slic3r::GUI::ParamsModel::GetTopLevelCategory(), RefreshSearch(), and Slic3r::GUI::ParamsModel::SetValue().

---

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