ApplicationPrefs Class Reference

A PrefsPanel to enable/disable certain general application options like checking updates, etc. More...

#include <ApplicationPrefs.h>

Inheritance diagram for ApplicationPrefs:

Collaboration diagram for ApplicationPrefs:

Public Member Functions
	ApplicationPrefs (wxWindow *parent, wxWindowID winid)
	~ApplicationPrefs ()
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...
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 ()
void	PopulateOrExchange (ShuttleGui &S) override

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 to enable/disable certain general application options like checking updates, etc.

Definition at line 21 of file ApplicationPrefs.h.

Constructor & Destructor Documentation

ApplicationPrefs()

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

Definition at line 33 of file ApplicationPrefs.cpp.

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

References Populate().

Here is the call graph for this function:

~ApplicationPrefs()

ApplicationPrefs::~ApplicationPrefs

(

)

Definition at line 39 of file ApplicationPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool ApplicationPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 106 of file ApplicationPrefs.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
   DefaultUpdatesCheckingFlag->Invalidate();
 
   return true;
}

References DefaultUpdatesCheckingFlag, eIsSavingToPrefs, PopulateOrExchange(), and S.

Here is the call graph for this function:

GetDescription()

TranslatableString ApplicationPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 48 of file ApplicationPrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol ApplicationPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 43 of file ApplicationPrefs.cpp.

{
   return s_ComponentInterfaceSymbol;
}

References s_ComponentInterfaceSymbol.

HelpPageName()

ManualPageID ApplicationPrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 53 of file ApplicationPrefs.cpp.

{
   return "Application_Preferences";
}

Populate()

void ApplicationPrefs::Populate ( )

private

Definition at line 58 of file ApplicationPrefs.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 ApplicationPrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void ApplicationPrefs::PopulateOrExchange ( ShuttleGui &  S )

overrideprivate

Definition at line 69 of file ApplicationPrefs.cpp.

{
   S.SetBorder(2);
   S.StartScroller();
 
   /* i18n-hint: Title for the update notifications panel in the preferences dialog. */
   S.StartStatic(XO("Update notifications"));
   {
      S.TieCheckBox(
         /* i18n-hint: Check-box title that configures periodic updates checking. */
         XXC("&Check for updates", "application preferences"),
         *DefaultUpdatesCheckingFlag);
 
      S.StartVerticalLay();
      {
         S.AddFixedText(XO(
            "App update checking requires network access. In order to protect your privacy, Audacity does not store any personal information."),
            false, 470);
 
         /* i18n-hint: %s will be replaced with "our Privacy Policy" */
         AccessibleLinksFormatter privacyPolicy(XO("See %s for more info."));
 
         privacyPolicy.FormatLink(
            /* i18n-hint: Title of hyperlink to the privacy policy. This is an object of "See". */
            wxT("%s"), XO("our Privacy Policy"),
            "https://www.audacityteam.org/about/desktop-privacy-notice/");
 
         privacyPolicy.Populate(S);
      }
 
      S.EndVerticalLay();
   }
 
   S.EndStatic();
   S.EndScroller();
}

References DefaultUpdatesCheckingFlag, AccessibleLinksFormatter::FormatLink(), AccessibleLinksFormatter::Populate(), S, wxT(), XO(), and XXC.

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:

• ApplicationPrefs.h
• ApplicationPrefs.cpp