BatchPrefs Class Reference

A PrefsPanel that builds up a chain of effects in MacroCommands. More...

#include <BatchPrefs.h>

Inheritance diagram for BatchPrefs:

Public Member Functions
	BatchPrefs (wxWindow *parent, wxWindowID winid)
	Constructor. More...
	~BatchPrefs ()
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 wxString &title)
virtual	~PrefsPanel ()
virtual void	Preview ()
virtual bool	ShowsPreviewButton ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual wxString	HelpPageName ()
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 wxString &name=_("Panel"))
bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, const wxString &name=_("Panel"))
Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&...args)

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

Detailed Description

A PrefsPanel that builds up a chain of effects in MacroCommands.

Definition at line 23 of file BatchPrefs.h.

Constructor & Destructor Documentation

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

Constructor.

Definition at line 35 of file BatchPrefs.cpp.

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

BatchPrefs::~BatchPrefs

(

)

Definition at line 82 of file BatchPrefs.cpp.

{
}

Member Function Documentation

bool BatchPrefs::Commit ( )

overridevirtual

Send changed values back to Prefs, and update Audacity.

Implements PrefsPanel.

Definition at line 74 of file BatchPrefs.cpp.

References eIsSavingToPrefs, and PopulateOrExchange().

{
   ShuttleGui S( this, eIsSavingToPrefs );
   PopulateOrExchange( S );

   return true;
}

void BatchPrefs::Populate ( )

private

Creates the dialog and its contents.

Definition at line 42 of file BatchPrefs.cpp.

References eIsCreatingFromPrefs, and PopulateOrExchange().

{
   //------------------------- 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 --------------
}

void BatchPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Defines the dialog and does data exchange with it.

Definition at line 54 of file BatchPrefs.cpp.

References _(), ShuttleGuiBase::EndHorizontalLay(), ShuttleGuiBase::EndScroller(), ShuttleGuiBase::EndStatic(), ShuttleGuiBase::SetBorder(), ShuttleGuiBase::StartHorizontalLay(), ShuttleGuiBase::StartScroller(), ShuttleGuiBase::StartStatic(), and ShuttleGuiBase::TieCheckBox().

Referenced by Commit(), and Populate().

{
   S.SetBorder( 2 );
   S.StartScroller();
   S.StartHorizontalLay( wxEXPAND, 0 );

   S.StartStatic( _("Behaviors"),1 );
   {
#ifdef __WXDEBUG__
      S.TieCheckBox( _("&Don't apply effects in batch mode"),
         wxT("/Batch/Debug"), false);
#endif
   }
   S.EndStatic();
   S.EndHorizontalLay();
   S.EndScroller();
   return;
}

---

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

• BatchPrefs.h
• BatchPrefs.cpp