Audacity  2.2.0
KeyConfigPrefs Class Referencefinal

A PrefsPanel for keybindings. More...

#include <KeyConfigPrefs.h>

Inheritance diagram for KeyConfigPrefs:
PrefsPanel wxTabTraversalWrapper< Base >

Public Member Functions

 KeyConfigPrefs (wxWindow *parent)
 
 ~KeyConfigPrefs ()
 
bool Commit () override
 
void Cancel () override
 
wxString HelpPageName () override
 
- Public Member Functions inherited from PrefsPanel
 PrefsPanel (wxWindow *parent, const wxString &title)
 
virtual ~PrefsPanel ()
 
virtual void Preview ()
 
virtual bool ShowsPreviewButton ()
 
- Public Member Functions inherited from wxTabTraversalWrapper< Base >
template<typename... Args>
 wxTabTraversalWrapper (Args &&...args)
 
 ~wxTabTraversalWrapper ()
 

Private Member Functions

void Populate ()
 
void PopulateOrExchange (ShuttleGui &S)
 
void RefreshBindings (bool bSort)
 
void FilterKeys (wxArrayString &arr)
 
wxString NameFromKey (const wxString &key)
 
void SetKeyForSelected (const wxString &key)
 
void OnViewBy (wxCommandEvent &e)
 
void OnDefaults (wxCommandEvent &e)
 
void OnImportDefaults (wxCommandEvent &e)
 
void OnImport (wxCommandEvent &e)
 
void OnExport (wxCommandEvent &e)
 
void OnSet (wxCommandEvent &e)
 
void OnClear (wxCommandEvent &e)
 
void OnSelected (wxCommandEvent &e)
 
void OnHotkeyKeyDown (wxKeyEvent &e)
 
void OnHotkeyChar (wxKeyEvent &e)
 
void OnHotkeyKillFocus (wxFocusEvent &e)
 
void OnFilterTimer (wxTimerEvent &e)
 
void OnFilterKeyDown (wxKeyEvent &e)
 
void OnFilterChar (wxKeyEvent &e)
 

Private Attributes

KeyViewmView
 
wxTextCtrl * mKey
 
wxButton * mSet
 
wxButton * mClear
 
wxTextCtrl * mFilter
 
wxStaticText * mFilterLabel
 
wxTimer mFilterTimer
 
bool mFilterPending
 
ViewByType mViewType
 
wxRadioButton * mViewByTree
 
wxRadioButton * mViewByName
 
wxRadioButton * mViewByKey
 
CommandManagermManager
 
int mCommandSelected
 
wxArrayString mNames
 
wxArrayString mDefaultKeys
 
wxArrayString mStandardDefaultKeys
 
wxArrayString mKeys
 
wxArrayString mNewKeys
 

Detailed Description

A PrefsPanel for keybindings.

The code for displaying keybindings is similar to code in MousePrefs. It would be nice to create a NEW 'Bindings' class which both KeyConfigPrefs and MousePrefs use.

Constructor & Destructor Documentation

KeyConfigPrefs::KeyConfigPrefs ( wxWindow *  parent)
KeyConfigPrefs::~KeyConfigPrefs ( )

Member Function Documentation

void KeyConfigPrefs::Cancel ( )
overridevirtual

Reimplemented from PrefsPanel.

References mKeys, mManager, mNames, and CommandManager::SetKeyFromIndex().

bool KeyConfigPrefs::Commit ( )
overridevirtual
void KeyConfigPrefs::FilterKeys ( wxArrayString &  arr)
private
wxString KeyConfigPrefs::HelpPageName ( )
overridevirtual

Reimplemented from PrefsPanel.

wxString KeyConfigPrefs::NameFromKey ( const wxString &  key)
private

References KeyView::GetNameByKey(), and mView.

void KeyConfigPrefs::OnClear ( wxCommandEvent &  e)
private
void KeyConfigPrefs::OnDefaults ( wxCommandEvent &  e)
private

References _(), and OnImportDefaults().

void KeyConfigPrefs::OnExport ( wxCommandEvent &  e)
private
void KeyConfigPrefs::OnFilterChar ( wxKeyEvent &  e)
private

References mViewType, and ViewByKey.

Referenced by PopulateOrExchange(), and ~KeyConfigPrefs().

void KeyConfigPrefs::OnFilterKeyDown ( wxKeyEvent &  e)
private
void KeyConfigPrefs::OnFilterTimer ( wxTimerEvent &  e)
private
void KeyConfigPrefs::OnHotkeyChar ( wxKeyEvent &  e)
private
void KeyConfigPrefs::OnHotkeyKeyDown ( wxKeyEvent &  e)
private
void KeyConfigPrefs::OnHotkeyKillFocus ( wxFocusEvent &  e)
private
void KeyConfigPrefs::OnImport ( wxCommandEvent &  e)
private
void KeyConfigPrefs::OnImportDefaults ( wxCommandEvent &  e)
private
void KeyConfigPrefs::OnSelected ( wxCommandEvent &  e)
private
void KeyConfigPrefs::OnViewBy ( wxCommandEvent &  e)
private
void KeyConfigPrefs::RefreshBindings ( bool  bSort)
private
void KeyConfigPrefs::SetKeyForSelected ( const wxString &  key)
private

Member Data Documentation

wxButton* KeyConfigPrefs::mClear
private

Referenced by OnSelected(), and PopulateOrExchange().

int KeyConfigPrefs::mCommandSelected
private
wxArrayString KeyConfigPrefs::mDefaultKeys
private
wxTextCtrl* KeyConfigPrefs::mFilter
private
wxStaticText* KeyConfigPrefs::mFilterLabel
private
bool KeyConfigPrefs::mFilterPending
private

Referenced by OnFilterKeyDown(), and OnFilterTimer().

wxTimer KeyConfigPrefs::mFilterTimer
private

Referenced by OnFilterKeyDown().

wxTextCtrl* KeyConfigPrefs::mKey
private
wxArrayString KeyConfigPrefs::mKeys
private

Referenced by Cancel(), and RefreshBindings().

wxArrayString KeyConfigPrefs::mNames
private
wxArrayString KeyConfigPrefs::mNewKeys
private
wxButton* KeyConfigPrefs::mSet
private

Referenced by OnSelected(), and PopulateOrExchange().

wxArrayString KeyConfigPrefs::mStandardDefaultKeys
private

Referenced by Commit(), and RefreshBindings().

wxRadioButton* KeyConfigPrefs::mViewByKey
private

Referenced by Populate(), and PopulateOrExchange().

wxRadioButton* KeyConfigPrefs::mViewByName
private

Referenced by Populate(), and PopulateOrExchange().

wxRadioButton* KeyConfigPrefs::mViewByTree
private

Referenced by Populate(), and PopulateOrExchange().

ViewByType KeyConfigPrefs::mViewType
private

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