ProjectsPrefs Class Reference

A PrefsPanel used to select options related to Audacity Project handling. More...

#include <ProjectsPrefs.h>

Inheritance diagram for ProjectsPrefs:

Collaboration diagram for ProjectsPrefs:

Public Member Functions
	ProjectsPrefs (wxWindow *parent, wxWindowID winid)
	~ProjectsPrefs ()
ComponentInterfaceSymbol	GetSymbol () override
TranslatableString	GetDescription () override
bool	Commit () override
wxString	HelpPageName () override
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 PluginPath	GetPath ()
virtual VendorSymbol	GetVendor ()
virtual wxString	GetVersion ()
virtual bool	ShowsPreviewButton ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
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 PrefsPanel used to select options related to Audacity Project handling.

Definition at line 24 of file ProjectsPrefs.h.

Constructor & Destructor Documentation

ProjectsPrefs()

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

Definition at line 33 of file ProjectsPrefs.cpp.

:   PrefsPanel(parent, winid,
   /* i18n-hint: (noun) i.e Audacity projects. */
               XO("Projects"))
{
   Populate();
}

References Populate().

Here is the call graph for this function:

~ProjectsPrefs()

ProjectsPrefs::~ProjectsPrefs

(

)

Definition at line 41 of file ProjectsPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool ProjectsPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 92 of file ProjectsPrefs.cpp.

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

References eIsSavingToPrefs, and PopulateOrExchange().

Here is the call graph for this function:

GetDescription()

TranslatableString ProjectsPrefs::GetDescription ( )

overridevirtual

Implements ComponentInterface.

Definition at line 50 of file ProjectsPrefs.cpp.

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

References XO.

GetSymbol()

ComponentInterfaceSymbol ProjectsPrefs::GetSymbol ( )

overridevirtual

Implements ComponentInterface.

Definition at line 45 of file ProjectsPrefs.cpp.

{
   return PROJECTS_PREFS_PLUGIN_SYMBOL;
}

References PROJECTS_PREFS_PLUGIN_SYMBOL.

HelpPageName()

wxString ProjectsPrefs::HelpPageName ( )

overridevirtual

Reimplemented from PrefsPanel.

Definition at line 55 of file ProjectsPrefs.cpp.

{
   return "Projects_Preferences";
}

Populate()

void ProjectsPrefs::Populate ( )

private

Creates the dialog and its contents.

Definition at line 61 of file ProjectsPrefs.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, and PopulateOrExchange().

Referenced by ProjectsPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void ProjectsPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 72 of file ProjectsPrefs.cpp.

{
   S.SetBorder(2);
   S.StartScroller();
 
   S.StartStatic(XO("When saving a project that depends on other audio files"));
   {
      S.StartRadioButtonGroup(FileFormatsSaveWithDependenciesSetting);
      {
         S.TieRadioButton();
         S.TieRadioButton();
         S.TieRadioButton();
      }
      S.EndRadioButtonGroup();
   }
   S.EndStatic();
   S.EndScroller();
 
}

References ShuttleGuiBase::EndRadioButtonGroup(), ShuttleGuiBase::EndScroller(), ShuttleGuiBase::EndStatic(), FileFormatsSaveWithDependenciesSetting, ShuttleGuiBase::SetBorder(), ShuttleGuiBase::StartRadioButtonGroup(), ShuttleGuiBase::StartScroller(), ShuttleGuiBase::StartStatic(), ShuttleGuiBase::TieRadioButton(), and XO.

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:

• ProjectsPrefs.h
• ProjectsPrefs.cpp