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

Inheritance diagram for Slic3r::GUI::ShortcutCaptureDialog:

Collaboration diagram for Slic3r::GUI::ShortcutCaptureDialog:

Public Member Functions
	ShortcutCaptureDialog (wxWindow *parent, Shortcut shortcut)
const KeyChord &	chord () const
const std::vector< Shortcut > &	conflicts () const
void	EndModal (int retCode) override
float	scale_factor () const
float	prev_scale_factor () const
void	set_scale_factor (float v)
void	set_prev_scale_factor (float v)
void	set_em_unit (int v)
bool	force_rescale () const
int	em_unit () const
const wxFont &	normal_font () const
void	enable_force_rescale ()
int	ShowModal ()

Protected Member Functions
void	on_dpi_changed (const wxRect &suggested_rect) override
virtual void	on_sys_color_changed ()

Private Member Functions
void	on_key (wxKeyEvent &evt)
void	on_char (wxKeyEvent &evt)
void	record (const KeyChord &chord)
void	update_em_unit ()
bool	is_new_scale_factor () const
void	rescale (const wxRect &suggested_rect)

Private Attributes
Shortcut	m_shortcut
KeyChord	m_chord
std::vector< Shortcut >	m_conflicts
wxStaticText *	m_chord_label
wxString	m_hint
wxString	m_rejection
Label *	m_status
wxColour	m_status_colour
Button *	m_ok
float	m_scale_factor
int	m_em_unit
wxFont	m_normal_font
float	m_prev_scale_factor
bool	m_can_rescale
bool	m_force_rescale
int	m_new_font_point_size

Detailed Description

Constructor & Destructor Documentation

◆ ShortcutCaptureDialog()

Slic3r::GUI::ShortcutCaptureDialog::ShortcutCaptureDialog	(	wxWindow *	parent,
		Shortcut	shortcut )

    : DPIDialog(parent, wxID_ANY, _(shortcut_info(shortcut).name), wxDefaultPosition, wxDefaultSize, wxDEFAULT_DIALOG_STYLE)
    , m_shortcut(shortcut)
{
    SetBackgroundColour(*wxWHITE);
    wxBoxSizer* sizer = new wxBoxSizer(wxVERTICAL);
 
    // A Global shortcut runs before the focused control gets the key, so its hint names the keys it can use.
    const bool     global = (shortcut_info(shortcut).contexts & context_bit(ShortcutContext::Global)) != 0;
    const wxString advice = global_key_advice();
    const wxString rule   = _L("A key that types a character cannot be a global shortcut.");
    m_hint      = global ? advice : _L("Esc cancels, Enter confirms.");
    m_rejection = rule + "\n" + advice;
 
    // Wide enough for each sentence on a line of its own where the translation allows, within limits.
    int width = FromDIP(450);
    for (const wxString& sentence : { rule, advice }) {
        int extent = 0;
        GetTextExtent(sentence, &extent, nullptr, nullptr, nullptr, &wxGetApp().normal_font());
        width = std::max(width, extent);
    }
    width = std::min(width, FromDIP(550));
 
    auto prompt = new Label(this, wxGetApp().normal_font(), wxString::Format(_L("Press the new shortcut for\n\"%s\""), _(shortcut_info(shortcut).name)), LB_AUTO_WRAP);
    prompt->SetMinSize(wxSize(width, -1));
    sizer->Add(prompt, 0, wxALL, FromDIP(20));
 
    // Keyboard focus stays on this box so the buttons never receive the key presses.
    const wxColour box_colour = StateColor::darkModeColorFor(*wxWHITE);
    StaticBox* capture = new StaticBox(this, wxID_ANY, wxDefaultPosition, wxSize(width, FromDIP(60)), wxWANTS_CHARS);
    capture->SetCornerRadius(FromDIP(4));
    capture->SetBorderColorNormal(StateColor::darkModeColorFor(wxColour("#009688")));   // the focused-input colour, since the box always has the focus
    capture->SetBackgroundColorNormal(box_colour);
    capture->SetBackgroundColour(box_colour);
    wxBoxSizer* capture_sizer = new wxBoxSizer(wxVERTICAL);
    m_chord_label = new wxStaticText(capture, wxID_ANY, join_keys(to_wx(wxGetApp().shortcuts().binding(shortcut).display_parts())));
    m_chord_label->SetFont(::Label::Head_14);
    m_chord_label->SetBackgroundColour(box_colour);
    capture_sizer->AddStretchSpacer();
    capture_sizer->Add(m_chord_label, 0, wxALIGN_CENTER);
    capture_sizer->AddStretchSpacer();
    capture->SetSizer(capture_sizer);
    capture->Layout();   // the box is created at its final size, so nothing resizes it into laying the sizer out
    // The hook runs before the window procedure, so Windows does not open its window menu
    // over the dialog on Alt+Space.
    Bind(wxEVT_CHAR_HOOK, &ShortcutCaptureDialog::on_key, this);
    capture->Bind(wxEVT_CHAR, &ShortcutCaptureDialog::on_char, this);
    capture->Bind(wxEVT_LEFT_DOWN, [capture](wxMouseEvent&) { capture->SetFocus(); });
    sizer->Add(capture, 0, wxLEFT | wxRIGHT | wxEXPAND, FromDIP(20));
 
    m_status = new Label(this, wxGetApp().normal_font(), m_hint, LB_AUTO_WRAP);
    m_status->SetMinSize(wxSize(width, 3 * m_status->GetCharHeight()));   // room for three lines, so the dialog keeps its size while keys are tried
    m_status_colour = m_status->GetForegroundColour();
    sizer->Add(m_status, 0, wxLEFT | wxRIGHT | wxTOP, FromDIP(20));
 
    auto dlg_btns = new DialogButtons(this, {L("Unbind"), "OK", "Cancel"}, "", 1 /*left_aligned*/);
    dlg_btns->GetFIRST()->Bind(wxEVT_BUTTON, [this](wxCommandEvent&) {
        m_chord = KeyChord{};
        m_conflicts.clear();
        EndModal(wxID_OK);
    });
    dlg_btns->GetCANCEL()->Bind(wxEVT_BUTTON, [this](wxCommandEvent&) { EndModal(wxID_CANCEL); });
    m_ok = dlg_btns->GetOK();
    m_ok->Bind(wxEVT_BUTTON, [this](wxCommandEvent&) { EndModal(wxID_OK); });
    m_ok->Enable(false);
    sizer->Add(dlg_btns, 0, wxEXPAND | wxTOP, FromDIP(10));
 
    SetSizerAndFit(sizer);
    CenterOnParent();
    wxGetApp().UpdateDlgDarkUI(this);
    capture->CallAfter([capture]() { capture->SetFocus(); });
}

References _, _L, Slic3r::GUI::context_bit(), Slic3r::GUI::ShortcutInfo::contexts, StateColor::darkModeColorFor(), Slic3r::GUI::DPIDialog::EndModal(), Slic3r::GUI::DialogButtons::GetFIRST(), Slic3r::GUI::Global, Label::Head_14, L, LB_AUTO_WRAP, m_chord, m_chord_label, m_conflicts, m_hint, m_ok, m_rejection, m_shortcut, m_status, m_status_colour, Slic3r::GUI::DPIAware< wxDialog >::normal_font(), on_char(), on_key(), StaticBox::SetBackgroundColorNormal(), StaticBox::SetBorderColorNormal(), StaticBox::SetCornerRadius(), Slic3r::GUI::shortcut_info(), Slic3r::GUI::wxMouseEvent, and wxStaticText.

Here is the call graph for this function:

Member Function Documentation

◆ chord()

const KeyChord & Slic3r::GUI::ShortcutCaptureDialog::chord ( ) const

inline

115{ return m_chord; }

References m_chord.

Referenced by Slic3r::GUI::KBShortcutsDialog::edit_shortcut(), on_char(), on_key(), and record().

Here is the caller graph for this function:

◆ conflicts()

const std::vector< Shortcut > & Slic3r::GUI::ShortcutCaptureDialog::conflicts ( ) const

inline

116{ return m_conflicts; }

References m_conflicts.

Referenced by Slic3r::GUI::KBShortcutsDialog::edit_shortcut().

Here is the caller graph for this function:

◆ em_unit()

int Slic3r::GUI::DPIAware< wxDialog >::em_unit ( ) const

inlineinherited

203{ return m_em_unit; }

Slic3r::GUI::DPIAware

Definition GUI_Utils.hpp:107

Here is the caller graph for this function:

◆ enable_force_rescale()

void Slic3r::GUI::DPIAware< wxDialog >::enable_force_rescale ( )

inlineinherited

206{ m_force_rescale = true; }

◆ EndModal()

void Slic3r::GUI::DPIDialog::EndModal ( int retCode )

inlineoverrideinherited

    {
        if (!dialogStack.empty() && dialogStack.front() != this) {
            // This is a bug in wxWidgets
            // when the dialog is not top modal dialog, EndModal() just hide dialog without quit 
            // the modal event loop. And the modal event loop blocks us from bottom widgets.
            // Solution: let user click it manually or close outside. FIXME
            BOOST_LOG_TRIVIAL(warning) << "DPIAware::EndModal Error: dialogStack is not empty, but top dialog is not this one. retCode=" << retCode;
            return;
        }
 
        return wxDialog::EndModal(retCode);
    }

References Slic3r::GUI::dialogStack.

◆ force_rescale()

bool Slic3r::GUI::DPIAware< wxDialog >::force_rescale ( ) const

inlineinherited

201{ return m_force_rescale; }

◆ is_new_scale_factor()

bool Slic3r::GUI::DPIAware< wxDialog >::is_new_scale_factor ( ) const

inlineprivateinherited

262{ return fabs(m_scale_factor - m_prev_scale_factor) > 0.001; }

◆ normal_font()

const wxFont & Slic3r::GUI::DPIAware< wxDialog >::normal_font ( ) const

inlineinherited

205{ return m_normal_font; }

Here is the caller graph for this function:

◆ on_char()

void Slic3r::GUI::ShortcutCaptureDialog::on_char ( wxKeyEvent & evt )

private

{
    const KeyChord chord = KeyChord::from_event(evt);
    if (chord.is_punctuation())
        record(chord);
}

References chord(), Slic3r::GUI::KeyChord::from_event(), and record().

Referenced by ShortcutCaptureDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ on_dpi_changed()

void Slic3r::GUI::ShortcutCaptureDialog::on_dpi_changed ( const wxRect & suggested_rect )

overrideprotectedvirtual

Implements Slic3r::GUI::DPIAware< wxDialog >.

{
    Layout();
    Fit();
}

◆ on_key()

void Slic3r::GUI::ShortcutCaptureDialog::on_key ( wxKeyEvent & evt )

private

{
    if (!evt.HasAnyModifiers()) {
        if (evt.GetKeyCode() == WXK_ESCAPE) {
            EndModal(wxID_CANCEL);
            return;
        }
        if (evt.GetKeyCode() == WXK_RETURN || evt.GetKeyCode() == WXK_NUMPAD_ENTER) {
            if (m_ok->IsEnabled())
                EndModal(wxID_OK);
            return;
        }
    }
    const KeyChord chord = KeyChord::from_event(evt);
    if (!chord.valid())
        return;
    if (chord.needs_char_event()) {
        evt.Skip();
        return;
    }
    record(chord);
}

References chord(), Slic3r::GUI::DPIDialog::EndModal(), Slic3r::GUI::KeyChord::from_event(), m_ok, and record().

Referenced by ShortcutCaptureDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ on_sys_color_changed()

virtual void Slic3r::GUI::DPIAware< wxDialog >::on_sys_color_changed ( )

inlineprotectedvirtualinherited

Reimplemented in PrintHostQueueDialog, Slic3r::GUI::ColorPickerDialog, Slic3r::GUI::ConfigWizard, Slic3r::GUI::DesignTextDialog, Slic3r::GUI::DiffPresetDialog, Slic3r::GUI::EditGCodeDialog, Slic3r::GUI::MultiMachinePickPage, Slic3r::GUI::ObjectTableDialog, Slic3r::GUI::PhysicalPrinterDialog, Slic3r::GUI::PrintHostQueueDialog, Slic3r::GUI::PublishSettingsDialog, Slic3r::GUI::SavePresetDialog, Slic3r::GUI::SendMultiMachinePage, and Slic3r::GUI::UnsavedChangesDialog.

226{};

◆ prev_scale_factor()

float Slic3r::GUI::DPIAware< wxDialog >::prev_scale_factor ( ) const

inlineinherited

196{ return m_prev_scale_factor; }

◆ record()

void Slic3r::GUI::ShortcutCaptureDialog::record ( const KeyChord & chord )

private

{
    m_chord = chord;
    m_chord_label->SetLabel(join_keys(to_wx(chord.display_parts())));
    m_chord_label->GetParent()->Layout();
 
    auto reject = [this](const wxString& reason) {
        m_status->SetForegroundColour(ERROR_COLOUR);
        m_status->SetLabel(reason);
        m_conflicts.clear();
        m_ok->Enable(false);
    };
    const bool global = (shortcut_info(m_shortcut).contexts & context_bit(ShortcutContext::Global)) != 0;
    if (chord.is_system_shortcut()) {
        reject(_L("The system uses this shortcut, so it cannot be assigned."));
    } else if (global && !chord.is_menu_accelerator()) {
        reject(m_rejection);
    } else if (const std::optional<Shortcut> owner = wxGetApp().shortcuts().step_owner(m_shortcut, chord); owner.has_value()) {
        reject(wxString::Format(_L("Shift and Ctrl with this key belong to %s and cannot be assigned."), _(shortcut_info(*owner).name)));
    } else {
        m_conflicts = wxGetApp().shortcuts().conflicts(m_shortcut, chord);
        m_status->SetForegroundColour(m_status_colour);
        if (m_conflicts.empty())
            m_status->SetLabel(m_hint);
        else
            m_status->SetLabel(wxString::Format(_L("Already assigned to %s. Press OK to reassign it."), shortcut_names(m_conflicts)));
        m_ok->Enable(true);
    }
    m_status->Refresh();   // a colour change alone does not repaint
    Layout();
    Fit();
}

References _, _L, chord(), Slic3r::GUI::context_bit(), Slic3r::GUI::ShortcutInfo::contexts, Slic3r::GUI::Global, m_chord, m_chord_label, m_conflicts, m_hint, m_ok, m_rejection, m_shortcut, m_status, m_status_colour, Slic3r::GUI::ShortcutInfo::name, and Slic3r::GUI::shortcut_info().

Referenced by on_char(), and on_key().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rescale()

void Slic3r::GUI::DPIAware< wxDialog >::rescale ( const wxRect & suggested_rect )

inlineprivateinherited

    {
        this->Freeze();
 
        m_force_rescale = false;
 
        // set normal application font as a current window font
        m_normal_font = this->GetFont();
 
        update_em_unit();
 
        // rescale missed controls sizes and images
        on_dpi_changed(suggested_rect);
 
        this->Layout();
        this->Thaw();
 
        // reset previous scale factor from current scale factor value
        m_prev_scale_factor = m_scale_factor;
    }

◆ scale_factor()

float Slic3r::GUI::DPIAware< wxDialog >::scale_factor ( ) const

inlineinherited

195{ return m_scale_factor; }

◆ set_em_unit()

void Slic3r::GUI::DPIAware< wxDialog >::set_em_unit ( int v )

inlineinherited

200{ m_em_unit = v; }

◆ set_prev_scale_factor()

void Slic3r::GUI::DPIAware< wxDialog >::set_prev_scale_factor ( float v )

inlineinherited

199{ m_prev_scale_factor = v; }

◆ set_scale_factor()

void Slic3r::GUI::DPIAware< wxDialog >::set_scale_factor ( float v )

inlineinherited

198{ m_scale_factor = v; }

◆ ShowModal()

int Slic3r::GUI::DPIAware< wxDialog >::ShowModal ( )

inlineinherited

    {
        dialogStack.push_front(this);
        int r = wxDialog::ShowModal();
        dialogStack.pop_front();
        return r;
    }

Referenced by Slic3r::GUI::EditFilamentPresetDialog::delete_preset(), Slic3r::GUI::SingleChoiceDialog::GetSingleChoiceIndex(), Slic3r::GUI::ConfirmBeforeSendDialog::on_show(), Slic3r::GUI::PrivacyUpdateDialog::on_show(), Slic3r::GUI::AMSMaterialsSetting::Popup(), Slic3r::GUI::ExtrusionCalibration::Popup(), Slic3r::GUI::ObjectTableDialog::Popup(), Slic3r::GUI::ConfigWizard::run(), Slic3r::GUI::GuideFrame::run(), Slic3r::GUI::MultiNozzleSyncDialog::ShowModal(), Slic3r::GUI::RichMessageDialog::ShowModal(), Slic3r::GUI::TextureImportDialog::ShowModal(), and Slic3r::GUI::UnsavedChangesDialog::ShowModal().

Here is the caller graph for this function:

◆ update_em_unit()

void Slic3r::GUI::DPIAware< wxDialog >::update_em_unit ( )

inlineprivateinherited

    {
        // Linux specific issue : get_dpi_for_window(this) still doesn't responce to the Display's scale in new wxWidgets(3.1.3).
        // So, calculate the m_em_unit value from the font size, as before
#if !defined(__WXGTK__)
        m_em_unit = std::max<size_t>(10, 10.0f * m_scale_factor);
#else
        // initialize default width_unit according to the width of the one symbol ("m") of the currently active font of this window.
        m_em_unit = std::max<size_t>(10, this->GetTextExtent("m").x - 1);
#endif // __WXGTK__
    }

Member Data Documentation

◆ m_can_rescale

bool Slic3r::GUI::DPIAware< wxDialog >::m_can_rescale

privateinherited

235{ true };

◆ m_chord

KeyChord Slic3r::GUI::ShortcutCaptureDialog::m_chord

private

Referenced by ShortcutCaptureDialog(), chord(), and record().

◆ m_chord_label

wxStaticText* Slic3r::GUI::ShortcutCaptureDialog::m_chord_label

private

Referenced by ShortcutCaptureDialog(), and record().

◆ m_conflicts

◆ m_status_colour

wxColour Slic3r::GUI::ShortcutCaptureDialog::m_status_colour

private

Referenced by ShortcutCaptureDialog(), and record().

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

/home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/KBShortcutsDialog.hpp
/home/runner/work/OrcaSlicer/OrcaSlicer/src/slic3r/GUI/KBShortcutsDialog.cpp

	OrcaSlicer latest OrcaSlicer

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ShortcutCaptureDialog()

Member Function Documentation

◆ chord()

◆ conflicts()

◆ em_unit()

◆ enable_force_rescale()

◆ EndModal()

◆ force_rescale()

◆ is_new_scale_factor()

◆ normal_font()

◆ on_char()

◆ on_dpi_changed()

◆ on_key()

◆ on_sys_color_changed()

◆ prev_scale_factor()

◆ record()

◆ rescale()

◆ scale_factor()

◆ set_em_unit()

◆ set_prev_scale_factor()

◆ set_scale_factor()

◆ ShowModal()

◆ update_em_unit()

Member Data Documentation

◆ m_can_rescale

◆ m_chord

◆ m_chord_label

◆ m_conflicts

◆ m_em_unit

◆ m_force_rescale

◆ m_hint

◆ m_new_font_point_size

◆ m_normal_font

◆ m_ok

◆ m_prev_scale_factor

◆ m_rejection

◆ m_scale_factor

◆ m_shortcut

◆ m_status

◆ m_status_colour