Slic3r::GUI::KeyChord Struct Reference

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

Public Member Functions
bool	valid () const
bool	operator== (const KeyChord &other) const
bool	operator!= (const KeyChord &other) const
bool	is_punctuation () const
bool	needs_char_event () const
bool	is_menu_accelerator () const
bool	edits_text () const
bool	is_system_shortcut () const
std::string	to_string () const
std::string	display () const
std::vector< std::string >	display_parts () const
wxAcceleratorEntry	to_accelerator_entry (int command) const

Static Public Member Functions
static std::optional< KeyChord >	parse (const std::string &text)
static std::string	modifier_prefix (int modifier)
static std::string	modifier_name (int modifier)
static KeyChord	from_event (const wxKeyEvent &evt)

Public Attributes
int	key = WXK_NONE
int	modifiers = wxMOD_NONE

Detailed Description

Member Function Documentation

display()

std::string Slic3r::GUI::KeyChord::display

(

)

const

{
    std::string out;
    for (const std::string& part : display_parts())
        out += (out.empty() ? "" : "+") + part;
    return out;
}

References display_parts().

Referenced by Slic3r::GUI::ShortcutRegistry::display().

Here is the call graph for this function:

Here is the caller graph for this function:

display_parts()

std::vector< std::string > Slic3r::GUI::KeyChord::display_parts

(

)

const

{
    std::vector<std::string> parts;
    if (!valid())
        return parts;
    for (int modifier : MODIFIER_ORDER)
        if (modifiers & modifier)
            parts.push_back(modifier_name(modifier));
    parts.push_back(is_printable(key) ? std::string(1, char(key)) : special_key_label(key));
    return parts;
}

References key, modifier_name(), modifiers, and valid().

Referenced by Slic3r::GUI::KBShortcutsDialog::apply_bindings(), display(), and Slic3r::GUI::KBShortcutsDialog::edit_shortcut().

Here is the call graph for this function:

Here is the caller graph for this function:

edits_text()

bool Slic3r::GUI::KeyChord::edits_text

(

)

const

{
    if (!valid())
        return false;
    if (!is_menu_accelerator())
        return true;
    const int mods = modifiers & ~wxMOD_SHIFT;
    switch (key) {
    case WXK_LEFT: case WXK_RIGHT: case WXK_UP: case WXK_DOWN:
    case WXK_HOME: case WXK_END: case WXK_BACK: case WXK_DELETE:
#ifdef __APPLE__
        return mods == wxMOD_NONE || mods == wxMOD_CONTROL || mods == wxMOD_ALT; // Option moves by word
#else
        return mods == wxMOD_NONE || mods == wxMOD_CONTROL;
#endif
    case WXK_INSERT:
        return mods == wxMOD_NONE || mods == wxMOD_CONTROL;
    case WXK_RETURN: case WXK_TAB: case WXK_ESCAPE: case WXK_PAGEUP: case WXK_PAGEDOWN:
        return mods == wxMOD_NONE;
    default:
        break;
    }
    if (!is_printable(key))
        return false;
#ifdef __APPLE__
    if (mods == wxMOD_ALT || mods == wxMOD_RAW_CONTROL)
        return true; // Option types a character, Control runs the Cocoa text key bindings
#else
    if (mods == (wxMOD_CONTROL | wxMOD_ALT))
        return true; // AltGr types a character
#endif
    return mods == wxMOD_CONTROL && (key == 'A' || key == 'C' || key == 'V' || key == 'X' || key == 'Y' || key == 'Z');
}

References is_menu_accelerator(), key, modifiers, and valid().

Referenced by Slic3r::GUI::MainFrame::handle_global_shortcut(), and Slic3r::GUI::ImGuiWrapper::owns_key().

Here is the call graph for this function:

Here is the caller graph for this function:

from_event()

KeyChord Slic3r::GUI::KeyChord::from_event ( const wxKeyEvent & evt )

static

{
    KeyChord chord;
    chord.modifiers = evt.GetModifiers() & BINDABLE_MODIFIERS;
    int key = fold_numpad(evt.GetKeyCode());
 
    if (evt.GetEventType() == wxEVT_CHAR) {
        if (key >= 1 && key <= 26 && evt.ControlDown())
            key = 'A' + key - 1;   // Ctrl+letter arrives as the control character
        else if (is_symbol(key))
            chord.modifiers &= ~wxMOD_SHIFT;   // the character already reflects Shift
    }
    if (key >= 'a' && key <= 'z')
        key -= 'a' - 'A';
 
    if (is_printable(key) || is_special(key))
        chord.key = key;
    return chord;
}

References key, and modifiers.

Referenced by Slic3r::GUI::ObjectList::key_event(), Slic3r::GUI::GLCanvas3D::on_char(), Slic3r::GUI::ShortcutCaptureDialog::on_char(), Slic3r::GUI::GLCanvas3D::on_key(), Slic3r::GUI::GLGizmosManager::on_key(), and Slic3r::GUI::ShortcutCaptureDialog::on_key().

Here is the caller graph for this function:

is_menu_accelerator()

bool Slic3r::GUI::KeyChord::is_menu_accelerator

(

)

const

{
    return valid() && ((modifiers & (wxMOD_CONTROL | wxMOD_ALT | wxMOD_RAW_CONTROL)) != 0 || (!is_printable(key) && key != WXK_SPACE));
}

References key, modifiers, and valid().

Referenced by Slic3r::GUI::ShortcutRegistry::accelerator(), and edits_text().

Here is the call graph for this function:

Here is the caller graph for this function:

is_punctuation()

bool Slic3r::GUI::KeyChord::is_punctuation

(

)

const

{ return is_symbol(key) && modifiers == wxMOD_NONE; }

References key, and modifiers.

is_system_shortcut()

bool Slic3r::GUI::KeyChord::is_system_shortcut

(

)

const

{
#ifdef _WIN32
    return modifiers == wxMOD_ALT && (key == WXK_F4 || key == WXK_SPACE);
#else
    return false;
#endif
}

References key, and modifiers.

modifier_name()

std::string Slic3r::GUI::KeyChord::modifier_name ( int modifier )

static

{
    std::string name = modifier_prefix(modifier);
    if (!name.empty() && name.back() == '+')
        name.pop_back();
    while (!name.empty() && name.back() == ' ')
        name.pop_back();
    return name;
}

References modifier_prefix().

Referenced by display_parts(), Slic3r::GUI::KBShortcutsDialog::fill_pages(), and Slic3r::GUI::anonymous_namespace{KBShortcutsDialog.cpp}::global_key_advice().

Here is the call graph for this function:

Here is the caller graph for this function:

modifier_prefix()

std::string Slic3r::GUI::KeyChord::modifier_prefix ( int modifier )

static

{
    if (modifier == wxMOD_CONTROL)
        return shortkey_ctrl_prefix();
    if (modifier == wxMOD_SHIFT)
        return _u8L("Shift+");
    if (modifier == wxMOD_ALT)
        return shortkey_alt_prefix();
#ifdef __APPLE__
    if (modifier == wxMOD_RAW_CONTROL)
        return u8"⌃+";
#endif
    return {};
}

References _u8L, Slic3r::GUI::shortkey_alt_prefix(), and Slic3r::GUI::shortkey_ctrl_prefix().

Referenced by modifier_name().

Here is the call graph for this function:

Here is the caller graph for this function:

needs_char_event()

bool Slic3r::GUI::KeyChord::needs_char_event

(

)

const

{ return is_symbol(key) && (modifiers & ~wxMOD_SHIFT) == 0; }

References key, and modifiers.

operator!=()

bool Slic3r::GUI::KeyChord::operator!= ( const KeyChord & other ) const

inline

{ return !(*this == other); }

operator==()

bool Slic3r::GUI::KeyChord::operator== ( const KeyChord & other ) const

inline

{ return key == other.key && modifiers == other.modifiers; }

References key, and modifiers.

parse()

std::optional< KeyChord > Slic3r::GUI::KeyChord::parse ( const std::string & text )

static

{
    if (text.empty())
        return std::nullopt;
 
    // The key is whatever follows the last separator; a trailing '+' is the '+' key itself.
    size_t      key_start = text.size() - 1;
    if (text.back() != '+') {
        const size_t sep = text.rfind('+');
        key_start = sep == std::string::npos ? 0 : sep + 1;
    }
    KeyChord chord;
    chord.key = parse_key(text.substr(key_start));
    if (chord.key == WXK_NONE)
        return std::nullopt;
 
    const std::string prefix = key_start == 0 ? std::string() : text.substr(0, key_start - 1);
    size_t begin = 0;
    while (begin < prefix.size()) {
        size_t end = prefix.find('+', begin);
        if (end == std::string::npos)
            end = prefix.size();
        const int modifier = parse_modifier(prefix.substr(begin, end - begin));
        if (modifier == wxMOD_NONE)
            return std::nullopt;
        chord.modifiers |= modifier;
        begin = end + 1;
    }
    if (is_letter(chord.key) || is_digit(chord.key) || !is_printable(chord.key) || chord.modifiers == wxMOD_NONE)
        return chord;
    // Shift is folded into the character for punctuation, so "Shift+/" is not accepted.
    return (chord.modifiers & wxMOD_SHIFT) ? std::nullopt : std::optional<KeyChord>(chord);
}

References key, modifiers, and Slic3r::GUI::sep.

Referenced by Slic3r::GUI::ShortcutRegistry::load().

Here is the caller graph for this function:

to_accelerator_entry()

wxAcceleratorEntry Slic3r::GUI::KeyChord::to_accelerator_entry

(

int

command

)

const

{
    int flags = wxACCEL_NORMAL;
    if (modifiers & wxMOD_CONTROL)
        flags |= wxACCEL_CTRL;
    if (modifiers & wxMOD_SHIFT)
        flags |= wxACCEL_SHIFT;
    if (modifiers & wxMOD_ALT)
        flags |= wxACCEL_ALT;
#ifdef __APPLE__
    if (modifiers & wxMOD_RAW_CONTROL)
        flags |= wxACCEL_RAW_CTRL;
#endif
    return wxAcceleratorEntry(flags, key, command);
}

References key, and modifiers.

to_string()

std::string Slic3r::GUI::KeyChord::to_string

(

)

const

{
    if (!valid())
        return {};
    std::string out = join_modifiers(modifiers, canonical_modifier_prefix);
    if (is_printable(key))
        out += char(key);
    else
        out += special_key_name(key);
    return out;
}

References key, modifiers, and valid().

Referenced by Slic3r::GUI::ShortcutRegistry::accelerator().

Here is the call graph for this function:

Here is the caller graph for this function:

valid()

bool Slic3r::GUI::KeyChord::valid ( ) const

inline

{ return key != WXK_NONE; }

References key.

Referenced by Slic3r::GUI::ShortcutRegistry::conflicts(), display_parts(), edits_text(), is_menu_accelerator(), Slic3r::GUI::ShortcutRegistry::lookup(), Slic3r::GUI::ShortcutRegistry::rebuild_index(), Slic3r::GUI::anonymous_namespace{Shortcuts.cpp}::step_modifiers(), and to_string().

Here is the caller graph for this function:

Member Data Documentation

key

int Slic3r::GUI::KeyChord::key = WXK_NONE

Referenced by display_parts(), edits_text(), from_event(), is_menu_accelerator(), is_punctuation(), is_system_shortcut(), needs_char_event(), Slic3r::GUI::KeyChordHash::operator()(), operator==(), parse(), Slic3r::GUI::anonymous_namespace{Shortcuts.cpp}::step_modifiers(), to_accelerator_entry(), to_string(), and valid().

modifiers

int Slic3r::GUI::KeyChord::modifiers = wxMOD_NONE

Referenced by display_parts(), edits_text(), from_event(), is_menu_accelerator(), is_punctuation(), is_system_shortcut(), Slic3r::GUI::ShortcutRegistry::match(), needs_char_event(), Slic3r::GUI::KeyChordHash::operator()(), operator==(), parse(), Slic3r::GUI::anonymous_namespace{Shortcuts.cpp}::step_modifiers(), to_accelerator_entry(), and to_string().

---

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

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