LibraryPrefs Class Reference

A PrefsPanel used to select manage external libraries like the MP3 and FFmpeg encoding libraries. More...

#include <LibraryPrefs.h>

Inheritance diagram for LibraryPrefs:

Collaboration diagram for LibraryPrefs:

Classes
struct	PopulatorItem
struct	RegisteredControls
	To be statically constructed, it registers additions to the Library preference page. More...
struct	Traits

Public Types
using	Populator = std::function< void(ShuttleGui &) >
	Type of function that adds to the Library preference page. More...
Public Types inherited from PrefsPanel
using	Factories = std::vector< PrefsPanel::PrefsNode >
using	Factory = std::function< PrefsPanel *(wxWindow *parent, wxWindowID winid, AudacityProject *) >

Public Member Functions
	LibraryPrefs (wxWindow *parent, wxWindowID winid)
	~LibraryPrefs ()
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...
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 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
Static Public Member Functions inherited from PrefsPanel
static Factories &	DefaultFactories ()

Detailed Description

A PrefsPanel used to select manage external libraries like the MP3 and FFmpeg encoding libraries.

Definition at line 27 of file LibraryPrefs.h.

Member Typedef Documentation

Populator

using LibraryPrefs::Populator = std::function< void(ShuttleGui&) >

Type of function that adds to the Library preference page.

Definition at line 33 of file LibraryPrefs.h.

Constructor & Destructor Documentation

LibraryPrefs()

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

Definition at line 56 of file LibraryPrefs.cpp.

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

References Populate().

Here is the call graph for this function:

~LibraryPrefs()

LibraryPrefs::~LibraryPrefs

(

)

Definition at line 63 of file LibraryPrefs.cpp.

{
}

Member Function Documentation

Commit()

bool LibraryPrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 120 of file LibraryPrefs.cpp.

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

References eIsSavingToPrefs, PopulateOrExchange(), and S.

Here is the call graph for this function:

GetDescription()

TranslatableString LibraryPrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 72 of file LibraryPrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol LibraryPrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 67 of file LibraryPrefs.cpp.

{
   return LIBRARY_PREFS_PLUGIN_SYMBOL;
}

References LIBRARY_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID LibraryPrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 77 of file LibraryPrefs.cpp.

{
   return "Libraries_Preferences";
}

Populate()

void LibraryPrefs::Populate ( )

private

Creates the dialog and its contents.

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

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void LibraryPrefs::PopulateOrExchange ( ShuttleGui &  S )

override

This PopulateOrExchange function is a good example of mixing the fully automatic style of reading/writing from GUI to prefs with the partial form.

You'll notice that some of the Tie functions have Prefs identifiers in them and others don't.

Definition at line 99 of file LibraryPrefs.cpp.

{
   using namespace Registry;
   static OrderingPreferenceInitializer init{
      PathStart,
      { {wxT(""), wxT("MP3,FFmpeg") } },
   };
 
   S.SetBorder(2);
   S.StartScroller();
 
   // visit the registry to collect the plug-ins properly
   // sorted
   GroupItem<Traits> top{ PathStart };
   Registry::Visit(
      [&](const PopulatorItem &item, auto &) { item.mPopulator(S); },
      &top, &PopulatorItem::Registry());
 
   S.EndScroller();
}

References LibraryPrefs::PopulatorItem::mPopulator, PathStart, LibraryPrefs::PopulatorItem::Registry(), S, Registry::Visit(), and wxT().

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:

• LibraryPrefs.h
• LibraryPrefs.cpp