MacroCommandDialog Class Reference

Provides a list of configurable commands for use with MacroCommands. More...

#include <BatchCommandDialog.h>

Inheritance diagram for MacroCommandDialog:

Collaboration diagram for MacroCommandDialog:

Public Member Functions
	MacroCommandDialog (wxWindow *parent, wxWindowID id, AudacityProject &project)
void	SetCommandAndParams (const CommandID &Command, const wxString &Params)
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

Public Attributes
CommandID	mSelectedCommand
wxString	mSelectedParameters

Private Member Functions
void	Populate ()
void	PopulateOrExchange (ShuttleGui &S)
void	OnEditParams (wxCommandEvent &event)
void	OnUsePreset (wxCommandEvent &event)
void	OnChoice (wxCommandEvent &event)
void	OnOk (wxCommandEvent &event)
void	OnCancel (wxCommandEvent &event)
void	OnHelp (wxCommandEvent &event)
void	OnItemSelected (wxListEvent &event)
ManualPageID	GetHelpPageName ()
void	ValidateChoices ()
void	PopulateCommandList ()

Private Attributes
wxButton *	mEditParams
wxButton *	mUsePreset
wxListCtrl *	mChoices
wxTextCtrl *	mCommand
wxTextCtrl *	mParameters
wxTextCtrl *	mDetails
CommandID	mInternalCommandName
const MacroCommandsCatalog	mCatalog

Detailed Description

Provides a list of configurable commands for use with MacroCommands.

Provides a list of commands, mostly effects, which can be chained together in a simple linear sequence. Can configure parameters on each selected command.

Definition at line 28 of file BatchCommandDialog.h.

Constructor & Destructor Documentation

MacroCommandDialog()

MacroCommandDialog::MacroCommandDialog	(	wxWindow *	parent,
		wxWindowID	id,
		AudacityProject &	project
	)

Definition at line 59 of file BatchCommandDialog.cpp.

                                                              :
   wxDialogWrapper(parent, id, XO("Select Command"),
            wxDefaultPosition, wxDefaultSize,
            wxCAPTION | wxRESIZE_BORDER)
   , mCatalog{ &project }
{
   SetLabel(XO("Select Command"));         // Provide visual label
   SetName(XO("Select Command"));          // Provide audible label
   Populate();
}

References project.

Member Function Documentation

GetHelpPageName()

ManualPageID MacroCommandDialog::GetHelpPageName ( )

inlineprivate

Definition at line 46 of file BatchCommandDialog.h.

{ return L"Scripting Reference" ; }

Referenced by OnHelp().

Here is the caller graph for this function:

OnCancel()

void MacroCommandDialog::OnCancel ( wxCommandEvent &  event )

private

Definition at line 164 of file BatchCommandDialog.cpp.

{
   EndModal(false);
}

OnChoice()

void MacroCommandDialog::OnChoice ( wxCommandEvent &  event )

private

Definition at line 149 of file BatchCommandDialog.cpp.

{
}

OnEditParams()

void MacroCommandDialog::OnEditParams ( wxCommandEvent &  event )

private

Definition at line 211 of file BatchCommandDialog.cpp.

{
   auto command = mInternalCommandName;
   wxString params  = mParameters->GetValue();
 
   params = MacroCommands::PromptForParamsFor(command, params, *this).Trim();
 
   mParameters->SetValue(params);
   mParameters->Refresh();
}

References mInternalCommandName, mParameters, params, and MacroCommands::PromptForParamsFor().

Here is the call graph for this function:

OnHelp()

void MacroCommandDialog::OnHelp ( wxCommandEvent &  event )

private

Definition at line 169 of file BatchCommandDialog.cpp.

{
   const auto &page = GetHelpPageName();
   HelpSystem::ShowHelp(this, page, true);
}

References GetHelpPageName(), and HelpSystem::ShowHelp().

Here is the call graph for this function:

OnItemSelected()

void MacroCommandDialog::OnItemSelected ( wxListEvent &  event )

private

Definition at line 175 of file BatchCommandDialog.cpp.

{
   const auto &command = mCatalog[ event.GetIndex() ];
 
   EffectManager & em = EffectManager::Get();
   PluginID ID = em.GetEffectByIdentifier( command.name.Internal() );
 
   // If ID is empty, then the effect wasn't found, in which case, the user must have
   // selected one of the "special" commands.
   mEditParams->Enable(!ID.empty());
   mUsePreset->Enable(em.HasPresets(ID));
 
   auto value = command.name.StrippedTranslation();
   if ( value == mCommand->GetValue() )
      // This uses the assumption of uniqueness of translated names!
      return;
 
   mCommand->SetValue(value);
   mInternalCommandName = command.name.Internal();
 
   wxString params = MacroCommands::GetCurrentParamsFor(mInternalCommandName);
   if (params.empty())
   {
      params = em.GetDefaultPreset(ID);
   }
 
   // using GET to expose a CommandID to the user!
   // Cryptic command and category.
   // Later we can put help information there, perhaps.
   // Macro command details are one place that we do expose Identifier
   // to (more sophisticated) users
   mDetails->SetValue(
      mInternalCommandName.GET() + "\r\n" + command.category.Translation()  );
   mParameters->SetValue(params);
}

References EffectManager::Get(), Identifier::GET(), MacroCommands::GetCurrentParamsFor(), EffectManager::GetDefaultPreset(), EffectManager::GetEffectByIdentifier(), EffectManager::HasPresets(), mCatalog, mCommand, mDetails, mEditParams, mInternalCommandName, mParameters, mUsePreset, and params.

Here is the call graph for this function:

OnOk()

void MacroCommandDialog::OnOk ( wxCommandEvent &  event )

private

Definition at line 153 of file BatchCommandDialog.cpp.

{
   mSelectedCommand = mInternalCommandName
      // .Strip(wxString::both) // PRL: used to do this, here only,
         // but ultimately mSelectedCommand is looked up in the catalog without
         // similar adjustment of whitespace in the comparison
   ;
   mSelectedParameters = mParameters->GetValue().Strip(wxString::trailing);
   EndModal(true);
}

References mInternalCommandName, mParameters, mSelectedCommand, and mSelectedParameters.

OnUsePreset()

void MacroCommandDialog::OnUsePreset ( wxCommandEvent &  event )

private

Definition at line 222 of file BatchCommandDialog.cpp.

{
   auto command = mInternalCommandName;
   wxString params  = mParameters->GetValue();
 
   wxString preset = MacroCommands::PromptForPresetFor(command, params, this).Trim();
 
   mParameters->SetValue(preset);
   mParameters->Refresh();
}

References mInternalCommandName, mParameters, params, preset, and MacroCommands::PromptForPresetFor().

Here is the call graph for this function:

Populate()

void MacroCommandDialog::Populate ( )

private

Definition at line 71 of file BatchCommandDialog.cpp.

{
   //------------------------- Main section --------------------
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
}

References eIsCreating, PopulateOrExchange(), and S.

Here is the call graph for this function:

PopulateCommandList()

void MacroCommandDialog::PopulateCommandList ( )

private

Definition at line 136 of file BatchCommandDialog.cpp.

{
   mChoices->DeleteAllItems();
   long ii = 0;
   for ( const auto &entry : mCatalog )
      // insert the user-facing string
      mChoices->InsertItem( ii++, entry.name.StrippedTranslation() );
}

References entry, mCatalog, and mChoices.

Referenced by PopulateOrExchange().

Here is the caller graph for this function:

PopulateOrExchange()

void MacroCommandDialog::PopulateOrExchange ( ShuttleGui &  S )

private

Definition at line 79 of file BatchCommandDialog.cpp.

{
   S.StartVerticalLay(true);
   {
      S.StartMultiColumn(4, wxEXPAND);
      {
         S.SetStretchyCol(1);
         mCommand = S.AddTextBox(XXO("&Command"), wxT(""), 20);
         mCommand->SetEditable(false);
         mEditParams = S.Id(EditParamsButtonID)
            .Disable() // disable button as box is empty
            .AddButton(XXO("&Edit Parameters"));
         mUsePreset = S.Id(UsePresetButtonID)
            .Disable() // disable button as box is empty
            .AddButton(XXO("&Use Preset"));
      }
      S.EndMultiColumn();
 
      S.StartMultiColumn(2, wxEXPAND);
      {
         S.SetStretchyCol(1);
         mParameters = S.AddTextBox(XXO("&Parameters"), wxT(""), 0);
         mParameters->SetEditable(false);
         auto prompt = XXO("&Details");
         S.Prop(0).AddPrompt(prompt);
         mDetails = S
            .Name( prompt )
            .AddTextWindow( wxT(""));
         mDetails->SetEditable(false);
      }
      S.EndMultiColumn();
 
      S.Prop(10).StartStatic(XO("Choose command"), true);
      {
         mChoices = S.Id(CommandsListID)
            .Style(wxSUNKEN_BORDER | wxLC_LIST | wxLC_SINGLE_SEL)
            .AddListControl();
      }
      S.EndStatic();
   }
   S.EndVerticalLay();
 
   S.AddStandardButtons( eOkButton | eCancelButton | eHelpButton);
 
   PopulateCommandList();
   if (mChoices->GetItemCount() > 0) {
      // set first item to be selected (and the focus when the
      // list first becomes the focus)
      mChoices->SetItemState(0, wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED,
         wxLIST_STATE_FOCUSED | wxLIST_STATE_SELECTED);
   }
 
   SetMinSize(wxSize(780, 560));
   Fit();
   Center();
}

References CommandsListID, eCancelButton, EditParamsButtonID, eHelpButton, eOkButton, mChoices, mCommand, mDetails, mEditParams, mParameters, mUsePreset, PopulateCommandList(), S, UsePresetButtonID, wxT(), XO(), and XXO().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

SetCommandAndParams()

void MacroCommandDialog::SetCommandAndParams	(	const CommandID &	Command,
		const wxString &	Params
	)

Definition at line 233 of file BatchCommandDialog.cpp.

{
   auto iter = mCatalog.ByCommandId( Command );
 
   mParameters->SetValue( Params );
 
   mInternalCommandName = Command;
   if (iter == mCatalog.end())
      // uh oh, using GET to expose an internal name to the user!
      // in default of any better friendly name
      mCommand->SetValue( Command.GET() );
   else {
      mCommand->SetValue( iter->name.StrippedTranslation() );
      // using GET to expose a CommandID to the user!
      // Macro command details are one place that we do expose Identifier
      // to (more sophisticated) users
      mDetails->SetValue(
         iter->name.Internal() + "\r\n" + iter->category.Translation()  );
      mChoices->SetItemState(iter - mCatalog.begin(),
                             wxLIST_STATE_SELECTED, wxLIST_STATE_SELECTED);
 
      EffectManager & em = EffectManager::Get();
      PluginID ID = em.GetEffectByIdentifier(Command);
 
      // If ID is empty, then the effect wasn't found, in which case, the user must have
      // selected one of the "special" commands.
      mEditParams->Enable(!ID.empty());
      mUsePreset->Enable(em.HasPresets(ID));
   }
}

References MacroCommandsCatalog::begin(), MacroCommandsCatalog::ByCommandId(), MenuRegistry::Command, MacroCommandsCatalog::end(), EffectManager::Get(), EffectManager::GetEffectByIdentifier(), EffectManager::HasPresets(), mCatalog, mChoices, mCommand, mDetails, mEditParams, mInternalCommandName, mParameters, and mUsePreset.

Here is the call graph for this function:

ValidateChoices()

void MacroCommandDialog::ValidateChoices ( )

private

Definition at line 145 of file BatchCommandDialog.cpp.

{
}

Member Data Documentation

mCatalog

const MacroCommandsCatalog MacroCommandDialog::mCatalog

private

Definition at line 61 of file BatchCommandDialog.h.

Referenced by OnItemSelected(), PopulateCommandList(), and SetCommandAndParams().

mChoices

wxListCtrl* MacroCommandDialog::mChoices

private

Definition at line 54 of file BatchCommandDialog.h.

Referenced by PopulateCommandList(), PopulateOrExchange(), and SetCommandAndParams().

mCommand

wxTextCtrl* MacroCommandDialog::mCommand

private

Definition at line 55 of file BatchCommandDialog.h.

Referenced by OnItemSelected(), PopulateOrExchange(), and SetCommandAndParams().

mDetails

wxTextCtrl* MacroCommandDialog::mDetails

private

Definition at line 57 of file BatchCommandDialog.h.

Referenced by OnItemSelected(), PopulateOrExchange(), and SetCommandAndParams().

mEditParams

wxButton* MacroCommandDialog::mEditParams

private

Definition at line 52 of file BatchCommandDialog.h.

Referenced by OnItemSelected(), PopulateOrExchange(), and SetCommandAndParams().

mInternalCommandName

CommandID MacroCommandDialog::mInternalCommandName

private

Definition at line 59 of file BatchCommandDialog.h.

Referenced by OnEditParams(), OnItemSelected(), OnOk(), OnUsePreset(), and SetCommandAndParams().

mParameters

wxTextCtrl* MacroCommandDialog::mParameters

private

Definition at line 56 of file BatchCommandDialog.h.

Referenced by OnEditParams(), OnItemSelected(), OnOk(), OnUsePreset(), PopulateOrExchange(), and SetCommandAndParams().

mSelectedCommand

CommandID MacroCommandDialog::mSelectedCommand

Definition at line 34 of file BatchCommandDialog.h.

Referenced by MacrosWindow::InsertCommandAt(), and OnOk().

mSelectedParameters

wxString MacroCommandDialog::mSelectedParameters

Definition at line 35 of file BatchCommandDialog.h.

Referenced by MacrosWindow::InsertCommandAt(), and OnOk().

mUsePreset

wxButton* MacroCommandDialog::mUsePreset

private

Definition at line 53 of file BatchCommandDialog.h.

Referenced by OnItemSelected(), PopulateOrExchange(), and SetCommandAndParams().

---

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

• BatchCommandDialog.h
• BatchCommandDialog.cpp