ImportExportPrefs Class Reference

A PrefsPanel used to select import and export options. More...

#include <ImportExportPrefs.h>

Inheritance diagram for ImportExportPrefs:

Collaboration diagram for ImportExportPrefs:

Classes
struct	PopulatorItem
struct	RegisteredControls
struct	Traits

Public Types
using	Populator = std::function< void(ShuttleGui &)>
	Type of function that adds to the Import/Export preference page. More...
Public Types inherited from PrefsPanel
using	Factories = std::vector< PrefsPanel::PrefsNode >
using	Factory = std::function< PrefsPanel *(wxWindow *parent, wxWindowID winid, AudacityProject *) >

Public Member Functions
	ImportExportPrefs (wxWindow *parent, wxWindowID winid)
	~ImportExportPrefs ()
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
bool	Commit () 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

Static Public Attributes
static EnumSetting< bool >	MusicFileImportSetting

Private Member Functions
void	Populate ()
	Creates the dialog and its contents. More...

Additional Inherited Members
Static Public Member Functions inherited from PrefsPanel
static Factories &	DefaultFactories ()

Detailed Description

A PrefsPanel used to select import and export options.

Definition at line 26 of file ImportExportPrefs.h.

Member Typedef Documentation

Populator

using ImportExportPrefs::Populator = std::function<void(ShuttleGui&)>

Type of function that adds to the Import/Export preference page.

Definition at line 32 of file ImportExportPrefs.h.

Constructor & Destructor Documentation

ImportExportPrefs()

ImportExportPrefs::ImportExportPrefs	(	wxWindow *	parent,
		wxWindowID	winid
	)

Definition at line 59 of file ImportExportPrefs.cpp.

:   PrefsPanel(parent, winid, XO("Import / Export"))
{
   Populate();
}

References Populate().

Here is the call graph for this function:

~ImportExportPrefs()

ImportExportPrefs::~ImportExportPrefs

(

)

Definition at line 65 of file ImportExportPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool ImportExportPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 165 of file ImportExportPrefs.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
 
   return true;
}

References eIsSavingToPrefs, PopulateOrExchange(), and S.

Here is the call graph for this function:

GetDescription()

TranslatableString ImportExportPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 74 of file ImportExportPrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol ImportExportPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 69 of file ImportExportPrefs.cpp.

{
   return IMPORT_EXPORT_PREFS_PLUGIN_SYMBOL;
}

References IMPORT_EXPORT_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID ImportExportPrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 79 of file ImportExportPrefs.cpp.

{
   return "Import_-_Export_Preferences";
}

Populate()

void ImportExportPrefs::Populate ( )

private

Creates the dialog and its contents.

Definition at line 85 of file ImportExportPrefs.cpp.

{
   //------------------------- Main section --------------------
   // Now construct the GUI itself.
   // Use 'eIsCreatingFromPrefs' so that the GUI is
   // initialised with values from gPrefs.
   ShuttleGui S(this, eIsCreatingFromPrefs);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
}

References eIsCreatingFromPrefs, PopulateOrExchange(), and S.

Referenced by ImportExportPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void ImportExportPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 112 of file ImportExportPrefs.cpp.

{
   S.SetBorder(2);
   S.StartScroller();
 
   // Add registered controls
   using namespace Registry;
   static OrderingPreferenceInitializer init{
      PathStart,
      { {wxT(""), wxT("LabelStyle,AllegroTimeOption") } },
   };
 
   // visit the registry to collect the plug-ins properly
   // sorted
   GroupItem<Traits> top{ PathStart };
   Registry::Visit(
      [&](const PopulatorItem &item, auto &) { item.mPopulator(S); },
      &top, &PopulatorItem::Registry());
 
 
   auto musicImportsBox = S.StartStatic(XO("Music Imports"));
   {
      const auto header = S.AddVariableText(
         XO("When Audacity detects music in file imported on empty project"));
#if wxUSE_ACCESSIBILITY
      if (musicImportsBox != nullptr)
      {
         musicImportsBox->SetName(header->GetLabel());
         safenew WindowAccessible(musicImportsBox);
      }
#endif
#if defined(__WXMAC__)
      // see https://bugzilla.audacityteam.org/show_bug.cgi?id=2692
      S.StartPanel();
#endif
      {
         S.StartRadioButtonGroup(ImportExportPrefs::MusicFileImportSetting);
         {
            S.TieRadioButton();
            S.TieRadioButton();
            S.TieRadioButton();
         }
         S.EndRadioButtonGroup();
      }
#if defined(__WXMAC__)
      S.EndPanel();
#endif
   }
   S.EndStatic();
 
   S.EndScroller();
}

References ImportExportPrefs::PopulatorItem::mPopulator, MusicFileImportSetting, PathStart, ImportExportPrefs::PopulatorItem::Registry(), S, safenew, Registry::Visit(), wxT(), and XO().

Referenced by Commit(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

MusicFileImportSetting

EnumSetting< bool > ImportExportPrefs::MusicFileImportSetting

static

Initial value:

{
   wxT("/FileFormats/MusicFileImportSettingChoice"),
   {
      
      EnumValueSymbol {
         wxT("Yes"),
         XXO(
            "S&witch view to Beats and Measures and align with musical grid") },
      EnumValueSymbol { wxT("Ask"), XXO("&Ask me each time") },
      EnumValueSymbol { wxT("No"), XXO("Do &nothing") },
   },
   1,
   { false, true, false },
   wxT("/FileFormats/MusicFileImportSetting"),
}

Definition at line 48 of file ImportExportPrefs.h.

Referenced by PopulateOrExchange(), and AudacityMirProject::ShouldBeReconfigured().

---

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

• ImportExportPrefs.h
• ImportExportPrefs.cpp