BasicKeyController Class Reference

The core class for assigning actions to key-presses and registering them as a program-wide service. More...

#include <KeyController.h>

Inheritance diagram for BasicKeyController:

Collaboration diagram for BasicKeyController:

Public Member Functions
virtual void	addKeyOption (const KeyOption &option)
	BasicKeyController (const TranslatedString &key_controller_title)
const Buffer< KeyOption > &	currentKeyMaps () const
virtual void	getINI (INIFactory &factory) override
const TranslatedString &	keyControllerTitle () const
bool	processKeyEvent (const KeyEvent &key_event, DesignObjectLookup *lookup, Camera *camera) final override
virtual bool	processKeyEvent (const String &id, const KeyEvent &key_event, DesignObjectLookup *lookup, Camera *camera)=0
virtual void	resetKeyControllerToDefaults ()=0
virtual void	setKeyOption (const KeyOption &option)
Public Member Functions inherited from KeyControllerBase
Public Member Functions inherited from INIInterface
virtual void	finishReadingINI (INIFactory &)
	INIInterface (const File &default_ini)
virtual void	prepareForINI (INIFactory &)
virtual bool	readINIOptions ()
virtual bool	readINIOptions (File &ini_file)
virtual bool	saveINIOptions (bool multithead=false)
virtual bool	saveINIOptions (File &ini_file, bool multithead=false)
void	setDefaultINIFile (const File &file)
virtual void	writeToLog (const String &title, ProgressInfo *log, uint01 log_level=2U)
virtual void	writeToLog (ProgressInfo *log, uint01 log_level=2U)
virtual	~INIInterface ()

Protected Attributes
TranslatedString	m_key_controller_title
Buffer< KeyOption >	m_key_options
bool	m_save_ini_on_change_key_option_change = false
Protected Attributes inherited from INIInterface
File	m_default_ini

Detailed Description

The core class for assigning actions to key-presses and registering them as a program-wide service.

---

Constructor & Destructor Documentation

BasicKeyController()

BasicKeyController

(

const TranslatedString &

key_controller_title

)

Member Function Documentation

addKeyOption()

virtual void addKeyOption ( const KeyOption & option )

virtual

currentKeyMaps()

const Buffer< KeyOption > & currentKeyMaps ( ) const

inline

getINI()

virtual void getINI ( INIFactory & factory )

overridevirtual

Implements INIInterface.

keyControllerTitle()

const TranslatedString & keyControllerTitle ( ) const

inline

processKeyEvent() [1/2]

bool processKeyEvent ( const KeyEvent & key_event, DesignObjectLookup * lookup, Camera * camera )

finaloverridevirtual

Implements KeyControllerBase.

processKeyEvent() [2/2]

virtual bool processKeyEvent ( const String & id, const KeyEvent & key_event, DesignObjectLookup * lookup, Camera * camera )

pure virtual

Implemented in NDEVRRibbon, QCustomMessageBox, and SelectionWidget.

resetKeyControllerToDefaults()

virtual void resetKeyControllerToDefaults ( )

pure virtual

Implemented in NDEVRRibbon, QCustomMessageBox, and SelectionWidget.

setKeyOption()

virtual void setKeyOption ( const KeyOption & option )

virtual

Member Data Documentation

m_key_controller_title

TranslatedString m_key_controller_title

protected

m_key_options

Buffer<KeyOption> m_key_options

protected

m_save_ini_on_change_key_option_change

bool m_save_ini_on_change_key_option_change = false

protected

---

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

• Base/Headers/KeyController.h