BatchPrefs Class Reference

A probably unused PrefsPanel that in debug builds could offer a setting used in debugging batch (aka macros) processing. More...

#include <BatchPrefs.h>

Inheritance diagram for BatchPrefs:

Collaboration diagram for BatchPrefs:

Public Member Functions
	BatchPrefs (wxWindow *parent, wxWindowID winid)
	Constructor. More...
	~BatchPrefs ()
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
ManualPageID	HelpPageName () override
	If not empty string, the Help button is added below the panel. More...
bool	Commit () override
	Send changed values back to Prefs, and update Audacity. More...
void	PopulateOrExchange (ShuttleGui &S) override
	Defines the dialog and does data exchange with it. More...
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 ()
	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 probably unused PrefsPanel that in debug builds could offer a setting used in debugging batch (aka macros) processing.

Definition at line 23 of file BatchPrefs.h.

Constructor & Destructor Documentation

BatchPrefs()

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

Constructor.

Definition at line 30 of file BatchPrefs.cpp.

                                                         :
   PrefsPanel(parent, winid, XO("Batch"))
{
   Populate();
}

~BatchPrefs()

BatchPrefs::~BatchPrefs

(

)

Definition at line 92 of file BatchPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool BatchPrefs::Commit ( )

overridevirtual

Send changed values back to Prefs, and update Audacity.

Implements PrefsPanel.

Definition at line 84 of file BatchPrefs.cpp.

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

References eIsSavingToPrefs, PopulateOrExchange(), and S.

Here is the call graph for this function:

GetDescription()

TranslatableString BatchPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 41 of file BatchPrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol BatchPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 36 of file BatchPrefs.cpp.

{
   return BATCH_PREFS_PLUGIN_SYMBOL;
}

References BATCH_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID BatchPrefs::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 BatchPrefs.cpp.

{
   return  "Batch_Preferences";
}

Populate()

void BatchPrefs::Populate ( )

private

Creates the dialog and its contents.

Definition at line 52 of file BatchPrefs.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.

Here is the call graph for this function:

PopulateOrExchange()

void BatchPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Defines the dialog and does data exchange with it.

Definition at line 64 of file BatchPrefs.cpp.

{
   S.SetBorder( 2 );
   S.StartScroller();
   S.StartHorizontalLay( wxEXPAND, 0 );
 
   S.StartStatic( XO("Behaviors"),1 );
   {
#ifdef _DEBUG
      S.TieCheckBox( XXO("&Don't apply effects in batch mode"),
         {wxT("/Batch/Debug"), false});
#endif
   }
   S.EndStatic();
   S.EndHorizontalLay();
   S.EndScroller();
   return;
}

References 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:

---

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

• BatchPrefs.h
• BatchPrefs.cpp