MacrosWindow Class Reference

#include <BatchProcessDialog.h>

Inheritance diagram for MacrosWindow:

Collaboration diagram for MacrosWindow:

Public Member Functions
	MacrosWindow (wxWindow *parent, AudacityProject &project, bool bExpanded=true)
	Constructor. More...
	~MacrosWindow ()
void	UpdateDisplay (bool bExpanded)
Public Member Functions inherited from ApplyMacroDialog
	ApplyMacroDialog (wxWindow *parent, AudacityProject &project, bool bInherited=false)
virtual	~ApplyMacroDialog ()
void	Populate ()
void	PopulateOrExchange (ShuttleGui &S)
	Defines the dialog and does data exchange with it. More...
virtual void	OnApplyToProject (wxCommandEvent &event)
virtual void	OnApplyToFiles (wxCommandEvent &event)
virtual void	OnCancel (wxCommandEvent &event)
virtual void	OnHelp (wxCommandEvent &event)
virtual ManualPageID	GetHelpPageName ()
void	PopulateMacros ()
void	ApplyMacroToProject (int iMacro, bool bHasGui=true)
void	ApplyMacroToProject (const CommandID &MacroID, bool bHasGui=true)
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 Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0

Private Member Functions
TranslatableString	WindowTitle () const
void	Populate ()
	Creates the dialog and its contents. More...
void	PopulateOrExchange (ShuttleGui &S)
	Defines the dialog and does data exchange with it. More...
void	OnApplyToProject (wxCommandEvent &event) override
void	OnApplyToFiles (wxCommandEvent &event) override
void	OnCancel (wxCommandEvent &event) override
virtual ManualPageID	GetHelpPageName () override
void	PopulateList ()
	This clears and updates the contents of mList, the commands for the current macro. More...
void	AddItem (const CommandID &command, wxString const &params)
	Add one item into mList. More...
bool	ChangeOK ()
void	UpdateMenus ()
void	ShowActiveMacro ()
void	OnMacroSelected (wxListEvent &event)
	An item in the macros list has been selected. More...
void	OnListSelected (wxListEvent &event)
	An item in the macros list has been selected. More...
void	OnMacrosBeginEdit (wxListEvent &event)
void	OnMacrosEndEdit (wxListEvent &event)
void	OnAdd (wxCommandEvent &event)
void	OnRemove (wxCommandEvent &event)
void	OnRename (wxCommandEvent &event)
void	OnRestore (wxCommandEvent &event)
	Reset a built in macro. More...
void	OnImport (wxCommandEvent &event)
void	OnExport (wxCommandEvent &event)
void	OnSave (wxCommandEvent &event)
void	OnExpand (wxCommandEvent &event)
void	OnShrink (wxCommandEvent &event)
void	OnSize (wxSizeEvent &event)
	The window has been resized. More...
void	OnCommandActivated (wxListEvent &event)
void	OnInsert (wxCommandEvent &event)
void	OnEditCommandParams (wxCommandEvent &event)
void	OnDelete (wxCommandEvent &event)
void	OnUp (wxCommandEvent &event)
void	OnDown (wxCommandEvent &event)
void	OnOK (wxCommandEvent &event)
	Send changed values back to Prefs, and update Audacity. More...
void	OnKeyDown (wxKeyEvent &event)
void	FitColumns ()
void	InsertCommandAt (int item)
bool	SaveChanges ()
void	UpdatePrefs () override

Private Attributes
AudacityProject &	mProject
wxButton *	mRemove
wxButton *	mRename
wxButton *	mRestore
wxButton *	mImport
wxButton *	mExport
wxButton *	mEdit
wxButton *	mSave
int	mSelectedCommand
bool	mChanged

Additional Inherited Members
Static Public Member Functions inherited from ApplyMacroDialog
static CommandID	MacroIdOfName (const wxString &MacroName)
Static Public Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...
Public Attributes inherited from ApplyMacroDialog
wxListCtrl *	mList
wxListCtrl *	mMacros
MacroCommands	mMacroCommands
wxButton *	mResize
	Provides list of available commands. More...
wxButton *	mOK
wxButton *	mCancel
wxTextCtrl *	mResults
bool	mAbort
bool	mbExpanded
wxString	mActiveMacro
wxString	mMacroBeingRenamed
Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)
Protected Attributes inherited from ApplyMacroDialog
AudacityProject &	mProject
const MacroCommandsCatalog	mCatalog

Detailed Description

Definition at line 73 of file BatchProcessDialog.h.

Constructor & Destructor Documentation

MacrosWindow()

MacrosWindow::MacrosWindow	(	wxWindow *	parent,
		AudacityProject &	project,
		bool	bExpanded = true
	)

Constructor.

Definition at line 567 of file BatchProcessDialog.cpp.

                                                               :
   ApplyMacroDialog(parent, project, true)
   , mProject{ project }
{
   mbExpanded = bExpanded;
   auto Title = WindowTitle();
   SetLabel( Title );   // Provide visual label
   SetName(  Title );   // Provide audible label
   SetTitle( Title );
 
   mChanged = false;
   mSelectedCommand = 0;
 
   if( mbExpanded )
      Populate();
   else
      ApplyMacroDialog::Populate();
}

References ApplyMacroDialog::mbExpanded, mChanged, mSelectedCommand, ApplyMacroDialog::Populate(), Populate(), wxDialogWrapper::SetLabel(), wxDialogWrapper::SetName(), wxDialogWrapper::SetTitle(), and WindowTitle().

Here is the call graph for this function:

~MacrosWindow()

MacrosWindow::~MacrosWindow

(

)

Definition at line 587 of file BatchProcessDialog.cpp.

{
}

Member Function Documentation

AddItem()

void MacrosWindow::AddItem ( const CommandID &  command, wxString const &  params  )

private

Add one item into mList.

Definition at line 757 of file BatchProcessDialog.cpp.

{
   auto entry = mCatalog.ByCommandId(Action);
   auto friendlyName = entry != mCatalog.end()
      ? entry->name.StrippedTranslation()
      :
         // uh oh, using GET to expose an internal name to the user!
         // in default of any better friendly name
        Action.GET();
 
   int i = mList->GetItemCount();
 
   mList->InsertItem(i, wxString::Format(wxT(" %02i"), i + 1));
   mList->SetItem(i, ActionColumn, friendlyName );
   mList->SetItem(i, ParamsColumn, Params );
}

References ActionColumn, MacroCommandsCatalog::ByCommandId(), MacroCommandsCatalog::end(), entry, ApplyMacroDialog::mCatalog, ApplyMacroDialog::mList, ParamsColumn, and wxT().

Referenced by PopulateList().

Here is the call graph for this function:

Here is the caller graph for this function:

ChangeOK()

bool MacrosWindow::ChangeOK ( )

private

Definition at line 831 of file BatchProcessDialog.cpp.

{
   if (mChanged) {
      int id;
 
      auto title = XO("%s changed").Format( mActiveMacro );
      auto msg = XO("Do you want to save the changes?");
 
      id = AudacityMessageBox(
         msg,
         title,
         wxYES_NO | wxCANCEL);
      if (id == wxCANCEL) {
         return false;
      }
 
      if (id == wxYES) {
         if (!mMacroCommands.WriteMacro(mActiveMacro)) {
            return false;
         }
      }
 
      mChanged = false;
      mSave->Enable( mChanged );
   }
 
   return true;
}

References AudacityMessageBox(), id, ApplyMacroDialog::mActiveMacro, mChanged, ApplyMacroDialog::mMacroCommands, mSave, title, MacroCommands::WriteMacro(), and XO().

Referenced by OnAdd(), OnCancel(), OnImport(), OnMacroSelected(), and OnShrink().

Here is the call graph for this function:

Here is the caller graph for this function:

FitColumns()

void MacrosWindow::FitColumns ( )

private

Definition at line 920 of file BatchProcessDialog.cpp.

{
 
#if defined(__WXMAC__)
   // wxMac uses a hard coded width of 150 when wxLIST_AUTOSIZE_USEHEADER
   // is specified, so we calculate the width ourselves. This method may
   // work equally well on other platforms.
   for (size_t c = 0; c < mList->GetColumnCount(); c++) {
      wxListItem info;
      int width;
 
      mList->SetColumnWidth(c, wxLIST_AUTOSIZE);
      info.Clear();
      info.SetId(c);
      info.SetMask(wxLIST_MASK_TEXT | wxLIST_MASK_WIDTH);
      mList->GetColumn(c, info);
 
      mList->GetTextExtent(info.GetText(), &width, NULL);
      width += 2 * 4;    // 2 * kItemPadding - see listctrl_mac.cpp
      width += 16;       // kIconWidth - see listctrl_mac.cpp
 
      mList->SetColumnWidth(c, wxMax(width, mList->GetColumnWidth(c)));
   }
 
   // Looks strange, but it forces the horizontal scrollbar to get
   // drawn.  If not done, strange column sizing can occur if the
   // user attempts to resize the columns.
   mList->SetClientSize(mList->GetClientSize());
#else
   mList->SetColumnWidth(0, wxLIST_AUTOSIZE_USEHEADER);
   mList->SetColumnWidth(1, wxLIST_AUTOSIZE_USEHEADER);
   mList->SetColumnWidth(2, wxLIST_AUTOSIZE);
#endif
 
   int bestfit = mList->GetColumnWidth(2);
   int clientsize = mList->GetClientSize().GetWidth();
   int col0 = mList->GetColumnWidth(0);
   int col1 = mList->GetColumnWidth(1);
   bestfit = (bestfit > clientsize-col0-col1)? bestfit : clientsize-col0-col1;
   mList->SetColumnWidth(2, bestfit);
 
}

References ApplyMacroDialog::mList.

Referenced by OnListSelected(), OnSize(), and Populate().

Here is the caller graph for this function:

GetHelpPageName()

virtual ManualPageID MacrosWindow::GetHelpPageName ( )

inlineoverrideprivatevirtual

Reimplemented from ApplyMacroDialog.

Definition at line 91 of file BatchProcessDialog.h.

                                                   {return 
      mbExpanded ? "Manage_Macros"
         : "Apply_Macro";}

References ApplyMacroDialog::mbExpanded.

InsertCommandAt()

void MacrosWindow::InsertCommandAt ( int  item )

private

Definition at line 1187 of file BatchProcessDialog.cpp.

{
   if (item == -1) {
      return;
   }
 
   MacroCommandDialog d(this, wxID_ANY, mProject);
 
   if (!d.ShowModal()) {
      Raise();
      return;
   }
   Raise();
 
   if(!d.mSelectedCommand.empty())
   {
      mMacroCommands.AddToMacro(d.mSelectedCommand,
                                d.mSelectedParameters,
                                item);
      mChanged = true;
      mSave->Enable( mChanged );
 
      mSelectedCommand = item + 1;
      PopulateList();
   }
 
}

References MacroCommands::AddToMacro(), Identifier::empty(), mChanged, ApplyMacroDialog::mMacroCommands, mProject, mSave, MacroCommandDialog::mSelectedCommand, mSelectedCommand, MacroCommandDialog::mSelectedParameters, and PopulateList().

Referenced by OnEditCommandParams(), and OnInsert().

Here is the call graph for this function:

Here is the caller graph for this function:

OnAdd()

void MacrosWindow::OnAdd ( wxCommandEvent &  event )

private

Definition at line 1001 of file BatchProcessDialog.cpp.

{
   // Similar to Bug 2284 we may need to save a changed macro.
   if (!ChangeOK()) {
      return;
   }
 
   while (true) {
      AudacityTextEntryDialog d(this,
         XO("Enter name of new macro"),
         XO("Name of new macro"));
      d.SetName(d.GetTitle());
      wxString name;
 
      if (d.ShowModal() == wxID_CANCEL) {
         Raise();
         return;
      }
      Raise();
 
      name = d.GetValue().Strip(wxString::both);
 
      if (name.length() == 0) {
         AudacityMessageBox(
            XO("Name must not be blank"),
            WindowTitle(),
            wxOK | wxICON_ERROR,
            this);
         continue;
      }
 
      if (name.Contains(wxFILE_SEP_PATH) ||
          name.Contains(wxFILE_SEP_PATH_UNIX)) {
         AudacityMessageBox(
            /*i18n-hint: The %c will be replaced with 'forbidden characters', like '/' and '\'.*/
            XO("Names may not contain '%c' and '%c'")
               .Format(wxFILE_SEP_PATH, wxFILE_SEP_PATH_UNIX),
            WindowTitle(),
            wxOK | wxICON_ERROR,
            this);
         continue;
      }
 
      mMacroCommands.AddMacro(name);
 
      mActiveMacro = name;
 
      PopulateMacros();
      UpdateMenus();
 
      break;
   }
}

References MacroCommands::AddMacro(), AudacityMessageBox(), ChangeOK(), ApplyMacroDialog::mActiveMacro, ApplyMacroDialog::mMacroCommands, name, ApplyMacroDialog::PopulateMacros(), UpdateMenus(), WindowTitle(), and XO().

Here is the call graph for this function:

OnApplyToFiles()

void MacrosWindow::OnApplyToFiles ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from ApplyMacroDialog.

Definition at line 1327 of file BatchProcessDialog.cpp.

{
   if( !SaveChanges() )
      return;
   ApplyMacroDialog::OnApplyToFiles( event );
}

References ApplyMacroDialog::OnApplyToFiles(), and SaveChanges().

Here is the call graph for this function:

OnApplyToProject()

void MacrosWindow::OnApplyToProject ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from ApplyMacroDialog.

Definition at line 1320 of file BatchProcessDialog.cpp.

{
   if( !SaveChanges() )
      return;
   ApplyMacroDialog::OnApplyToProject( event );
}

References ApplyMacroDialog::OnApplyToProject(), and SaveChanges().

Here is the call graph for this function:

OnCancel()

void MacrosWindow::OnCancel ( wxCommandEvent &  event )

overrideprivatevirtual

Reimplemented from ApplyMacroDialog.

Definition at line 1361 of file BatchProcessDialog.cpp.

{
   bool bWasChanged = mChanged;
   if (!ChangeOK()) {
      return;
   }
   // If we've rejected a change, we need to restore the display
   // of the active macro.
   // That's because next time we open this dialog we want to see the
   // unedited macro.
   if( bWasChanged )
      ShowActiveMacro();
   Hide();
}

References ChangeOK(), mChanged, and ShowActiveMacro().

Here is the call graph for this function:

OnCommandActivated()

void MacrosWindow::OnCommandActivated ( wxListEvent &  event )

private

An item in the list has been selected. Bring up a dialog to allow its parameters to be edited.

Definition at line 1169 of file BatchProcessDialog.cpp.

{
   wxCommandEvent dummy;
   OnEditCommandParams( dummy );
}

References OnEditCommandParams().

Here is the call graph for this function:

OnDelete()

void MacrosWindow::OnDelete ( wxCommandEvent &  event )

private

Definition at line 1255 of file BatchProcessDialog.cpp.

{
   long item = mList->GetNextItem(-1,
                                  wxLIST_NEXT_ALL,
                                  wxLIST_STATE_SELECTED);
   if (item == -1 || item + 1 == mList->GetItemCount()) {
      return;
   }
 
   mMacroCommands.DeleteFromMacro(item);
 
   mChanged = true;
   mSave->Enable( mChanged );
 
   if (item >= (mList->GetItemCount() - 2) && item >= 0) {
      item--;
   }
   mSelectedCommand = item;
   PopulateList();
}

References MacroCommands::DeleteFromMacro(), mChanged, ApplyMacroDialog::mList, ApplyMacroDialog::mMacroCommands, mSave, mSelectedCommand, and PopulateList().

Here is the call graph for this function:

OnDown()

void MacrosWindow::OnDown ( wxCommandEvent &  event )

private

Definition at line 1299 of file BatchProcessDialog.cpp.

{
   long item = mList->GetNextItem(-1,
                                  wxLIST_NEXT_ALL,
                                  wxLIST_STATE_SELECTED);
   if (item == -1 || item + 2 >= mList->GetItemCount()) {
      return;
   }
 
   mMacroCommands.AddToMacro(mMacroCommands.GetCommand(item),
                             mMacroCommands.GetParams(item),
                             item + 2);
   mMacroCommands.DeleteFromMacro(item);
 
   mChanged = true;
   mSave->Enable( mChanged );
 
   mSelectedCommand = item + 1;
   PopulateList();
}

References MacroCommands::AddToMacro(), MacroCommands::DeleteFromMacro(), MacroCommands::GetCommand(), MacroCommands::GetParams(), mChanged, ApplyMacroDialog::mList, ApplyMacroDialog::mMacroCommands, mSave, mSelectedCommand, and PopulateList().

Here is the call graph for this function:

OnEditCommandParams()

void MacrosWindow::OnEditCommandParams ( wxCommandEvent &  event )

private

Definition at line 1215 of file BatchProcessDialog.cpp.

{
   int item = mList->GetNextItem( -1, wxLIST_NEXT_ALL, wxLIST_STATE_SELECTED );
 
   // LAST command in list is END.
   // If nothing selected, add at END.
   // If END selected, add at END.
   // When adding at end we use InsertCommandAt, so that a new command
   // can be chosen.
   int lastItem = mList->GetItemCount()-1;
   if( (item<0) || (item+1) == mList->GetItemCount() )
   {
      InsertCommandAt( lastItem );
      return;
   }
 
   // Just edit the parameters, and not the command.
   auto command = mMacroCommands.GetCommand(item);
   wxString params  = mMacroCommands.GetParams(item);
   wxString oldParams = params;
 
   params = MacroCommands::PromptForParamsFor(command, params, mProject).Trim();
   Raise();
 
   if (oldParams == params)
      return; // They did not actually make any changes..
 
   mMacroCommands.DeleteFromMacro(item);
   mMacroCommands.AddToMacro(command,
      params,
      item);
 
   mChanged = true;
   mSave->Enable( mChanged );
 
   mSelectedCommand = item;
   PopulateList();
}

References MacroCommands::AddToMacro(), MacroCommands::DeleteFromMacro(), MacroCommands::GetCommand(), MacroCommands::GetParams(), InsertCommandAt(), mChanged, ApplyMacroDialog::mList, ApplyMacroDialog::mMacroCommands, mProject, mSave, mSelectedCommand, params, PopulateList(), and MacroCommands::PromptForParamsFor().

Referenced by OnCommandActivated().

Here is the call graph for this function:

Here is the caller graph for this function:

OnExpand()

void MacrosWindow::OnExpand ( wxCommandEvent &  event )

private

Definition at line 821 of file BatchProcessDialog.cpp.

{  UpdateDisplay( true );}

References UpdateDisplay().

Here is the call graph for this function:

OnExport()

void MacrosWindow::OnExport ( wxCommandEvent &  event )

private

Definition at line 1149 of file BatchProcessDialog.cpp.

{
   long item = mMacros->GetNextItem(-1,
                                    wxLIST_NEXT_ALL,
                                    wxLIST_STATE_SELECTED);
   if (item == -1) {
      return;
   }
 
   mMacroCommands.WriteMacro(mMacros->GetItemText(item), this);
}

References ApplyMacroDialog::mMacroCommands, ApplyMacroDialog::mMacros, and MacroCommands::WriteMacro().

Here is the call graph for this function:

OnImport()

void MacrosWindow::OnImport ( wxCommandEvent &  event )

private

Definition at line 1122 of file BatchProcessDialog.cpp.

{
   if (!ChangeOK()) {
      return;
   }
 
   long item = mMacros->GetNextItem(-1,
                                    wxLIST_NEXT_ALL,
                                    wxLIST_STATE_SELECTED);
   if (item == -1) {
      return;
   }
 
   wxString name = mMacros->GetItemText(item);
 
   name = mMacroCommands.ReadMacro({}, this);
   if (name == wxEmptyString) {
      return;
   }
 
   mActiveMacro = name;
 
   PopulateMacros();
   UpdateMenus();
}

References ChangeOK(), ApplyMacroDialog::mActiveMacro, ApplyMacroDialog::mMacroCommands, ApplyMacroDialog::mMacros, name, ApplyMacroDialog::PopulateMacros(), MacroCommands::ReadMacro(), and UpdateMenus().

Here is the call graph for this function:

OnInsert()

void MacrosWindow::OnInsert ( wxCommandEvent &  event )

private

Definition at line 1176 of file BatchProcessDialog.cpp.

{
   long item = mList->GetNextItem(-1,
                                  wxLIST_NEXT_ALL,
                                  wxLIST_STATE_SELECTED);
   if (item == -1) {
      item = mList->GetItemCount()-1;
   }
   InsertCommandAt( item );
}

References InsertCommandAt(), and ApplyMacroDialog::mList.

Here is the call graph for this function:

OnKeyDown()

void MacrosWindow::OnKeyDown ( wxKeyEvent &  event )

private

Definition at line 1377 of file BatchProcessDialog.cpp.

{
   if (event.GetKeyCode() == WXK_DELETE) {
      wxLogDebug(wxT("wxKeyEvent"));
   }
 
   event.Skip();
}

References wxT().

Here is the call graph for this function:

OnListSelected()

void MacrosWindow::OnListSelected ( wxListEvent &  event )

private

An item in the macros list has been selected.

Definition at line 894 of file BatchProcessDialog.cpp.

{
   const auto &command = mCatalog.ByTranslation(mList->GetItemText(event.GetIndex(), ActionColumn));
 
   if (command != mCatalog.end())
   {
      PluginID ID =
         PluginManager::Get().GetByCommandIdentifier(command->name.Internal());
 
      mEdit->Enable(!ID.empty());
   }
 
 
   FitColumns();
}

References ActionColumn, MacroCommandsCatalog::ByTranslation(), MacroCommandsCatalog::end(), FitColumns(), PluginManager::Get(), PluginManager::GetByCommandIdentifier(), ApplyMacroDialog::mCatalog, mEdit, and ApplyMacroDialog::mList.

Here is the call graph for this function:

OnMacrosBeginEdit()

void MacrosWindow::OnMacrosBeginEdit ( wxListEvent &  event )

private

Definition at line 964 of file BatchProcessDialog.cpp.

{
   int itemNo = event.GetIndex();
 
   wxString macro = mMacros->GetItemText(itemNo);
 
   if (mMacroCommands.IsFixed(macro)) {
      wxBell();
      event.Veto();
   }
   if( mMacroBeingRenamed.IsEmpty())
      mMacroBeingRenamed = macro;
}

References MacroCommands::IsFixed(), ApplyMacroDialog::mMacroBeingRenamed, ApplyMacroDialog::mMacroCommands, and ApplyMacroDialog::mMacros.

Here is the call graph for this function:

OnMacroSelected()

void MacrosWindow::OnMacroSelected ( wxListEvent &  event )

private

An item in the macros list has been selected.

Definition at line 860 of file BatchProcessDialog.cpp.

{
   if (!ChangeOK()) {
      event.Veto();
      return;
   }
 
   int item = event.GetIndex();
 
   mActiveMacro = mMacros->GetItemText(item);
   ShowActiveMacro();
}

References ChangeOK(), ApplyMacroDialog::mActiveMacro, ApplyMacroDialog::mMacros, and ShowActiveMacro().

Here is the call graph for this function:

OnMacrosEndEdit()

void MacrosWindow::OnMacrosEndEdit ( wxListEvent &  event )

private

Definition at line 979 of file BatchProcessDialog.cpp.

{
   if (event.IsEditCancelled()) {
      mMacroBeingRenamed = "";
      return;
   }
 
   if( mMacroBeingRenamed.IsEmpty())
      return;
 
   wxString newname = event.GetLabel();
 
   mMacroCommands.RenameMacro(mMacroBeingRenamed, newname);
   if( mMacroBeingRenamed == mActiveMacro )
      mActiveMacro = newname;
   mMacroBeingRenamed="";
   PopulateMacros();
   UpdateMenus();
   event.Veto();
}

References ApplyMacroDialog::mActiveMacro, ApplyMacroDialog::mMacroBeingRenamed, ApplyMacroDialog::mMacroCommands, ApplyMacroDialog::PopulateMacros(), MacroCommands::RenameMacro(), and UpdateMenus().

Here is the call graph for this function:

OnOK()

void MacrosWindow::OnOK ( wxCommandEvent &  event )

private

Send changed values back to Prefs, and update Audacity.

Definition at line 1352 of file BatchProcessDialog.cpp.

{
   if( !SaveChanges() )
      return;
   Hide();
   //EndModal(true);
}

References SaveChanges().

Here is the call graph for this function:

OnRemove()

void MacrosWindow::OnRemove ( wxCommandEvent &  event )

private

Definition at line 1056 of file BatchProcessDialog.cpp.

{
   long item = mMacros->GetNextItem(-1,
                                    wxLIST_NEXT_ALL,
                                    wxLIST_STATE_SELECTED);
   if (item == -1) {
      return;
   }
 
   wxString name = mMacros->GetItemText(item);
   AudacityMessageDialog m(
      this,
      /*i18n-hint: %s will be replaced by the name of a file.*/
      XO("Are you sure you want to delete %s?").Format( name ),
      Verbatim( GetTitle() ),
      wxYES_NO | wxICON_QUESTION );
   if (m.ShowModal() == wxID_NO) {
      Raise();
      return;
   }
   Raise();
 
   mMacroCommands.DeleteMacro(name);
 
   item++;
   if (item >= (mMacros->GetItemCount() - 1) && item >= 0) {
      item--;
   }
 
   // Bug 2284.  The macro we have just removed might have been
   // changed.  Since we've just deleted the macro, we should
   // forget about that change.
   mChanged = false;
   mSave->Enable( mChanged );
   mActiveMacro = mMacros->GetItemText(item);
 
   PopulateMacros();
   UpdateMenus();
}

References MacroCommands::DeleteMacro(), ApplyMacroDialog::mActiveMacro, mChanged, ApplyMacroDialog::mMacroCommands, ApplyMacroDialog::mMacros, mSave, name, ApplyMacroDialog::PopulateMacros(), UpdateMenus(), Verbatim(), and XO().

Here is the call graph for this function:

OnRename()

void MacrosWindow::OnRename ( wxCommandEvent &  event )

private

Definition at line 1097 of file BatchProcessDialog.cpp.

{
   long item = mMacros->GetNextItem(-1,
                                    wxLIST_NEXT_ALL,
                                    wxLIST_STATE_SELECTED);
   if (item == -1) {
      return;
   }
 
   mMacros->EditLabel(item);
   UpdateMenus();
}

References ApplyMacroDialog::mMacros, and UpdateMenus().

Here is the call graph for this function:

OnRestore()

void MacrosWindow::OnRestore ( wxCommandEvent &  event )

private

Reset a built in macro.

Definition at line 1111 of file BatchProcessDialog.cpp.

{
   mMacroCommands.RestoreMacro(mActiveMacro);
 
   mChanged = true;
   mSave->Enable( mChanged );
 
   PopulateList();
}

References ApplyMacroDialog::mActiveMacro, mChanged, ApplyMacroDialog::mMacroCommands, mSave, PopulateList(), and MacroCommands::RestoreMacro().

Here is the call graph for this function:

OnSave()

void MacrosWindow::OnSave ( wxCommandEvent &  event )

private

Definition at line 1161 of file BatchProcessDialog.cpp.

{
   SaveChanges();
}

References SaveChanges().

Here is the call graph for this function:

OnShrink()

void MacrosWindow::OnShrink ( wxCommandEvent &  event )

private

Definition at line 824 of file BatchProcessDialog.cpp.

{
   if( ChangeOK() )
      UpdateDisplay( false );
}

References ChangeOK(), and UpdateDisplay().

Here is the call graph for this function:

OnSize()

void MacrosWindow::OnSize ( wxSizeEvent &  event )

private

The window has been resized.

Definition at line 911 of file BatchProcessDialog.cpp.

{
   // Refresh the layout and re-fit the columns.
   Layout();
   if( !mbExpanded )
      return;
   FitColumns();
}

References FitColumns(), and ApplyMacroDialog::mbExpanded.

Here is the call graph for this function:

OnUp()

void MacrosWindow::OnUp ( wxCommandEvent &  event )

private

Definition at line 1277 of file BatchProcessDialog.cpp.

{
   long item = mList->GetNextItem(-1,
                                  wxLIST_NEXT_ALL,
                                  wxLIST_STATE_SELECTED);
   if (item == -1 || item == 0 || item + 1 == mList->GetItemCount()) {
      return;
   }
 
   mMacroCommands.AddToMacro(mMacroCommands.GetCommand(item),
                             mMacroCommands.GetParams(item),
                             item - 1);
   mMacroCommands.DeleteFromMacro(item + 1);
 
   mChanged = true;
   mSave->Enable( mChanged );
 
   mSelectedCommand = item - 1;
   PopulateList();
}

References MacroCommands::AddToMacro(), MacroCommands::DeleteFromMacro(), MacroCommands::GetCommand(), MacroCommands::GetParams(), mChanged, ApplyMacroDialog::mList, ApplyMacroDialog::mMacroCommands, mSave, mSelectedCommand, and PopulateList().

Here is the call graph for this function:

Populate()

void MacrosWindow::Populate ( )

private

Creates the dialog and its contents.

Definition at line 592 of file BatchProcessDialog.cpp.

{
   //------------------------- Main section --------------------
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
 
   // Get and validate the currently active macro
   mActiveMacro = gPrefs->Read(wxT("/Batch/ActiveMacro"), wxT(""));
   // Go populate the macros list.
   PopulateMacros();
 
   // We have a bare list.  We need to add columns and content.
   PopulateList();
 
   // Layout and set minimum size of window
   Layout();
   Fit();
   SetSizeHints(GetSize());
 
   // Size and place window
   SetSize(std::min(wxSystemSettings::GetMetric(wxSYS_SCREEN_X) * 3 / 4, 800),
           std::min(wxSystemSettings::GetMetric(wxSYS_SCREEN_Y) * 4 / 5, 400));
   Center();
 
   // Set the column size for the macros list.
   wxSize sz = mMacros->GetClientSize();
   mMacros->SetColumnWidth(0, sz.x);
 
   // Size columns properly
   FitColumns();
}

References eIsCreating, FitColumns(), gPrefs, ApplyMacroDialog::mActiveMacro, min(), ApplyMacroDialog::mMacros, PopulateList(), ApplyMacroDialog::PopulateMacros(), PopulateOrExchange(), audacity::BasicSettings::Read(), S, and wxT().

Referenced by MacrosWindow(), and UpdateDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateList()

void MacrosWindow::PopulateList ( )

private

This clears and updates the contents of mList, the commands for the current macro.

Definition at line 724 of file BatchProcessDialog.cpp.

{
   int topItem = mList->GetTopItem();
   mList->DeleteAllItems();
 
   for (int i = 0; i < mMacroCommands.GetCount(); i++) {
      AddItem(mMacroCommands.GetCommand(i),
              mMacroCommands.GetParams(i));
   }
   /*i18n-hint: This is the last item in a list.*/
   AddItem(_("- END -"), wxT(""));
 
   // Select the name in the list...this will fire an event.
   if (mSelectedCommand >= (int)mList->GetItemCount()) {
      mSelectedCommand = 0;
   }
   mList->SetItemState(mSelectedCommand,
      wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED,
      wxLIST_STATE_SELECTED | wxLIST_STATE_FOCUSED);
   if( 0 <= topItem && topItem < (int)mList->GetItemCount())
   {
      // Workaround for scrolling being windows only.
      // Try to scroll back to where we once were...
      mList->EnsureVisible( (int)mList->GetItemCount() -1 );
      mList->EnsureVisible( topItem );
      // And then make sure whatever is selected is still visible...
      if (mSelectedCommand >= 0) {
         mList->EnsureVisible( mSelectedCommand );
      }
   }
}

References _, AddItem(), MacroCommands::GetCommand(), MacroCommands::GetCount(), MacroCommands::GetParams(), ApplyMacroDialog::mList, ApplyMacroDialog::mMacroCommands, mSelectedCommand, and wxT().

Referenced by InsertCommandAt(), OnDelete(), OnDown(), OnEditCommandParams(), OnRestore(), OnUp(), Populate(), and ShowActiveMacro().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void MacrosWindow::PopulateOrExchange ( ShuttleGui &  S )

private

Defines the dialog and does data exchange with it.

Definition at line 626 of file BatchProcessDialog.cpp.

{
   S.StartHorizontalLay(wxEXPAND, 1);
   {
      S.StartStatic(XO("Select Macro"),0);
      {
         S.StartHorizontalLay(wxEXPAND,1);
         {
            mMacros = S.Id(MacrosListID).Prop(1)
               .Style( wxLC_REPORT | wxLC_HRULES
                      | wxLC_SINGLE_SEL | wxLC_EDIT_LABELS)
              // i18n-hint: This is the heading for a column in the edit macros dialog
              .AddListControlReportMode( { XO("Macro") } );
            S.StartVerticalLay(wxALIGN_TOP, 0);
            {
               S.Id(AddButtonID).AddButton(XXO("&New"), wxALIGN_LEFT);
               mRemove = S.Id(RemoveButtonID).AddButton(XXO("Remo&ve"), wxALIGN_LEFT);
               mRename = S.Id(RenameButtonID).AddButton(XXO("&Rename..."), wxALIGN_LEFT);
               mRestore = S.Id(RestoreButtonID).AddButton(XXO("Re&store"), wxALIGN_LEFT);
               mImport = S.Id(ImportButtonID).AddButton(XO("I&mport..."), wxALIGN_LEFT);
               mExport = S.Id(ExportButtonID).AddButton(XO("E&xport..."), wxALIGN_LEFT);
            }
            S.EndVerticalLay();
         }
         S.EndHorizontalLay();
      }
      S.EndStatic();
 
      S.StartStatic(XO("Edit Steps"), true);
      {
         S.StartHorizontalLay(wxEXPAND,1);
         {
            mList = S.Id(CommandsListID)
               .Style( wxLC_REPORT | wxLC_HRULES | wxLC_VRULES |
                   wxLC_SINGLE_SEL)
               .AddListControlReportMode({
                  /* i18n-hint: This is the number of the command in the list */
                  { XO("Num"), wxLIST_FORMAT_RIGHT },
                  { XO("Command  "), wxLIST_FORMAT_RIGHT },
                  { XO("Parameters"), wxLIST_FORMAT_LEFT }
                });
 
            S.StartVerticalLay(wxALIGN_TOP, 0);
            {
               S.Id(InsertButtonID).AddButton(XXO("&Insert"), wxALIGN_LEFT);
               mEdit = S.Id(EditButtonID).AddButton(XXO("&Edit..."), wxALIGN_LEFT);
               S.Id(DeleteButtonID).AddButton(XXO("De&lete"), wxALIGN_LEFT);
               S.Id(UpButtonID).AddButton(XXO("Move &Up"), wxALIGN_LEFT);
               S.Id(DownButtonID).AddButton(XXO("Move &Down"), wxALIGN_LEFT);
               mSave = S.Id(SaveButtonID).AddButton(XO("&Save"), wxALIGN_LEFT);
               mSave->Enable( mChanged );
            }
            S.EndVerticalLay();
         }
         S.EndHorizontalLay();
      }
      S.EndStatic();
   }
   S.EndHorizontalLay();
 
   S.StartHorizontalLay(wxEXPAND, 0);
   {
      /* i18n-hint: The Shrink button makes the dialog smaller, with less in it */
      mResize = S.Id(ShrinkID).AddButton(XXO("Shrin&k"));
      // Using variable text just to get the positioning options.
      S.Prop(0).AddVariableText(
         XO("Apply Macro to:"), false, wxALL | wxALIGN_CENTRE_VERTICAL );
      wxButton* btn = S.Id(ApplyToProjectID)
         .Name(XO("Apply macro to project"))
         .AddButton(XXO("&Project"));
#if wxUSE_ACCESSIBILITY
      // so that name can be set on a standard control
      btn->SetAccessible(safenew WindowAccessible(btn));
#endif
 
      btn = S.Id(ApplyToFilesID)
         .Name(XO("Apply macro to files..."))
         .AddButton(XXO("&Files..."));
#if wxUSE_ACCESSIBILITY
      // so that name can be set on a standard control
      btn->SetAccessible(safenew WindowAccessible(btn));
#endif
      S.AddSpace( 10,10,1 );
      // Bug 2524 OK button does much the same as cancel, so remove it.
      // OnCancel prompts you if there has been a change.
      // OnOK saves without prompting.
      // That difference is too slight to merit a button, and with the OK
      // button, people might expect the dialog to apply the macro too.
      S.AddStandardButtons( /*eOkButton |*/ eCloseButton | eHelpButton);
   }
 
   S.EndHorizontalLay();
 
 
   return;
}

References AddButtonID, ApplyToFilesID, ApplyToProjectID, CommandsListID, DeleteButtonID, DownButtonID, eCloseButton, EditButtonID, eHelpButton, ExportButtonID, ImportButtonID, InsertButtonID, MacrosListID, mChanged, mEdit, mExport, mImport, ApplyMacroDialog::mList, ApplyMacroDialog::mMacros, mRemove, mRename, ApplyMacroDialog::mResize, mRestore, mSave, RemoveButtonID, RenameButtonID, RestoreButtonID, S, safenew, SaveButtonID, ShrinkID, UpButtonID, XO(), and XXO().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

SaveChanges()

bool MacrosWindow::SaveChanges ( )

private

Definition at line 1334 of file BatchProcessDialog.cpp.

                              {
   gPrefs->Write(wxT("/Batch/ActiveMacro"), mActiveMacro);
   gPrefs->Flush();
 
   if (mChanged) {
      if (!mMacroCommands.WriteMacro(mActiveMacro)) {
         return false;
      }
   }
 
   mChanged = false;
   if( mSave )
      mSave->Enable( mChanged );
 
   return true;
}

References audacity::BasicSettings::Flush(), gPrefs, ApplyMacroDialog::mActiveMacro, mChanged, ApplyMacroDialog::mMacroCommands, mSave, audacity::BasicSettings::Write(), MacroCommands::WriteMacro(), and wxT().

Referenced by OnApplyToFiles(), OnApplyToProject(), OnOK(), OnSave(), and UpdateDisplay().

Here is the call graph for this function:

Here is the caller graph for this function:

ShowActiveMacro()

void MacrosWindow::ShowActiveMacro ( )

private

Definition at line 873 of file BatchProcessDialog.cpp.

{
   mMacroCommands.ReadMacro(mActiveMacro);
   if( !mbExpanded )
      return;
 
   if (mMacroCommands.IsFixed(mActiveMacro)) {
      mRemove->Disable();
      mRename->Disable();
      mRestore->Enable();
   }
   else {
      mRemove->Enable();
      mRename->Enable();
      mRestore->Disable();
   }
 
   PopulateList();
}

References MacroCommands::IsFixed(), ApplyMacroDialog::mActiveMacro, ApplyMacroDialog::mbExpanded, ApplyMacroDialog::mMacroCommands, mRemove, mRename, mRestore, PopulateList(), and MacroCommands::ReadMacro().

Referenced by OnCancel(), and OnMacroSelected().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateDisplay()

void MacrosWindow::UpdateDisplay

(

bool

bExpanded

)

Definition at line 781 of file BatchProcessDialog.cpp.

{
   // If we failed to save changes, we abandon the attempt to
   // change the expand/shrink state of the GUI.
   if( !SaveChanges() )
      return;
 
   mbExpanded = bExpanded;
 
   mChanged = false;
   // if we try to access the about to be destroyed mSave button
   // inappropriately, we need to crash rather than (sometimes) silently
   // succeed.
   mSave = nullptr;
 
   DestroyChildren();
   SetSizer( nullptr );
 
   mSelectedCommand = 0;
   SetMinSize( wxSize( 200,200 ));
 
   // Get and set position for optical stability.
   // Expanded and shrunk dialogs 'stay where they were'.
   // That's OK , and what we want, even if we exapnd off-screen.
   // We won't shrink to being off-screen, since the shrink button
   // was clicked, so must have been on screen.
   wxPoint p = GetPosition( );
   if( mbExpanded )
      Populate();
   else
      ApplyMacroDialog::Populate();
   SetPosition( p );
   mResize->SetFocus();
 
   auto Title = WindowTitle();
   SetLabel( Title );         // Provide visual label
   SetName( Title );          // Provide audible label
   SetTitle( Title );
}

References ApplyMacroDialog::mbExpanded, mChanged, ApplyMacroDialog::mResize, mSave, mSelectedCommand, ApplyMacroDialog::Populate(), Populate(), SaveChanges(), wxDialogWrapper::SetLabel(), wxDialogWrapper::SetName(), wxDialogWrapper::SetTitle(), and WindowTitle().

Referenced by anonymous_namespace{BatchProcessDialog.cpp}::OnApplyMacrosPalette(), OnExpand(), anonymous_namespace{BatchProcessDialog.cpp}::OnManageMacros(), OnShrink(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdateMenus()

void MacrosWindow::UpdateMenus ( )

private

Definition at line 774 of file BatchProcessDialog.cpp.

{
   // OK even on mac, as dialog is modal.
   auto p = &mProject;
   MenuCreator::Get(*p).RebuildMenuBar();
}

References MenuCreator::Get(), mProject, and MenuCreator::RebuildMenuBar().

Referenced by OnAdd(), OnImport(), OnMacrosEndEdit(), OnRemove(), and OnRename().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdatePrefs()

void MacrosWindow::UpdatePrefs ( )

overrideprivatevirtual

Implements PrefsListener.

Definition at line 1392 of file BatchProcessDialog.cpp.

{
   UpdateDisplay(mbExpanded);
}

References ApplyMacroDialog::mbExpanded, and UpdateDisplay().

Here is the call graph for this function:

WindowTitle()

TranslatableString MacrosWindow::WindowTitle ( ) const

private

Definition at line 1386 of file BatchProcessDialog.cpp.

{
   return mbExpanded ? ManageMacrosTitle : MacrosPaletteTitle;
}

References MacrosPaletteTitle, ManageMacrosTitle, and ApplyMacroDialog::mbExpanded.

Referenced by MacrosWindow(), OnAdd(), and UpdateDisplay().

Here is the caller graph for this function:

Member Data Documentation

mChanged

bool MacrosWindow::mChanged

private

Definition at line 146 of file BatchProcessDialog.h.

Referenced by ChangeOK(), InsertCommandAt(), MacrosWindow(), OnCancel(), OnDelete(), OnDown(), OnEditCommandParams(), OnRemove(), OnRestore(), OnUp(), PopulateOrExchange(), SaveChanges(), and UpdateDisplay().

mEdit

wxButton* MacrosWindow::mEdit

private

Definition at line 142 of file BatchProcessDialog.h.

Referenced by OnListSelected(), and PopulateOrExchange().

mExport

wxButton* MacrosWindow::mExport

private

Definition at line 141 of file BatchProcessDialog.h.

Referenced by PopulateOrExchange().

mImport

wxButton* MacrosWindow::mImport

private

Definition at line 140 of file BatchProcessDialog.h.

Referenced by PopulateOrExchange().

mProject

AudacityProject& MacrosWindow::mProject

private

Definition at line 135 of file BatchProcessDialog.h.

Referenced by InsertCommandAt(), OnEditCommandParams(), and UpdateMenus().

mRemove

wxButton* MacrosWindow::mRemove

private

Definition at line 137 of file BatchProcessDialog.h.

Referenced by PopulateOrExchange(), and ShowActiveMacro().

mRename

wxButton* MacrosWindow::mRename

private

Definition at line 138 of file BatchProcessDialog.h.

Referenced by PopulateOrExchange(), and ShowActiveMacro().

mRestore

wxButton* MacrosWindow::mRestore

private

Definition at line 139 of file BatchProcessDialog.h.

Referenced by PopulateOrExchange(), and ShowActiveMacro().

mSave

wxButton* MacrosWindow::mSave

private

Definition at line 143 of file BatchProcessDialog.h.

Referenced by ChangeOK(), InsertCommandAt(), OnDelete(), OnDown(), OnEditCommandParams(), OnRemove(), OnRestore(), OnUp(), PopulateOrExchange(), SaveChanges(), and UpdateDisplay().

mSelectedCommand

int MacrosWindow::mSelectedCommand

private

Definition at line 145 of file BatchProcessDialog.h.

Referenced by InsertCommandAt(), MacrosWindow(), OnDelete(), OnDown(), OnEditCommandParams(), OnUp(), PopulateList(), and UpdateDisplay().

---

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

• BatchProcessDialog.h
• BatchProcessDialog.cpp