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

#include <ImportExportPrefs.h>

Inheritance diagram for ImportExportPrefs:

Collaboration diagram for ImportExportPrefs:

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 >	ExportDownMixSetting

static EnumSetting< bool >	LabelStyleSetting

static EnumSetting< bool >	AllegroStyleSetting

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

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 used to select import and export options.

Definition at line 26 of file ImportExportPrefs.h.

Constructor & Destructor Documentation

◆ ImportExportPrefs()

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

Definition at line 26 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 32 of file ImportExportPrefs.cpp.

33{

34}

Member Function Documentation

◆ Commit()

bool ImportExportPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 174 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 41 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 36 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 46 of file ImportExportPrefs.cpp.

{
   return "Import_-_Export_Preferences";
}

◆ Populate()

void ImportExportPrefs::Populate ( )

private

Creates the dialog and its contents.

Definition at line 52 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 106 of file ImportExportPrefs.cpp.

{
   S.SetBorder(2);
   S.StartScroller();
 
   S.StartStatic(XO("When exporting tracks to an audio file"));
   {
      // Bug 2692: Place button group in panel so tabbing will work and,
      // on the Mac, VoiceOver will announce as radio buttons.
      S.StartPanel();
      {
         S.StartRadioButtonGroup(ImportExportPrefs::ExportDownMixSetting);
         {
            S.TieRadioButton();
            S.TieRadioButton();
         }
         S.EndRadioButtonGroup();
      }
      S.EndPanel();
 
      S.TieCheckBox(XXO("S&how Metadata Tags editor before export"),
                    {wxT("/AudioFiles/ShowId3Dialog"),
                     true});
      /* i18n-hint 'blank space' is space on the tracks with no audio in it*/
      S.TieCheckBox(XXO("&Ignore blank space at the beginning"),
                    {wxT("/AudioFiles/SkipSilenceAtBeginning"),
                     false});
   }
   S.EndStatic();
 
   S.StartStatic(XO("Exported Label Style:"));
   {
      // Bug 2692: Place button group in panel so tabbing will work and,
      // on the Mac, VoiceOver will announce as radio buttons.
      S.StartPanel();
      {
         S.StartRadioButtonGroup(ImportExportPrefs::LabelStyleSetting);
         {
            S.TieRadioButton();
            S.TieRadioButton();
         }
         S.EndRadioButtonGroup();
      }
      S.EndPanel();
   }
   S.EndStatic();
 
#ifdef USE_MIDI
   S.StartStatic(XO("Exported Allegro (.gro) files save time as:"));
   {
      // Bug 2692: Place button group in panel so tabbing will work and,
      // on the Mac, VoiceOver will announce as radio buttons.
      S.StartPanel();
      {
         S.StartRadioButtonGroup(ImportExportPrefs::AllegroStyleSetting);
         {
            S.TieRadioButton();
            S.TieRadioButton();
         }
         S.EndRadioButtonGroup();
      }
      S.EndPanel();
   }
   S.EndStatic();
#endif
   S.EndScroller();
}

References AllegroStyleSetting, ExportDownMixSetting, LabelStyleSetting, S, 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:

Member Data Documentation

◆ AllegroStyleSetting

EnumSetting< bool > ImportExportPrefs::AllegroStyleSetting

static

Initial value:

{
   wxT("/FileFormats/AllegroStyleChoice"),
   {
      EnumValueSymbol{ wxT("Seconds"), XXO("&Seconds") },
      EnumValueSymbol{ wxT("Beats"), XXO("&Beats") },
   },
   0, 
 
   
   {
      true, false,
   },
   wxT("/FileFormats/AllegroStyle"),
}

Definition at line 31 of file ImportExportPrefs.h.

Referenced by NoteTrack::ExportAllegro(), and PopulateOrExchange().

◆ ExportDownMixSetting

EnumSetting< bool > ImportExportPrefs::ExportDownMixSetting

static

Initial value:

{
   wxT("/FileFormats/ExportDownMixChoice"),
   {
      EnumValueSymbol{ wxT("MixDown"), XXO("&Mix down to Stereo or Mono") },
      EnumValueSymbol{ wxT("Custom"), XXO("&Use Advanced Mixing Options") },
   },
   0, 
 
   
   {
      true, false,
   },
   wxT("/FileFormats/ExportDownMix"),
}

Definition at line 29 of file ImportExportPrefs.h.

Referenced by Exporter::CheckMix(), and PopulateOrExchange().

◆ LabelStyleSetting

EnumSetting< bool > ImportExportPrefs::LabelStyleSetting

static

Initial value:

{
   wxT("/FileFormats/LabelStyleChoice"),
   {
      EnumValueSymbol{ wxT("Standard"), XXO("S&tandard") },
      EnumValueSymbol{ wxT("Extended"), XXO("E&xtended (with frequency ranges)") },
   },
   0, 
 
   {
      true, false,
   },
}

Definition at line 30 of file ImportExportPrefs.h.

Referenced by LabelStruct::Export(), and PopulateOrExchange().

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

Public Member Functions

Static Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ ImportExportPrefs()

◆ ~ImportExportPrefs()

Member Function Documentation

◆ Commit()

◆ GetDescription()

◆ GetSymbol()

◆ HelpPageName()

◆ Populate()

◆ PopulateOrExchange()

Member Data Documentation

◆ AllegroStyleSetting

◆ ExportDownMixSetting

◆ LabelStyleSetting