WarningsPrefs Class Reference

A PrefsPanel to enable/disable certain warning messages. More...

#include <WarningsPrefs.h>

Inheritance diagram for WarningsPrefs:

Collaboration diagram for WarningsPrefs:

Public Member Functions
	WarningsPrefs (wxWindow *parent, wxWindowID winid)
	~WarningsPrefs ()
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 warning messages.

Definition at line 24 of file WarningsPrefs.h.

Constructor & Destructor Documentation

WarningsPrefs()

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

Definition at line 30 of file WarningsPrefs.cpp.

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

References Populate().

Here is the call graph for this function:

~WarningsPrefs()

WarningsPrefs::~WarningsPrefs

(

)

Definition at line 36 of file WarningsPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool WarningsPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 85 of file WarningsPrefs.cpp.

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

References eIsSavingToPrefs, PopulateOrExchange(), and S.

Here is the call graph for this function:

GetDescription()

TranslatableString WarningsPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 45 of file WarningsPrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol WarningsPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 40 of file WarningsPrefs.cpp.

{
   return WARNINGS_PREFS_PLUGIN_SYMBOL;
}

References WARNINGS_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID WarningsPrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 50 of file WarningsPrefs.cpp.

{
   return "Warnings_Preferences";
}

Populate()

void WarningsPrefs::Populate ( )

private

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

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void WarningsPrefs::PopulateOrExchange ( ShuttleGui &  S )

overrideprivate

Definition at line 66 of file WarningsPrefs.cpp.

{
   S.SetBorder(2);
   S.StartScroller();
 
   S.StartStatic(XO("Show Warnings/Prompts for"));
   {
      S.TieCheckBox(XXO("Saving &projects versus exporting audio"),
                    {wxT("/Warnings/FirstProjectSave"),
                     true});
      S.TieCheckBox(XXO("Saving &empty project"),
                    {wxT("/GUI/EmptyCanBeDirty"),
                     true});
   }
   S.EndStatic();
   S.EndScroller();
 
}

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:

• WarningsPrefs.h
• WarningsPrefs.cpp