BALL  1.4.2
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Signals | Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
BALL::VIEW::ShortcutRegistry Class Reference

#include <BALL/VIEW/KERNEL/shortcutRegistry.h>

Inheritance diagram for BALL::VIEW::ShortcutRegistry:
QObject BALL::Embeddable BALL::VIEW::PreferencesEntry::ExtendedPreferencesObject

Signals

void shortcutChanged ()
 

Public Member Functions

 ShortcutRegistry ()
 
virtual ~ShortcutRegistry ()
 
void registerShortcut (String description, QAction *shortcut)
 
void clear ()
 
void clearKeySequences ()
 Clear all key sequences for all registered QActions. More...
 
bool readShortcutsFromFile (const String &filename)
 Read the shortcuts from a data file. More...
 
bool writeShortcutsToFile (const String &filename)
 Write the shortcuts to a data file. More...
 
bool changeShortcut (QAction *shortcut, const String &new_sequence)
 
bool changeShortcut (int index, const String &new_sequence)
 
size_t size ()
 
bool hasDescription (const String &description)
 
bool hasKey (const QString &key_seq)
 
bool hasKey (const QKeySequence &key_seq)
 
bool hasKey (const String &key_seq)
 
std::pair< String, QAction * > operator[] (Index i)
 
virtual bool getValue (String &) const
 Overload this in derived classes! More...
 
virtual bool setValue (const String &)
 Overload this in derived classes! More...
 
- Public Member Functions inherited from BALL::Embeddable
virtual void dump (std::ostream &s=std::cout, Size depth=0) const
 
 Embeddable (const String &identifier="<Embeddable>")
 
 Embeddable (const Embeddable &embeddable)
 
virtual ~Embeddable ()
 
void setIdentifier (const String &identifier)
 
const StringgetIdentifier () const
 
void unregisterThis ()
 
virtual void registerThis ()
 
- Public Member Functions inherited from BALL::VIEW::PreferencesEntry::ExtendedPreferencesObject
 ExtendedPreferencesObject ()
 
virtual ~ExtendedPreferencesObject ()
 

Protected Member Functions

std::pair< String, QAction * > getEntry_ (Index pos)
 

Protected Attributes

std::map< String, QAction * > shortcuts_
 
std::map< String, Stringunknown_shortcuts_
 
HashSet< Stringshortcut_keys_
 

Static Protected Attributes

static const char * BETWEEN_SC_SEPERATOR
 
static const char * IN_SC_SEPERATOR
 

Additional Inherited Members

- Public Types inherited from BALL::Embeddable
typedef std::vector< Embeddable * > EmbeddableVector
 
- Static Protected Member Functions inherited from BALL::Embeddable
static void registerInstance_ (const std::type_info &type, const Embeddable *instance)
 
static void unregisterInstance_ (const Embeddable *instance)
 
static Size countInstances_ (const std::type_info &type)
 
static EmbeddablegetInstance_ (const std::type_info &type, Position index)
 
static EmbeddablegetInstance_ (const std::type_info &type, const String &identifier)
 

Detailed Description

ShortcutRegistry. It takes care of handling all shortcuts. It is responsible for registering, changing single shortcuts or loading entire shortcut-configuration files.

Definition at line 36 of file shortcutRegistry.h.

Constructor & Destructor Documentation

BALL::VIEW::ShortcutRegistry::ShortcutRegistry ( )
virtual BALL::VIEW::ShortcutRegistry::~ShortcutRegistry ( )
virtual

Destructor

Member Function Documentation

bool BALL::VIEW::ShortcutRegistry::changeShortcut ( QAction *  shortcut,
const String new_sequence 
)
bool BALL::VIEW::ShortcutRegistry::changeShortcut ( int  index,
const String new_sequence 
)
void BALL::VIEW::ShortcutRegistry::clear ( )
void BALL::VIEW::ShortcutRegistry::clearKeySequences ( )

Clear all key sequences for all registered QActions.

std::pair<String, QAction*> BALL::VIEW::ShortcutRegistry::getEntry_ ( Index  pos)
protected
virtual bool BALL::VIEW::ShortcutRegistry::getValue ( String ) const
virtual

Overload this in derived classes!

Implements BALL::VIEW::PreferencesEntry::ExtendedPreferencesObject.

bool BALL::VIEW::ShortcutRegistry::hasDescription ( const String description)
bool BALL::VIEW::ShortcutRegistry::hasKey ( const QString &  key_seq)
bool BALL::VIEW::ShortcutRegistry::hasKey ( const QKeySequence &  key_seq)
bool BALL::VIEW::ShortcutRegistry::hasKey ( const String key_seq)
std::pair<String, QAction*> BALL::VIEW::ShortcutRegistry::operator[] ( Index  i)
bool BALL::VIEW::ShortcutRegistry::readShortcutsFromFile ( const String filename)

Read the shortcuts from a data file.

void BALL::VIEW::ShortcutRegistry::registerShortcut ( String  description,
QAction *  shortcut 
)
virtual bool BALL::VIEW::ShortcutRegistry::setValue ( const String )
virtual

Overload this in derived classes!

Implements BALL::VIEW::PreferencesEntry::ExtendedPreferencesObject.

void BALL::VIEW::ShortcutRegistry::shortcutChanged ( )
signal
size_t BALL::VIEW::ShortcutRegistry::size ( )
bool BALL::VIEW::ShortcutRegistry::writeShortcutsToFile ( const String filename)

Write the shortcuts to a data file.

Member Data Documentation

const char* BALL::VIEW::ShortcutRegistry::BETWEEN_SC_SEPERATOR
staticprotected

Definition at line 89 of file shortcutRegistry.h.

const char* BALL::VIEW::ShortcutRegistry::IN_SC_SEPERATOR
staticprotected

Definition at line 90 of file shortcutRegistry.h.

HashSet<String> BALL::VIEW::ShortcutRegistry::shortcut_keys_
protected

Definition at line 96 of file shortcutRegistry.h.

std::map<String, QAction*> BALL::VIEW::ShortcutRegistry::shortcuts_
protected

Definition at line 94 of file shortcutRegistry.h.

std::map<String, String> BALL::VIEW::ShortcutRegistry::unknown_shortcuts_
protected

Definition at line 95 of file shortcutRegistry.h.