ShortcutsSettings Class Reference

#include <shortcuts_settings.h>

Inheritance diagram for ShortcutsSettings:

Collaboration diagram for ShortcutsSettings:

Signals
void	shortCutChanged ()

Public Member Functions
	ShortcutsSettings (const QString &settingsFilePath, QObject *parent=nullptr)
ShortcutKey	getDefaultShortcut (const QString &name) const
ShortcutKey	getShortcut (const QString &name) const
QKeySequence	getSingleShortcut (const QString &name) const
QString	getDefaultShortcutString (const QString &name) const
QString	getShortcutString (const QString &name) const
QString	getShortcutFriendlyName (const QString &shortcutName) const
QList< QString >	getAllShortcutKeys () const
void	setShortcuts (const QString &name, const QList< QKeySequence > &Sequence)
void	setShortcuts (const QString &name, const QKeySequence &Sequence)
void	setShortcuts (const QString &name, const QString &sequences)
bool	isKeyAllowed (const QString &name, const QString &sequences) const
bool	isValid (const QString &name, const QString &sequences) const
QStringList	findOverlaps (const QString &name, const QString &sequences) const
void	resetAllShortcuts ()
void	clearAllShortcuts ()
void	migrateShortcuts ()
	Migrates legacy shortcut key names to current naming scheme.

Private Member Functions
QString	stringifySequence (const QList< QKeySequence > &Sequence) const
QList< QKeySequence >	parseSequenceString (const QString &stringSequence) const

Private Attributes
const QChar	sep = ';'
const QString	custom = "Custom"
QString	settingsFilePath
QHash< QString, ShortcutKey >	shortCuts
const QHash< QString, ShortcutKey >	defaultShortCuts

Constructor & Destructor Documentation

ShortcutsSettings()

ShortcutsSettings::ShortcutsSettings ( const QString & settingsFilePath, QObject * parent = nullptr )

explicit

Here is the call graph for this function:

Here is the caller graph for this function:

Member Function Documentation

clearAllShortcuts()

void ShortcutsSettings::clearAllShortcuts

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

findOverlaps()

QStringList ShortcutsSettings::findOverlaps ( const QString & name, const QString & sequences ) const

nodiscard

Here is the call graph for this function:

Here is the caller graph for this function:

getAllShortcutKeys()

QList< QString > ShortcutsSettings::getAllShortcutKeys ( ) const

inlinenodiscard

getDefaultShortcut()

ShortcutKey ShortcutsSettings::getDefaultShortcut ( const QString & name ) const

nodiscard

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultShortcutString()

QString ShortcutsSettings::getDefaultShortcutString ( const QString & name ) const

nodiscard

Here is the call graph for this function:

getShortcut()

ShortcutKey ShortcutsSettings::getShortcut ( const QString & name ) const

nodiscard

Here is the call graph for this function:

Here is the caller graph for this function:

getShortcutFriendlyName()

QString ShortcutsSettings::getShortcutFriendlyName ( const QString & shortcutName ) const

nodiscard

Here is the caller graph for this function:

getShortcutString()

QString ShortcutsSettings::getShortcutString ( const QString & name ) const

nodiscard

Here is the call graph for this function:

Here is the caller graph for this function:

getSingleShortcut()

QKeySequence ShortcutsSettings::getSingleShortcut ( const QString & name ) const

nodiscard

Gets the first shortcut for the given action.

NOTE: In most cases you should be using ShortcutsSettings::getShortcut instead, as that will return all shortcuts if there are multiple shortcuts. The only reason to use this method is if an object does not accept multiple shortcuts, such as with QButtons.

Here is the call graph for this function:

Here is the caller graph for this function:

isKeyAllowed()

bool ShortcutsSettings::isKeyAllowed ( const QString & name, const QString & sequences ) const

nodiscard

Here is the caller graph for this function:

isValid()

bool ShortcutsSettings::isValid ( const QString & name, const QString & sequences ) const

nodiscard

Checks that the shortcut doesn't overlap with an existing shortcut

Parameters

name	The name of the shortcut
sequences	The shortcut key sequence

Returns

Whether the shortcut is valid.

Here is the call graph for this function:

migrateShortcuts()

void ShortcutsSettings::migrateShortcuts

(

)

Migrates legacy shortcut key names to current naming scheme.

PR 5079 changed Textbox/unfocusTextBox to Player/unfocusTextBox and tab_game/aFocusChat to Player/aFocusChat. This migration allows players to keep their already configured shortcuts.

Here is the call graph for this function:

Here is the caller graph for this function:

parseSequenceString()

QList< QKeySequence > ShortcutsSettings::parseSequenceString ( const QString & stringSequence ) const

nodiscardprivate

Here is the caller graph for this function:

resetAllShortcuts()

void ShortcutsSettings::resetAllShortcuts

(

)

Here is the call graph for this function:

Here is the caller graph for this function:

setShortcuts() [1/3]

void ShortcutsSettings::setShortcuts	(	const QString &	name,
		const QKeySequence &	Sequence )

Here is the call graph for this function:

setShortcuts() [2/3]

void ShortcutsSettings::setShortcuts	(	const QString &	name,
		const QList< QKeySequence > &	Sequence )

Here is the call graph for this function:

Here is the caller graph for this function:

setShortcuts() [3/3]

void ShortcutsSettings::setShortcuts	(	const QString &	name,
		const QString &	sequences )

Here is the call graph for this function:

shortCutChanged

void ShortcutsSettings::shortCutChanged ( )

signal

Here is the caller graph for this function:

stringifySequence()

QString ShortcutsSettings::stringifySequence ( const QList< QKeySequence > & Sequence ) const

nodiscardprivate

Here is the caller graph for this function:

Member Data Documentation

custom

const QString ShortcutsSettings::custom = "Custom"

private

defaultShortCuts

const QHash<QString, ShortcutKey> ShortcutsSettings::defaultShortCuts

private

sep

const QChar ShortcutsSettings::sep = ';'

private

settingsFilePath

QString ShortcutsSettings::settingsFilePath

private

shortCuts

QHash<QString, ShortcutKey> ShortcutsSettings::shortCuts

private

---

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

• cockatrice/src/client/settings/shortcuts_settings.h
• cockatrice/src/client/settings/shortcuts_settings.cpp