swift
Public Member Functions | List of all members
swift::misc::input::CHotkeyCombination Class Reference

Value object representing hotkey sequence. More...

Inheritance diagram for swift::misc::input::CHotkeyCombination:
[legend]

Public Member Functions

 CHotkeyCombination ()=default
 Default constructor.
 
 CHotkeyCombination (CKeyboardKey key)
 Init with key.
 
 CHotkeyCombination (const CKeyboardKeyList &keys)
 Init with list of keys.
 
void setKeyboardKeys (const CKeyboardKeyList &keys)
 Set keyboard keys.
 
CKeyboardKeyList getKeyboardKeys () const
 Get keyboard keys.
 
QStringList getKeyStrings () const
 As keyboard key strings.
 
void setJoystickButtons (const CJoystickButtonList &list)
 Set joystick buttons.
 
CJoystickButtonList getJoystickButtons () const
 Get joystick buttons.
 
void addKeyboardKey (const CKeyboardKey &key)
 Add keyboard key.
 
void addJoystickButton (const CJoystickButton &button)
 Add joystick button.
 
bool containsKeyboardKey (const CKeyboardKey &key) const
 Does combination contain key?
 
bool containsJoystickButton (const CJoystickButton &button) const
 Does combination contain button?
 
void replaceKey (CKeyboardKey oldKey, CKeyboardKey newKey)
 Replace oldKey with newKey.
 
void replaceButton (CJoystickButton oldButton, CJoystickButton newButton)
 Replace oldButton with newButton.
 
void removeKeyboardKey (CKeyboardKey key)
 Remove keyboard key.
 
void removeJoystickButton (CJoystickButton button)
 Remove joystick button.
 
bool isEmpty () const
 Is sequence empty?
 
int size () const
 Get size of sequence.
 
bool isSubsetOf (const CHotkeyCombination &other) const
 Is sequence a subset of other? E.g. CTRL would be a subset of CTRL+D.
 
CHotkeyCombination getDeltaComparedTo (const CHotkeyCombination &other) const
 Returns the delta (removing all keys and buttons contained in other)
 
QString convertToQString (bool i18n=false) const
 Cast as QString. More...
 
QString asStringWithDeviceNames () const
 Returns the button name with the device name prefix.
 
- Public Member Functions inherited from swift::misc::mixin::MetaType< Derived >
int getMetaTypeId () const
 Returns the Qt meta type ID of this object. More...
 
QString getClassName () const
 Class name.
 
bool isA (int metaTypeId) const
 Returns true if this object is an instance of the class with the given meta type ID, or one of its subclasses.
 
- Public Member Functions inherited from swift::misc::mixin::DBusByMetaClass< Derived, Tags >
void marshallToDbus (QDBusArgument &arg, Tags...) const
 Marshall without begin/endStructure, for when composed within another object.
 
void unmarshallFromDbus (const QDBusArgument &arg, Tags...)
 Unmarshall without begin/endStructure, for when composed within another object.
 
- Public Member Functions inherited from swift::misc::mixin::DataStreamByMetaClass< Derived >
void marshalToDataStream (QDataStream &stream) const
 Marshal a value to a QDataStream.
 
void unmarshalFromDataStream (QDataStream &stream)
 Unmarshal a value from a QDataStream.
 
- Public Member Functions inherited from swift::misc::mixin::JsonByMetaClass< Derived >
QJsonObject toJson () const
 Cast to JSON object.
 
QString toJsonString (QJsonDocument::JsonFormat format=QJsonDocument::Indented) const
 Convenience function JSON as string.
 
void convertFromJson (const QJsonObject &json)
 Assign from JSON object.
 
void convertFromJson (const QString &jsonString, bool acceptCacheFormat=false)
 Assign from JSON object string.
 
- Public Member Functions inherited from swift::misc::mixin::String< Derived >
QString toQString (bool i18n=false) const
 Cast as QString.
 
std::string toStdString (bool i18n=false) const
 To std string.
 
QString stringForStreaming () const
 String for streaming operators.
 
- Public Member Functions inherited from swift::misc::mixin::Index< Derived >
CPropertyIndexList apply (const CPropertyIndexVariantMap &indexMap, bool skipEqualValues=false)
 Update by variant map. More...
 
void setPropertyByIndex (CPropertyIndexRef index, const QVariant &variant)
 Set property by index.
 
QVariant propertyByIndex (CPropertyIndexRef index) const
 Property by index.
 
int comparePropertyByIndex (CPropertyIndexRef index, const Derived &compareValue) const
 Compare for index.
 
bool equalsPropertyByIndex (const QVariant &compareValue, CPropertyIndexRef index) const
 Is given variant equal to value of property index?
 
- Public Member Functions inherited from swift::misc::mixin::Icon< Derived, IconIndex >
CIcons::IconIndex toIcon () const
 As icon, not implemented by all classes.
 

Additional Inherited Members

- Public Types inherited from swift::misc::CValueObject< CHotkeyCombination >
using base_type = CEmpty
 Base class.
 
- Public Types inherited from swift::misc::CEmpty
using base_type = CEmpty
 Base class is alias of itself.
 
- Public Types inherited from swift::misc::mixin::Index< Derived >
enum  ColumnIndex { IndexPixmap = 10 , IndexIcon , IndexString }
 Base class enums.
 
- Static Public Member Functions inherited from swift::misc::mixin::MetaType< Derived >
static void registerMetadata ()
 Register metadata.
 
- Static Public Member Functions inherited from swift::misc::mixin::JsonByMetaClass< Derived >
template<class DerivedObj = Derived>
static DerivedObj fromJson (const QJsonObject &json)
 Get object from QJsonObject.
 
template<class DerivedObj = Derived>
static DerivedObj fromJson (const QString &jsonString, bool acceptCacheJson=false)
 Get object from JSON string.
 
template<class DerivedObj = Derived>
static DerivedObj fromJsonNoThrow (const QString &jsonString, bool acceptCacheJson, bool &success, QString &errMsg)
 Get object from JSON string.
 
- Protected Member Functions inherited from swift::misc::CValueObject< CHotkeyCombination >
 CValueObject ()=default
 Default constructor.
 
 CValueObject (const CValueObject &)=default
 Copy constructor.
 
CValueObjectoperator= (const CValueObject &)=default
 Copy assignment operator.
 
 ~CValueObject ()=default
 Destructor.
 
 CEmpty ()=default
 Inheriting constructors.
 
 CEmpty (const CEmpty &)=default
 Inheriting constructors.
 
- Protected Member Functions inherited from swift::misc::CEmpty
 CEmpty ()=default
 Protected default constructor.
 
 CEmpty (const CEmpty &)=default
 Protected copy constructor.
 
CEmptyoperator= (const CEmpty &)=default
 Protected copy assignment operator.
 
 ~CEmpty ()=default
 Non-virtual protected destructor.
 

Detailed Description

Value object representing hotkey sequence.

Definition at line 25 of file hotkeycombination.h.

Member Function Documentation

◆ convertToQString()

QString swift::misc::input::CHotkeyCombination::convertToQString ( bool  i18n = false) const

Cast as QString.

Definition at line 89 of file hotkeycombination.cpp.


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