Manages a hotkey setting for a GUI object. More...
#include <CGUIHotkey.h>
Inheritance diagram for CGUIHotkey:
Collaboration diagram for CGUIHotkey:
Public Member Functions | |
| CGUIHotkey (IGUIObject *pObject, const CStr &Name) | |
| NONCOPYABLE (CGUIHotkey) | |
| MOVABLE (CGUIHotkey) | |
| bool | DoFromString (const CStrW &value) override |
| bool | DoFromJSVal (const ScriptRequest &rq, JS::HandleValue value) override |
| void | OnSettingChange (const CStr &setting, bool sendMessage) override |
| Triggers the IGUIObject logic when a setting changes. More... | |
 Public Member Functions inherited from CGUISimpleSetting< CStr > | |
| CGUISimpleSetting (IGUIObject *pObject, const CStr &Name, Args &&... args) | |
| NONCOPYABLE (CGUISimpleSetting) | |
| MOVABLE (CGUISimpleSetting) | |
| operator const CStr & () const | |
| const CStr & | operator* () const |
| const CStr * | operator-> () const |
| CStr & | GetMutable () |
| 'Uglified' getter when you want direct access without triggering messages. More... | |
| void | Set (CStr value, bool sendMessage) |
| 'Uglified' operator=, so that SendMessage is explicit. More... | |
| Public Member Functions inherited from IGUISetting | |
| NONCOPYABLE (IGUISetting) | |
| IGUISetting (const CStr &name, IGUIObject *owner) | |
| bool | FromString (const CStrW &value, const bool sendMessage) |
| Parses the given string and assigns to the setting value. More... | |
| bool | FromJSVal (const ScriptRequest &rq, JS::HandleValue value, const bool sendMessage) |
| Parses the given JS::Value using Script::FromJSVal and assigns it to the setting data. More... | |
Additional Inherited Members | |
| Protected Member Functions inherited from CGUISimpleSetting< CStr > | |
| CStr | GetName () const override |
| Return the name of the setting, from JS. More... | |
| bool | DoFromString (const CStrW &value) override |
| bool | DoFromJSVal (const ScriptRequest &rq, JS::HandleValue value) override |
| void | ToJSVal (const ScriptRequest &rq, JS::MutableHandleValue value) override |
| Converts the setting data to a JS::Value using Script::ToJSVal. More... | |
| Protected Member Functions inherited from IGUISetting | |
| IGUISetting (IGUISetting &&o) | |
| virtual | ~IGUISetting ()=default |
| Protected Attributes inherited from CGUISimpleSetting< CStr > | |
| const CStr | m_Name |
| CStr | m_Setting |
| Protected Attributes inherited from IGUISetting | |
| IGUIObject & | m_pObject |
| The object that stores this setting. More... | |
Detailed Description
Manages a hotkey setting for a GUI object.
Constructor & Destructor Documentation
◆ CGUIHotkey()
|
inline |
Member Function Documentation
◆ DoFromJSVal()
|
overridevirtual |
Implements IGUISetting.
◆ DoFromString()
|
overridevirtual |
Implements IGUISetting.
◆ MOVABLE()
| CGUIHotkey::MOVABLE | ( | CGUIHotkey | ) |
◆ NONCOPYABLE()
| CGUIHotkey::NONCOPYABLE | ( | CGUIHotkey | ) |
◆ OnSettingChange()
|
overridevirtual |
Triggers the IGUIObject logic when a setting changes.
This should be called by derived classes when something externally visible changes, unless overloaded to provide similar behaviour.
Reimplemented from IGUISetting.
The documentation for this class was generated from the following files:
- /zpool0/docker-engine-docs/source/gui/SettingTypes/CGUIHotkey.h
- /zpool0/docker-engine-docs/source/gui/SettingTypes/CGUIHotkey.cpp
