Slic3r::GUI::DialogButtons Class Reference

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

Inheritance diagram for Slic3r::GUI::DialogButtons:

Collaboration diagram for Slic3r::GUI::DialogButtons:

Public Member Functions
	DialogButtons (wxWindow *parent, std::vector< wxString > non_translated_labels, const wxString &primary_btn_label="", const int left_aligned_buttons_count=0)
wxBoxSizer *	GetSizer () const
Button *	GetButtonFromID (wxStandardID id)
Button *	GetButtonFromLabel (wxString label)
Button *	GetButtonFromIndex (int index)
Button *	GetOK ()
Button *	GetYES ()
Button *	GetAPPLY ()
Button *	GetCONFIRM ()
Button *	GetNO ()
Button *	GetCANCEL ()
Button *	GetRETURN ()
Button *	GetNEXT ()
Button *	GetFIRST ()
Button *	GetLAST ()
void	SetPrimaryButton (wxString label)
void	SetAlertButton (wxString label)
void	SetLeftAlignedButtonsCount (int left_aligned_buttons_count)
void	UpdateButtons ()
	~DialogButtons ()

Private Member Functions
Button *	PickFromList (std::set< wxStandardID > ID_list)
int	FromDIP (int d)
void	on_dpi_changed (wxDPIChangedEvent &event)
void	on_keydown (wxKeyEvent &event)

Private Attributes
wxWindow *	m_parent
wxBoxSizer *	m_sizer
std::vector< Button * >	m_buttons
wxString	m_primary
wxString	m_alert
int	m_left_aligned_buttons_count
const std::map< wxString, wxStandardID >	m_standardIDs
std::set< wxStandardID >	m_primaryIDs
std::set< wxStandardID >	m_alertIDs

Detailed Description

Constructor & Destructor Documentation

DialogButtons()

Slic3r::GUI::DialogButtons::DialogButtons	(	wxWindow *	parent,
		std::vector< wxString >	non_translated_labels,
		const wxString &	primary_btn_label = "",
		const int	left_aligned_buttons_count = 0 )

    : wxPanel(parent, wxID_ANY)
{
    m_parent  = parent;
    m_sizer   = new wxBoxSizer(wxHORIZONTAL);
    m_primary = primary_btn_translated_label;
    m_alert   = wxEmptyString;
    m_left_aligned_buttons_count = left_aligned_buttons_count;
    SetBackgroundColour(StateColor::darkModeColorFor(wxColour("#FFFFFF")));
 
    // Add all to array
    for (wxString label : non_translated_labels) {
        Button* btn = new Button(this, _L(label));
        wxString l = label;
        l.LowerCase();
        auto f = m_standardIDs.find(l);
        if (f != m_standardIDs.end())
            btn->SetId(f->second);
        m_buttons.push_back(btn);
    }
 
    m_parent->Bind(wxEVT_DPI_CHANGED, &DialogButtons::on_dpi_changed, this);
 
    SetSizer(m_sizer);
 
    UpdateButtons();
}

References _L, StateColor::darkModeColorFor(), Slic3r::f(), m_alert, m_buttons, m_left_aligned_buttons_count, m_parent, m_primary, m_sizer, m_standardIDs, on_dpi_changed(), and UpdateButtons().

Here is the call graph for this function:

~DialogButtons()

Slic3r::GUI::DialogButtons::~DialogButtons

(

)

                              {
    m_parent->Unbind(wxEVT_DPI_CHANGED, &DialogButtons::on_dpi_changed, this);
}

References m_parent, and on_dpi_changed().

Here is the call graph for this function:

Member Function Documentation

FromDIP()

int Slic3r::GUI::DialogButtons::FromDIP ( int d )

private

                                {
    return m_parent->FromDIP(d);
}

References m_parent.

Referenced by UpdateButtons().

Here is the caller graph for this function:

GetAPPLY()

Button * Slic3r::GUI::DialogButtons::GetAPPLY

(

)

{return GetButtonFromID(wxID_APPLY)   ;}

References GetButtonFromID().

Here is the call graph for this function:

GetButtonFromID()

Button * Slic3r::GUI::DialogButtons::GetButtonFromID

(

wxStandardID

id

)

                                                      {
    for (Button* btn : m_buttons)
        if (btn->GetId() == id)
            return btn;
    return nullptr;
}

References m_buttons.

Referenced by GetAPPLY(), GetCANCEL(), GetCONFIRM(), GetNEXT(), GetNO(), GetOK(), GetRETURN(), GetYES(), and PickFromList().

Here is the caller graph for this function:

GetButtonFromIndex()

Button * Slic3r::GUI::DialogButtons::GetButtonFromIndex

(

int

index

)

                                                   {
    if(index >= 0 && index < m_buttons.size())
        return m_buttons[index];
    else
        return nullptr;
}

References m_buttons.

Referenced by Slic3r::GUI::NetworkPluginRestartDialog::NetworkPluginRestartDialog(), Slic3r::GUI::NetworkPluginDownloadDialog::create_missing_plugin_ui(), Slic3r::GUI::NetworkPluginDownloadDialog::create_update_available_ui(), GetFIRST(), and GetLAST().

Here is the caller graph for this function:

GetButtonFromLabel()

Button * Slic3r::GUI::DialogButtons::GetButtonFromLabel

(

wxString

label

)

                                                                   {
    for (Button* btn : m_buttons)
        if (btn->GetLabel() == translated_label)
            return btn;
    return nullptr;
}

References m_buttons.

Referenced by SetAlertButton(), and SetPrimaryButton().

Here is the caller graph for this function:

GetCANCEL()

Button * Slic3r::GUI::DialogButtons::GetCANCEL

(

)

{return GetButtonFromID(wxID_CANCEL)  ;}

References GetButtonFromID().

Referenced by Slic3r::GUI::CrealityDiscoveryDialog::CrealityDiscoveryDialog(), Slic3r::GUI::OAuthDialog::OAuthDialog(), Slic3r::GUI::anonymous_namespace{SceneBenchmark.cpp}::SceneBenchmarkDialog::SceneBenchmarkDialog(), Slic3r::GUI::DiffPresetDialog::create_buttons(), and Slic3r::GUI::CreateFilamentPresetDialog::create_dialog_buttons().

Here is the call graph for this function:

Here is the caller graph for this function:

GetCONFIRM()

Button * Slic3r::GUI::DialogButtons::GetCONFIRM

(

)

{return GetButtonFromID(wxID_APPLY)   ;}

References GetButtonFromID().

Here is the call graph for this function:

GetFIRST()

Button * Slic3r::GUI::DialogButtons::GetFIRST

(

)

{return GetButtonFromIndex(0)         ;}

References GetButtonFromIndex().

Referenced by Slic3r::GUI::ShortcutCaptureDialog::ShortcutCaptureDialog(), and Slic3r::GUI::EditFilamentPresetDialog::create_dialog_buttons().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLAST()

Button * Slic3r::GUI::DialogButtons::GetLAST

(

)

{return GetButtonFromIndex(m_buttons.size() - 1);}

References GetButtonFromIndex(), and m_buttons.

Here is the call graph for this function:

GetNEXT()

Button * Slic3r::GUI::DialogButtons::GetNEXT

(

)

{return GetButtonFromID(wxID_FORWARD) ;}

References GetButtonFromID().

Here is the call graph for this function:

GetNO()

Button * Slic3r::GUI::DialogButtons::GetNO

(

)

{return GetButtonFromID(wxID_NO)      ;}

References GetButtonFromID().

Here is the call graph for this function:

GetOK()

Button * Slic3r::GUI::DialogButtons::GetOK

(

)

{return GetButtonFromID(wxID_OK)      ;}

References GetButtonFromID().

Referenced by Slic3r::GUI::Cornering_Test_Dlg::Cornering_Test_Dlg(), Slic3r::GUI::CrealityDiscoveryDialog::CrealityDiscoveryDialog(), Slic3r::GUI::CreatePresetSuccessfulDialog::CreatePresetSuccessfulDialog(), Slic3r::GUI::EditCalibrationHistoryDialog::EditCalibrationHistoryDialog(), Slic3r::GUI::FlowRateCalibrationDialog::FlowRateCalibrationDialog(), Slic3r::GUI::Input_Shaping_Damp_Test_Dlg::Input_Shaping_Damp_Test_Dlg(), Slic3r::GUI::Input_Shaping_Freq_Test_Dlg::Input_Shaping_Freq_Test_Dlg(), Slic3r::GUI::MaxVolumetricSpeed_Test_Dlg::MaxVolumetricSpeed_Test_Dlg(), Slic3r::GUI::MultiChoiceDialog::MultiChoiceDialog(), Slic3r::GUI::NewCalibrationHistoryDialog::NewCalibrationHistoryDialog(), Slic3r::GUI::PA_Calibration_Dlg::PA_Calibration_Dlg(), Slic3r::GUI::PlateNameEditDialog::PlateNameEditDialog(), Slic3r::GUI::PlateSettingsDialog::PlateSettingsDialog(), Slic3r::GUI::ProjectDropDialog::ProjectDropDialog(), Slic3r::GUI::PublishSettingsDialog::PublishSettingsDialog(), Slic3r::GUI::PurgeModeDialog::PurgeModeDialog(), Slic3r::GUI::RecenterDialog::RecenterDialog(), Slic3r::GUI::Retraction_Test_Dlg::Retraction_Test_Dlg(), Slic3r::GUI::SingleChoiceDialog::SingleChoiceDialog(), StepMeshDialog::StepMeshDialog(), Slic3r::GUI::Temp_Calibration_Dlg::Temp_Calibration_Dlg(), Slic3r::GUI::VFA_Test_Dlg::VFA_Test_Dlg(), Slic3r::GUI::SavePresetDialog::build(), Slic3r::GUI::PluginPickerDialog::build_capability_ui(), Slic3r::GUI::PluginPickerDialog::build_ui(), Slic3r::GUI::DiffPresetDialog::create_buttons(), Slic3r::GUI::CreateFilamentPresetDialog::create_dialog_buttons(), Slic3r::GUI::CreatePresetForPrinterDialog::create_dialog_buttons(), Slic3r::GUI::ExportConfigsDialog::create_dialog_buttons(), and Slic3r::GUI::CreatePrinterPresetDialog::create_page1_dialog_buttons().

Here is the call graph for this function:

Here is the caller graph for this function:

GetRETURN()

Button * Slic3r::GUI::DialogButtons::GetRETURN

(

)

{return GetButtonFromID(wxID_BACKWARD);} // gets Return button

References GetButtonFromID().

Referenced by Slic3r::GUI::CreatePrinterPresetDialog::create_page2_dialog_buttons().

Here is the call graph for this function:

Here is the caller graph for this function:

GetSizer()

wxBoxSizer * Slic3r::GUI::DialogButtons::GetSizer ( ) const

inline

{ return m_sizer; }

References m_sizer.

GetYES()

Button * Slic3r::GUI::DialogButtons::GetYES

(

)

{return GetButtonFromID(wxID_YES)     ;}

References GetButtonFromID().

Here is the call graph for this function:

on_dpi_changed()

void Slic3r::GUI::DialogButtons::on_dpi_changed ( wxDPIChangedEvent & event )

private

                                                           {
    UpdateButtons();
    event.Skip();
}

References UpdateButtons().

Referenced by DialogButtons(), and ~DialogButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

on_keydown()

void Slic3r::GUI::DialogButtons::on_keydown ( wxKeyEvent & event )

private

                                            {
    wxObject* current = e.GetEventObject();
    int key = e.GetKeyCode();
    int cnt = m_buttons.size();
    if(cnt > 1){
        int i = -1;
        for (Button* btn : m_buttons){
            i++;
            if(btn->HasFocus())
                break;
        }
        // possible issue if button hidden
        if      (key == WXK_LEFT)  {m_buttons[i - 1 < 0 ? (cnt - 1) : i - 1]->SetFocus();}
        else if (key == WXK_RIGHT) {m_buttons[i + 1 > (cnt - 1) ? 0 : i + 1]->SetFocus();}
    }
    e.Skip();
}

References m_buttons.

Referenced by UpdateButtons().

Here is the caller graph for this function:

PickFromList()

Button * Slic3r::GUI::DialogButtons::PickFromList ( std::set< wxStandardID > ID_list )

private

                                                                {
    // Picks first button from given list
    Button* b;
    for (auto itr : ID_list) {
        b = GetButtonFromID(itr);
        if (b != nullptr)
            return b;
    }
    return nullptr;
}

References GetButtonFromID().

Referenced by SetAlertButton(), and SetPrimaryButton().

Here is the call graph for this function:

Here is the caller graph for this function:

SetAlertButton()

void Slic3r::GUI::DialogButtons::SetAlertButton

(

wxString

label

)

                                                            {
    // use _L("Create") translated text for custom buttons
    // use non existing button name to disable alert styled button
    if(m_buttons.size() == 1)
        return;
    Button* btn;
    if(translated_label.IsEmpty()){ // prefer standard alert buttons if label empty
        btn = PickFromList(m_alertIDs);
    }else
        btn = GetButtonFromLabel(translated_label);
 
    if(btn == nullptr) return;
 
    m_alert = translated_label;
 
    btn->SetStyle(ButtonStyle::Alert, ButtonType::Choice);
}

References Alert, Choice, GetButtonFromLabel(), m_alert, m_alertIDs, m_buttons, PickFromList(), and Button::SetStyle().

Referenced by UpdateButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

SetLeftAlignedButtonsCount()

void Slic3r::GUI::DialogButtons::SetLeftAlignedButtonsCount

(

int

left_aligned_buttons_count

)

                                                                            {
    m_left_aligned_buttons_count = left_aligned_buttons_count;
    UpdateButtons();
}

References m_left_aligned_buttons_count, and UpdateButtons().

Here is the call graph for this function:

SetPrimaryButton()

void Slic3r::GUI::DialogButtons::SetPrimaryButton

(

wxString

label

)

                                                              {
    // use _L("Create") translated text for custom buttons
    // use non existing button name to disable primary styled button
    Button* btn;
    if(translated_label.IsEmpty()){ // prefer standard primary buttons if label empty
        if(m_buttons.size() == 1)
            btn = m_buttons.front();
        else
            btn = PickFromList(m_primaryIDs);
    }else
        btn = GetButtonFromLabel(translated_label);
 
    if(btn == nullptr) return;
 
    m_primary = translated_label;
 
    // apply focus only if there is no focused element exist. this prevents stealing focus from input boxes
    if(m_parent->FindFocus() == nullptr)
        btn->SetFocus();
 
    btn->SetStyle(ButtonStyle::Confirm, ButtonType::Choice);
}

References Choice, Confirm, GetButtonFromLabel(), m_buttons, m_parent, m_primary, m_primaryIDs, PickFromList(), and Button::SetStyle().

Referenced by UpdateButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateButtons()

void Slic3r::GUI::DialogButtons::UpdateButtons

(

)

                                  {
    m_sizer->Clear();
    SetBackgroundColour(StateColor::darkModeColorFor(wxColour("#FFFFFF")));
 
    // Apply standard style to all
    for (Button* btn : m_buttons) {
        btn->SetStyle(ButtonStyle::Regular, ButtonType::Choice);
        btn->Bind(wxEVT_KEY_DOWN, &DialogButtons::on_keydown, this);
    }
 
    int btn_gap = FromDIP(ButtonProps::ChoiceButtonGap());
 
    if(m_left_aligned_buttons_count == 0)
        m_sizer->AddSpacer(btn_gap);
 
    for (int i = 0; i < m_buttons.size(); i++) {
        if(m_left_aligned_buttons_count == i)
            m_sizer->AddStretchSpacer();
 
        auto margin_to = (i >= m_left_aligned_buttons_count ? wxRIGHT : wxLEFT);
        m_sizer->Add(m_buttons[i], 0, margin_to | wxTOP | wxBOTTOM | wxALIGN_CENTER_VERTICAL, btn_gap);
    }
 
    SetPrimaryButton(m_primary);
    SetAlertButton(m_alert);
 
    Layout();
    Fit();
}

References Choice, ButtonProps::ChoiceButtonGap(), StateColor::darkModeColorFor(), FromDIP(), m_alert, m_buttons, m_left_aligned_buttons_count, m_primary, m_sizer, on_keydown(), Regular, SetAlertButton(), and SetPrimaryButton().

Referenced by DialogButtons(), on_dpi_changed(), and SetLeftAlignedButtonsCount().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_alert

wxString Slic3r::GUI::DialogButtons::m_alert

private

Referenced by DialogButtons(), SetAlertButton(), and UpdateButtons().

m_alertIDs

std::set<wxStandardID> Slic3r::GUI::DialogButtons::m_alertIDs

private

Initial value:

{
        wxID_REMOVE,
        wxID_DELETE,
        wxID_ABORT,
        wxID_STOP,
        wxID_RESET,
        wxID_CLEAR,
        wxID_EXIT
    }

                                    {
        wxID_REMOVE,
        wxID_DELETE,
        wxID_ABORT,
        wxID_STOP,
        wxID_RESET,
        wxID_CLEAR,
        wxID_EXIT
    };

Referenced by SetAlertButton().

m_buttons

std::vector<Button*> Slic3r::GUI::DialogButtons::m_buttons

private

Referenced by DialogButtons(), GetButtonFromID(), GetButtonFromIndex(), GetButtonFromLabel(), GetLAST(), on_keydown(), SetAlertButton(), SetPrimaryButton(), and UpdateButtons().

m_left_aligned_buttons_count

int Slic3r::GUI::DialogButtons::m_left_aligned_buttons_count

private

Referenced by DialogButtons(), SetLeftAlignedButtonsCount(), and UpdateButtons().

m_parent

wxWindow* Slic3r::GUI::DialogButtons::m_parent

private

Referenced by DialogButtons(), ~DialogButtons(), FromDIP(), and SetPrimaryButton().

m_primary

wxString Slic3r::GUI::DialogButtons::m_primary

private

Referenced by DialogButtons(), SetPrimaryButton(), and UpdateButtons().

m_primaryIDs

std::set<wxStandardID> Slic3r::GUI::DialogButtons::m_primaryIDs

private

Initial value:

{
        wxID_OK,
        wxID_YES,
        wxID_APPLY,
        wxID_SAVE,
        wxID_PRINT
    }

                                      {
        wxID_OK,
        wxID_YES,
        wxID_APPLY,
        wxID_SAVE,
        wxID_PRINT
    };

Referenced by SetPrimaryButton().

m_sizer

wxBoxSizer* Slic3r::GUI::DialogButtons::m_sizer

private

Referenced by DialogButtons(), GetSizer(), and UpdateButtons().

m_standardIDs

const std::map<wxString, wxStandardID> Slic3r::GUI::DialogButtons::m_standardIDs

private

                                                         {
        // Choice
        {"ok"         , wxID_OK},
        {"yes"        , wxID_YES},
        {"apply"      , wxID_APPLY},
        {"confirm"    , wxID_APPLY}, // no id for confirm, reusing wxID_APPLY
        {"no"         , wxID_NO},
        {"cancel"     , wxID_CANCEL},
        // Action
        {"open"       , wxID_PRINT},
        {"open"       , wxID_OPEN},
        {"add"        , wxID_ADD},
        {"copy"       , wxID_COPY},
        {"new"        , wxID_NEW},
        {"save"       , wxID_SAVE},
        {"save as"    , wxID_SAVEAS},
        {"refresh"    , wxID_REFRESH},
        {"retry"      , wxID_RETRY},
        {"ignore"     , wxID_IGNORE},
        {"help"       , wxID_HELP},
        {"clone"      , wxID_DUPLICATE},
        {"duplicate"  , wxID_DUPLICATE},
        {"select all" , wxID_SELECTALL},
        {"replace"    , wxID_REPLACE},
        {"replace all", wxID_REPLACE_ALL},
        // Navigation
        {"return"     , wxID_BACKWARD}, // use return instead back. back mostly used as side of object in translations
        {"next"       , wxID_FORWARD},
        // Alert / Negative
        {"remove"     , wxID_REMOVE},
        {"delete"     , wxID_DELETE},
        {"abort"      , wxID_ABORT},
        {"stop"       , wxID_STOP},
        {"reset"      , wxID_RESET},
        {"clear"      , wxID_CLEAR},
        {"exit"       , wxID_EXIT},
        {"quit"       , wxID_EXIT}
    };

Referenced by DialogButtons().

---

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

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