QcKeyBindings Class

Member Function Documentation

std::optional<QcKeyBindings::Action> QcKeyBindings::actionFor(int key) const

Returns the first action (in table order) bound to key.

std::optional<QcKeyBindings::Action> QcKeyBindings::actionForPress(int key, Qt::KeyboardModifiers modifiers) const

Returns the action of a press of key with modifiers. On a Mac a press with Cmd (Qt::ControlModifier) triggers nothing, so Cmd+Q, Cmd+H, Cmd+W … keep their system meaning; Option and Control do.

[static] std::optional<QcKeyBindings::Action> QcKeyBindings::actionFromId(const QString &id)

Returns the action with the id id; std::nullopt for unknown ids.

[static] const QList<QcKeyBindings::Action> &QcKeyBindings::actions()

Returns every action in table order.

std::optional<QcKeyBindings::Displaced> QcKeyBindings::bind(QcKeyBindings::Action action, int slot, int key)

Binds key (0 clears) to slot of action. A key used elsewhere is swapped: the other action gets the key this slot had before, so no key ends up with two actions. Returns that change, if any. Fixed actions and keys that are not bindable are refused (std::nullopt, nothing changes).

QList<std::pair<QcKeyBindings::Action, int>> QcKeyBindings::conflicts() const

Returns the pairs of (action, slot) that share a key with an earlier one; empty for a consistent table.

[static] QcKeyBindings::Platform QcKeyBindings::currentPlatform()

Returns the platform of the running program.

[static] QcKeyBindings QcKeyBindings::defaults(QcKeyBindings::Platform platform = currentPlatform())

Returns the default table for platform.

QList<std::pair<QcKeyBindings::Action, int>> QcKeyBindings::dropConflicts(const QList<std::pair<QcKeyBindings::Action, int>> &preferred = {})

Removes keys used twice. A key stays with the first of the preferred slots that holds it (loading: the slots the player set himself beat defaults that came later), otherwise with the first action in table order. Returns the slots that lost their key.

[static] QString QcKeyBindings::id(QcKeyBindings::Action action)

Returns the stable id of action used in the settings file and placeholders, e.g. "cameraView", "hotbar1".

[static] bool QcKeyBindings::isBindable(int key, QcKeyBindings::Platform platform)

Returns whether a player may bind key on platform: not Esc, not Backspace (clears), not "unknown", not Cmd on a Mac.

[static] bool QcKeyBindings::isFixed(QcKeyBindings::Action action)

Returns whether action cannot be rebound (the pause key).

[static] bool QcKeyBindings::isFunctionKey(int key)

Returns whether key is one of the function keys F1 to F35.

int QcKeyBindings::key(QcKeyBindings::Action action, int slot) const

Returns the key in slot of action; 0 for none.

See also setKey().

[static] std::optional<int> QcKeyBindings::keyFromName(const QString &name)

Returns the key named name, the inverse of keyName(); std::nullopt for unknown names. "" gives 0 (no key).

[static] QString QcKeyBindings::keyName(int key)

Returns the portable name of key; empty for 0 or keys without a name.

QList<int> QcKeyBindings::keys(QcKeyBindings::Action action) const

Returns both keys of action, primary first, without empty slots.

bool QcKeyBindings::matches(QcKeyBindings::Action action, int key) const

Returns whether key is one of the keys of action.

QMap<QString, QStringList> QcKeyBindings::placeholderKeys() const

Returns the values for handbook placeholders: "key.<id>" lists all keys of an action, "key1.<id>" only the primary key, both as key names; on a Mac the modifiers are "MacCmd", "MacControl" and "MacOption", so the handbook names them like the keyboard, and a function key that comes first is "fn+F11" (no letter key before it; a Mac needs fn for it). "key.stackModifier" names the modifier of stackModifier().

QcKeyBindings::Platform QcKeyBindings::platform() const

Returns the platform the table was made for.

void QcKeyBindings::setKey(QcKeyBindings::Action action, int slot, int key)

Sets slot of action to key as it is, without resolving conflicts (loading; see dropConflicts()). Fixed actions and unbindable keys are ignored.

See also key().

[static] Qt::KeyboardModifier QcKeyBindings::stackModifier(QcKeyBindings::Platform platform)

Returns the modifier that makes the drop key throw the whole stack on platform: Ctrl, on a Mac Control (Cmd+Q quits there).