PlainExportOptionsEditor Class Reference

#include <PlainExportOptionsEditor.h>

Inheritance diagram for PlainExportOptionsEditor:

Collaboration diagram for PlainExportOptionsEditor:

Classes
struct	OptionDesc

Public Member Functions
	PlainExportOptionsEditor (std::initializer_list< OptionDesc > options, Listener *listener=nullptr)
	PlainExportOptionsEditor (std::initializer_list< OptionDesc > options, SampleRateList samplerates, Listener *listener=nullptr)
int	GetOptionsCount () const override
bool	GetOption (int index, ExportOption &option) const override
bool	GetValue (int id, ExportValue &value) const override
bool	SetValue (int id, const ExportValue &value) override
void	Load (const audacity::BasicSettings &config) override
void	Store (audacity::BasicSettings &) const override
SampleRateList	GetSampleRateList () const override
void	SetSampleRateList (SampleRateList rates)
Public Member Functions inherited from ExportOptionsEditor
virtual	~ExportOptionsEditor ()
virtual int	GetOptionsCount () const =0
virtual bool	GetOption (int index, ExportOption &option) const =0
virtual bool	GetValue (ExportOptionID id, ExportValue &value) const =0
virtual bool	SetValue (ExportOptionID id, const ExportValue &value)=0
virtual SampleRateList	GetSampleRateList () const =0
virtual void	Store (audacity::BasicSettings &settings) const =0
virtual void	Load (const audacity::BasicSettings &config)=0

Private Member Functions
void	InitOptions (std::initializer_list< OptionDesc > options)

Private Attributes
std::vector< ExportOption >	mOptions
wxArrayString	mConfigKeys
std::unordered_map< int, ExportValue >	mValues
SampleRateList	mRates
Listener *	mOptionsListener {}

Additional Inherited Members
Public Types inherited from ExportOptionsEditor
using	SampleRateList = std::vector< int >

Detailed Description

Definition at line 19 of file PlainExportOptionsEditor.h.

Constructor & Destructor Documentation

PlainExportOptionsEditor() [1/2]

PlainExportOptionsEditor::PlainExportOptionsEditor ( std::initializer_list< OptionDesc >  options, Listener *  listener = nullptr  )

explicit

Definition at line 16 of file PlainExportOptionsEditor.cpp.

   : mOptionsListener(listener)
{
   InitOptions(options);
}

References InitOptions().

Here is the call graph for this function:

PlainExportOptionsEditor() [2/2]

PlainExportOptionsEditor::PlainExportOptionsEditor ( std::initializer_list< OptionDesc >  options, SampleRateList  samplerates, Listener *  listener = nullptr  )

explicit

Definition at line 23 of file PlainExportOptionsEditor.cpp.

   : mRates(std::move(sampleRates))
   , mOptionsListener(listener)
{
   InitOptions(options);
}

References InitOptions().

Here is the call graph for this function:

Member Function Documentation

GetOption()

bool PlainExportOptionsEditor::GetOption ( int  index, ExportOption &  option  ) const

overridevirtual

Implements ExportOptionsEditor.

Definition at line 37 of file PlainExportOptionsEditor.cpp.

{
   if(index >= 0 && index < static_cast<int>(mOptions.size()))
   {
      option = mOptions[index];
      return true;
   }
   return false;
}

References mOptions.

GetOptionsCount()

int PlainExportOptionsEditor::GetOptionsCount ( ) const

overridevirtual

Implements ExportOptionsEditor.

Definition at line 32 of file PlainExportOptionsEditor.cpp.

{
   return static_cast<int>(mOptions.size());
}

References mOptions.

GetSampleRateList()

ExportOptionsEditor::SampleRateList PlainExportOptionsEditor::GetSampleRateList ( ) const

overridevirtual

Implements ExportOptionsEditor.

Definition at line 112 of file PlainExportOptionsEditor.cpp.

{
   return mRates;
}

References mRates.

GetValue()

bool PlainExportOptionsEditor::GetValue ( int  id, ExportValue &  value  ) const

override

Definition at line 47 of file PlainExportOptionsEditor.cpp.

{
   const auto it = mValues.find(id);
   if(it != mValues.end())
   {
      value = it->second;
      return true;
   }
   return false;
}

References mValues.

InitOptions()

void PlainExportOptionsEditor::InitOptions ( std::initializer_list< OptionDesc >  options )

private

Definition at line 124 of file PlainExportOptionsEditor.cpp.

{
   assert(mOptions.empty());
 
   mOptions.reserve(options.size());
   mValues.reserve(options.size());
   for(auto& desc : options)
   {
      mValues[desc.option.id] = desc.option.defaultValue;
      mOptions.emplace_back(desc.option);
      mConfigKeys.push_back(desc.configKey);
   }
}

References anonymous_namespace{ExportPCM.cpp}::desc, mConfigKeys, mOptions, and mValues.

Referenced by PlainExportOptionsEditor().

Here is the caller graph for this function:

Load()

void PlainExportOptionsEditor::Load ( const audacity::BasicSettings &  config )

overridevirtual

Implements ExportOptionsEditor.

Definition at line 69 of file PlainExportOptionsEditor.cpp.

{
   auto index = 0;
   for(const auto& option : mOptions)
   {
      auto it = mValues.find(option.id);
      assert(it != mValues.end());
      if(auto val = std::get_if<bool>(&it->second))
         config.Read(mConfigKeys[index], val);
      else if(auto val = std::get_if<int>(&it->second))
         config.Read(mConfigKeys[index], val);
      else if(auto val = std::get_if<double>(&it->second))
         config.Read(mConfigKeys[index], val);
      else if(auto val = std::get_if<std::string>(&it->second))
      {
         wxString wxstr;
         if(config.Read(mConfigKeys[index], &wxstr))
            *val = wxstr.ToStdString();
      }
      ++index;
   }
}

References mConfigKeys, mOptions, mValues, and audacity::BasicSettings::Read().

Here is the call graph for this function:

SetSampleRateList()

void PlainExportOptionsEditor::SetSampleRateList

(

SampleRateList

rates

)

Definition at line 117 of file PlainExportOptionsEditor.cpp.

{
   mRates = std::move(rates);
   if(mOptionsListener)
      mOptionsListener->OnSampleRateListChange();
}

References mOptionsListener, mRates, and ExportOptionsEditor::Listener::OnSampleRateListChange().

Here is the call graph for this function:

SetValue()

bool PlainExportOptionsEditor::SetValue ( int  id, const ExportValue &  value  )

override

Definition at line 58 of file PlainExportOptionsEditor.cpp.

{
   const auto it = mValues.find(id);
   if(it != mValues.end() && it->second.index() == value.index())
   {
      it->second = value;
      return true;
   }
   return false;
}

References mValues.

Store()

void PlainExportOptionsEditor::Store ( audacity::BasicSettings &  config ) const

overridevirtual

Implements ExportOptionsEditor.

Definition at line 92 of file PlainExportOptionsEditor.cpp.

{
   auto index = 0;
   for(const auto& option : mOptions)
   {
      auto it = mValues.find(option.id);
      assert(it != mValues.end());
      if(auto val = std::get_if<bool>(&it->second))
         config.Write(mConfigKeys[index], *val);
      else if(auto val = std::get_if<int>(&it->second))
         config.Write(mConfigKeys[index], *val);
      else if(auto val = std::get_if<double>(&it->second))
         config.Write(mConfigKeys[index], *val);
      else if(auto val = std::get_if<std::string>(&it->second))
         config.Write(mConfigKeys[index], wxString(*val));
 
      ++index;
   }
}

References mConfigKeys, mOptions, mValues, and audacity::BasicSettings::Write().

Here is the call graph for this function:

Member Data Documentation

mConfigKeys

wxArrayString PlainExportOptionsEditor::mConfigKeys

private

Definition at line 22 of file PlainExportOptionsEditor.h.

Referenced by InitOptions(), Load(), and Store().

mOptions

std::vector<ExportOption> PlainExportOptionsEditor::mOptions

private

Definition at line 21 of file PlainExportOptionsEditor.h.

Referenced by GetOption(), GetOptionsCount(), InitOptions(), Load(), and Store().

mOptionsListener

Listener* PlainExportOptionsEditor::mOptionsListener {}

private

Definition at line 25 of file PlainExportOptionsEditor.h.

Referenced by SetSampleRateList().

mRates

SampleRateList PlainExportOptionsEditor::mRates

private

Definition at line 24 of file PlainExportOptionsEditor.h.

Referenced by GetSampleRateList(), and SetSampleRateList().

mValues

std::unordered_map<int, ExportValue> PlainExportOptionsEditor::mValues

private

Definition at line 23 of file PlainExportOptionsEditor.h.

Referenced by GetValue(), InitOptions(), Load(), SetValue(), and Store().

---

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

• PlainExportOptionsEditor.h
• PlainExportOptionsEditor.cpp