Pyrogenesis HEAD
Pyrogenesis, a RTS Engine
Public Member Functions | List of all members
CGUIHotkey Class Reference

Manages a hotkey setting for a GUI object. More...

#include <CGUIHotkey.h>

Inheritance diagram for CGUIHotkey:
Inheritance graph
[legend]
Collaboration diagram for CGUIHotkey:
Collaboration graph
[legend]

Public Member Functions

 CGUIHotkey (IGUIObject *pObject, const CStr &Name)
 
 NONCOPYABLE (CGUIHotkey)
 
 CGUIHotkey (CGUIHotkey &&)=default
 
CGUIHotkey & operator= (CGUIHotkey &&)=delete
 
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)
 
 CGUISimpleSetting (CGUISimpleSetting &&)=default
 
 NONCOPYABLE (CGUISimpleSetting)
 
CGUISimpleSetting & operator= (CGUISimpleSetting &&)=delete
 
 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...
 
virtual void ToJSVal (const ScriptRequest &rq, JS::MutableHandleValue value)=0
 Converts the setting data to a JS::Value using Script::ToJSVal. More...
 

Additional Inherited Members

- Protected Member Functions inherited from CGUISimpleSetting< CStr >
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 &&other)
 
IGUISetting & operator= (IGUISetting &&other)=delete
 
virtual ~IGUISetting ()=default
 
virtual bool DoFromString (const CStrW &value)=0
 
virtual bool DoFromJSVal (const ScriptRequest &rq, JS::HandleValue value)=0
 
virtual void OnSettingChange (const CStr &setting, bool sendMessage)
 Triggers the IGUIObject logic when a setting changes. More...
 
const CStr & GetName () const
 Return the name of the setting, from JS. More...
 
- Protected Attributes inherited from CGUISimpleSetting< CStr >
CStr m_Setting
 
- Protected Attributes inherited from IGUISetting
IGUIObject & m_Object
 The object that stores this setting. More...
 

Detailed Description

Manages a hotkey setting for a GUI object.

Constructor & Destructor Documentation

◆ CGUIHotkey() [1/2]

CGUIHotkey::CGUIHotkey ( IGUIObject *  pObject,
const CStr &  Name 
)
inline

◆ CGUIHotkey() [2/2]

CGUIHotkey::CGUIHotkey ( CGUIHotkey &&  )
default

Member Function Documentation

◆ DoFromJSVal()

bool CGUIHotkey::DoFromJSVal ( const ScriptRequest &  rq,
JS::HandleValue  value 
)
overridevirtual

Implements IGUISetting.

◆ DoFromString()

bool CGUIHotkey::DoFromString ( const CStrW &  value)
overridevirtual

Implements IGUISetting.

◆ NONCOPYABLE()

CGUIHotkey::NONCOPYABLE ( CGUIHotkey  )

◆ OnSettingChange()

void CGUIHotkey::OnSettingChange ( const CStr &  setting,
bool  sendMessage 
)
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.

◆ operator=()

CGUIHotkey & CGUIHotkey::operator= ( CGUIHotkey &&  )
delete
The documentation for this class was generated from the following files: