ExportOptionsHandler Class Reference

#include <ExportOptionsHandler.h>

Inheritance diagram for ExportOptionsHandler:

Collaboration diagram for ExportOptionsHandler:

Public Member Functions
	ExportOptionsHandler (ShuttleGui &S, const ExportPlugin &plugin, int format)
	~ExportOptionsHandler ()
bool	TransferDataFromEditor ()
ExportProcessor::Parameters	GetParameters () const
void	SetParameters (const ExportProcessor::Parameters &parameters)
ExportOptionsEditor::SampleRateList	GetSampleRateList () const
void	OnExportOptionChangeBegin () override
	Called before OnExportOptionChange More...
void	OnExportOptionChangeEnd () override
	Called after OnExportOptionChange More...
void	OnExportOptionChange (const ExportOption &option) override
	Called when option change. More...
void	OnFormatInfoChange () override
	Called when format extension change (usually in response parameter change) More...
void	OnSampleRateListChange () override
Public Member Functions inherited from ExportOptionsEditor::Listener
virtual	~Listener ()
virtual void	OnExportOptionChangeBegin ()=0
	Called before OnExportOptionChange More...
virtual void	OnExportOptionChangeEnd ()=0
	Called after OnExportOptionChange More...
virtual void	OnExportOptionChange (const ExportOption &option)=0
	Called when option change. More...
virtual void	OnFormatInfoChange ()=0
	Called when format extension change (usually in response parameter change) More...
virtual void	OnSampleRateListChange ()=0
Public Member Functions inherited from Observer::Publisher< ExportOptionsHandlerEvent >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Private Member Functions
void	PopulateEmpty (ShuttleGui &S)
void	PopulateOptions (ShuttleGui &S)
void	UpdateSampleRateList ()

Private Attributes
wxWindow *	mParent { nullptr }
std::unique_ptr< wxWindowUpdateLocker >	mUpdateLocker
std::unique_ptr< ExportOptionsEditor >	mEditor
std::vector< std::tuple< wxStaticText *, wxControl * > >	mRows
std::unordered_map< int, int >	mIDRowIndexMap

Additional Inherited Members
Public Types inherited from Observer::Publisher< ExportOptionsHandlerEvent >
using	message_type = ExportOptionsHandlerEvent
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const ExportOptionsHandlerEvent &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Attributes inherited from Observer::Publisher< ExportOptionsHandlerEvent >
static constexpr bool	notifies_all
Protected Member Functions inherited from Observer::Publisher< ExportOptionsHandlerEvent >
CallbackReturn	Publish (const ExportOptionsHandlerEvent &message)
	Send a message to connected callbacks. More...

Detailed Description

Definition at line 38 of file ExportOptionsHandler.h.

Constructor & Destructor Documentation

ExportOptionsHandler()

ExportOptionsHandler::ExportOptionsHandler	(	ShuttleGui &	S,
		const ExportPlugin &	plugin,
		int	format
	)

Definition at line 33 of file ExportOptionsHandler.cpp.

{
   mParent = S.GetParent();
 
   mEditor = plugin.CreateOptionsEditor(format, this);
   if(mEditor)
   {
      mEditor->Load(*gPrefs);
      if(auto uiServices = dynamic_cast<ExportOptionsUIServices*>(mEditor.get()))
         uiServices->PopulateUI(S);
      else
         PopulateOptions(S);
   }
   else
      PopulateEmpty(S);
}

References ExportPlugin::CreateOptionsEditor(), anonymous_namespace{ExportPCM.cpp}::format, gPrefs, mEditor, mParent, PopulateEmpty(), PopulateOptions(), and S.

Here is the call graph for this function:

~ExportOptionsHandler()

ExportOptionsHandler::~ExportOptionsHandler ( )

default

Member Function Documentation

GetParameters()

ExportProcessor::Parameters ExportOptionsHandler::GetParameters

(

)

const

Definition at line 64 of file ExportOptionsHandler.cpp.

{
   if(mEditor)
      return ExportUtils::ParametersFromEditor(*mEditor);
   return {};
}

References mEditor, and ExportUtils::ParametersFromEditor().

Here is the call graph for this function:

GetSampleRateList()

ExportOptionsEditor::SampleRateList ExportOptionsHandler::GetSampleRateList

(

)

const

Definition at line 80 of file ExportOptionsHandler.cpp.

{
   if(mEditor)
      return mEditor->GetSampleRateList();
   return {};
}

References mEditor.

OnExportOptionChange()

void ExportOptionsHandler::OnExportOptionChange ( const ExportOption &  option )

overridevirtual

Called when option change.

Implements ExportOptionsEditor::Listener.

Definition at line 228 of file ExportOptionsHandler.cpp.

{
   const auto it = mIDRowIndexMap.find(option.id);
   if(it == mIDRowIndexMap.end())
      return;
 
   const auto index = it->second;
   const auto [prompt, control] = mRows[index];
 
   const auto visible = (option.flags & ExportOption::Hidden) == 0;
   
   prompt->Show(visible);
   control->Show(visible);
   
   const auto enabled = (option.flags & ExportOption::ReadOnly) == 0;
   control->Enable(enabled);
}

References ExportOption::flags, ExportOption::Hidden, ExportOption::id, mIDRowIndexMap, mRows, and ExportOption::ReadOnly.

OnExportOptionChangeBegin()

void ExportOptionsHandler::OnExportOptionChangeBegin ( )

overridevirtual

Called before OnExportOptionChange

Implements ExportOptionsEditor::Listener.

Definition at line 217 of file ExportOptionsHandler.cpp.

{
   mUpdateLocker = std::make_unique<wxWindowUpdateLocker>(mParent);
}

References mParent, and mUpdateLocker.

OnExportOptionChangeEnd()

void ExportOptionsHandler::OnExportOptionChangeEnd ( )

overridevirtual

Called after OnExportOptionChange

Implements ExportOptionsEditor::Listener.

Definition at line 222 of file ExportOptionsHandler.cpp.

{
   mParent->Layout();
   mUpdateLocker.reset();
}

References mParent, and mUpdateLocker.

OnFormatInfoChange()

void ExportOptionsHandler::OnFormatInfoChange ( )

overridevirtual

Called when format extension change (usually in response parameter change)

Implements ExportOptionsEditor::Listener.

Definition at line 246 of file ExportOptionsHandler.cpp.

{
   Publish({ ExportOptionsHandlerEvent::FormatInfoChange });
}

References ExportOptionsHandlerEvent::FormatInfoChange, and Observer::Publisher< ExportOptionsHandlerEvent >::Publish().

Here is the call graph for this function:

OnSampleRateListChange()

void ExportOptionsHandler::OnSampleRateListChange ( )

overridevirtual

Implements ExportOptionsEditor::Listener.

Definition at line 251 of file ExportOptionsHandler.cpp.

{
   Publish({ ExportOptionsHandlerEvent::SampleRateListChange });
}

References Observer::Publisher< ExportOptionsHandlerEvent >::Publish(), and ExportOptionsHandlerEvent::SampleRateListChange.

Here is the call graph for this function:

PopulateEmpty()

void ExportOptionsHandler::PopulateEmpty ( ShuttleGui &  S )

private

Definition at line 87 of file ExportOptionsHandler.cpp.

{
   S.StartHorizontalLay(wxCENTER);
   {
      S.StartHorizontalLay(wxCENTER, 0);
      {
         S.Prop(1).AddTitle(XO("No format specific options"));
      }
      S.EndHorizontalLay();
   }
   S.EndHorizontalLay();
}

References S, and XO().

Referenced by ExportOptionsHandler().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOptions()

void ExportOptionsHandler::PopulateOptions ( ShuttleGui &  S )

private

Definition at line 100 of file ExportOptionsHandler.cpp.

{
   {
      S.StartMultiColumn(2, wxALIGN_LEFT);
      {
         for(int i = 0; i < mEditor->GetOptionsCount(); ++i)
         {
            ExportOption option;
            if(!mEditor->GetOption(i, option))
               continue;
 
            ExportValue value;
            if(!mEditor->GetValue(option.id, value))
               continue;
            
            wxControl* control { nullptr };
 
            auto prompt = S.AddPrompt(option.title);
            prompt->SetMinSize({140, -1});
 
            if((option.flags & ExportOption::TypeMask) == ExportOption::TypeEnum)
            {
               int selected = -1;
               TranslatableStrings list;
 
               int index { 0 };
               std::unordered_map<int, ExportValue> indexValueMap;
               indexValueMap.reserve(option.values.size());
               for(auto& e : option.values)
               {
                  list.push_back(option.names[index]);
                  if(value == e)
                     selected = index;
                  indexValueMap[index] = e;
                  ++index;
               }
               control = S.AddChoice({}, list, selected);
               control->Bind(wxEVT_CHOICE, [this, id = option.id, indexValueMap](const wxCommandEvent& evt)
               {
                  const auto it = indexValueMap.find(evt.GetInt());
                  if(it != indexValueMap.end())
                     mEditor->SetValue(id, it->second);
               });
            }
            else if(auto selected = std::get_if<bool>(&value))
            {
               control = S.Name(option.title).
                  AddCheckBox({}, *selected);
#if wxUSE_ACCESSIBILITY
               safenew WindowAccessible(control);
#endif
               control->Bind(wxEVT_CHECKBOX, [this, id = option.id](const wxCommandEvent& evt)
               {
                  const auto checked = evt.GetInt() != 0;
                  mEditor->SetValue(id, checked);
               });
            }
            else if(auto num = std::get_if<int>(&value))
            {
               if((option.flags & ExportOption::TypeMask) == ExportOption::TypeRange)
               {
                  const int min = *std::get_if<int>(&option.values[0]);
                  const int max = *std::get_if<int>(&option.values[1]);
                  if(max - min < 20)
                  {
                     control = S.Name(option.title)
                        .AddSlider({}, *num, max, min);
                     control->Bind(wxEVT_SLIDER, [this, id = option.id](const wxCommandEvent& evt)
                     {
                        mEditor->SetValue(id, evt.GetInt());
                     });
                     control->SetMinSize({180, -1});
                  }
                  else
                  {
                     control = S.AddSpinCtrl({}, *num, max, min);
                     control->Bind(wxEVT_SPINCTRL, [this, id = option.id](const wxSpinEvent& evt)
                     {
                        mEditor->SetValue(id, evt.GetInt());
                     });
                  }
               }
               else
               {
                  control = S.AddNumericTextBox({}, wxString::Format("%d", *num), 0);
                  control->Bind(wxEVT_TEXT, [this, id = option.id](const wxCommandEvent& evt)
                  {
                     long num;
                     if(evt.GetString().ToLong(&num))
                        mEditor->SetValue(id, static_cast<int>(num));
                  });
               }
            }
            else if(auto str = std::get_if<std::string>(&value))
            {
               control = S.AddTextBox({}, wxString::FromUTF8(*str), 0);
               control->Bind(wxEVT_TEXT, [this, id = option.id](const wxCommandEvent& evt)
               {
                  mEditor->SetValue(id, evt.GetString().ToStdString());
               });
            }
            mIDRowIndexMap[option.id] = static_cast<int>(mRows.size());
            mRows.emplace_back(prompt, control);
            
            if(option.flags & ExportOption::ReadOnly)
               control->Disable();
            if(option.flags & ExportOption::Hidden)
            {
               prompt->Hide();
               control->Hide();
            }
         }
      }
      S.EndMultiColumn();
   }
}

References ExportOption::flags, ExportOption::Hidden, ExportOption::id, mEditor, mIDRowIndexMap, min(), mRows, ExportOption::names, ExportOption::ReadOnly, S, safenew, str, ExportOption::title, ExportOption::TypeEnum, ExportOption::TypeMask, ExportOption::TypeRange, and ExportOption::values.

Referenced by ExportOptionsHandler().

Here is the call graph for this function:

Here is the caller graph for this function:

SetParameters()

void ExportOptionsHandler::SetParameters

(

const ExportProcessor::Parameters &

parameters

)

Definition at line 71 of file ExportOptionsHandler.cpp.

{
   if(mEditor)
   {
      for(const auto& p : parameters)
         mEditor->SetValue(std::get<0>(p), std::get<1>(p));
   }
}

References mEditor.

TransferDataFromEditor()

bool ExportOptionsHandler::TransferDataFromEditor

(

)

Definition at line 50 of file ExportOptionsHandler.cpp.

{
   if(mEditor)
   {
      if(auto uiServices = dynamic_cast<ExportOptionsUIServices*>(mEditor.get()))
      {
         if(!uiServices->TransferDataFromWindow())
            return false;
      }
      mEditor->Store(*gPrefs);
   }
   return true;
}

References gPrefs, and mEditor.

UpdateSampleRateList()

void ExportOptionsHandler::UpdateSampleRateList ( )

private

Member Data Documentation

mEditor

std::unique_ptr<ExportOptionsEditor> ExportOptionsHandler::mEditor

private

Definition at line 68 of file ExportOptionsHandler.h.

Referenced by ExportOptionsHandler(), GetParameters(), GetSampleRateList(), PopulateOptions(), SetParameters(), and TransferDataFromEditor().

mIDRowIndexMap

std::unordered_map<int, int> ExportOptionsHandler::mIDRowIndexMap

private

Definition at line 70 of file ExportOptionsHandler.h.

Referenced by OnExportOptionChange(), and PopulateOptions().

mParent

wxWindow* ExportOptionsHandler::mParent { nullptr }

private

Definition at line 66 of file ExportOptionsHandler.h.

Referenced by ExportOptionsHandler(), OnExportOptionChangeBegin(), and OnExportOptionChangeEnd().

mRows

std::vector<std::tuple<wxStaticText*, wxControl*> > ExportOptionsHandler::mRows

private

Definition at line 69 of file ExportOptionsHandler.h.

Referenced by OnExportOptionChange(), and PopulateOptions().

mUpdateLocker

std::unique_ptr<wxWindowUpdateLocker> ExportOptionsHandler::mUpdateLocker

private

Definition at line 67 of file ExportOptionsHandler.h.

Referenced by OnExportOptionChangeBegin(), and OnExportOptionChangeEnd().

---

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

• ExportOptionsHandler.h
• ExportOptionsHandler.cpp