Ms::Shortcut Class Reference

#include <shortcut.h>

Collaboration diagram for Ms::Shortcut:

Public Member Functions
	Shortcut ()
	Shortcut (Ms::MsWidget assignedWidget, int state, const char *key, const char *d=0, const char *txt=0, const char *h=0, Icons i=Icons::Invalid_ICON, Qt::ShortcutContext cont=Qt::WindowShortcut, ShortcutFlags f=ShortcutFlags::NONE)
QAction *	action () const
const QByteArray &	key () const
void	setKey (const QByteArray &key)
QString	descr () const
QString	text () const
QString	help () const
MsWidget	assignedWidget () const
void	clear ()
void	reset ()
	remove shortcuts More...
void	addShortcut (const QKeySequence &)
	reset to buildin More...
int	state () const
void	setState (int v)
bool	needsScore () const
bool	isCmd () const
bool	isCheckable () const
bool	isChecked () const
Icons	icon () const
const QList< QKeySequence > &	keys () const
QKeySequence::StandardKey	standardKey () const
void	setStandardKey (QKeySequence::StandardKey k)
void	setKeys (const QList< QKeySequence > &ks)
void	setKeys (const Shortcut &)
bool	compareKeys (const Shortcut &) const
QString	keysToString () const
void	write (Ms::XmlWriter &) const
void	read (Ms::XmlReader &)

Static Public Member Functions
static QString	getMenuShortcutString (const QMenu *menu)
static void	init ()
static void	retranslate ()
static void	refreshIcons ()
static void	load ()
static void	loadFromNewFile (QString fileLocation)
static void	save ()
static void	saveToNewFile (QString fileLocation)
static void	resetToDefault ()
static bool	customSource ()
static Shortcut *	getShortcutByKeySequence (const QKeySequence &keySequence, const ScoreState state)
static Shortcut *	getShortcut (const char *key)
static const QHash< QByteArray, Shortcut * > &	shortcuts ()
static QActionGroup *	getActionGroupForWidget (MsWidget w)
static QActionGroup *	getActionGroupForWidget (MsWidget w, Qt::ShortcutContext newShortcutContext)
static QString	keySeqToString (const QKeySequence &keySeq, QKeySequence::SequenceFormat fmt, bool escapeKeyStr=false)
static QKeySequence	keySeqFromString (const QString &str, QKeySequence::SequenceFormat fmt)

Static Public Attributes
static constexpr const char *	defaultFileName = ":/data/shortcuts.xml"
static bool	dirty = false

Private Member Functions
void	translateAction (QAction *action) const

Private Attributes
MsWidget	_assignedWidget
int	_state { 0 }
	the widget where the action will be assigned More...
QByteArray	_key
	shortcut is valid in this Mscore state More...
QByteArray	_descr
	xml tag name for configuration file More...
QByteArray	_text
	descriptor, shown in editor More...
QByteArray	_help
	text as shown on buttons or menus More...
Icons	_icon { Icons::Invalid_ICON }
	ballon help (or'd list of states) More...
Qt::ShortcutContext	_context { Qt::WindowShortcut }
ShortcutFlags	_flags { ShortcutFlags::NONE }
QList< QKeySequence >	_keys
QKeySequence::StandardKey	_standardKey { QKeySequence::UnknownKey }
	shortcut list More...
QAction *	_action { 0 }

Static Private Attributes
static QString	source
	cached action More...
static Shortcut	_sc []
static QHash< QByteArray, Shortcut * >	_shortcuts

Constructor & Destructor Documentation

Shortcut() [1/2]

Ms::Shortcut::Shortcut ( )

inline

Shortcut() [2/2]

Ms::Shortcut::Shortcut	(	Ms::MsWidget	assignedWidget,
		int	state,
		const char *	key,
		const char *	d = 0,
		const char *	txt = 0,
		const char *	h = 0,
		Icons	i = Icons::Invalid_ICON,
		Qt::ShortcutContext	cont = Qt::WindowShortcut,
		ShortcutFlags	f = ShortcutFlags::NONE
	)

Member Function Documentation

action()

QAction * Ms::Shortcut::action

(

)

const

addShortcut()

void Ms::Shortcut::addShortcut

(

const QKeySequence &

ks

)

reset to buildin

assignedWidget()

MsWidget Ms::Shortcut::assignedWidget ( ) const

inline

clear()

void Ms::Shortcut::clear

(

void

)

compareKeys()

bool Ms::Shortcut::compareKeys

(

const Shortcut &

sc

)

const

customSource()

static bool Ms::Shortcut::customSource ( )

inlinestatic

descr()

QString Ms::Shortcut::descr

(

)

const

getActionGroupForWidget() [1/2]

QActionGroup * Ms::Shortcut::getActionGroupForWidget ( MsWidget  w )

static

getActionGroupForWidget() [2/2]

QActionGroup * Ms::Shortcut::getActionGroupForWidget ( MsWidget  w, Qt::ShortcutContext  newShortcutContext  )

static

getMenuShortcutString()

QString Ms::Shortcut::getMenuShortcutString ( const QMenu *  menu )

static

getShortcut()

Shortcut * Ms::Shortcut::getShortcut ( const char *  key )

static

getShortcutByKeySequence()

Shortcut * Ms::Shortcut::getShortcutByKeySequence ( const QKeySequence &  keySequence, const ScoreState  state  )

static

help()

QString Ms::Shortcut::help

(

)

const

icon()

Icons Ms::Shortcut::icon ( ) const

inline

init()

void Ms::Shortcut::init ( )

static

isCheckable()

bool Ms::Shortcut::isCheckable ( ) const

inline

isChecked()

bool Ms::Shortcut::isChecked ( ) const

inline

isCmd()

bool Ms::Shortcut::isCmd ( ) const

inline

key()

const QByteArray& Ms::Shortcut::key ( ) const

inline

keys()

const QList<QKeySequence>& Ms::Shortcut::keys ( ) const

inline

keySeqFromString()

QKeySequence Ms::Shortcut::keySeqFromString ( const QString &  str, QKeySequence::SequenceFormat  fmt  )

static

keySeqToString()

QString Ms::Shortcut::keySeqToString ( const QKeySequence &  keySeq, QKeySequence::SequenceFormat  fmt, bool  escapeKeyStr = false  )

static

keysToString()

QString Ms::Shortcut::keysToString

(

)

const

load()

void Ms::Shortcut::load ( void  )

static

loadFromNewFile()

void Ms::Shortcut::loadFromNewFile ( QString  fileLocation )

static

needsScore()

bool Ms::Shortcut::needsScore ( ) const

inline

read()

void Ms::Shortcut::read

(

Ms::XmlReader &

e

)

refreshIcons()

void Ms::Shortcut::refreshIcons ( )

static

reset()

void Ms::Shortcut::reset

(

)

remove shortcuts

resetToDefault()

void Ms::Shortcut::resetToDefault ( )

static

retranslate()

void Ms::Shortcut::retranslate ( )

static

save()

void Ms::Shortcut::save ( )

static

saveToNewFile()

void Ms::Shortcut::saveToNewFile ( QString  fileLocation )

static

setKey()

void Ms::Shortcut::setKey ( const QByteArray &  key )

inline

setKeys() [1/2]

void Ms::Shortcut::setKeys

(

const QList< QKeySequence > &

ks

)

setKeys() [2/2]

void Ms::Shortcut::setKeys

(

const Shortcut &

sc

)

setStandardKey()

void Ms::Shortcut::setStandardKey

(

QKeySequence::StandardKey

k

)

setState()

void Ms::Shortcut::setState ( int  v )

inline

shortcuts()

static const QHash<QByteArray, Shortcut*>& Ms::Shortcut::shortcuts ( )

inlinestatic

standardKey()

QKeySequence::StandardKey Ms::Shortcut::standardKey ( ) const

inline

state()

int Ms::Shortcut::state ( ) const

inline

text()

QString Ms::Shortcut::text

(

)

const

translateAction()

void Ms::Shortcut::translateAction ( QAction *  action ) const

private

write()

void Ms::Shortcut::write

(

Ms::XmlWriter &

xml

)

const

Member Data Documentation

_action

QAction* Ms::Shortcut::_action { 0 }

mutableprivate

_assignedWidget

MsWidget Ms::Shortcut::_assignedWidget

private

_context

Qt::ShortcutContext Ms::Shortcut::_context { Qt::WindowShortcut }

private

_descr

QByteArray Ms::Shortcut::_descr

private

xml tag name for configuration file

_flags

ShortcutFlags Ms::Shortcut::_flags { ShortcutFlags::NONE }

private

_help

QByteArray Ms::Shortcut::_help

private

text as shown on buttons or menus

_icon

Icons Ms::Shortcut::_icon { Icons::Invalid_ICON }

private

ballon help (or'd list of states)

_key

QByteArray Ms::Shortcut::_key

private

shortcut is valid in this Mscore state

_keys

QList<QKeySequence> Ms::Shortcut::_keys

private

_sc

Shortcut Ms::Shortcut::_sc

staticprivate

_shortcuts

QHash< QByteArray, Shortcut * > Ms::Shortcut::_shortcuts

staticprivate

_standardKey

QKeySequence::StandardKey Ms::Shortcut::_standardKey { QKeySequence::UnknownKey }

private

shortcut list

_state

int Ms::Shortcut::_state { 0 }

private

the widget where the action will be assigned

_text

QByteArray Ms::Shortcut::_text

private

descriptor, shown in editor

defaultFileName

constexpr const char* Ms::Shortcut::defaultFileName = ":/data/shortcuts.xml"

static

dirty

bool Ms::Shortcut::dirty = false

static

source

QString Ms::Shortcut::source

staticprivate

cached action

---

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

• mscore/shortcut.h
• mscore/shortcut.cpp