EffectPresetsDialog Class Reference

#include <EffectPresetDialog.h>

Inheritance diagram for EffectPresetsDialog:

Collaboration diagram for EffectPresetsDialog:

Public Member Functions
	EffectPresetsDialog (wxWindow *parent, EffectPlugin *effect)
virtual	~EffectPresetsDialog ()
wxString	GetSelected () const
void	SetSelected (const wxString &parms)
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()
	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
void	SetTitle (const TranslatableString &title)
void	SetLabel (const TranslatableString &title)
void	SetName (const TranslatableString &title)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	SetPrefix (const TranslatableString &type, const wxString &prefix)
void	UpdateUI ()
void	OnType (wxCommandEvent &evt)
void	OnOk (wxCommandEvent &evt)
void	OnCancel (wxCommandEvent &evt)

Private Attributes
wxChoice *	mType
wxListBox *	mPresets
RegistryPaths	mFactoryPresets
RegistryPaths	mUserPresets
wxString	mSelection

Detailed Description

Definition at line 9 of file EffectPresetDialog.h.

Constructor & Destructor Documentation

EffectPresetsDialog()

EffectPresetsDialog::EffectPresetsDialog	(	wxWindow *	parent,
		EffectPlugin *	effect
	)

Definition at line 18 of file EffectPresetDialog.cpp.

    : wxDialogWrapper(parent, wxID_ANY, XO("Select Preset"))
{
   ShuttleGui S(this, eIsCreating);
   S.StartVerticalLay();
   {
      S.StartTwoColumn();
      S.SetStretchyCol(1);
      {
         S.AddPrompt(XXO("Type:"));
         mType = S.Id(ID_Type).AddChoice({}, {}, 0);
 
         S.AddPrompt(XXO("&Preset:"));
         mPresets = S.Style(wxLB_SINGLE | wxLB_NEEDED_SB).AddListBox({});
      }
      S.EndTwoColumn();
 
      S.AddStandardButtons();
   }
   S.EndVerticalLay();
 
   mUserPresets = GetUserPresets(*effect);
   mFactoryPresets = effect->GetDefinition().GetFactoryPresets();
 
   if (mUserPresets.size() > 0)
   {
      mType->Append(_("User Presets"));
   }
 
   if (mFactoryPresets.size() > 0)
   {
      mType->Append(_("Factory Presets"));
   }
 
   if (HasCurrentSettings(*effect))
   {
      mType->Append(_("Current Settings"));
   }
 
   if (HasFactoryDefaults(*effect))
   {
      mType->Append(_("Factory Defaults"));
   }
 
   UpdateUI();
}

References _, eIsCreating, GetUserPresets(), HasCurrentSettings(), HasFactoryDefaults(), ID_Type, S, and XXO().

Here is the call graph for this function:

~EffectPresetsDialog()

EffectPresetsDialog::~EffectPresetsDialog ( )

virtual

Definition at line 65 of file EffectPresetDialog.cpp.

{
}

Member Function Documentation

GetSelected()

wxString EffectPresetsDialog::GetSelected

(

)

const

Definition at line 69 of file EffectPresetDialog.cpp.

{
   return mSelection;
}

References mSelection.

Referenced by MacroCommands::PromptForPresetFor().

Here is the caller graph for this function:

OnCancel()

void EffectPresetsDialog::OnCancel ( wxCommandEvent &  evt )

private

Definition at line 226 of file EffectPresetDialog.cpp.

{
   mSelection = wxEmptyString;
 
   EndModal(false);
}

References mSelection.

OnOk()

void EffectPresetsDialog::OnOk ( wxCommandEvent &  evt )

private

Definition at line 219 of file EffectPresetDialog.cpp.

{
   UpdateUI();
 
   EndModal(true);
}

References UpdateUI().

Here is the call graph for this function:

OnType()

void EffectPresetsDialog::OnType ( wxCommandEvent &  evt )

private

Definition at line 214 of file EffectPresetDialog.cpp.

{
   UpdateUI();
}

References UpdateUI().

Here is the call graph for this function:

SetPrefix()

void EffectPresetsDialog::SetPrefix ( const TranslatableString &  type, const wxString &  prefix  )

private

Definition at line 97 of file EffectPresetDialog.cpp.

{
   mType->SetStringSelection(type.Translation());
 
   if (type == XO("User Presets"))
   {
      mPresets->Clear();
      for (const auto& preset : mUserPresets)
         mPresets->Append(preset);
      mPresets->Enable(true);
      mPresets->SetStringSelection(prefix);
      if (mPresets->GetSelection() == wxNOT_FOUND)
      {
         mPresets->SetSelection(0);
      }
      mSelection =
         EffectPlugin::kUserPresetIdent + mPresets->GetStringSelection();
   }
   else if (type == XO("Factory Presets"))
   {
      mPresets->Clear();
      for (size_t i = 0, cnt = mFactoryPresets.size(); i < cnt; i++)
      {
         auto label = mFactoryPresets[i];
         if (label.empty())
         {
            label = _("None");
         }
         mPresets->Append(label);
      }
      mPresets->Enable(true);
      mPresets->SetStringSelection(prefix);
      if (mPresets->GetSelection() == wxNOT_FOUND)
      {
         mPresets->SetSelection(0);
      }
      mSelection =
         EffectPlugin::kFactoryPresetIdent + mPresets->GetStringSelection();
   }
   else if (type == XO("Current Settings"))
   {
      mPresets->Clear();
      mPresets->Enable(false);
      mSelection = EffectPlugin::kCurrentSettingsIdent;
   }
   else if (type == XO("Factory Defaults"))
   {
      mPresets->Clear();
      mPresets->Enable(false);
      mSelection = EffectPlugin::kFactoryDefaultsIdent;
   }
}

References _, TranslatableString::empty(), EffectPlugin::kCurrentSettingsIdent, EffectPlugin::kFactoryDefaultsIdent, EffectPlugin::kFactoryPresetIdent, EffectPlugin::kUserPresetIdent, label, mFactoryPresets, mPresets, mSelection, mType, mUserPresets, preset, TranslatableString::Translation(), and XO().

Referenced by SetSelected().

Here is the call graph for this function:

Here is the caller graph for this function:

SetSelected()

void EffectPresetsDialog::SetSelected

(

const wxString &

parms

)

Definition at line 74 of file EffectPresetDialog.cpp.

{
   wxString preset = parms;
   if (preset.StartsWith(EffectPlugin::kUserPresetIdent))
   {
      preset.Replace(EffectPlugin::kUserPresetIdent, wxEmptyString, false);
      SetPrefix(XO("User Presets"), preset);
   }
   else if (preset.StartsWith(EffectPlugin::kFactoryPresetIdent))
   {
      preset.Replace(EffectPlugin::kFactoryPresetIdent, wxEmptyString, false);
      SetPrefix(XO("Factory Presets"), preset);
   }
   else if (preset.StartsWith(EffectPlugin::kCurrentSettingsIdent))
   {
      SetPrefix(XO("Current Settings"), wxEmptyString);
   }
   else if (preset.StartsWith(EffectPlugin::kFactoryDefaultsIdent))
   {
      SetPrefix(XO("Factory Defaults"), wxEmptyString);
   }
}

References EffectPlugin::kCurrentSettingsIdent, EffectPlugin::kFactoryDefaultsIdent, EffectPlugin::kFactoryPresetIdent, EffectPlugin::kUserPresetIdent, preset, SetPrefix(), and XO().

Referenced by MacroCommands::PromptForPresetFor().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateUI()

void EffectPresetsDialog::UpdateUI ( )

private

Definition at line 151 of file EffectPresetDialog.cpp.

{
   int selected = mType->GetSelection();
   if (selected == wxNOT_FOUND)
   {
      selected = 0;
      mType->SetSelection(selected);
   }
   wxString type = mType->GetString(selected);
 
   if (type == _("User Presets"))
   {
      selected = mPresets->GetSelection();
      if (selected == wxNOT_FOUND)
      {
         selected = 0;
      }
 
      mPresets->Clear();
      for (const auto& preset : mUserPresets)
         mPresets->Append(preset);
      mPresets->Enable(true);
      mPresets->SetSelection(selected);
      mSelection =
         EffectPlugin::kUserPresetIdent + mPresets->GetString(selected);
   }
   else if (type == _("Factory Presets"))
   {
      selected = mPresets->GetSelection();
      if (selected == wxNOT_FOUND)
      {
         selected = 0;
      }
 
      mPresets->Clear();
      for (size_t i = 0, cnt = mFactoryPresets.size(); i < cnt; i++)
      {
         auto label = mFactoryPresets[i];
         if (label.empty())
         {
            label = _("None");
         }
         mPresets->Append(label);
      }
      mPresets->Enable(true);
      mPresets->SetSelection(selected);
      mSelection =
         EffectPlugin::kFactoryPresetIdent + mPresets->GetString(selected);
   }
   else if (type == _("Current Settings"))
   {
      mPresets->Clear();
      mPresets->Enable(false);
      mSelection = EffectPlugin::kCurrentSettingsIdent;
   }
   else if (type == _("Factory Defaults"))
   {
      mPresets->Clear();
      mPresets->Enable(false);
      mSelection = EffectPlugin::kFactoryDefaultsIdent;
   }
}

References _, TranslatableString::empty(), EffectPlugin::kCurrentSettingsIdent, EffectPlugin::kFactoryDefaultsIdent, EffectPlugin::kFactoryPresetIdent, EffectPlugin::kUserPresetIdent, label, mFactoryPresets, mPresets, mSelection, mType, mUserPresets, and preset.

Referenced by OnOk(), and OnType().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mFactoryPresets

RegistryPaths EffectPresetsDialog::mFactoryPresets

private

Definition at line 30 of file EffectPresetDialog.h.

Referenced by SetPrefix(), and UpdateUI().

mPresets

wxListBox* EffectPresetsDialog::mPresets

private

Definition at line 28 of file EffectPresetDialog.h.

Referenced by SetPrefix(), and UpdateUI().

mSelection

wxString EffectPresetsDialog::mSelection

private

Definition at line 32 of file EffectPresetDialog.h.

Referenced by GetSelected(), OnCancel(), SetPrefix(), and UpdateUI().

mType

wxChoice* EffectPresetsDialog::mType

private

Definition at line 27 of file EffectPresetDialog.h.

Referenced by SetPrefix(), and UpdateUI().

mUserPresets

RegistryPaths EffectPresetsDialog::mUserPresets

private

Definition at line 31 of file EffectPresetDialog.h.

Referenced by SetPrefix(), and UpdateUI().

---

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

• EffectPresetDialog.h
• EffectPresetDialog.cpp