ModulePrefs Class Reference

A PrefsPanel to enable/disable certain modules. 'Modules' are dynamically linked libraries that modify Audacity. They are plug-ins with names like mod-script-pipe that add NEW features. More...

#include <ModulePrefs.h>

Inheritance diagram for ModulePrefs:

Collaboration diagram for ModulePrefs:

Public Member Functions
	ModulePrefs (wxWindow *parent, wxWindowID winid)
	~ModulePrefs ()
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	GetAllModuleStatuses ()
void	Populate ()

Private Attributes
wxArrayString	mModules
std::vector< int >	mStatuses
FilePaths	mPaths

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 modules. 'Modules' are dynamically linked libraries that modify Audacity. They are plug-ins with names like mod-script-pipe that add NEW features.

Definition at line 26 of file ModulePrefs.h.

Constructor & Destructor Documentation

ModulePrefs()

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

Definition at line 33 of file ModulePrefs.cpp.

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

References Populate().

Here is the call graph for this function:

~ModulePrefs()

ModulePrefs::~ModulePrefs

(

)

Definition at line 40 of file ModulePrefs.cpp.

{
}

Member Function Documentation

Commit()

bool ModulePrefs::Commit ( )

overridevirtual

Implements PrefsPanel.

Definition at line 157 of file ModulePrefs.cpp.

{
   ShuttleGui S(this, eIsSavingToPrefs);
   PopulateOrExchange(S);
   int i;
   for(i=0;i<(int)mPaths.size();i++)
      ModuleSettings::SetModuleStatus( mPaths[i], mStatuses[i] );
   return true;
}

References eIsSavingToPrefs, mPaths, mStatuses, PopulateOrExchange(), S, and ModuleSettings::SetModuleStatus().

Here is the call graph for this function:

GetAllModuleStatuses()

void ModulePrefs::GetAllModuleStatuses ( )

private

Definition at line 59 of file ModulePrefs.cpp.

                                      {
   wxString str;
   long dummy;
 
   // Modules could for example be:
   //    mod-script-pipe
   //    mod-nyq-bench
   //    mod-menu-munger
   //    mod-theming
 
   // TODO: On an Audacity upgrade we should (?) actually untick modules.
   // The old modules might be still around, and we do not want to use them.
   mModules.clear();
   mStatuses.clear();
   mPaths.clear();
 
 
   // Iterate through all Modules listed in prefs.
   // Get their names and values.
   gPrefs->SetPath( wxT("Module/") );
   bool bCont = gPrefs->GetFirstEntry(str, dummy);
   while ( bCont ) {
      int iStatus;
      gPrefs->Read( str, &iStatus, kModuleDisabled );
      wxString fname;
      gPrefs->Read( wxString( wxT("/ModulePath/") ) + str, &fname, wxEmptyString );
      if( !fname.empty() && wxFileExists( fname ) ){
         if( iStatus > kModuleNew ){
            iStatus = kModuleNew;
            gPrefs->Write( str, iStatus );
         }
         //wxLogDebug( wxT("Entry: %s Value: %i"), str, iStatus );
         mModules.push_back( str );
         mStatuses.push_back( iStatus );
         mPaths.push_back( fname );
      }
      bCont = gPrefs->GetNextEntry(str, dummy);
   }
   gPrefs->SetPath( wxT("") );
}

References FileConfig::GetFirstEntry(), FileConfig::GetNextEntry(), gPrefs, kModuleDisabled, kModuleNew, mModules, mPaths, mStatuses, FileConfig::SetPath(), str, and wxT().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDescription()

TranslatableString ModulePrefs::GetDescription ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 49 of file ModulePrefs.cpp.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol ModulePrefs::GetSymbol ( ) const

overridevirtual

Implements ComponentInterface.

Definition at line 44 of file ModulePrefs.cpp.

{
   return MODULE_PREFS_PLUGIN_SYMBOL;
}

References MODULE_PREFS_PLUGIN_SYMBOL.

HelpPageName()

ManualPageID ModulePrefs::HelpPageName ( )

overridevirtual

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

Default returns empty string.

Reimplemented from PrefsPanel.

Definition at line 54 of file ModulePrefs.cpp.

{
   return "Modules_Preferences";
}

Populate()

void ModulePrefs::Populate ( )

private

Definition at line 100 of file ModulePrefs.cpp.

{
   GetAllModuleStatuses();
   //------------------------- 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, GetAllModuleStatuses(), PopulateOrExchange(), and S.

Referenced by ModulePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void ModulePrefs::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 112 of file ModulePrefs.cpp.

{
   S.SetBorder(2);
   S.StartScroller();
 
   S.StartStatic( {} );
   {
      S.AddFixedText(XO(
"These are experimental modules. Enable them only if you've read the Audacity Manual\nand know what you are doing.") );
      S.AddFixedText(XO(
/* i18n-hint preserve the leading spaces */
"  'Ask' means Audacity will ask if you want to load the module each time it starts.") );
      S.AddFixedText(XO(
/* i18n-hint preserve the leading spaces */
"  'Failed' means Audacity thinks the module is broken and won't run it.") );
      S.AddFixedText(XO(
/* i18n-hint preserve the leading spaces */
"  'New' means no choice has been made yet.") );
      S.AddFixedText(XO(
"Changes to these settings only take effect when Audacity starts up."));
      {
        S.StartMultiColumn( 2 );
        int i;
        for(i=0;i<(int)mModules.size();i++)
           S.TieChoice( Verbatim( mModules[i] ),
              mStatuses[i],
              {
                 XO("Disabled" ) ,
                 XO("Enabled" ) ,
                 XO("Ask" ) ,
                 XO("Failed" ) ,
                 XO("New" ) ,
              }
           );
        S.EndMultiColumn();
      }
      if( mModules.size() < 1 )
      {
        S.AddFixedText( XO("No modules were found") );
      }
   }
   S.EndStatic();
   S.EndScroller();
}

References mModules, mStatuses, S, Verbatim(), and XO().

Referenced by Commit(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mModules

wxArrayString ModulePrefs::mModules

private

Definition at line 41 of file ModulePrefs.h.

Referenced by GetAllModuleStatuses(), and PopulateOrExchange().

mPaths

FilePaths ModulePrefs::mPaths

private

Definition at line 43 of file ModulePrefs.h.

Referenced by Commit(), and GetAllModuleStatuses().

mStatuses

std::vector<int> ModulePrefs::mStatuses

private

Definition at line 42 of file ModulePrefs.h.

Referenced by Commit(), GetAllModuleStatuses(), and PopulateOrExchange().

---

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

• ModulePrefs.h
• ModulePrefs.cpp