LibraryPrefs.h

Go to the documentation of this file.

/**********************************************************************
 
  Audacity: A Digital Audio Editor
 
  FileFormatPrefs.h
 
  Joshua Haberman
  Dominic Mazzoni
  James Crook
 
**********************************************************************/
 
#ifndef __AUDACITY_FILE_FORMAT_PREFS__
#define __AUDACITY_FILE_FORMAT_PREFS__
 
#include <functional>
#include <wx/defs.h>
 
#include "PrefsPanel.h"
 
class wxStaticText;
class wxTextCtrl;
class ShuttleGui;
 
#define LIBRARY_PREFS_PLUGIN_SYMBOL ComponentInterfaceSymbol{ XO("Library") }
 
class LibraryPrefs final : public PrefsPanel
{
   struct PopulatorItem;
 public:
 
   using Populator = std::function< void(ShuttleGui&) >;
 
   struct PREFERENCE_PAGES_API RegisteredControls
      : Registry::RegisteredItem<PopulatorItem>
   {
      // Whether any controls have been registered
      static bool Any();
 
      RegisteredControls( const Identifier &id, Populator populator,
         const Registry::Placement &placement = { wxEmptyString, {} } );
 
      struct PREFERENCE_PAGES_API Init{ Init(); };
   };
 
   LibraryPrefs(wxWindow * parent, wxWindowID winid);
   ~LibraryPrefs();
   ComponentInterfaceSymbol GetSymbol() const override;
   TranslatableString GetDescription() const override;
 
   bool Commit() override;
   ManualPageID HelpPageName() override;
   void PopulateOrExchange(ShuttleGui & S) override;
 
 
 private:
   struct Traits : Registry::DefaultTraits {
      using LeafTypes = List<PopulatorItem>;
   };
   struct PREFERENCE_PAGES_API PopulatorItem final : Registry::SingleItem {
      static Registry::GroupItem<Traits> &Registry();
   
      PopulatorItem(const Identifier &id, Populator populator);
 
      Populator mPopulator;
   };
 
   void Populate();
};
 
// Guarantees registry exists before attempts to use it
static LibraryPrefs::RegisteredControls::Init sInitRegisteredControls;
 
#endif