PrefsDialog Class Reference

Dialog that shows the current PrefsPanel in a tabbed divider. More...

#include <PrefsDialog.h>

Inheritance diagram for PrefsDialog:

Collaboration diagram for PrefsDialog:

Public Member Functions
	PrefsDialog (wxWindow *parent, AudacityProject *pProject, const TranslatableString &titlePrefix=XO("Preferences:"), PrefsPanel::Factories &factories=PrefsPanel::DefaultFactories())
virtual	~PrefsDialog ()
int	ShowModal () override
void	ShuttleAll (ShuttleGui &S)
void	OnCategoryChange (wxCommandEvent &e)
void	OnOK (wxCommandEvent &e)
void	OnCancel (wxCommandEvent &e)
void	OnPreview (wxCommandEvent &e)
void	OnHelp (wxCommandEvent &e)
void	OnTreeKeyDown (wxTreeEvent &e)
void	SelectPageByName (const wxString &pageName)
int	GetSelectedPage () const
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()
	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
void	SetTitle (const TranslatableString &title)
void	SetLabel (const TranslatableString &title)
void	SetName (const TranslatableString &title)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Protected Member Functions
virtual long	GetPreferredPage ()=0
virtual void	SavePreferredPage ()=0

Private Member Functions
void	RecordExpansionState ()
PrefsPanel *	GetCurrentPanel ()

Private Attributes
wxTreebook *	mCategories {}
PrefsPanel *	mUniquePage {}
PrefsPanel::Factories &	mFactories
const TranslatableString	mTitlePrefix
std::unique_ptr< SettingTransaction >	mTransaction

Detailed Description

Dialog that shows the current PrefsPanel in a tabbed divider.

Definition at line 28 of file PrefsDialog.h.

Constructor & Destructor Documentation

PrefsDialog()

PrefsDialog::PrefsDialog	(	wxWindow *	parent,
		AudacityProject *	pProject,
		const TranslatableString &	titlePrefix = XO("Preferences:"),
		PrefsPanel::Factories &	factories = PrefsPanel::DefaultFactories()
	)

Definition at line 443 of file PrefsDialog.cpp.

:  wxDialogWrapper(parent, wxID_ANY, XO("Audacity Preferences"),
            wxDefaultPosition,
            wxDefaultSize,
            wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER)
, mFactories(factories)
, mTitlePrefix(titlePrefix)
{
   wxASSERT(factories.size() > 0);
   const bool uniquePage = (factories.size() == 1);
   SetLayoutDirection(wxLayout_LeftToRight);
 
   ShuttleGui S(this, eIsCreating);
 
   S.StartVerticalLay(true);
   {
      wxASSERT(factories.size() > 0);
      if (!uniquePage) {
         mCategories = safenew wxTreebookExt(S.GetParent(), wxID_ANY, mTitlePrefix);
#if wxUSE_ACCESSIBILITY
         // so that name can be set on a standard control
         mCategories->GetTreeCtrl()->SetAccessible(
            safenew TreeCtrlAx(mCategories->GetTreeCtrl()));
#endif
         // RJH: Prevent NVDA from reading "treeCtrl"
         mCategories->GetTreeCtrl()->SetName(_("Category"));
         S.StartHorizontalLay(wxALIGN_LEFT | wxEXPAND, true);
         {
            S.Prop(1)
               .Position(wxEXPAND)
               .AddWindow(mCategories);
 
            {
               typedef std::pair<int, int> IntPair;
               std::vector<IntPair> stack;
               int iPage = 0;
               for (auto it = factories.begin(), end = factories.end();
                  it != end; ++it, ++iPage)
               {
                  const auto &node = *it;
                  const auto &factory = node.factory;
                  wxWindow *const w = factory(mCategories, wxID_ANY, pProject);
                  node.enabled = (w != nullptr);
                  if (stack.empty()) {
                     // Parameters are: AddPage(page, name, IsSelected, imageId).
                     if (w)
                        mCategories->AddPage(w, w->GetName(), false, 0);
                  }
                  else {
                     IntPair &top = *stack.rbegin();
                     if (w)
                        mCategories->InsertSubPage(top.first,
                           w, w->GetName(), false, 0);
                     if (--top.second == 0) {
                        // Expand all nodes before the layout calculation
                        mCategories->ExpandNode(top.first, true);
                        stack.pop_back();
                     }
                  }
                  if (node.nChildren > 0)
                     stack.push_back(IntPair(iPage, node.nChildren));
               }
            }
         }
         S.EndHorizontalLay();
      }
      else {
         // TODO: Look into getting rid of mUniquePage and instead
         // adding into mCategories, so there is just one page in mCategories.
         // And then hiding the treebook.
 
         // Unique page, don't show the factory
         const auto &node = factories[0];
         const auto &factory = node.factory;
         mUniquePage = factory(S.GetParent(), wxID_ANY, pProject);
         node.enabled = (mUniquePage != nullptr);
         if (mUniquePage) {
            wxWindow * uniquePageWindow = S.Prop(1)
               .Position(wxEXPAND)
               .AddWindow(mUniquePage);
            // We're not in the wxTreebook, so add the accelerator here
            wxAcceleratorEntry entries[1];
#if defined(__WXMAC__)
            // Is there a standard shortcut on Mac?
#else
            entries[0].Set(wxACCEL_NORMAL, (int) WXK_F1, wxID_HELP);
#endif
            wxAcceleratorTable accel(1, entries);
            uniquePageWindow->SetAcceleratorTable(accel);
         }
      }
   }
   S.EndVerticalLay();
 
   S.AddStandardButtons(eOkButton | eCancelButton | ePreviewButton | eHelpButton);
 
   if (mUniquePage && !mUniquePage->ShowsPreviewButton()) {
      wxWindow *const previewButton =
         wxWindow::FindWindowById(wxID_PREVIEW, GetParent());
      previewButton->Show(false);
   }
 
#if defined(__WXGTK__)
   if (mCategories)
      mCategories->GetTreeCtrl()->EnsureVisible(mCategories->GetTreeCtrl()->GetRootItem());
#endif
 
//   mCategories->SetMaxSize({ 790, 600 });  // 790 = 800 - (border * 2)
   Layout();
   Fit();
   wxSize sz = GetSize();
 
   // Collapse nodes only after layout so the tree is wide enough
   if (mCategories)
   {
      int iPage = 0;
      for (auto it = factories.begin(), end = factories.end();
         it != end; ++it) {
         if (it->enabled)
            mCategories->ExpandNode(iPage++, it->expanded);
      }
   }
 
   // This ASSERT was originally used to limit us to 800 x 600.
   // However, the range of screen sizes and dpi of modern (2018) displays
   // makes pixel dimensions an inadequate measure of usability, so
   // now we only ASSERT that preferences will fit in the client display
   // rectangle of the developer / tester's monitor.
   // Use scrollers when necessary to ensure that preference pages will
   // be fully visible.
   wxRect screenRect(wxGetClientDisplayRect());
   wxASSERT_MSG(sz.x <= screenRect.width && sz.y <= screenRect.height, wxT("Preferences dialog exceeds max size"));
 
   sz.DecTo(screenRect.GetSize());
 
   if( !mUniquePage ){
      int prefWidth, prefHeight;
      gPrefs->Read(wxT("/Prefs/Width"), &prefWidth, sz.x);
      gPrefs->Read(wxT("/Prefs/Height"), &prefHeight, wxMax(480,sz.y));
 
      wxSize prefSize = wxSize(prefWidth, prefHeight);
      prefSize.DecTo(screenRect.GetSize());
      SetSize(prefSize);
      InvalidateBestSize();
      Layout();
   }
   SetMinSize(sz);
 
   // Center after all that resizing, but make sure it doesn't end up
   // off-screen
   CentreOnParent();
 
   mTransaction = std::make_unique< SettingTransaction >();
}

References _, eCancelButton, eHelpButton, eIsCreating, PackedArray::end(), entries, eOkButton, ePreviewButton, cloud::factory, gPrefs, mCategories, mTitlePrefix, mTransaction, mUniquePage, audacity::BasicSettings::Read(), S, safenew, PrefsPanel::ShowsPreviewButton(), and wxT().

Referenced by anonymous_namespace{SpectrumView.cpp}::SpectrogramSettingsHandler::OnSpectrogramSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

~PrefsDialog()

PrefsDialog::~PrefsDialog ( )

virtual

Definition at line 601 of file PrefsDialog.cpp.

{
}

Member Function Documentation

GetCurrentPanel()

PrefsPanel * PrefsDialog::GetCurrentPanel ( )

private

Definition at line 651 of file PrefsDialog.cpp.

{
   if( mCategories) 
      return static_cast<PrefsPanel*>(mCategories->GetCurrentPage());
   else
      return mUniquePage;
}

References mCategories, and mUniquePage.

Referenced by OnHelp(), and OnPreview().

Here is the caller graph for this function:

GetPreferredPage()

virtual long PrefsDialog::GetPreferredPage ( )

protectedpure virtual

Implemented in GlobalPrefsDialog, and anonymous_namespace{AudioSetupToolBar.cpp}::ViewDeviceSettingsDialog.

Referenced by anonymous_namespace{SpectrumView.cpp}::SpectrogramSettingsHandler::OnSpectrogramSettings(), and ShowModal().

Here is the caller graph for this function:

GetSelectedPage()

int PrefsDialog::GetSelectedPage

(

)

const

Definition at line 811 of file PrefsDialog.cpp.

{
   if (mCategories)
      return mCategories->GetSelection();
   else
      return 0;
}

References mCategories.

Referenced by GlobalPrefsDialog::SavePreferredPage().

Here is the caller graph for this function:

OnCancel()

void PrefsDialog::OnCancel

(

wxCommandEvent &

e

)

Definition at line 628 of file PrefsDialog.cpp.

{
   RecordExpansionState();
 
   if (mCategories) {
      for (size_t i = 0; i < mCategories->GetPageCount(); i++) {
         ((PrefsPanel *)mCategories->GetPage(i))->Cancel();
      }
   }
   else if (mUniquePage)
      mUniquePage->Cancel();
 
   // Remember modified dialog size, even if cancelling.
   if( !mUniquePage ){
      wxSize sz = GetSize();
      gPrefs->Write(wxT("/Prefs/Width"), sz.x);
      gPrefs->Write(wxT("/Prefs/Height"), sz.y);
   }
   gPrefs->Flush();
 
   EndModal(false);
}

References PrefsPanel::Cancel(), audacity::BasicSettings::Flush(), gPrefs, mCategories, mUniquePage, RecordExpansionState(), audacity::BasicSettings::Write(), and wxT().

Here is the call graph for this function:

OnCategoryChange()

void PrefsDialog::OnCategoryChange

(

wxCommandEvent &

e

)

OnHelp()

void PrefsDialog::OnHelp

(

wxCommandEvent &

e

)

Definition at line 665 of file PrefsDialog.cpp.

{
   if (const auto pPanel = GetCurrentPanel()) {
      const auto &page = pPanel->HelpPageName();
      HelpSystem::ShowHelp(this, page, true);
   }
}

References GetCurrentPanel(), and HelpSystem::ShowHelp().

Here is the call graph for this function:

OnOK()

void PrefsDialog::OnOK

(

wxCommandEvent &

e

)

Definition at line 699 of file PrefsDialog.cpp.

{
   RecordExpansionState();
 
   // Validate all pages first
   if (mCategories) {
      for (size_t i = 0; i < mCategories->GetPageCount(); i++) {
         PrefsPanel *panel = (PrefsPanel *)mCategories->GetPage(i);
 
         // The dialog doesn't end until all the input is valid
         if (!panel->Validate()) {
            mCategories->SetSelection(i);
            return;
         }
      }
   }
   else if (mUniquePage) {
      if (!mUniquePage->Validate())
         return;
   }
 
   // flush now so toolbars will know their position.
   gPrefs->Flush();
   if (mCategories) {
      // Now apply the changes
      // Reverse order - so Track Name is updated before language change
      // A workaround for Bug 1661
      for (int i = (int)mCategories->GetPageCount()-1; i>= 0; i--) {
         PrefsPanel *panel = (PrefsPanel *)mCategories->GetPage(i);
 
         panel->Preview();
         panel->Commit();
      }
   }
   else if (mUniquePage) {
      mUniquePage->Preview();
      mUniquePage->Commit();
   }
 
   if( !mUniquePage ){
      wxSize sz = GetSize();
      gPrefs->Write(wxT("/Prefs/Width"), sz.x);
      gPrefs->Write(wxT("/Prefs/Height"), sz.y);
   }
   gPrefs->Flush();
 
   SavePreferredPage();
 
#if USE_PORTMIXER
   auto gAudioIO = AudioIOBase::Get();
   if (gAudioIO) {
      // We cannot have opened this dialog if gAudioIO->IsAudioTokenActive(),
      // per the setting of AudioIONotBusyFlag and AudioIOBusyFlag in
      // AudacityProject::GetUpdateFlags().
      // However, we can have an invalid audio token (so IsAudioTokenActive()
      // is false), but be monitoring.
      // If monitoring, have to stop the stream, so HandleDeviceChange() can work.
      // We could disable the Preferences command while monitoring, i.e.,
      // set AudioIONotBusyFlag/AudioIOBusyFlag according to monitoring, as well.
      // Instead allow it because unlike recording, for example, monitoring
      // is not clearly something that should prohibit opening prefs.
      // TODO: We *could* be smarter in this method and call HandleDeviceChange()
      // only when the device choices actually changed. True of lots of prefs!
      // As is, we always stop monitoring before handling the device change.
      if (gAudioIO->IsMonitoring())
      {
         gAudioIO->StopStream();
         while (gAudioIO->IsBusy()) {
            using namespace std::chrono;
            std::this_thread::sleep_for(100ms);
         }
      }
      gAudioIO->HandleDeviceChange();
   }
#endif
 
   // PRL:  Is the following concern still valid, now that prefs update is
   //      handled instead by delayed event processing?
 
   // LL:  wxMac can't handle recreating the menus when this dialog is still active,
   //      so AudacityProject::UpdatePrefs() or any of the routines it calls must
   //      not cause MenuCreator::RebuildMenuBar() to be executed.
 
   PrefsListener::Broadcast();
 
   mTransaction->Commit();
 
   if( IsModal() )
      EndModal(true);
   else
      Destroy();
}

References PrefsListener::Broadcast(), PrefsPanel::Commit(), audacity::BasicSettings::Flush(), AudioIOBase::Get(), gPrefs, mCategories, mTransaction, mUniquePage, PrefsPanel::Preview(), RecordExpansionState(), SavePreferredPage(), audacity::BasicSettings::Write(), and wxT().

Referenced by DoReloadPreferences(), and OnTreeKeyDown().

Here is the call graph for this function:

Here is the caller graph for this function:

OnPreview()

void PrefsDialog::OnPreview

(

wxCommandEvent &

e

)

Definition at line 659 of file PrefsDialog.cpp.

{
   if (const auto pPanel = GetCurrentPanel())
      pPanel->Preview();
}

References GetCurrentPanel().

Here is the call graph for this function:

OnTreeKeyDown()

void PrefsDialog::OnTreeKeyDown

(

wxTreeEvent &

e

)

Definition at line 691 of file PrefsDialog.cpp.

{
   if(event.GetKeyCode() == WXK_RETURN)
      OnOK(event);
   else
      event.Skip(); // Ensure standard behavior when enter is not pressed
}

References OnOK().

Here is the call graph for this function:

RecordExpansionState()

void PrefsDialog::RecordExpansionState ( )

private

Definition at line 842 of file PrefsDialog.cpp.

{
   // Remember expansion state of the tree control
   if (mCategories)
   {
      int iPage = 0;
      for (auto it = mFactories.begin(), end = mFactories.end();
         it != end; ++it) {
         if (it->enabled)
            it->expanded = mCategories->IsNodeExpanded(iPage++);
      }
   }
   else
      mFactories[0].expanded = true;
}

References PackedArray::end(), mCategories, and mFactories.

Referenced by OnCancel(), and OnOK().

Here is the call graph for this function:

Here is the caller graph for this function:

SavePreferredPage()

virtual void PrefsDialog::SavePreferredPage ( )

protectedpure virtual

Implemented in GlobalPrefsDialog, and anonymous_namespace{AudioSetupToolBar.cpp}::ViewDeviceSettingsDialog.

Referenced by OnOK(), anonymous_namespace{SpectrumView.cpp}::SpectrogramSettingsHandler::OnSpectrogramSettings(), and SelectPageByName().

Here is the caller graph for this function:

SelectPageByName()

void PrefsDialog::SelectPageByName

(

const wxString &

pageName

)

Definition at line 792 of file PrefsDialog.cpp.

{
   if (mCategories) {
      size_t n = mCategories->GetPageCount();
 
      for (size_t i = 0; i < n; i++) {
         if (mCategories->GetPageText(i) == pageName) {
            mCategories->SetSelection(i);
            // This covers the case, when ShowModal is called 
            // after selecting the page.
            // ShowModal will select the page previously used by 
            // user
            SavePreferredPage();
            return;
         }
      }
   }
}

References mCategories, and SavePreferredPage().

Referenced by NoUpdatesAvailableDialog::NoUpdatesAvailableDialog(), UnwritableLocationErrorDialog::UnwritableLocationErrorDialog(), and UpdateNoticeDialog::UpdateNoticeDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

ShowModal()

int PrefsDialog::ShowModal ( )

override

Definition at line 605 of file PrefsDialog.cpp.

{
   if (mCategories) {
      /* long is signed, size_t is unsigned. On some platforms they are different
       * lengths as well. So we must check that the stored category is both > 0
       * and within the possible range of categories, making the first check on the
       * _signed_ value to avoid issues when converting an unsigned one.
       */
      long selected = GetPreferredPage();
      if (selected < 0 || size_t(selected) >= mCategories->GetPageCount())
         selected = 0;  // clamp to available range of tabs
      mCategories->SetSelection(selected);
   }
   else if (mUniquePage) {
      auto Temp = mTitlePrefix;
      Temp.Join( Verbatim( mUniquePage->GetLabel() ), wxT(" ") );
      SetTitle(Temp);
      SetName(Temp);
   }
 
   return wxDialogWrapper::ShowModal();
}

References GetPreferredPage(), TranslatableString::Join(), mCategories, mTitlePrefix, mUniquePage, wxDialogWrapper::SetName(), wxDialogWrapper::SetTitle(), Verbatim(), and wxT().

Referenced by AudacityApp::InitPart2(), AudacityApp::InitTempDir(), NoUpdatesAvailableDialog::NoUpdatesAvailableDialog(), AudacityApp::OnMenuPreferences(), anonymous_namespace{EditMenus.cpp}::OnPreferences(), UnwritableLocationErrorDialog::UnwritableLocationErrorDialog(), and UpdateNoticeDialog::UpdateNoticeDialog().

Here is the call graph for this function:

Here is the caller graph for this function:

ShuttleAll()

void PrefsDialog::ShuttleAll

(

ShuttleGui &

S

)

Definition at line 673 of file PrefsDialog.cpp.

{
   // Validate all pages first
   if (mCategories) {
      for (size_t i = 0; i < mCategories->GetPageCount(); i++) {
         S.ResetId();
         PrefsPanel *panel = (PrefsPanel *)mCategories->GetPage(i);
         panel->PopulateOrExchange( S );
      }
   }
   else
   {
      S.ResetId();
      if (mUniquePage)
         mUniquePage->PopulateOrExchange( S );
   }
}

References mCategories, mUniquePage, PrefsPanel::PopulateOrExchange(), and S.

Referenced by GetInfoCommand::SendPreferences().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCategories

wxTreebook* PrefsDialog::mCategories {}

private

Definition at line 65 of file PrefsDialog.h.

Referenced by GetCurrentPanel(), GetSelectedPage(), OnCancel(), OnOK(), PrefsDialog(), RecordExpansionState(), SelectPageByName(), ShowModal(), and ShuttleAll().

mFactories

PrefsPanel::Factories& PrefsDialog::mFactories

private

Definition at line 67 of file PrefsDialog.h.

Referenced by RecordExpansionState().

mTitlePrefix

const TranslatableString PrefsDialog::mTitlePrefix

private

Definition at line 68 of file PrefsDialog.h.

Referenced by PrefsDialog(), and ShowModal().

mTransaction

std::unique_ptr< SettingTransaction > PrefsDialog::mTransaction

private

Definition at line 70 of file PrefsDialog.h.

Referenced by OnOK(), and PrefsDialog().

mUniquePage

PrefsPanel* PrefsDialog::mUniquePage {}

private

Definition at line 66 of file PrefsDialog.h.

Referenced by GetCurrentPanel(), OnCancel(), OnOK(), PrefsDialog(), ShowModal(), and ShuttleAll().

---

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

• PrefsDialog.h
• PrefsDialog.cpp