Slic3r::BBLStatusBar Class Reference

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

Inheritance diagram for Slic3r::BBLStatusBar:

Collaboration diagram for Slic3r::BBLStatusBar:

Public Types
using	CancelFn = std::function<void()>
	Cancel callback function type.

Public Member Functions
	BBLStatusBar (wxWindow *parent=nullptr, int id=-1)
	~BBLStatusBar ()=default
int	get_progress () const
void	set_progress (int) override
int	get_range () const override
void	set_range (int=100) override
void	clear_percent () override
void	show_error_info (wxString msg, int code, wxString description, wxString extra) override
void	show_progress (bool)
void	start_busy (int=100)
void	stop_busy ()
bool	is_busy () const
void	set_cancel_callback (CancelFn=CancelFn()) override
void	reset_cancel_callback ()
wxPanel *	get_panel ()
void	set_status_text (const wxString &txt)
void	set_status_text (const std::string &txt)
void	set_status_text (const char *txt) override
wxString	get_status_text () const
void	set_font (const wxFont &font)
void	set_object_info (const wxString &txt)
void	set_slice_info (const wxString &txt)
void	show_slice_info (bool show)
bool	is_slice_info_shown ()
void	show_cancel_button ()
void	hide_cancel_button ()

Private Attributes
wxPanel *	m_self
wxGauge *	m_prog
wxButton *	m_cancelbutton
wxStaticText *	m_status_text
wxStaticText *	m_object_info
wxStaticText *	m_slice_info
wxBoxSizer *	m_slice_info_sizer
wxBoxSizer *	m_object_info_sizer
wxBoxSizer *	m_sizer
bool	m_busy = false
CancelFn	m_cancel_cb

Detailed Description

Member Typedef Documentation

CancelFn

using Slic3r::ProgressIndicator::CancelFn = std::function<void()>

inherited

Cancel callback function type.

Constructor & Destructor Documentation

BBLStatusBar()

Slic3r::BBLStatusBar::BBLStatusBar	(	wxWindow *	parent = nullptr,
		int	id = -1 )

    : m_self{new wxPanel(parent, id == -1 ? wxID_ANY : id)}
    , m_prog{new wxGauge(m_self,
                         wxGA_HORIZONTAL,
                         100,
                         wxDefaultPosition,
                         wxSize(120, -1))}
    , m_cancelbutton{new wxButton(m_self,
                                  -1,
                                  _(L("Cancel")),
                                  wxDefaultPosition,
                                  wxDefaultSize)}
    , m_sizer(new wxBoxSizer(wxHORIZONTAL))
    , m_slice_info_sizer(new wxBoxSizer(wxHORIZONTAL))
    , m_object_info_sizer(new wxBoxSizer(wxHORIZONTAL))
{
    m_status_text = new wxStaticText(m_self, wxID_ANY, "", wxDefaultPosition, wxDefaultSize, wxST_ELLIPSIZE_END);
    m_status_text->SetForegroundColour(*wxBLACK);
 
    m_object_info = new wxStaticText(m_self, wxID_ANY, "", wxDefaultPosition, wxDefaultSize, wxST_ELLIPSIZE_END);
    m_object_info->SetForegroundColour(*wxBLACK);
 
    m_slice_info = new wxStaticText(m_self, wxID_ANY, "", wxDefaultPosition, wxDefaultSize, wxST_ELLIPSIZE_END);
    m_slice_info->SetForegroundColour(*wxBLACK);
 
    wxStaticLine* seperator_1 = new wxStaticLine(m_self, wxID_ANY, wxDefaultPosition, wxSize(3, -1), wxLI_VERTICAL);
    wxStaticLine* seperator_2 = new wxStaticLine(m_self, wxID_ANY, wxDefaultPosition, wxSize(3, -1), wxLI_VERTICAL);
 
    m_object_info_sizer->Add(m_object_info, 1, wxEXPAND | wxALL, 0);
    m_object_info_sizer->Add(seperator_1, 0, wxEXPAND | wxLEFT | wxRIGHT, 5);
 
    m_slice_info_sizer->Add(m_slice_info, 1, wxEXPAND | wxALL, 0);
    m_slice_info_sizer->Add(seperator_2, 0, wxEXPAND | wxLEFT | wxRIGHT, 5);
 
    m_cancelbutton->Bind(wxEVT_BUTTON, [this](const wxCommandEvent&) {
        if (m_cancel_cb) 
            m_cancel_cb();
        m_cancelbutton->Hide();
    });
 
    m_sizer->Add(m_object_info_sizer, 1, wxEXPAND | wxALL, 5);
    m_sizer->Add(m_slice_info_sizer, 1, wxEXPAND | wxALL, 5);
    m_sizer->Add(m_status_text, 1, wxEXPAND | wxALL, 5);
    m_sizer->Add(m_prog, 0, wxEXPAND | wxLEFT | wxALL, 5);
    m_sizer->Add(m_cancelbutton, 0, wxEXPAND | wxALL, 5);
    m_sizer->SetSizeHints(m_self);
    m_self->SetSizer(m_sizer);
 
    m_sizer->Hide(m_object_info_sizer);
    m_sizer->Hide(m_slice_info_sizer);
    m_sizer->Hide(m_prog);
    m_sizer->Hide(m_cancelbutton);
    m_sizer->Layout();
}

References _, L, m_cancel_cb, m_cancelbutton, m_object_info, m_object_info_sizer, m_prog, m_self, m_sizer, m_slice_info, m_slice_info_sizer, m_status_text, wxButton, wxGauge, and wxStaticText.

~BBLStatusBar()

Slic3r::BBLStatusBar::~BBLStatusBar ( )

default

Member Function Documentation

clear_percent()

void Slic3r::BBLStatusBar::clear_percent ( )

overridevirtual

Implements Slic3r::ProgressIndicator.

{
 
}

get_panel()

wxPanel * Slic3r::BBLStatusBar::get_panel

(

)

{
    return m_self;
}

References m_self.

get_progress()

int Slic3r::BBLStatusBar::get_progress

(

)

const

{
    return m_prog->GetValue();
}

References m_prog.

get_range()

int Slic3r::BBLStatusBar::get_range ( ) const

overridevirtual

Implements Slic3r::ProgressIndicator.

{
    return m_prog->GetRange();
}

References m_prog.

get_status_text()

wxString Slic3r::BBLStatusBar::get_status_text

(

)

const

{
    return m_status_text->GetLabelText();
}

References m_status_text.

hide_cancel_button()

void Slic3r::BBLStatusBar::hide_cancel_button

(

)

{
    m_sizer->Hide(m_cancelbutton);
    m_sizer->Layout();
}

References m_cancelbutton, and m_sizer.

Referenced by stop_busy().

Here is the caller graph for this function:

is_busy()

bool Slic3r::BBLStatusBar::is_busy ( ) const

inline

{ return m_busy; }

References m_busy.

is_slice_info_shown()

bool Slic3r::BBLStatusBar::is_slice_info_shown

(

)

{
    return m_sizer->IsShown(m_slice_info_sizer);
}

References m_sizer, and m_slice_info_sizer.

reset_cancel_callback()

void Slic3r::BBLStatusBar::reset_cancel_callback ( )

inline

{ set_cancel_callback(); }

References set_cancel_callback().

Here is the call graph for this function:

set_cancel_callback()

void Slic3r::BBLStatusBar::set_cancel_callback ( BBLStatusBar::CancelFn ccb = CancelFn() )

overridevirtual

Implements Slic3r::ProgressIndicator.

                                                               {
    m_cancel_cb = ccb;
    if (ccb) {
        m_sizer->Show(m_cancelbutton);
    }
    else {
        m_sizer->Hide(m_cancelbutton);
    }
}

References m_cancel_cb, m_cancelbutton, and m_sizer.

Referenced by reset_cancel_callback().

Here is the caller graph for this function:

set_font()

void Slic3r::BBLStatusBar::set_font

(

const wxFont &

font

)

{
    m_self->SetFont(font);
}

References m_self.

set_object_info()

void Slic3r::BBLStatusBar::set_object_info

(

const wxString &

txt

)

{
    if (txt == "") {
        m_object_info->SetLabelText("");
        m_sizer->Hide(m_object_info_sizer);
    }
    else {
        if (!m_sizer->IsShown(m_object_info_sizer)) {
            m_sizer->Show(m_object_info_sizer);
        }
        m_object_info->SetLabelText(txt);
    }
    m_sizer->Layout();
}

References m_object_info, m_object_info_sizer, and m_sizer.

set_progress()

void Slic3r::BBLStatusBar::set_progress ( int val )

overridevirtual

Implements Slic3r::ProgressIndicator.

{
    if(val < 0)
        return;
 
    bool need_layout = false;
    //add the logic for arrange/orient jobs, which don't call stop_busy
    if(val == m_prog->GetRange()) {
        m_prog->SetValue(0);
        m_sizer->Hide(m_prog);
        need_layout = true;
    }
    else
    {
        if (m_sizer->IsShown(m_object_info_sizer)) {
            m_sizer->Hide(m_object_info_sizer);
            need_layout = true;
        }
 
        if (m_sizer->IsShown(m_slice_info_sizer)) {
            m_sizer->Hide(m_slice_info_sizer);
            need_layout = true;
        }
 
        if (!m_sizer->IsShown(m_prog)) {
            m_sizer->Show(m_prog);
            m_sizer->Show(m_cancelbutton);
            need_layout = true;
        }
        m_prog->SetValue(val);
    }
 
    if (need_layout) {
        m_sizer->Layout();
    }
}

References m_cancelbutton, m_object_info_sizer, m_prog, m_sizer, and m_slice_info_sizer.

set_range()

void Slic3r::BBLStatusBar::set_range ( int val = 100 )

overridevirtual

Implements Slic3r::ProgressIndicator.

{
    if(val != m_prog->GetRange()) {
        m_prog->SetRange(val);
    }
}

References m_prog.

set_slice_info()

void Slic3r::BBLStatusBar::set_slice_info

(

const wxString &

txt

)

{
    if (!txt.empty()) {
        if (!m_sizer->IsShown(m_slice_info_sizer)) {
            m_sizer->Show(m_slice_info_sizer);
        }
        m_slice_info->SetLabelText(txt);
        m_sizer->Layout();
    }
}

References m_sizer, m_slice_info, and m_slice_info_sizer.

set_status_text() [1/3]

void Slic3r::BBLStatusBar::set_status_text ( const char * txt )

overridevirtual

Implements Slic3r::ProgressIndicator.

{ 
    this->set_status_text(wxString::FromUTF8(txt));
}

References set_status_text().

Here is the call graph for this function:

set_status_text() [2/3]

void Slic3r::BBLStatusBar::set_status_text

(

const std::string &

txt

)

{ 
    this->set_status_text(txt.c_str());
}

References set_status_text().

Here is the call graph for this function:

set_status_text() [3/3]

void Slic3r::BBLStatusBar::set_status_text

(

const wxString &

txt

)

{
    m_status_text->SetLabelText(txt);
}

References m_status_text.

Referenced by set_status_text(), and set_status_text().

Here is the caller graph for this function:

show_cancel_button()

void Slic3r::BBLStatusBar::show_cancel_button

(

)

{
    m_sizer->Show(m_cancelbutton);
    m_sizer->Layout();
}

References m_cancelbutton, and m_sizer.

Referenced by start_busy().

Here is the caller graph for this function:

show_error_info()

void Slic3r::BBLStatusBar::show_error_info ( wxString msg, int code, wxString description, wxString extra )

overridevirtual

Implements Slic3r::ProgressIndicator.

{
 
}

show_progress()

void Slic3r::BBLStatusBar::show_progress

(

bool

show

)

{
    if (show) {
        m_sizer->Hide(m_object_info);
        m_sizer->Hide(m_slice_info);
 
        m_sizer->Show(m_prog);
        m_sizer->Layout();
    }
    else {
        m_sizer->Hide(m_prog);
        m_sizer->Layout();
    }
}

References m_object_info, m_prog, m_sizer, and m_slice_info.

Referenced by start_busy(), and stop_busy().

Here is the caller graph for this function:

show_slice_info()

void Slic3r::BBLStatusBar::show_slice_info

(

bool

show

)

{
    if (show) {
        m_sizer->Show(m_slice_info_sizer);
        m_sizer->Layout();
    }
    else {
        m_sizer->Hide(m_slice_info_sizer);
        m_sizer->Layout();
    }
}

References m_sizer, and m_slice_info_sizer.

start_busy()

void Slic3r::BBLStatusBar::start_busy

(

int

rate = 100

)

{
    m_busy = true;
    show_progress(true);
    show_cancel_button();
}

References m_busy, show_cancel_button(), and show_progress().

Here is the call graph for this function:

stop_busy()

void Slic3r::BBLStatusBar::stop_busy

(

)

{
    show_progress(false);
    hide_cancel_button();
    m_prog->SetValue(0);
    m_sizer->Show(m_slice_info_sizer);
    m_sizer->Layout();
    m_busy = false;
}

References hide_cancel_button(), m_busy, m_prog, m_sizer, m_slice_info_sizer, and show_progress().

Here is the call graph for this function:

Member Data Documentation

m_busy

bool Slic3r::BBLStatusBar::m_busy = false

private

Referenced by is_busy(), start_busy(), and stop_busy().

m_cancel_cb

CancelFn Slic3r::BBLStatusBar::m_cancel_cb

private

Referenced by BBLStatusBar(), and set_cancel_callback().

m_cancelbutton

wxButton* Slic3r::BBLStatusBar::m_cancelbutton

private

Referenced by BBLStatusBar(), hide_cancel_button(), set_cancel_callback(), set_progress(), and show_cancel_button().

m_object_info

wxStaticText* Slic3r::BBLStatusBar::m_object_info

private

Referenced by BBLStatusBar(), set_object_info(), and show_progress().

m_object_info_sizer

wxBoxSizer* Slic3r::BBLStatusBar::m_object_info_sizer

private

Referenced by BBLStatusBar(), set_object_info(), and set_progress().

m_prog

wxGauge* Slic3r::BBLStatusBar::m_prog

private

Referenced by BBLStatusBar(), get_progress(), get_range(), set_progress(), set_range(), show_progress(), and stop_busy().

m_self

wxPanel* Slic3r::BBLStatusBar::m_self

private

Referenced by BBLStatusBar(), get_panel(), and set_font().

m_sizer

wxBoxSizer* Slic3r::BBLStatusBar::m_sizer

private

Referenced by BBLStatusBar(), hide_cancel_button(), is_slice_info_shown(), set_cancel_callback(), set_object_info(), set_progress(), set_slice_info(), show_cancel_button(), show_progress(), show_slice_info(), and stop_busy().

m_slice_info

wxStaticText* Slic3r::BBLStatusBar::m_slice_info

private

Referenced by BBLStatusBar(), set_slice_info(), and show_progress().

m_slice_info_sizer

wxBoxSizer* Slic3r::BBLStatusBar::m_slice_info_sizer

private

Referenced by BBLStatusBar(), is_slice_info_shown(), set_progress(), set_slice_info(), show_slice_info(), and stop_busy().

m_status_text

wxStaticText* Slic3r::BBLStatusBar::m_status_text

private

Referenced by BBLStatusBar(), get_status_text(), and set_status_text().

---

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

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