KeyConfigPrefs Class Reference

A PrefsPanel for keybindings. More...

#include <KeyConfigPrefs.h>

Inheritance diagram for KeyConfigPrefs:

Collaboration diagram for KeyConfigPrefs:

Public Member Functions
	KeyConfigPrefs (wxWindow *parent, wxWindowID winid, AudacityProject *pProject, const CommandID &name)
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
bool	Commit () override
void	Cancel () override
ManualPageID	HelpPageName () override
	If not empty string, the Help button is added below the panel. More...
void	PopulateOrExchange (ShuttleGui &S) override
Public Member Functions inherited from PrefsPanel
	PrefsPanel (wxWindow *parent, wxWindowID winid, const TranslatableString &title)
virtual	~PrefsPanel ()
virtual void	Preview ()
virtual bool	Commit ()=0
virtual PluginPath	GetPath () const override
virtual VendorSymbol	GetVendor () const override
virtual wxString	GetVersion () const override
virtual bool	ShowsPreviewButton ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual ManualPageID	HelpPageName ()
	If not empty string, the Help button is added below the panel. More...
virtual void	Cancel ()
Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()
	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const TranslatableString &name=XO("Panel"))
void	SetLabel (const TranslatableString &label)
void	SetName (const TranslatableString &name)
void	SetToolTip (const TranslatableString &toolTip)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	Populate ()
void	RefreshBindings (bool bSort)
void	RefreshKeyInfo ()
void	ClearAllKeys ()
bool	ContainsIllegalDups (TranslatableString &fMatching, TranslatableString &sMatching) const
TranslatableString	MergeWithExistingKeys (const std::vector< NormalizedKeyString > &toAdd)
void	FilterKeys (std::vector< NormalizedKeyString > &arr)
CommandID	NameFromKey (const NormalizedKeyString &key)
void	SetKeyForSelected (const NormalizedKeyString &key)
void	OnShow (wxShowEvent &e)
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 (wxEvent &e)
void	OnHotkeyKillFocus (wxEvent &e)
void	OnHotkeyContext (wxEvent &e)
void	OnFilterTimer (wxTimerEvent &e)
void	OnFilterKeyDown (wxKeyEvent &e)
void	OnFilterChar (wxEvent &e)

Private Attributes
KeyView *	mView
wxTextCtrl *	mKey
wxButton *	mSet
wxButton *	mClear
wxTextCtrl *	mFilter
wxStaticText *	mFilterLabel
wxTimer	mFilterTimer
bool	mFilterPending
ViewByType	mViewType
wxRadioButton *	mViewByTree
wxRadioButton *	mViewByName
wxRadioButton *	mViewByKey
AudacityProject *	mProject {}
CommandManager *	mManager
int	mCommandSelected
CommandIDs	mNames
std::vector< NormalizedKeyString >	mDefaultKeys
std::vector< NormalizedKeyString >	mStandardDefaultKeys
std::vector< NormalizedKeyString >	mKeys
std::vector< NormalizedKeyString >	mNewKeys

Additional Inherited Members
Public Types inherited from PrefsPanel
using	Factories = std::vector< PrefsPanel::PrefsNode >
using	Factory = std::function< PrefsPanel *(wxWindow *parent, wxWindowID winid, AudacityProject *) >
Static Public Member Functions inherited from PrefsPanel
static Factories &	DefaultFactories ()

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.

Definition at line 32 of file KeyConfigPrefs.h.

Constructor & Destructor Documentation

KeyConfigPrefs()

KeyConfigPrefs::KeyConfigPrefs	(	wxWindow *	parent,
		wxWindowID	winid,
		AudacityProject *	pProject,
		const CommandID &	name
	)

Definition at line 91 of file KeyConfigPrefs.cpp.

:  PrefsPanel(parent, winid, XO("Keyboard")),
   mView(NULL),
   mKey(NULL),
   mFilter(NULL),
   mFilterTimer(this, FilterTimerID),
   mFilterPending(false)
   , mProject{ pProject }
{
   Populate();
   if (!name.empty()) {
      auto index = mView->GetIndexByName(name);
      mView->SelectNode(index);
   }
 
   // See bug #2315 for discussion. This should be reviewed
   // and (possibly) removed after wx3.1.3.
   Bind(wxEVT_SHOW, &KeyConfigPrefs::OnShow, this);
}

Member Function Documentation

Cancel()

void KeyConfigPrefs::Cancel ( )

overridevirtual

Reimplemented from PrefsPanel.

Definition at line 930 of file KeyConfigPrefs.cpp.

{
   // Restore original key values
   for (size_t i = 0; i < mNames.size(); i++) {
      mManager->SetKeyFromIndex(i, mKeys[i]);
   }
 
   return;
}

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

Here is the call graph for this function:

ClearAllKeys()

void KeyConfigPrefs::ClearAllKeys ( )

private

Definition at line 373 of file KeyConfigPrefs.cpp.

{
   const NormalizedKeyString noKey{ NO_SHORTCUT };
   for (const auto & command : mNames)
      mManager->SetKeyFromName(command, noKey);
}

References mManager, mNames, NO_SHORTCUT, and CommandManager::SetKeyFromName().

Referenced by OnImport().

Here is the call graph for this function:

Here is the caller graph for this function:

Commit()

bool KeyConfigPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 891 of file KeyConfigPrefs.cpp.

{
   // On the Mac, preferences may be changed without any active
   // projects.  This means that the CommandManager isn't available
   // either.  So we can't attempt to save preferences, otherwise
   // NULL ptr dereferences will happen in ShuttleGui because the
   // radio buttons are never created.  (See Populate() above.)
   if ( !mProject ) {
      return true;
   }
 
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   bool bFull = gPrefs->ReadBool(wxT("/GUI/Shortcuts/FullDefaults"), false);
   for (size_t i = 0; i < mNames.size(); i++) {
      const auto &dkey = bFull ? mDefaultKeys[i] : mStandardDefaultKeys[i];
      // using GET to interpret CommandID as a config path component
      auto name = wxT("/NewKeys/") + mNames[i].GET();
      const auto &key = mNewKeys[i];
 
      if (gPrefs->HasEntry(name)) {
         if (key != NormalizedKeyString{ gPrefs->ReadObject(name, key) } ) {
            gPrefs->Write(name, key);
         }
         if (key == dkey) {
            gPrefs->DeleteEntry(name);
         }
      }
      else {
         if (key != dkey) {
            gPrefs->Write(name, key);
         }
      }
   }
 
   return gPrefs->Flush();
}

References FileConfig::DeleteEntry(), eIsSavingToPrefs, FileConfig::Flush(), gPrefs, FileConfig::HasEntry(), key, mDefaultKeys, mNames, mNewKeys, mProject, mStandardDefaultKeys, name, PopulateOrExchange(), S, and wxT().

Here is the call graph for this function:

ContainsIllegalDups()

bool KeyConfigPrefs::ContainsIllegalDups ( TranslatableString &  fMatching, TranslatableString &  sMatching  ) const

private

Definition at line 385 of file KeyConfigPrefs.cpp.

{
   using IndexesArray = std::vector<int>;
   std::unordered_map<NormalizedKeyString, IndexesArray> seen;
 
   for (size_t i{ 0 }; i < mKeys.size(); i++)
   {
      if (mKeys[i] == EMPTY_SHORTCUT || mKeys[i] == NO_SHORTCUT)
         continue;
 
      if (seen.count(mKeys[i]) == 0)
         seen.insert({ mKeys[i], {(int)i} });
      else
      {
         IndexesArray checkMe{ seen.at(mKeys[i]) };
         for (int index : checkMe)
         {
            if (mDefaultKeys[i] == EMPTY_SHORTCUT ||
               mDefaultKeys[i] != mDefaultKeys[index])
            {
               fMatching = mManager->GetPrefixedLabelFromName(mNames[i]);
               sMatching = mManager->GetPrefixedLabelFromName(mNames[index]);
               return true;
            }
            else
               seen.at(mKeys[i]).push_back(index);
         }
      }
   }
   return false;
}

References EMPTY_SHORTCUT, CommandManager::GetPrefixedLabelFromName(), mDefaultKeys, mKeys, mManager, mNames, and NO_SHORTCUT.

Referenced by OnImport().

Here is the call graph for this function:

Here is the caller graph for this function:

FilterKeys()

void KeyConfigPrefs::FilterKeys ( std::vector< NormalizedKeyString > &  arr )

private

Definition at line 607 of file KeyConfigPrefs.cpp.

{
   const auto &MaxListOnly = CommandManager::ExcludedList();
 
   // Remove items that are in MaxList.
   for (size_t i = 0; i < arr.size(); i++) {
      if( std::binary_search(MaxListOnly.begin(), MaxListOnly.end(), arr[i]) )
         arr[i] = {};
   }
}

References CommandManager::ExcludedList().

Referenced by OnImportDefaults(), and RefreshBindings().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDescription()

TranslatableString KeyConfigPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 119 of file KeyConfigPrefs.cpp.

{
   return XO("Preferences for KeyConfig");
}

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol KeyConfigPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 114 of file KeyConfigPrefs.cpp.

{
   return KEY_CONFIG_PREFS_PLUGIN_SYMBOL;
}

References KEY_CONFIG_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID KeyConfigPrefs::HelpPageName ( )

overridevirtual

If not empty string, the Help button is added below the panel.

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 124 of file KeyConfigPrefs.cpp.

{
   return "Keyboard_Preferences";
}

MergeWithExistingKeys()

TranslatableString KeyConfigPrefs::MergeWithExistingKeys ( const std::vector< NormalizedKeyString > &  toAdd )

private

Definition at line 425 of file KeyConfigPrefs.cpp.

{
   TranslatableString disabledShortcuts;
 
   auto searchAddInKeys = [&](size_t index)
   {
      for (size_t k{ 0 }; k < toAdd.size(); k++)
         if (k == index)
            continue;
         else if (toAdd[index] == mKeys[k] &&
            (mDefaultKeys[k] == EMPTY_SHORTCUT ||
             mDefaultKeys[k] != mDefaultKeys[index]))
            return (int)k;
 
      return -1;
   };
   
   const NormalizedKeyString noKey{ EMPTY_SHORTCUT };
 
   for (size_t i{ 0 }; i < toAdd.size(); i++)
   {
      if (mKeys[i] != NO_SHORTCUT)
         continue;
      else if (toAdd[i] == EMPTY_SHORTCUT)
         mManager->SetKeyFromIndex(i, noKey);
      else
      {
         int sRes{ searchAddInKeys(i) };
 
         if (sRes == -1)
            mManager->SetKeyFromIndex(i, toAdd[i]);
         else
         {
            TranslatableString name{ mManager->GetKeyFromName(mNames[sRes]).GET(), {} };
            
            disabledShortcuts +=
               XO(
"\n   *   \"%s\"  (because the shortcut \'%s\' is used by \"%s\")\n")
                  .Format(
                     mManager->GetPrefixedLabelFromName(mNames[i]),
                     name,
                     mManager->GetPrefixedLabelFromName(mNames[sRes]) );
            
            mManager->SetKeyFromIndex(i, noKey);
         }
      }
   }
 
   return disabledShortcuts;
}

References EMPTY_SHORTCUT, Identifier::GET(), CommandManager::GetKeyFromName(), CommandManager::GetPrefixedLabelFromName(), mDefaultKeys, mKeys, mManager, mNames, name, NO_SHORTCUT, CommandManager::SetKeyFromIndex(), and XO().

Referenced by OnImport().

Here is the call graph for this function:

Here is the caller graph for this function:

NameFromKey()

CommandID KeyConfigPrefs::NameFromKey ( const NormalizedKeyString &  key )

private

Definition at line 737 of file KeyConfigPrefs.cpp.

{
   return mView->GetNameByKey(key);
}

References KeyView::GetNameByKey(), key, and mView.

Here is the call graph for this function:

OnClear()

void KeyConfigPrefs::OnClear ( wxCommandEvent &  e )

private

Definition at line 841 of file KeyConfigPrefs.cpp.

{
   mKey->Clear();
 
   if (mCommandSelected != wxNOT_FOUND) {
      SetKeyForSelected({});
   }
}

References mCommandSelected, mKey, and SetKeyForSelected().

Here is the call graph for this function:

OnDefaults()

void KeyConfigPrefs::OnDefaults ( wxCommandEvent &  e )

private

Definition at line 598 of file KeyConfigPrefs.cpp.

{
   wxMenu Menu;
   Menu.Append( 1, _("Standard") );
   Menu.Append( 2, _("Full") );
   Menu.Bind( wxEVT_COMMAND_MENU_SELECTED, &KeyConfigPrefs::OnImportDefaults, this );
   BasicMenu::Handle( &Menu ).Popup( wxWidgetsWindowPlacement{ this } );
}

References _, MenuTable::Menu(), OnImportDefaults(), and BasicMenu::Handle::Popup().

Here is the call graph for this function:

OnExport()

void KeyConfigPrefs::OnExport ( wxCommandEvent &  e )

private

Definition at line 570 of file KeyConfigPrefs.cpp.

{
   wxString file = wxT("Audacity-keys.xml");
 
   file = SelectFile(FileNames::Operation::Export,
      XO("Export Keyboard Shortcuts As:"),
      wxEmptyString,
      file,
      wxT("xml"),
      { FileNames::XMLFiles, FileNames::AllFiles },
      wxFD_SAVE | wxFD_OVERWRITE_PROMPT | wxRESIZE_BORDER,
      this);
 
   if (!file) {
      return;
   }
 
   GuardedCall( [&] {
      XMLFileWriter prefFile{ file, XO("Error Exporting Keyboard Shortcuts") };
      mManager->WriteXML(prefFile);
      prefFile.Commit();
   } );
}

References FileNames::AllFiles, GuardedCall(), mManager, SelectFile(), CommandManager::WriteXML(), wxT(), FileNames::XMLFiles, and XO().

Here is the call graph for this function:

OnFilterChar()

void KeyConfigPrefs::OnFilterChar ( wxEvent &  e )

private

Definition at line 727 of file KeyConfigPrefs.cpp.

{
   if (mViewType != ViewByKey)
   {
      e.Skip();
   }
}

References mViewType, and ViewByKey.

Referenced by PopulateOrExchange().

Here is the caller graph for this function:

OnFilterKeyDown()

void KeyConfigPrefs::OnFilterKeyDown ( wxKeyEvent &  e )

private

Definition at line 685 of file KeyConfigPrefs.cpp.

{
   wxTextCtrl *t = (wxTextCtrl *)e.GetEventObject();
   int keycode = e.GetKeyCode();
 
   // Make sure we can navigate away from the hotkey textctrl.
   // On Linux and OSX, it an get stuck, but it doesn't hurt
   // to do it for Windows as well.
   if (keycode == WXK_TAB) {
      wxNavigationKeyEvent nevent;
      nevent.SetWindowChange(e.ControlDown());
      nevent.SetDirection(!e.ShiftDown());
      nevent.SetEventObject(t);
      nevent.SetCurrentFocus(t);
      t->GetParent()->GetEventHandler()->ProcessEvent(nevent);
 
      return;
   }
 
   if (mViewType == ViewByKey) {
      wxString key = KeyEventToKeyString(e).Display();
      t->SetValue(key);
 
      if (!key.empty()) {
         mView->SetFilter(t->GetValue());
      }
   }
   else
   {
      if (keycode == WXK_RETURN) {
         mFilterPending = false;
         mView->SetFilter(t->GetValue());
      }
      else {
         mFilterPending = true;
         mFilterTimer.Start(500, wxTIMER_ONE_SHOT);
 
         e.Skip();
      }
   }
}

References NormalizedKeyString::Display(), key, KeyEventToKeyString(), mFilterPending, mFilterTimer, mView, mViewType, KeyView::SetFilter(), and ViewByKey.

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnFilterTimer()

void KeyConfigPrefs::OnFilterTimer ( wxTimerEvent &  e )

private

Definition at line 675 of file KeyConfigPrefs.cpp.

{
   // The filter timer has expired, so set the filter
   if (mFilterPending)
   {
      // Do not reset mFilterPending here...possible race
      mView->SetFilter(mFilter->GetValue());
   }
}

References mFilter, mFilterPending, mView, and KeyView::SetFilter().

Here is the call graph for this function:

OnHotkeyChar()

void KeyConfigPrefs::OnHotkeyChar ( wxEvent &  e )

private

Definition at line 656 of file KeyConfigPrefs.cpp.

{
   // event.Skip() not performed, so event will not be processed further.
}

Referenced by PopulateOrExchange().

Here is the caller graph for this function:

OnHotkeyContext()

void KeyConfigPrefs::OnHotkeyContext ( wxEvent &  e )

private

Definition at line 670 of file KeyConfigPrefs.cpp.

{
   // event.Skip() not performed, so event will not be processed further.
}

Referenced by PopulateOrExchange().

Here is the caller graph for this function:

OnHotkeyKeyDown()

void KeyConfigPrefs::OnHotkeyKeyDown ( wxKeyEvent &  e )

private

Definition at line 634 of file KeyConfigPrefs.cpp.

{
   wxTextCtrl *t = (wxTextCtrl *)e.GetEventObject();
 
   // Make sure we can navigate away from the hotkey textctrl.
   // On Linux and OSX, it can get stuck, but it doesn't hurt
   // to do it for Windows as well.
   //
   // Mac note:  Don't waste time trying to figure out why the
   // focus goes back to the prefs tree.  Unless Voiceover is
   // active, buttons on the Mac do not accept focus and all the
   // controls between this one and the tree control are buttons.
   if (e.GetKeyCode() == WXK_TAB) {
      t->Navigate(e.ShiftDown()
                 ? wxNavigationKeyEvent::IsBackward
                 : wxNavigationKeyEvent::IsForward);
      return;
   }
 
   t->SetValue(KeyEventToKeyString(e).Display());
}

References NormalizedKeyString::Display(), and KeyEventToKeyString().

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnHotkeyKillFocus()

void KeyConfigPrefs::OnHotkeyKillFocus ( wxEvent &  e )

private

Definition at line 661 of file KeyConfigPrefs.cpp.

{
   if (mKey->GetValue().empty() && mCommandSelected != wxNOT_FOUND) {
      mKey->AppendText(mView->GetKey(mCommandSelected).Display());
   }
 
   e.Skip();
}

References NormalizedKeyString::Display(), KeyView::GetKey(), mCommandSelected, mKey, and mView.

Referenced by PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnImport()

void KeyConfigPrefs::OnImport ( wxCommandEvent &  e )

private

Definition at line 491 of file KeyConfigPrefs.cpp.

{
   wxString file = wxT("Audacity-keys.xml");
 
   file = SelectFile(FileNames::Operation::Open,
      XO("Select an XML file containing Audacity keyboard shortcuts..."),
      wxEmptyString,
      file,
      wxT(""),
      { FileNames::XMLFiles, FileNames::AllFiles },
      wxRESIZE_BORDER,
      this);
 
   if (!file) {
      return;
   }
 
   // this RefreshKeyInfo is here to account for 
   // potential OnSet() function executions before importing
   RefreshKeyInfo();
 
   // saving pre-import settings
   const std::vector<NormalizedKeyString> oldKeys{ mKeys };
 
   // clearing all pre-import settings
   ClearAllKeys();
 
   // getting new settings
   XMLFileReader reader;
   if (!reader.Parse(mManager, file)) {
      AudacityMessageBox(
         reader.GetErrorStr(),
         XO("Error Importing Keyboard Shortcuts"),
         wxOK | wxCENTRE,
         this);
   }
 
   RefreshKeyInfo();
 
   // checking new setting for duplicates
   // if there are duplicates, throwing error and returning to pre-import state
   TranslatableString fMatching;
   TranslatableString sMatching;
 
   if (ContainsIllegalDups(fMatching, sMatching))
   {
      // restore the old pre-import hotkeys stored in oldKeys
      for (size_t k{ 0 }; k < mNames.size(); k++)
         mManager->SetKeyFromName(mNames[k], oldKeys[k]);
      mKeys = oldKeys;
 
      // output an error message
      AudacityMessageBox(
         XO(
"The file with the shortcuts contains illegal shortcut duplicates for \"%s\" and \"%s\".\nNothing is imported.")
            .Format( fMatching, sMatching ),
         XO("Error Importing Keyboard Shortcuts"),
         wxICON_ERROR | wxCENTRE, this);
 
      // stop the function
      return;
   }
 
   // adding possible old settings to the new settings and recording the conflicting ones
   TranslatableString disabledShortcuts{ MergeWithExistingKeys(oldKeys) };
 
   RefreshBindings(true);
   
   TranslatableString message{ 
      XO("Loaded %d keyboard shortcuts\n").Format(mManager->GetNumberOfKeysRead()) };
 
   if (disabledShortcuts.Translation() != (""))
      message += XO("\nThe following commands are not mentioned in the imported file, "
         "but have their shortcuts removed because of the conflict with other new shortcuts:\n") +
         disabledShortcuts;
 
   AudacityMessageBox(message, XO("Loading Keyboard Shortcuts"), wxOK | wxCENTRE);
}

References FileNames::AllFiles, AudacityMessageBox(), ClearAllKeys(), ContainsIllegalDups(), XMLFileReader::GetErrorStr(), CommandManager::GetNumberOfKeysRead(), MergeWithExistingKeys(), mKeys, mManager, mNames, XMLFileReader::Parse(), RefreshBindings(), RefreshKeyInfo(), SelectFile(), CommandManager::SetKeyFromName(), wxT(), FileNames::XMLFiles, and XO().

Here is the call graph for this function:

OnImportDefaults()

void KeyConfigPrefs::OnImportDefaults ( wxCommandEvent &  e )

private

Definition at line 618 of file KeyConfigPrefs.cpp.

{
   gPrefs->DeleteEntry(wxT("/GUI/Shortcuts/FullDefaults"));
   gPrefs->Flush();
 
   mNewKeys = mDefaultKeys;
   if( event.GetId() == 1 )
      FilterKeys( mNewKeys );
 
   for (size_t i = 0; i < mNewKeys.size(); i++) {
      mManager->SetKeyFromIndex(i, mNewKeys[i]);
   }
 
   RefreshBindings(true);
}

References FileConfig::DeleteEntry(), FilterKeys(), FileConfig::Flush(), gPrefs, mDefaultKeys, mManager, mNewKeys, RefreshBindings(), CommandManager::SetKeyFromIndex(), and wxT().

Referenced by OnDefaults().

Here is the call graph for this function:

Here is the caller graph for this function:

OnSelected()

void KeyConfigPrefs::OnSelected ( wxCommandEvent &  e )

private

Definition at line 850 of file KeyConfigPrefs.cpp.

{
   mCommandSelected = mView->GetSelected();
   mKey->Clear();
 
   if (mCommandSelected != wxNOT_FOUND) {
      bool canset = mView->CanSetKey(mCommandSelected);
      if (canset) {
         mKey->AppendText(mView->GetKey(mCommandSelected).Display());
      }
 
      mKey->Enable(canset);
      mSet->Enable(canset);
      mClear->Enable(canset);
   }
}

References KeyView::CanSetKey(), NormalizedKeyString::Display(), KeyView::GetKey(), KeyView::GetSelected(), mClear, mCommandSelected, mKey, mSet, and mView.

Here is the call graph for this function:

OnSet()

void KeyConfigPrefs::OnSet ( wxCommandEvent &  e )

private

Definition at line 764 of file KeyConfigPrefs.cpp.

{
   if (mCommandSelected == wxNOT_FOUND) {
      AudacityMessageBox(
         XO("You must select a binding before assigning a shortcut"),
         XO("Error"),
         wxICON_WARNING | wxCENTRE,
         this);
      return;
   }
 
   CommandID newCommand{ mView->GetName(mCommandSelected) };
   NormalizedKeyString enteredKey{ mKey->GetValue() };
   NormalizedKeyString newComDefaultKey{ 
      mManager->GetDefaultKeyFromName(newCommand) };
   CommandIDs oldCommands;
 
   // collecting commands competing for the same shortcut
   for (size_t i{ 0 }; i < mNames.size(); i++)
   {
      if (mNewKeys[i] == enteredKey)
      {
         // ignore the Set button if the same shortcut is used
         if (mNames[i] == newCommand)
            return;
 
         if (newComDefaultKey == EMPTY_SHORTCUT ||
            mDefaultKeys[i] != newComDefaultKey)
         {
            oldCommands.push_back(mNames[i]);
         }
      }
   }
 
   // Prevent same hotkey combination being used twice.
   if (!oldCommands.empty()) {
      auto newlabel = Verbatim( wxT("'%s - %s'") )
         .Format(
            mManager->GetCategoryFromName(newCommand),
            mManager->GetPrefixedLabelFromName(newCommand) );
      auto oldlabel = Verbatim(wxT("'%s - %s'"))
         .Format(
            mManager->GetCategoryFromName(oldCommands[0]),
            mManager->GetPrefixedLabelFromName(oldCommands[0]));
 
      for (size_t i{ 1 }; i < oldCommands.size(); i++)
         oldlabel += XO("\n\n\t and\n\n\t") +
         Verbatim(wxT("'%s - %s'")).Format(
            mManager->GetCategoryFromName(oldCommands[i]),
            mManager->GetPrefixedLabelFromName(oldCommands[i]));
      
      if (wxCANCEL == AudacityMessageBox(
            XO(
"The keyboard shortcut '%s' is already assigned to:\n\n\t%s\n\n\nClick OK to assign the shortcut to\n\n\t%s\n\ninstead. Otherwise, click Cancel.")
               .Format(
                  mKey->GetValue(),
                  oldlabel,
                  newlabel
               ),
            XO("Warning"),
            wxOK | wxCANCEL | wxICON_STOP | wxCENTRE,
            this))
      {
         return;
      }
      
      for (const auto & command : oldCommands)
      {
         mView->SetKeyByName(command, {});
         mManager->SetKeyFromName(command, {});
         mNewKeys[make_iterator_range(mNames).index(command)] = {};
      }
   }
 
   SetKeyForSelected(enteredKey);
}

References AudacityMessageBox(), EMPTY_SHORTCUT, TranslatableString::Format(), CommandManager::GetCategoryFromName(), CommandManager::GetDefaultKeyFromName(), KeyView::GetName(), CommandManager::GetPrefixedLabelFromName(), make_iterator_range(), mCommandSelected, mDefaultKeys, mKey, mManager, mNames, mNewKeys, mView, KeyView::SetKeyByName(), SetKeyForSelected(), CommandManager::SetKeyFromName(), Verbatim(), wxT(), and XO().

Here is the call graph for this function:

OnShow()

void KeyConfigPrefs::OnShow ( wxShowEvent &  e )

private

Definition at line 479 of file KeyConfigPrefs.cpp.

{
   event.Skip();
 
   // This is required to prevent a crash if Preferences 
   // were opened without a project.
   if (event.IsShown() && mView != nullptr)
   {
      mView->Refresh();
   }
}

References mView.

OnViewBy()

void KeyConfigPrefs::OnViewBy ( wxCommandEvent &  e )

private

Definition at line 867 of file KeyConfigPrefs.cpp.

{
   switch (e.GetId())
   {
      case ViewByTreeID:
         mViewType = ViewByTree;
         mFilterLabel->SetLabel(_("Searc&h:"));
      break;
 
      case ViewByNameID:
         mViewType = ViewByName;
         mFilterLabel->SetLabel(_("Searc&h:"));
      break;
 
      case ViewByKeyID:
         mViewType = ViewByKey;
         mFilterLabel->SetLabel(_("&Hotkey:"));
      break;
   }
 
   mView->SetView(mViewType);
   mFilter->SetName(wxStripMenuCodes(mFilterLabel->GetLabel()));
}

References _, mFilter, mFilterLabel, mView, mViewType, KeyView::SetView(), ViewByKey, ViewByKeyID, ViewByName, ViewByNameID, ViewByTree, and ViewByTreeID.

Here is the call graph for this function:

Populate()

void KeyConfigPrefs::Populate ( )

private

Definition at line 129 of file KeyConfigPrefs.cpp.

{
   ShuttleGui S(this, eIsCreatingFromPrefs);
 
   if (!mProject) {
      S.StartVerticalLay(true);
      {
         S.StartStatic( {}, true);
         {
            S.AddTitle(XO("Keyboard preferences currently unavailable."));
            S.AddTitle(XO("Open a new project to modify keyboard shortcuts."));
         }
         S.EndStatic();
      }
      S.EndVerticalLay();
 
      return;
   }
 
   PopulateOrExchange(S);
 
   mCommandSelected = wxNOT_FOUND;
 
   mManager = &CommandManager::Get( *mProject );
 
   // For speed, don't sort here.  We're just creating.
   // Instead sort when we do SetView later in this function.
   RefreshBindings(false);
 
   if (mViewByTree->GetValue()) {
      mViewType = ViewByTree;
   }
   else if (mViewByName->GetValue()) {
      mViewType = ViewByName;
   }
   else if (mViewByKey->GetValue()) {
      mViewType = ViewByKey;
      mFilterLabel->SetLabel(_("&Hotkey:"));
      mFilter->SetName(wxStripMenuCodes(mFilterLabel->GetLabel()));
   }
 
   mView->SetView(mViewType);
}

References _, eIsCreatingFromPrefs, CommandManager::Get(), mCommandSelected, mFilter, mFilterLabel, mManager, mProject, mView, mViewByKey, mViewByName, mViewByTree, mViewType, PopulateOrExchange(), RefreshBindings(), S, KeyView::SetView(), ViewByKey, ViewByName, ViewByTree, and XO().

Here is the call graph for this function:

PopulateOrExchange()

void KeyConfigPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Normally in classes derived from PrefsPanel this function is used both to populate the panel and to exchange data with it. With KeyConfigPrefs all the exchanges are handled specially, so this is only used in populating the panel.

Definition at line 177 of file KeyConfigPrefs.cpp.

{
   ChoiceSetting Setting{ L"/Prefs/KeyConfig/ViewBy",
      {
         { wxT("tree"), XXO("&Tree") },
         { wxT("name"), XXO("&Name") },
         { wxT("key"), XXO("&Key") },
      },
      0 // tree
   };
 
   S.SetBorder(2);
 
   S.StartStatic(XO("Key Bindings"), 1);
   {
      S.StartHorizontalLay(wxEXPAND, 0);
      {
         S.Position(wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL).AddTitle(XO("View by:"));
 
         // Bug 2692: Place button group in panel so tabbing will work and,
         // on the Mac, VoiceOver will announce as radio buttons.
         S.StartPanel();
         {
            S.StartHorizontalLay();
            {
               S.StartRadioButtonGroup(Setting);
               {
                  mViewByTree = S.Id(ViewByTreeID)
                     .Name(XO("View by tree"))
                     .TieRadioButton();
                  mViewByName = S.Id(ViewByNameID)
                     .Name(XO("View by name"))
                     .TieRadioButton();
                  mViewByKey = S.Id(ViewByKeyID)
                     .Name(XO("View by key"))
                     .TieRadioButton();
#if !defined(__WXMAC__) && wxUSE_ACCESSIBILITY
                  // so that name can be set on a standard control
                  if (mViewByTree) mViewByTree->SetAccessible(safenew WindowAccessible(mViewByTree));
                  if (mViewByName) mViewByName->SetAccessible(safenew WindowAccessible(mViewByName));
                  if (mViewByKey) mViewByKey->SetAccessible(safenew WindowAccessible(mViewByKey));
#endif
               }
               S.EndRadioButtonGroup();
            }
            S.EndHorizontalLay();
         }
         S.EndPanel();
 
         S.AddSpace(wxDefaultCoord, wxDefaultCoord, 1);
 
         S.StartHorizontalLay(wxALIGN_CENTER_VERTICAL, 0);
         {
            mFilterLabel = S.Position(wxALIGN_CENTER_VERTICAL).AddVariableText(XO("Searc&h:"));
 
            if (!mFilter) {
               mFilter = safenew wxTextCtrl(S.GetParent(),
                                        FilterID,
                                        wxT(""),
                                        wxDefaultPosition,
#if defined(__WXMAC__)
                                        wxSize(300, -1),
#else
                                        wxSize(210, -1),
#endif
                                        wxTE_PROCESS_ENTER);
               mFilter->SetName(wxStripMenuCodes(mFilterLabel->GetLabel()));
            }
            S.Position(wxALIGN_NOT | wxALIGN_LEFT)
               .ConnectRoot(wxEVT_KEY_DOWN,
                            &KeyConfigPrefs::OnFilterKeyDown)
               .ConnectRoot(wxEVT_CHAR,
                            &KeyConfigPrefs::OnFilterChar)
               .AddWindow(mFilter);
         }
         S.EndHorizontalLay();
      }
      S.EndHorizontalLay();
 
      S.AddSpace(wxDefaultCoord, 2);
 
      S.StartHorizontalLay(wxEXPAND, 1);
      {
         if (!mView) {
            mView = safenew KeyView(S.GetParent(), CommandsListID);
            mView->SetName(_("Bindings"));
         }
         S.Prop(true)
            .Position(wxEXPAND)
            .AddWindow(mView);
      }
      S.EndHorizontalLay();
 
      S.StartThreeColumn();
      {
         if (!mKey) {
            mKey = safenew wxTextCtrl(S.GetParent(),
                                  CurrentComboID,
                                  wxT(""),
                                  wxDefaultPosition,
#if defined(__WXMAC__)
                                  wxSize(300, -1),
#else
                                  wxSize(210, -1),
#endif
                                  wxTE_PROCESS_ENTER);
#if !defined(__WXMAC__) && wxUSE_ACCESSIBILITY
            // so that name can be set on a standard control
            mKey->SetAccessible(safenew WindowAccessible(mKey));
#endif
            mKey->SetName(_("Short cut"));
         }
         S
            .ConnectRoot(wxEVT_KEY_DOWN,
                      &KeyConfigPrefs::OnHotkeyKeyDown)
            .ConnectRoot(wxEVT_CHAR,
                      &KeyConfigPrefs::OnHotkeyChar)
            .ConnectRoot(wxEVT_KILL_FOCUS,
                      &KeyConfigPrefs::OnHotkeyKillFocus)
            .ConnectRoot(wxEVT_CONTEXT_MENU,
                      &KeyConfigPrefs::OnHotkeyContext)
            .AddWindow(mKey);
 
         /* i18n-hint: (verb)*/
         mSet = S.Id(SetButtonID).AddButton(XXO("&Set"));
         /* i18n-hint: (verb)*/
         mClear = S.Id(ClearButtonID).AddButton(XXO("Cl&ear"));
      }
      S.EndThreeColumn();
 
#if defined(__WXMAC__)
      S.AddFixedText(XO("Note: Pressing Cmd+Q will quit. All other keys are valid."));
#endif
 
      S.StartThreeColumn();
      {
         S.Id(ImportButtonID).AddButton(XXO("&Import..."));
         S.Id(ExportButtonID).AddButton(XXO("&Export..."));
         S.Id(AssignDefaultsButtonID).AddButton(XXO("&Defaults"));
      }
      S.EndThreeColumn();
   }
   S.EndStatic();
 
 
   // Need to layout so that the KeyView is properly sized before populating.
   // Otherwise, the initial selection is not scrolled into view.
   Layout();
}

References _, AssignDefaultsButtonID, ClearButtonID, CommandsListID, CurrentComboID, ExportButtonID, FilterID, ImportButtonID, mClear, mFilter, mFilterLabel, mKey, mSet, mView, mViewByKey, mViewByName, mViewByTree, OnFilterChar(), OnFilterKeyDown(), OnHotkeyChar(), OnHotkeyContext(), OnHotkeyKeyDown(), OnHotkeyKillFocus(), S, safenew, SetButtonID, ViewByKeyID, ViewByNameID, ViewByTreeID, wxT(), XO(), and XXO().

Referenced by Commit(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

RefreshBindings()

void KeyConfigPrefs::RefreshBindings ( bool  bSort )

private

Definition at line 327 of file KeyConfigPrefs.cpp.

{
   TranslatableStrings Labels;
   TranslatableStrings Categories;
   TranslatableStrings Prefixes;
 
   mNames.clear();
   mKeys.clear();
   mDefaultKeys.clear();
   mStandardDefaultKeys.clear();
   mManager->GetAllCommandData(
      mNames,
      mKeys,
      mDefaultKeys,
      Labels,
      Categories,
      Prefixes,
      true); // True to include effects (list items), false otherwise.
 
   mStandardDefaultKeys = mDefaultKeys;
   FilterKeys( mStandardDefaultKeys );
 
   mView->RefreshBindings(mNames,
                          Categories,
                          Prefixes,
                          Labels,
                          mKeys,
                          bSort);
   //Not needed as NEW nodes are already shown expanded.
   //mView->ExpandAll();
 
   mNewKeys = mKeys;
}

References FilterKeys(), CommandManager::GetAllCommandData(), mDefaultKeys, mKeys, mManager, mNames, mNewKeys, mStandardDefaultKeys, mView, and KeyView::RefreshBindings().

Referenced by OnImport(), OnImportDefaults(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

RefreshKeyInfo()

void KeyConfigPrefs::RefreshKeyInfo ( )

private

Definition at line 363 of file KeyConfigPrefs.cpp.

{
   mKeys.clear();
 
   for (const auto & name : mNames)
      mKeys.push_back(mManager->GetKeyFromName(name));
}

References CommandManager::GetKeyFromName(), mKeys, mManager, mNames, and name.

Referenced by OnImport().

Here is the call graph for this function:

Here is the caller graph for this function:

SetKeyForSelected()

void KeyConfigPrefs::SetKeyForSelected ( const NormalizedKeyString &  key )

private

Definition at line 744 of file KeyConfigPrefs.cpp.

{
   auto name = mView->GetName(mCommandSelected);
 
   if (!mView->CanSetKey(mCommandSelected))
   {
      AudacityMessageBox(
         XO("You may not assign a key to this entry"),
         XO("Error"),
         wxICON_ERROR | wxCENTRE,
         this);
      return;
   }
 
   mView->SetKey(mCommandSelected, key);
   mManager->SetKeyFromName(name, key);
   mNewKeys[ make_iterator_range( mNames ).index( name ) ] = key;
}

References AudacityMessageBox(), KeyView::CanSetKey(), KeyView::GetName(), key, make_iterator_range(), mCommandSelected, mManager, mNames, mNewKeys, mView, name, KeyView::SetKey(), CommandManager::SetKeyFromName(), and XO().

Referenced by OnClear(), and OnSet().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mClear

wxButton* KeyConfigPrefs::mClear

private

Definition at line 84 of file KeyConfigPrefs.h.

Referenced by OnSelected(), and PopulateOrExchange().

mCommandSelected

int KeyConfigPrefs::mCommandSelected

private

Definition at line 99 of file KeyConfigPrefs.h.

Referenced by OnClear(), OnHotkeyKillFocus(), OnSelected(), OnSet(), Populate(), and SetKeyForSelected().

mDefaultKeys

std::vector<NormalizedKeyString> KeyConfigPrefs::mDefaultKeys

private

Definition at line 102 of file KeyConfigPrefs.h.

Referenced by Commit(), ContainsIllegalDups(), MergeWithExistingKeys(), OnImportDefaults(), OnSet(), and RefreshBindings().

mFilter

wxTextCtrl* KeyConfigPrefs::mFilter

private

Definition at line 86 of file KeyConfigPrefs.h.

Referenced by OnFilterTimer(), OnViewBy(), Populate(), and PopulateOrExchange().

mFilterLabel

wxStaticText* KeyConfigPrefs::mFilterLabel

private

Definition at line 87 of file KeyConfigPrefs.h.

Referenced by OnViewBy(), Populate(), and PopulateOrExchange().

mFilterPending

bool KeyConfigPrefs::mFilterPending

private

Definition at line 89 of file KeyConfigPrefs.h.

Referenced by OnFilterKeyDown(), and OnFilterTimer().

mFilterTimer

wxTimer KeyConfigPrefs::mFilterTimer

private

Definition at line 88 of file KeyConfigPrefs.h.

Referenced by OnFilterKeyDown().

mKey

wxTextCtrl* KeyConfigPrefs::mKey

private

Definition at line 82 of file KeyConfigPrefs.h.

Referenced by OnClear(), OnHotkeyKillFocus(), OnSelected(), OnSet(), and PopulateOrExchange().

mKeys

std::vector<NormalizedKeyString> KeyConfigPrefs::mKeys

private

Definition at line 104 of file KeyConfigPrefs.h.

Referenced by Cancel(), ContainsIllegalDups(), MergeWithExistingKeys(), OnImport(), RefreshBindings(), and RefreshKeyInfo().

mManager

CommandManager* KeyConfigPrefs::mManager

private

Definition at line 98 of file KeyConfigPrefs.h.

Referenced by Cancel(), ClearAllKeys(), ContainsIllegalDups(), MergeWithExistingKeys(), OnExport(), OnImport(), OnImportDefaults(), OnSet(), Populate(), RefreshBindings(), RefreshKeyInfo(), and SetKeyForSelected().

mNames

CommandIDs KeyConfigPrefs::mNames

private

Definition at line 101 of file KeyConfigPrefs.h.

Referenced by Cancel(), ClearAllKeys(), Commit(), ContainsIllegalDups(), MergeWithExistingKeys(), OnImport(), OnSet(), RefreshBindings(), RefreshKeyInfo(), and SetKeyForSelected().

mNewKeys

std::vector<NormalizedKeyString> KeyConfigPrefs::mNewKeys

private

Definition at line 105 of file KeyConfigPrefs.h.

Referenced by Commit(), OnImportDefaults(), OnSet(), RefreshBindings(), and SetKeyForSelected().

mProject

AudacityProject* KeyConfigPrefs::mProject {}

private

Definition at line 96 of file KeyConfigPrefs.h.

Referenced by Commit(), and Populate().

mSet

wxButton* KeyConfigPrefs::mSet

private

Definition at line 83 of file KeyConfigPrefs.h.

Referenced by OnSelected(), and PopulateOrExchange().

mStandardDefaultKeys

std::vector<NormalizedKeyString> KeyConfigPrefs::mStandardDefaultKeys

private

Definition at line 103 of file KeyConfigPrefs.h.

Referenced by Commit(), and RefreshBindings().

mView

KeyView* KeyConfigPrefs::mView

private

Definition at line 81 of file KeyConfigPrefs.h.

Referenced by NameFromKey(), OnFilterKeyDown(), OnFilterTimer(), OnHotkeyKillFocus(), OnSelected(), OnSet(), OnShow(), OnViewBy(), Populate(), PopulateOrExchange(), RefreshBindings(), and SetKeyForSelected().

mViewByKey

wxRadioButton* KeyConfigPrefs::mViewByKey

private

Definition at line 94 of file KeyConfigPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

mViewByName

wxRadioButton* KeyConfigPrefs::mViewByName

private

Definition at line 93 of file KeyConfigPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

mViewByTree

wxRadioButton* KeyConfigPrefs::mViewByTree

private

Definition at line 92 of file KeyConfigPrefs.h.

Referenced by Populate(), and PopulateOrExchange().

mViewType

ViewByType KeyConfigPrefs::mViewType

private

Definition at line 91 of file KeyConfigPrefs.h.

Referenced by OnFilterChar(), OnFilterKeyDown(), OnViewBy(), and Populate().

---

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

• KeyConfigPrefs.h
• KeyConfigPrefs.cpp