Slic3r::GUI::Page Class Reference

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

Inheritance diagram for Slic3r::GUI::Page:

Collaboration diagram for Slic3r::GUI::Page:

Public Member Functions
	Page (wxWindow *parent, const wxString &title, int iconID, wxPanel *tab_owner)
	~Page ()
wxBoxSizer *	vsizer () const
wxWindow *	parent () const
const wxString &	title () const
size_t	iconID () const
void	set_config (DynamicPrintConfig *config_in)
void	reload_config ()
void	update_visibility (ConfigOptionMode mode, bool update_contolls_visibility)
void	activate (ConfigOptionMode mode, std::function< void()> throw_if_canceled)
bool	build_pending () const
bool	build_step (ConfigOptionMode mode)
bool	visibility_pending () const
void	clear ()
void	msw_rescale ()
void	sys_color_changed ()
void	refresh ()
Field *	get_field (const t_config_option_key &opt_key, int opt_index=-1) const
Line *	get_line (const t_config_option_key &opt_key, int opt_index=-1)
bool	set_value (const t_config_option_key &opt_key, const boost::any &value)
ConfigOptionsGroupShp	new_optgroup (const wxString &title, const wxString &icon=wxEmptyString, int noncommon_label_width=-1, bool is_extruder_og=false)
const ConfigOptionsGroupShp	get_optgroup (const wxString &title) const
bool	set_item_colour (const wxColour *clr)
const wxColour	get_item_colour ()
bool	get_show () const

Public Attributes
bool	m_is_modified_values { false }
bool	m_is_nonsys_values { true }
bool	m_split_multi_line = false
bool	m_option_label_at_right = false
std::vector< ConfigOptionsGroupShp >	m_optgroups
DynamicPrintConfig *	m_config
std::map< std::string, std::string >	m_opt_id_map

Protected Member Functions
size_t	next_group_to_build () const
bool	activate_group (size_t i, ConfigOptionMode mode, std::function< void()> throw_if_canceled)

Protected Attributes
const wxColour *	m_item_color

Private Attributes
wxPanel *	m_tab_owner
wxWindow *	m_parent
wxString	m_title
size_t	m_iconID
wxBoxSizer *	m_vsizer
wxStaticText *	m_page_title
bool	m_show = true
bool	m_visibility_applied = false

Detailed Description

Constructor & Destructor Documentation

Page()

Slic3r::GUI::Page::Page	(	wxWindow *	parent,
		const wxString &	title,
		int	iconID,
		wxPanel *	tab_owner )

                                                                                  :
        m_tab_owner(tab_owner),
        m_parent(parent),
        m_title(title),
        m_iconID(iconID)
{
    m_vsizer = (wxBoxSizer*)parent->GetSizer();
    m_page_title = NULL;
    m_item_color = &wxGetApp().get_label_clr_default();
}

References Page(), iconID(), m_iconID, m_item_color, m_page_title, m_parent, m_tab_owner, m_title, m_vsizer, parent(), and title().

Referenced by Page().

Here is the call graph for this function:

Here is the caller graph for this function:

~Page()

Slic3r::GUI::Page::~Page ( )

inline

{}

Member Function Documentation

activate()

void Slic3r::GUI::Page::activate	(	ConfigOptionMode	mode,
		std::function< void()>	throw_if_canceled )

{
#if 0 // BBS: page title
    if (m_page_title == NULL) {
        m_page_title = new Label(Label::Head_18, _(m_title), m_parent);
        m_vsizer->AddSpacer(30);
        m_vsizer->Add(m_page_title, 0, wxALIGN_CENTER);
        m_vsizer->AddSpacer(20);
    }
#else
    //m_vsizer->AddSpacer(10);
#endif
    for (size_t i = 0; i < m_optgroups.size(); ++i) {
        activate_group(i, mode, throw_if_canceled);
        throw_if_canceled();
    }
 
#ifdef __WXMSW__
    // BBS: fix field control position
    wxTheApp->CallAfter([wp = std::weak_ptr<Page>(shared_from_this())]() {
        auto page = wp.lock();
        if (!page)
            return;
 
        for (auto group : page->m_optgroups) {
            if (group->custom_ctrl)
                group->custom_ctrl->fixup_items_positions();
        }
    });
#endif
}

References _, activate_group(), Label::Head_18, m_optgroups, m_page_title, m_parent, m_title, and m_vsizer.

Here is the call graph for this function:

activate_group()

bool Slic3r::GUI::Page::activate_group ( size_t i, ConfigOptionMode mode, std::function< void()> throw_if_canceled )

protected

{
    auto& group = m_optgroups[i];
    if (!group->activate(throw_if_canceled))
        return false;
    m_visibility_applied = false;
    m_vsizer->Add(group->sizer, 0, wxEXPAND | (group->is_legend_line() ? (wxLEFT|wxTOP) : wxALL), m_parent->FromDIP(5)); // ORCA use less margin on parameters section
    group->update_visibility(mode);
#if HIDE_FIRST_SPLIT_LINE
    // BBS: no line spliter for first group
    if (i == 0) group->stb->Hide();
#endif
    group->reload_config();
    return true;
}

References m_optgroups, m_parent, m_visibility_applied, and m_vsizer.

Referenced by activate(), and build_step().

Here is the caller graph for this function:

build_pending()

bool Slic3r::GUI::Page::build_pending

(

)

const

{
    return next_group_to_build() < m_optgroups.size();
}

References m_optgroups, and next_group_to_build().

Referenced by build_step().

Here is the call graph for this function:

Here is the caller graph for this function:

build_step()

bool Slic3r::GUI::Page::build_step

(

ConfigOptionMode

mode

)

{
    const size_t i = next_group_to_build();
    if (i < m_optgroups.size())
        activate_group(i, mode, [] {});
    return build_pending();
}

References activate_group(), build_pending(), m_optgroups, and next_group_to_build().

Here is the call graph for this function:

clear()

void Slic3r::GUI::Page::clear

(

)

{
    for (auto group : m_optgroups)
        group->clear();
    m_page_title = NULL;
    m_visibility_applied = false;
}

References m_optgroups, m_page_title, and m_visibility_applied.

get_field()

Field * Slic3r::GUI::Page::get_field	(	const t_config_option_key &	opt_key,
		int	opt_index = -1 ) const

{
    Field *field = nullptr;
    auto   opt_key2 = opt_key;
    if (opt_index >= 256) {
        auto iter = m_opt_id_map.find(opt_key + '#' + std::to_string(opt_index - 256));
        if (iter != m_opt_id_map.end())
            opt_key2 = iter->second;
    }
    for (auto opt : m_optgroups) {
        field = opt->get_fieldc(opt_key2, opt_index);
        if (field != nullptr) return field;
    }
    return field;
}

References m_opt_id_map, and m_optgroups.

Referenced by Slic3r::GUI::TabFilament::update_filament_overrides_page().

Here is the caller graph for this function:

get_item_colour()

const wxColour Slic3r::GUI::Page::get_item_colour ( )

inline

                                    {
      return *m_item_color;
  }

References m_item_color.

get_line()

Line * Slic3r::GUI::Page::get_line	(	const t_config_option_key &	opt_key,
		int	opt_index = -1 )

{
    Line *line = nullptr;
    auto   opt_key2 = opt_key;
    if (opt_index >= 256) {
        auto iter = m_opt_id_map.find(opt_key + '#' + std::to_string(opt_index - 256));
        if (iter != m_opt_id_map.end())
            opt_key2 = iter->second;
    } else if (opt_index >= 0) {
        assert(opt_key.find('#') == std::string::npos);
        opt_key2 = opt_key + '#' + std::to_string(opt_index);
    }
    for (auto opt : m_optgroups) {
        line = opt->get_line(opt_key2);
        if (line != nullptr) return line;
    }
    return line;
}

References m_opt_id_map, and m_optgroups.

get_optgroup()

const ConfigOptionsGroupShp Slic3r::GUI::Page::get_optgroup

(

const wxString &

title

)

const

{
    for (ConfigOptionsGroupShp optgroup : m_optgroups) {
        if (optgroup->title == title)
            return optgroup;
    }
 
    return nullptr;
}

References m_optgroups, and title().

Here is the call graph for this function:

get_show()

bool Slic3r::GUI::Page::get_show ( ) const

inline

{ return m_show; }

References m_show.

iconID()

size_t Slic3r::GUI::Page::iconID ( ) const

inline

{ return m_iconID; }

References m_iconID.

Referenced by Page().

Here is the caller graph for this function:

msw_rescale()

void Slic3r::GUI::Page::msw_rescale

(

)

{
    for (auto group : m_optgroups)
        group->msw_rescale();
}

References m_optgroups.

new_optgroup()

ConfigOptionsGroupShp Slic3r::GUI::Page::new_optgroup	(	const wxString &	title,
		const wxString &	icon = wxEmptyString,
		int	noncommon_label_width = -1,
		bool	is_extruder_og = false )

config_ have to be "right"

This function will be called from OptionGroup. Using of CallAfter is redundant. And in some cases it causes update() function to be recalled again wxTheApp->CallAfter([this, opt_key, value]() {

});

{
    ConfigOptionsGroupShp optgroup  = is_extruder_og ? std::make_shared<ExtruderOptionsGroup>(m_parent, title, icon, m_config, true) // ORCA: add support for icons
        : std::make_shared<ConfigOptionsGroup>(m_parent, title, icon, m_config, true);
    optgroup->split_multi_line     = this->m_split_multi_line;
    optgroup->option_label_at_right = this->m_option_label_at_right;
    if (noncommon_label_width >= 0)
        optgroup->label_width = noncommon_label_width;
 
//BBS: GUI refactor
/*#ifdef __WXOSX__
    auto tab = parent()->GetParent()->GetParent();// GetParent()->GetParent();
#else
    auto tab = parent()->GetParent();// GetParent();
#endif*/
    auto tab = m_tab_owner;
    optgroup->set_config_category_and_type(m_title, static_cast<Tab*>(tab)->type());
    optgroup->m_on_change = [tab](t_config_option_key opt_key, boost::any value) {
            static_cast<Tab*>(tab)->update_dirty();
            static_cast<Tab*>(tab)->on_value_change(opt_key, value);
    };
 
    optgroup->m_get_initial_config = [tab]() {
        DynamicPrintConfig config = static_cast<Tab*>(tab)->m_presets->get_selected_preset().config;
        return config;
    };
 
    optgroup->m_get_sys_config = [tab]() {
        DynamicPrintConfig config = static_cast<Tab*>(tab)->m_presets->get_selected_preset_parent()->config;
        return config;
    };
 
    optgroup->have_sys_config = [tab]() {
        return static_cast<Tab*>(tab)->m_presets->get_selected_preset_parent() != nullptr;
    };
 
    optgroup->rescale_extra_column_item = [](wxWindow* win) {
        auto *ctrl = dynamic_cast<wxStaticBitmap*>(win);
        if (ctrl == nullptr)
            return;
 
        ctrl->SetBitmap(reinterpret_cast<ScalableBitmap*>(ctrl->GetClientData())->bmp());
    };
 
    m_optgroups.push_back(optgroup);
 
    return optgroup;
}

References ScalableBitmap::bmp(), m_config, m_optgroups, m_option_label_at_right, m_parent, m_split_multi_line, m_tab_owner, m_title, and title().

Here is the call graph for this function:

next_group_to_build()

size_t Slic3r::GUI::Page::next_group_to_build ( ) const

protected

{
    return std::find_if(m_optgroups.begin(), m_optgroups.end(), [](const auto& group) { return !group->is_activated(); }) - m_optgroups.begin();
}

References m_optgroups.

Referenced by build_pending(), and build_step().

Here is the caller graph for this function:

parent()

wxWindow * Slic3r::GUI::Page::parent ( ) const

inline

{ return m_parent; }

References m_parent.

Referenced by Page().

Here is the caller graph for this function:

refresh()

void Slic3r::GUI::Page::refresh

(

)

{
    for (auto group : m_optgroups)
        group->refresh();
}

References m_optgroups.

reload_config()

void Slic3r::GUI::Page::reload_config

(

)

{
    for (auto group : m_optgroups)
        group->reload_config();
}

References m_optgroups.

set_config()

void Slic3r::GUI::Page::set_config ( DynamicPrintConfig * config_in )

inline

{ m_config = config_in; }

References m_config.

set_item_colour()

bool Slic3r::GUI::Page::set_item_colour ( const wxColour * clr )

inline

                                               {
    if (m_item_color != clr) {
      m_item_color = clr;
      return true;
    }
    return false;
  }

References m_item_color.

set_value()

bool Slic3r::GUI::Page::set_value	(	const t_config_option_key &	opt_key,
		const boost::any &	value )

{
    bool changed = false;
    for(auto optgroup: m_optgroups) {
        if (optgroup->set_value(opt_key, value))
            changed = true ;
    }
    return changed;
}

References m_optgroups.

sys_color_changed()

void Slic3r::GUI::Page::sys_color_changed

(

)

{
    for (auto group : m_optgroups)
        group->sys_color_changed();
}

References m_optgroups.

title()

const wxString & Slic3r::GUI::Page::title ( ) const

inline

{ return m_title; }

References m_title.

Referenced by Page(), get_optgroup(), Slic3r::GUI::Tab::is_printer_extruder_page(), and new_optgroup().

Here is the caller graph for this function:

update_visibility()

void Slic3r::GUI::Page::update_visibility	(	ConfigOptionMode	mode,
		bool	update_contolls_visibility )

{
    bool ret_val = false;
#if HIDE_FIRST_SPLIT_LINE
    // BBS: no line spliter for first group
    bool first = true;
#endif
    for (auto group : m_optgroups) {
        ret_val = (update_contolls_visibility     ?
                   group->update_visibility(mode) :  // update visibility for all controlls in group
                   group->is_visible(mode)           // just detect visibility for the group
                   ) || ret_val;
#if HIDE_FIRST_SPLIT_LINE
        // BBS: no line spliter for first group
        if (update_contolls_visibility && ret_val && first) {
            if (group->stb) group->stb->Hide();
            first = false;
        }
#endif
    }
 
    m_show = ret_val;
    if (update_contolls_visibility)
        m_visibility_applied = true;
#ifdef __WXMSW__
    if (!m_show) return;
    // BBS: fix field control position
    wxTheApp->CallAfter([wp=std::weak_ptr<Page>(shared_from_this())]() {
        auto page = wp.lock();
        if (!page)
            return;
 
        for (auto group : page->m_optgroups) {
            if (group->custom_ctrl) group->custom_ctrl->fixup_items_positions();
        }
    });
#endif
}

References m_optgroups, m_show, and m_visibility_applied.

visibility_pending()

bool Slic3r::GUI::Page::visibility_pending ( ) const

inline

{ return !m_visibility_applied; }

References m_visibility_applied.

vsizer()

wxBoxSizer * Slic3r::GUI::Page::vsizer ( ) const

inline

{ return m_vsizer; }

References m_vsizer.

Member Data Documentation

m_config

DynamicPrintConfig* Slic3r::GUI::Page::m_config

Referenced by new_optgroup(), and set_config().

m_iconID

size_t Slic3r::GUI::Page::m_iconID

private

Referenced by Page(), and iconID().

m_is_modified_values

bool Slic3r::GUI::Page::m_is_modified_values { false }

{ false };

Referenced by Slic3r::GUI::Tab::tree_sel_change_delayed(), and Slic3r::GUI::Tab::update_current_page_in_background().

m_is_nonsys_values

bool Slic3r::GUI::Page::m_is_nonsys_values { true }

{ true };

Referenced by Slic3r::GUI::Tab::tree_sel_change_delayed(), and Slic3r::GUI::Tab::update_current_page_in_background().

m_item_color

const wxColour* Slic3r::GUI::Page::m_item_color

protected

Referenced by Page(), get_item_colour(), and set_item_colour().

m_opt_id_map

std::map<std::string, std::string> Slic3r::GUI::Page::m_opt_id_map

Referenced by get_field(), and get_line().

m_optgroups

std::vector<ConfigOptionsGroupShp> Slic3r::GUI::Page::m_optgroups

Referenced by activate(), activate_group(), Slic3r::GUI::PublishSettingsDialog::build_option_model(), build_pending(), build_step(), clear(), Slic3r::GUI::custom_gcode_group_title(), get_field(), get_line(), get_optgroup(), msw_rescale(), new_optgroup(), next_group_to_build(), refresh(), reload_config(), set_value(), sys_color_changed(), Slic3r::GUI::TabFilament::update_filament_overrides_page(), and update_visibility().

m_option_label_at_right

bool Slic3r::GUI::Page::m_option_label_at_right = false

Referenced by new_optgroup().

m_page_title

wxStaticText* Slic3r::GUI::Page::m_page_title

private

Referenced by Page(), activate(), and clear().

m_parent

wxWindow* Slic3r::GUI::Page::m_parent

private

Referenced by Page(), activate(), activate_group(), new_optgroup(), and parent().

m_show

bool Slic3r::GUI::Page::m_show = true

private

Referenced by get_show(), and update_visibility().

m_split_multi_line

bool Slic3r::GUI::Page::m_split_multi_line = false

Referenced by new_optgroup().

m_tab_owner

wxPanel* Slic3r::GUI::Page::m_tab_owner

private

Referenced by Page(), and new_optgroup().

m_title

wxString Slic3r::GUI::Page::m_title

private

Referenced by Page(), activate(), new_optgroup(), and title().

m_visibility_applied

bool Slic3r::GUI::Page::m_visibility_applied = false

private

Referenced by activate_group(), clear(), update_visibility(), and visibility_pending().

m_vsizer

wxBoxSizer* Slic3r::GUI::Page::m_vsizer

private

Referenced by Page(), activate(), activate_group(), and vsizer().

---

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

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