HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
HOM_hotkeys Class Referenceabstract

#include <HOM_hotkeys.h>

Public Member Functions

virtual ~HOM_hotkeys ()
 
virtual std::string __repr__ ()=0
 
virtual std::vector< std::string > assignments (const char *hotkey_symbol)=0
 
virtual std::vector< std::string > assignments (const char *context, const char *command, bool resolve_refs=true)=0
 
virtual std::string hotkeyDescription (const char *hotkey_symbol)=0
 
virtual std::string hotkeyLabel (const char *hotkey_symbol)=0
 
virtual bool isKeyMatch (const char *key, const char *hotkey_symbol)=0
 
virtual bool isKeycodeMatch (int key_code, const char *hotkey_symbol)=0
 
virtual std::vector< std::string > findConflicts (const char *hotkey_symbol, const char *key)=0
 
virtual std::vector< std::string > findConflicts (const char *context, const char *command, const char *key)=0
 
virtual std::vector
< std::vector< std::string > > 		resolveAssignments (const std::vector< std::string > &contexts, const std::vector< std::string > &hotkey_symbols)=0
 
virtual int changeIndex ()=0
 
virtual std::vector< std::map
< std::string, std::string > > 		commandsInContext (const char *context)=0
 
virtual std::vector< std::map
< std::string, std::string > > 		contextsInContext (const char *context)=0
 
virtual std::vector< std::map
< std::string, std::string > > 		commandCategoriesInCategory (const char *category)=0
 
virtual std::vector< std::map
< std::string, std::string > > 		commandsInCategory (const char *category)=0
 
virtual std::vector< std::map
< std::string, std::string > > 		commandBindingsInContext (const char *context)=0
 
virtual bool addCommand (const char *hotkey_symbol, const char *label, const char *description, const std::vector< std::string > &assignments=std::vector< std::string >())=0
 
virtual bool addContext (const char *hotkey_symbol, const char *label, const char *description)=0
 
virtual void installDefinitions (HOM_PluginHotkeyDefinitions const &definitions)=0
 
virtual void uninstallDefinitions (HOM_PluginHotkeyDefinitions const &definitions)=0
 
virtual bool addCommandBinding (const char *context, const char *command)=0
 
virtual bool removeCommandBinding (const char *context, const char *command)=0
 
virtual void removeHotkeySymbol (const char *hotkey_symbol)=0
 
virtual std::string hotkeySymbol (const char *english_context, const char *english_command=nullptr)=0
 
virtual bool clearAssignments (const char *hotkey_symbol)=0
 
virtual bool addAssignment (const char *hotkey_symbol, const char *key)=0
 
virtual bool removeAssignment (const char *hotkey_symbol, const char *key)=0
 
virtual bool clearAssignments (const char *context, const char *command)=0
 
virtual bool addAssignment (const char *context, const char *command, const char *key)=0
 
virtual bool removeAssignment (const char *context, const char *command, const char *key)=0
 
virtual std::map< std::string,
std::vector< std::string > > 		_getHotkeysStatus (const char *hotkey_symbol, const std::vector< std::string > &layout_keys, int modifier_mask=0)=0
 
virtual std::vector< int > availableKeycodes (const char *hotkey_symbol, const std::vector< int > &layout_keycodes, int modifier_mask=0)=0
 
virtual std::vector< int > availableKeycodes (const char *context, const char *command, const std::vector< int > &layout_keycodes, int modifier_mask=0)=0
 
virtual std::string keycodeToString (int keycode, short modifiers=0)=0
 
virtual int stringToKeycode (const char *key, short modifiers=0)=0
 
virtual void _createBackupTables ()=0
 
virtual void _restoreBackupTables ()=0
 
virtual void revertToDefaults (const char *hotkey_symbol, bool one_level_only)=0
 
virtual void revertToDefaults (const char *context, const char *command, bool one_level_only)=0
 
virtual bool saveOverrides ()=0
 
virtual bool saveAsKeymap (const char *name, const char *path=nullptr)=0
 
virtual bool loadKeymap (const char *name, const char *path=nullptr)=0
 
virtual bool importKeymap (const char *name, const char *path)=0
 
virtual std::vector< std::pair
< std::string, std::string > > 		keymaps ()=0
 
virtual std::string currentKeymap ()=0
 

Detailed Description

Definition at line 24 of file HOM_hotkeys.h.

Constructor & Destructor Documentation

virtual HOM_hotkeys::~HOM_hotkeys ( )
inlinevirtual

Definition at line 27 of file HOM_hotkeys.h.

Member Function Documentation

virtual std::string HOM_hotkeys::__repr__ ( )
pure virtual
virtual void HOM_hotkeys::_createBackupTables ( )
pure virtual
virtual std::map<std::string, std::vector<std::string> > HOM_hotkeys::_getHotkeysStatus ( const char *  hotkey_symbol,
const std::vector< std::string > &  layout_keys,
int  modifier_mask = 0 
)
pure virtual
virtual void HOM_hotkeys::_restoreBackupTables ( )
pure virtual
virtual bool HOM_hotkeys::addAssignment ( const char *  hotkey_symbol,
const char *  key 
)
pure virtual
virtual bool HOM_hotkeys::addAssignment ( const char *  context,
const char *  command,
const char *  key 
)
pure virtual
virtual bool HOM_hotkeys::addCommand ( const char *  hotkey_symbol,
const char *  label,
const char *  description,
const std::vector< std::string > &  assignments = std::vector< std::string >() 
)
pure virtual
virtual bool HOM_hotkeys::addCommandBinding ( const char *  context,
const char *  command 
)
pure virtual
virtual bool HOM_hotkeys::addContext ( const char *  hotkey_symbol,
const char *  label,
const char *  description 
)
pure virtual
virtual std::vector<std::string> HOM_hotkeys::assignments ( const char *  hotkey_symbol)
pure virtual
virtual std::vector<std::string> HOM_hotkeys::assignments ( const char *  context,
const char *  command,
bool  resolve_refs = true 
)
pure virtual
virtual std::vector<int> HOM_hotkeys::availableKeycodes ( const char *  hotkey_symbol,
const std::vector< int > &  layout_keycodes,
int  modifier_mask = 0 
)
pure virtual
virtual std::vector<int> HOM_hotkeys::availableKeycodes ( const char *  context,
const char *  command,
const std::vector< int > &  layout_keycodes,
int  modifier_mask = 0 
)
pure virtual
virtual int HOM_hotkeys::changeIndex ( )
pure virtual
virtual bool HOM_hotkeys::clearAssignments ( const char *  hotkey_symbol)
pure virtual
virtual bool HOM_hotkeys::clearAssignments ( const char *  context,
const char *  command 
)
pure virtual
virtual std::vector< std::map<std::string, std::string> > HOM_hotkeys::commandBindingsInContext ( const char *  context)
pure virtual
virtual std::vector< std::map<std::string, std::string> > HOM_hotkeys::commandCategoriesInCategory ( const char *  category)
pure virtual
virtual std::vector< std::map<std::string, std::string> > HOM_hotkeys::commandsInCategory ( const char *  category)
pure virtual
virtual std::vector< std::map<std::string, std::string> > HOM_hotkeys::commandsInContext ( const char *  context)
pure virtual
virtual std::vector< std::map<std::string, std::string> > HOM_hotkeys::contextsInContext ( const char *  context)
pure virtual
virtual std::string HOM_hotkeys::currentKeymap ( )
pure virtual
virtual std::vector<std::string> HOM_hotkeys::findConflicts ( const char *  hotkey_symbol,
const char *  key 
)
pure virtual
virtual std::vector<std::string> HOM_hotkeys::findConflicts ( const char *  context,
const char *  command,
const char *  key 
)
pure virtual
virtual std::string HOM_hotkeys::hotkeyDescription ( const char *  hotkey_symbol)
pure virtual
virtual std::string HOM_hotkeys::hotkeyLabel ( const char *  hotkey_symbol)
pure virtual
virtual std::string HOM_hotkeys::hotkeySymbol ( const char *  english_context,
const char *  english_command = nullptr 
)
pure virtual
virtual bool HOM_hotkeys::importKeymap ( const char *  name,
const char *  path 
)
pure virtual
virtual void HOM_hotkeys::installDefinitions ( HOM_PluginHotkeyDefinitions const &  definitions)
pure virtual
virtual bool HOM_hotkeys::isKeycodeMatch ( int  key_code,
const char *  hotkey_symbol 
)
pure virtual
virtual bool HOM_hotkeys::isKeyMatch ( const char *  key,
const char *  hotkey_symbol 
)
pure virtual
virtual std::string HOM_hotkeys::keycodeToString ( int  keycode,
short  modifiers = 0 
)
pure virtual
virtual std::vector<std::pair<std::string, std::string> > HOM_hotkeys::keymaps ( )
pure virtual
virtual bool HOM_hotkeys::loadKeymap ( const char *  name,
const char *  path = nullptr 
)
pure virtual
virtual bool HOM_hotkeys::removeAssignment ( const char *  hotkey_symbol,
const char *  key 
)
pure virtual
virtual bool HOM_hotkeys::removeAssignment ( const char *  context,
const char *  command,
const char *  key 
)
pure virtual
virtual bool HOM_hotkeys::removeCommandBinding ( const char *  context,
const char *  command 
)
pure virtual
virtual void HOM_hotkeys::removeHotkeySymbol ( const char *  hotkey_symbol)
pure virtual
virtual std::vector<std::vector<std::string> > HOM_hotkeys::resolveAssignments ( const std::vector< std::string > &  contexts,
const std::vector< std::string > &  hotkey_symbols 
)
pure virtual
virtual void HOM_hotkeys::revertToDefaults ( const char *  hotkey_symbol,
bool  one_level_only 
)
pure virtual
virtual void HOM_hotkeys::revertToDefaults ( const char *  context,
const char *  command,
bool  one_level_only 
)
pure virtual
virtual bool HOM_hotkeys::saveAsKeymap ( const char *  name,
const char *  path = nullptr 
)
pure virtual
virtual bool HOM_hotkeys::saveOverrides ( )
pure virtual
virtual int HOM_hotkeys::stringToKeycode ( const char *  key,
short  modifiers = 0 
)
pure virtual
virtual void HOM_hotkeys::uninstallDefinitions ( HOM_PluginHotkeyDefinitions const &  definitions)
pure virtual
The documentation for this class was generated from the following file: