KeyReference Class Reference

#include <KeyReference.h>

Inheritance diagram for KeyReference:

Collaboration diagram for KeyReference:

Classes
struct	KeyDetails

Public Member Functions
	KeyReference ()
virtual	~KeyReference ()
void	setCategory (QString category)
void	registerShortcut (QAction *, QString overrideName="")
void	registerAlternativeShortcut (QAction *, QString alternative)
void	registerAlternativeShortcut (QAction *, QKeySequence alternative)
void	registerShortcut (QString actionName, QString shortcut, QString tipText)
void	registerAlternativeShortcut (QString actionName, QString alternative)
void	registerAlternativeShortcut (QString actionName, QKeySequence alternative)
void	show ()
void	hide ()

Protected Types
typedef std::vector< KeyDetails >	KeyList
typedef std::map< QString, KeyList >	CategoryMap
typedef std::vector< QString >	CategoryList

Protected Slots
void	dialogButtonClicked (QAbstractButton *)

Protected Attributes
QString	m_currentCategory
CategoryMap	m_map
CategoryList	m_categoryOrder
QTextEdit *	m_text
QDialog *	m_dialog

Detailed Description

Definition at line 30 of file KeyReference.h.

Member Typedef Documentation

typedef std::vector<KeyDetails> KeyReference::KeyList

protected

Definition at line 62 of file KeyReference.h.

typedef std::map<QString, KeyList> KeyReference::CategoryMap

protected

Definition at line 63 of file KeyReference.h.

typedef std::vector<QString> KeyReference::CategoryList

protected

Definition at line 64 of file KeyReference.h.

Constructor & Destructor Documentation

KeyReference::KeyReference

(

)

Definition at line 26 of file KeyReference.cpp.

KeyReference::~KeyReference ( )

virtual

Definition at line 32 of file KeyReference.cpp.

References m_dialog.

Member Function Documentation

void KeyReference::setCategory

(

QString

category

)

Definition at line 38 of file KeyReference.cpp.

References m_categoryOrder, m_currentCategory, and m_map.

Referenced by Pane::registerShortcuts().

void KeyReference::registerShortcut	(	QAction *	action,
		QString	overrideName = ""
	)

Definition at line 48 of file KeyReference.cpp.

Referenced by Pane::registerShortcuts().

void KeyReference::registerAlternativeShortcut	(	QAction *	action,
		QString	alternative
	)

Definition at line 84 of file KeyReference.cpp.

Referenced by registerAlternativeShortcut(), and Pane::registerShortcuts().

void KeyReference::registerAlternativeShortcut	(	QAction *	action,
		QKeySequence	alternative
	)

Definition at line 91 of file KeyReference.cpp.

References registerAlternativeShortcut().

void KeyReference::registerShortcut	(	QString	actionName,
		QString	shortcut,
		QString	tipText
	)

Definition at line 60 of file KeyReference.cpp.

References KeyReference::KeyDetails::actionName, m_currentCategory, m_map, KeyReference::KeyDetails::shortcut, and KeyReference::KeyDetails::tip.

void KeyReference::registerAlternativeShortcut	(	QString	actionName,
		QString	alternative
	)

Definition at line 98 of file KeyReference.cpp.

References m_currentCategory, and m_map.

void KeyReference::registerAlternativeShortcut	(	QString	actionName,
		QKeySequence	alternative
	)

Definition at line 113 of file KeyReference.cpp.

References registerAlternativeShortcut().

void KeyReference::show

(

)

Definition at line 119 of file KeyReference.cpp.

References dialogButtonClicked(), m_categoryOrder, m_dialog, m_map, and m_text.

void KeyReference::hide

(

)

Definition at line 213 of file KeyReference.cpp.

References m_dialog.

void KeyReference::dialogButtonClicked ( QAbstractButton *  )

protectedslot

Definition at line 206 of file KeyReference.cpp.

References m_dialog.

Referenced by show().

Member Data Documentation

QString KeyReference::m_currentCategory

protected

Definition at line 66 of file KeyReference.h.

Referenced by registerAlternativeShortcut(), registerShortcut(), and setCategory().

CategoryMap KeyReference::m_map

protected

Definition at line 67 of file KeyReference.h.

Referenced by registerAlternativeShortcut(), registerShortcut(), setCategory(), and show().

CategoryList KeyReference::m_categoryOrder

protected

Definition at line 68 of file KeyReference.h.

Referenced by setCategory(), and show().

QTextEdit* KeyReference::m_text

protected

Definition at line 70 of file KeyReference.h.

Referenced by show().

QDialog* KeyReference::m_dialog

protected

Definition at line 71 of file KeyReference.h.

Referenced by dialogButtonClicked(), hide(), show(), and ~KeyReference().

---

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

• KeyReference.h
• KeyReference.cpp