KeyBindings Class Reference

#include <keybindings.h>

Detailed Description

Encapsulates information about the current keybindings.

This class can retrieve, set, and modify the keybindings used by MythTV

Definition at line 38 of file keybindings.h.


Public Types
enum	ConflictLevels { kKeyBindingWarning, kKeyBindingError }
	Levels of conflict. More...
Public Member Functions
	KeyBindings (const QString &hostname)
	Create a new KeyBindings instance.
bool	AddActionKey (const QString &context_name, const QString &action_name, const QString &key)
	Add a key to an action.
ActionID *	GetConflict (const QString &context_name, const QString &key, int &level) const
	Determine if adding a key would cause a conflict.
void	ReplaceActionKey (const QString &context_name, const QString &action_name, const QString &newkey, const QString &oldkey)
bool	RemoveActionKey (const QString &context_name, const QString &action_name, const QString &key)
	Unbind a key from an action.
void	CommitChanges (void)
	Commit all changes made to the keybindings.
QStringList	GetKeys (void) const
	Returns a list of all keys bound to an action.
QStringList	GetContexts (void) const
	Returns a list of the context names.
QStringList	GetActions (const QString &context) const
	Get a list of the actions in a context.
void	GetKeyActions (const QString &key, ActionList &list) const
	Get a list of the actions in a context.
QStringList	GetActionKeys (const QString &context_name, const QString &action_name) const
	Get an action's keys.
QStringList	GetContextKeys (const QString &context) const
	Get the keys within a context.
QStringList	GetKeyContexts (const QString &key) const
	Get the context names in which a key is bound.
QString	GetActionDescription (const QString &context_name, const QString &action_name) const
	Get an action's description.
bool	HasMandatoryBindings (void) const
	Returns true iff all mandatory bindings are satisfied.
bool	HasChanges (void) const
Protected Member Functions
void	CommitJumppoint (const ActionID &id)
	Commit a jumppoint to the database.
void	CommitAction (const ActionID &id)
	Commit an action to the database, and reload its keybindings.
void	LoadMandatoryBindings (void)
	Load the mandatory bindings.
void	LoadContexts (void)
void	LoadJumppoints (void)
Private Attributes
QString	m_hostname
ActionList	m_mandatoryBindings
QStringList	m_defaultKeys
ActionSet	m_actionSet

Member Enumeration Documentation

enum KeyBindings::ConflictLevels

Levels of conflict.

Enumerator:

kKeyBindingWarning
kKeyBindingError

Definition at line 42 of file keybindings.h.

Constructor & Destructor Documentation

KeyBindings::KeyBindings ( const QString & hostname )

Create a new KeyBindings instance.

Parameters:

hostname

The host for which to create the key bindings.

Definition at line 44 of file keybindings.cpp.

Member Function Documentation

bool KeyBindings::AddActionKey	(	const QString &	context_name,
		const QString &	action_name,
		const QString &	key
	)

Add a key to an action.

This does not take effect until CommitChanges() is called.

Parameters:

	context_name	The name of the context.
	action_name	The name of the action.
	key	The key to add.

Definition at line 158 of file keybindings.cpp.

Referenced by MythControls::AddKeyToAction().

ActionID * KeyBindings::GetConflict	(	const QString &	context_name,
		const QString &	key,
		int &	level
	)			const

Determine if adding a key would cause a conflict.

Parameters:

	context_name	The name of the context.
	key	The key to add.
	level	The level of conflict if this returns an ActionID

Returns:: pointer to an ActionID if adding the key would cause a conflict.

Conflicts occur if:

the key is a jump point, but is bound elsewhere
the key is already bound to a jumppoint.
the key is bound to something in the global context.
the key is bound to something else in the specified context

If the method does not return NULL, check the value given to level. Warnings can be ignored (at the users disgression), but errors should be prevented no matter what.

NOTE: If this returns a non-null pointer, the ActionID returned must be explicitly deleted with C++ "delete".

Definition at line 185 of file keybindings.cpp.

Referenced by MythControls::AddKeyToAction().