Merge pull request #1209 from Paul-Licameli/Preliminaries-for-lib-basic-ui

Preliminaries for lib basic UI (string types)

libraries/lib-strings/Identifier.h

@@ -232,5 +232,8 @@ struct CommandIdTag;
 using CommandID = TaggedIdentifier< CommandIdTag, false >;
 using CommandIDs = std::vector<CommandID>;
 
+struct ManualPageIDTag;
+using ManualPageID = TaggedIdentifier< ManualPageIDTag >;
+
 #endif
 

src/BatchCommandDialog.cpp

@@ -173,7 +173,7 @@ void MacroCommandDialog::OnCancel(wxCommandEvent & WXUNUSED(event))
 
 void MacroCommandDialog::OnHelp(wxCommandEvent & WXUNUSED(event))
 {
-   wxString page = GetHelpPageName();
+   const auto &page = GetHelpPageName();
    HelpSystem::ShowHelp(this, page, true);
 }
 

src/BatchCommandDialog.h

@@ -42,7 +42,7 @@ class MacroCommandDialog final : public wxDialogWrapper {
    void OnCancel(wxCommandEvent &event);
    void OnHelp(wxCommandEvent &event);
    void OnItemSelected(wxListEvent &event);
-   wxString GetHelpPageName() { return wxT("Scripting Reference") ; }
+   ManualPageID GetHelpPageName() { return L"Scripting Reference" ; }
 
    void ValidateChoices();
    void PopulateCommandList();

src/BatchProcessDialog.cpp

@@ -222,7 +222,7 @@ void ApplyMacroDialog::PopulateMacros()
 
 void ApplyMacroDialog::OnHelp(wxCommandEvent & WXUNUSED(event))
 {
-   wxString page = GetHelpPageName();
+   const auto &page = GetHelpPageName();
    HelpSystem::ShowHelp(this, page, true);
 }
 

src/BatchProcessDialog.h

@@ -41,7 +41,7 @@ class ApplyMacroDialog : public wxDialogWrapper {
    virtual void OnCancel(wxCommandEvent & event);
    virtual void OnHelp(wxCommandEvent & event);
 
-   virtual wxString GetHelpPageName() {return "Apply_Macro";};
+   virtual ManualPageID GetHelpPageName() {return "Apply_Macro";}
 
    void PopulateMacros();
    static CommandID MacroIdOfName( const wxString & MacroName );
@@ -87,9 +87,9 @@ private:
    void OnApplyToFiles(wxCommandEvent & event) override;
    void OnCancel(wxCommandEvent &event) override;
 
-   virtual wxString GetHelpPageName() override {return 
+   virtual ManualPageID GetHelpPageName() override {return 
       mbExpanded ? "Manage_Macros"
-         : "Apply_Macro";};
+         : "Apply_Macro";}
 
    void PopulateList();
    void AddItem(const CommandID &command, wxString const &params);

src/FFmpeg.cpp

@@ -538,7 +538,7 @@ public:
 
    void OnDownload(wxCommandEvent & WXUNUSED(event))
    {
-      HelpSystem::ShowHelp(this, wxT("FAQ:Installing_the_FFmpeg_Import_Export_Library"));
+      HelpSystem::ShowHelp(this, L"FAQ:Installing_the_FFmpeg_Import_Export_Library");
    }
 
    wxString GetLibPath()

src/FreqWindow.cpp

@@ -550,7 +550,7 @@ void FrequencyPlotDialog::OnGetURL(wxCommandEvent & WXUNUSED(event))
 {
    // Original help page is back on-line (March 2016), but the manual should be more reliable.
    // http://www.eramp.com/WCAG_2_audio_contrast_tool_help.htm
-   HelpSystem::ShowHelp(this, wxT("Plot Spectrum"));
+   HelpSystem::ShowHelp(this, L"Plot Spectrum");
 }
 
 bool FrequencyPlotDialog::Show(bool show)

src/HelpText.cpp

@@ -387,12 +387,13 @@ const wxString VerCheckArgs(){
 }
 
 // Text of hyperlink to check versions.
-const wxString VerCheckHtml(){
+const wxString VerCheckHtml()
+{
    wxStringOutputStream o;
    wxTextOutputStream s(o);
    s
       << "<center>[["
-      << VerCheckUrl()
+      << VerCheckUrl().GET()
       << "|"
       << XO("Check Online")
       << "]]</center>\n";
@@ -400,7 +401,8 @@ const wxString VerCheckHtml(){
 }
 
 // Url with Version check args attached.
-const wxString VerCheckUrl(){
+const URLString VerCheckUrl()
+{
    //The version we intend to use for live Audacity.
 #define VER_CHECK_URL "https://www.audacityteam.org/download/?"
 //For testing of our scriptlet.

src/HelpText.h

@@ -13,12 +13,17 @@
 
 class TranslatableString;
 class wxString;
+#include "Identifier.h"
+
+struct URLStringTag;
+//! Distinct type for URLs
+using URLString = TaggedIdentifier< URLStringTag >;
 
 AUDACITY_DLL_API  wxString HelpText( const wxString & Key );
 AUDACITY_DLL_API TranslatableString TitleText( const wxString & Key );
 
 extern AUDACITY_DLL_API const wxString VerCheckArgs();
-extern AUDACITY_DLL_API const wxString VerCheckUrl();
+extern AUDACITY_DLL_API const URLString VerCheckUrl();
 extern AUDACITY_DLL_API const wxString VerCheckHtml();
 extern AUDACITY_DLL_API wxString FormatHtmlText( const wxString & Text );
 

src/HistoryWindow.cpp

@@ -313,7 +313,7 @@ void HistoryDialog::OnCompact(wxCommandEvent & WXUNUSED(event))
 
 void HistoryDialog::OnGetURL(wxCommandEvent & WXUNUSED(event))
 {
-   HelpSystem::ShowHelp(this, wxT("Undo,_Redo_and_History"));
+   HelpSystem::ShowHelp(this, L"Undo,_Redo_and_History");
 }
 
 void HistoryDialog::OnItemSelected(wxListEvent &event)

src/LabelDialog.cpp

@@ -285,7 +285,7 @@ void LabelDialog::PopulateOrExchange( ShuttleGui & S )
 
 void LabelDialog::OnHelp(wxCommandEvent & WXUNUSED(event))
 {
-   wxString page = GetHelpPageName();
+   const auto &page = GetHelpPageName();
    HelpSystem::ShowHelp(this, page, true);
 }
 

src/LabelDialog.h

@@ -60,8 +60,8 @@ class LabelDialog final : public wxDialogWrapper
    void Populate();
    void PopulateOrExchange( ShuttleGui & S );
    void PopulateLabels();
-   virtual void OnHelp(wxCommandEvent & event);
-   virtual wxString GetHelpPageName() {return "Labels_Editor";};
+   void OnHelp(wxCommandEvent & event);
+   ManualPageID GetHelpPageName() {return "Labels_Editor";}
 
    bool TransferDataToWindow() override;
    bool TransferDataFromWindow() override;

src/ProjectFileIO.cpp

@@ -19,6 +19,7 @@ Paul Licameli split from AudacityProject.cpp
 #include <wx/xml/xml.h>
 
 #include "ActiveProjects.h"
+#include "CodeConversions.h"
 #include "DBConnection.h"
 #include "Project.h"
 #include "ProjectFileIORegistry.h"
@@ -2316,7 +2317,8 @@ void ProjectFileIO::ShowError(wxWindow *parent,
                               const TranslatableString &message,
                               const wxString &helpPage)
 {
-   ShowExceptionDialog(parent, dlogTitle, message, helpPage, true, GetLastLog());
+   ShowExceptionDialog(parent, dlogTitle, message, helpPage, true,
+                   audacity::ToWString(GetLastLog()));
 }
 
 const TranslatableString &ProjectFileIO::GetLastError() const

src/ProjectFileManager.cpp

@@ -17,6 +17,7 @@ Paul Licameli split from AudacityProject.cpp
 #endif
 
 #include <wx/frame.h>
+#include "CodeConversions.h"
 #include "Legacy.h"
 #include "PlatformCompatibility.h"
 #include "Project.h"
@@ -776,7 +777,7 @@ bool ProjectFileManager::OpenNewProject()
          XO("Error opening a new empty project"), 
          "FAQ:Errors_opening_a_new_empty_project",
          true, 
-         projectFileIO.GetLastLog());
+         audacity::ToWString(projectFileIO.GetLastLog()));
    }
    return bOK;
 }
@@ -1362,7 +1363,7 @@ public:
 
    void OnGetURL(wxCommandEvent &WXUNUSED(evt))
    {
-      HelpSystem::ShowHelp(this, wxT("File_Menu:_Compact_Project"), true);
+      HelpSystem::ShowHelp(this, L"File_Menu:_Compact_Project", true);
    }
 };
 }

src/Screenshot.cpp

@@ -559,7 +559,7 @@ void ScreenshotBigDialog::OnClose(wxCommandEvent &  WXUNUSED(event))
 
 void ScreenshotBigDialog::OnGetURL(wxCommandEvent & WXUNUSED(event))
 {
-   HelpSystem::ShowHelp(this, wxT("Screenshot"));
+   HelpSystem::ShowHelp(this, L"Screenshot");
 }
 
 void ScreenshotBigDialog::OnUIUpdate(wxUpdateUIEvent &  WXUNUSED(event))

src/Tags.cpp

@@ -972,7 +972,7 @@ void TagsEditorDialog::OnDontShow( wxCommandEvent & Evt )
 
 void TagsEditorDialog::OnHelp(wxCommandEvent& WXUNUSED(event))
 {
-   HelpSystem::ShowHelp(this, wxT("Metadata_Editor"), true);
+   HelpSystem::ShowHelp(this, L"Metadata_Editor", true);
 }
 
 bool TagsEditorDialog::TransferDataFromWindow()

src/TimerRecordDialog.cpp

@@ -363,7 +363,7 @@ void TimerRecordDialog::OnAutoExportCheckBox_Change(wxCommandEvent& WXUNUSED(eve
 
 void TimerRecordDialog::OnHelpButtonClick(wxCommandEvent& WXUNUSED(event))
 {
-   HelpSystem::ShowHelp(this, wxT("Timer_Record"), true);
+   HelpSystem::ShowHelp(this, L"Timer_Record", true);
 }
 
 void TimerRecordDialog::OnOK(wxCommandEvent& WXUNUSED(event))

src/commands/AudacityCommand.h

@@ -65,7 +65,7 @@ class AUDACITY_DLL_API AudacityCommand /* not final */ : public wxEvtHandler,
    {wxFAIL_MSG( "Implement a Description for this command");return XO("FAIL");};
 
    // Name of page in the Audacity alpha manual
-   virtual wxString ManualPage(){ return wxEmptyString;};
+   virtual ManualPageID ManualPage(){ return {}; }
    virtual bool IsBatchProcessing(){ return mIsBatch;}
    virtual void SetBatchProcessing(bool start){ mIsBatch = start;};
    

src/commands/CompareAudioCommand.h

@@ -35,7 +35,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#compare_Audio");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#compare_Audio";}
    bool Apply(const CommandContext &context) override;
 
 

src/commands/Demo.h

@@ -29,7 +29,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I";}
 
 private:
    double delay;

src/commands/DragCommand.h

@@ -32,7 +32,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#move_mouse");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#move_mouse";}
 
    bool Apply(const CommandContext & context) override;
 

src/commands/GetInfoCommand.h

@@ -38,7 +38,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#get_info");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#get_info";}
    bool Apply(const CommandContext &context) override;
    bool ApplyInner(const CommandContext &context);
 

src/commands/GetTrackInfoCommand.h

@@ -32,7 +32,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Tools#get_track_info");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Tools#get_track_info";}
 
    bool Apply(const CommandContext &context ) override;
 public:

src/commands/HelpCommand.h

@@ -38,7 +38,7 @@ public:
    bool ApplyInner(const CommandContext & context);
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#help");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#help";}
 public:
    wxString mCommandName;
 };
@@ -58,7 +58,7 @@ public:
       return true;
    };
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#comment");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#comment";}
 public:
    wxString mComment;
 };

src/commands/ImportExportCommands.h

@@ -36,7 +36,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#import");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#import";}
 public:
    wxString mFileName;
 };
@@ -54,7 +54,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#export");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#export";}
 public:
    wxString mFileName;
    int mnChannels;

src/commands/MessageCommand.h

@@ -37,7 +37,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#message");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#message";}
 public:
    wxString mMessage;
 };

src/commands/OpenSaveCommands.h

@@ -40,7 +40,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#open_project");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#open_project";}
 public:
    wxString mFileName;
    bool mbAddToHistory;
@@ -60,7 +60,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#save_project");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#save_project";}
 public:
    wxString mFileName;
    bool mbAddToHistory;
@@ -80,7 +80,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#save_copy");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#save_copy";}
 public:
    wxString mFileName;
 };
@@ -98,7 +98,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#save_log");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#save_log";}
 public:
    wxString mFileName;
 };
@@ -116,7 +116,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#Clear_log");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#Clear_log";}
 public:
    wxString mFileName;
 };

src/commands/PreferenceCommands.h

@@ -39,7 +39,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I#get_preference");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#get_preference";}
 
    wxString mName;
 };
@@ -59,7 +59,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I#set_preference");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#set_preference";}
 
    wxString mName;
    wxString mValue;

src/commands/ScreenshotCommand.h

@@ -87,7 +87,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#screenshot_short_format");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#screenshot_short_format";}
 
 private:
    int mWhat;

src/commands/SelectCommand.h

@@ -37,7 +37,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I#select_time");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#select_time";}
 
    bool bHasT0;
    bool bHasT1;
@@ -63,7 +63,7 @@ public:
    bool Apply(const CommandContext & context) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I#select_frequencies");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#select_frequencies";}
 
    bool bHasBottom;
    bool bHasTop;
@@ -85,7 +85,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
    bool Apply(const CommandContext & context) override;
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I#select_tracks");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#select_tracks";}
 
    bool bHasFirstTrack;
    bool bHasNumTracks;
@@ -123,7 +123,7 @@ public:
          mSelTracks.Apply(context);
    }
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#select");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#select";}
 private:
    SelectTimeCommand mSelTime;
    SelectFrequenciesCommand mSelFreq;

src/commands/SetClipCommand.h

@@ -31,7 +31,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I#set_clip");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#set_clip";}
    bool ApplyInner( const CommandContext & context, Track * t ) override;
 
 public:

src/commands/SetEnvelopeCommand.h

@@ -31,7 +31,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I#set_envelope");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#set_envelope";}
    bool ApplyInner( const CommandContext & context, Track * t ) override;
 
 public:

src/commands/SetLabelCommand.h

@@ -32,7 +32,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I#set_label");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#set_label";}
 
    bool Apply(const CommandContext & context) override;
 

src/commands/SetProjectCommand.h

@@ -33,7 +33,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I#set_project");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#set_project";}
 
    bool Apply(const CommandContext & context) override;
 

src/commands/SetTrackInfoCommand.h

@@ -54,7 +54,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I#set_track_status");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#set_track_status";}
    bool ApplyInner( const CommandContext & context, Track * t ) override;
 
 public:
@@ -81,7 +81,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I#set_track_audio");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#set_track_audio";}
    bool ApplyInner( const CommandContext & context, Track * t ) override;
 
 public:
@@ -110,7 +110,7 @@ public:
    void PopulateOrExchange(ShuttleGui & S) override;
 
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_I#set_track_visuals");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#set_track_visuals";}
    bool ApplyInner( const CommandContext & context, Track * t ) override;
 
 public:
@@ -150,7 +150,7 @@ public:
    ComponentInterfaceSymbol GetSymbol() override {return Symbol;};
    TranslatableString GetDescription() override {return XO("Sets various values for a track.");};
    // AudacityCommand overrides
-   wxString ManualPage() override {return wxT("Extra_Menu:_Scriptables_II#set_track");};
+   ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#set_track";}
 
 public:
 

src/effects/Amplify.cpp

@@ -99,9 +99,9 @@ TranslatableString EffectAmplify::GetDescription()
    return XO("Increases or decreases the volume of the audio you have selected");
 }
 
-wxString EffectAmplify::ManualPage()
+ManualPageID EffectAmplify::ManualPage()
 {
-   return wxT("Amplify");
+   return L"Amplify";
 }
 
 // EffectDefinitionInterface implementation

src/effects/Amplify.h

@@ -35,7 +35,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/AutoDuck.cpp

@@ -118,9 +118,9 @@ TranslatableString EffectAutoDuck::GetDescription()
    return XO("Reduces (ducks) the volume of one or more tracks whenever the volume of a specified \"control\" track reaches a particular level");
 }
 
-wxString EffectAutoDuck::ManualPage()
+ManualPageID EffectAutoDuck::ManualPage()
 {
-   return wxT("Auto_Duck");
+   return L"Auto_Duck";
 }
 
 // EffectDefinitionInterface implementation

src/effects/AutoDuck.h

@@ -32,7 +32,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/BassTreble.cpp

@@ -98,9 +98,9 @@ TranslatableString EffectBassTreble::GetDescription()
    return XO("Simple tone control effect");
 }
 
-wxString EffectBassTreble::ManualPage()
+ManualPageID EffectBassTreble::ManualPage()
 {
-   return wxT("Bass_and_Treble");
+   return L"Bass_and_Treble";
 }
 
 // EffectDefinitionInterface implementation

src/effects/BassTreble.h

@@ -45,7 +45,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/ChangePitch.cpp

@@ -150,9 +150,9 @@ TranslatableString EffectChangePitch::GetDescription()
    return XO("Changes the pitch of a track without changing its tempo");
 }
 
-wxString EffectChangePitch::ManualPage()
+ManualPageID EffectChangePitch::ManualPage()
 {
-   return wxT("Change_Pitch");
+   return L"Change_Pitch";
 }
 
 // EffectDefinitionInterface implementation

src/effects/ChangePitch.h

@@ -46,7 +46,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/ChangeSpeed.cpp

@@ -123,9 +123,9 @@ TranslatableString EffectChangeSpeed::GetDescription()
    return XO("Changes the speed of a track, also changing its pitch");
 }
 
-wxString EffectChangeSpeed::ManualPage()
+ManualPageID EffectChangeSpeed::ManualPage()
 {
-   return wxT("Change_Speed");
+   return L"Change_Speed";
 }
 
 

src/effects/ChangeSpeed.h

@@ -33,7 +33,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/ChangeTempo.cpp

@@ -124,9 +124,9 @@ TranslatableString EffectChangeTempo::GetDescription()
    return XO("Changes the tempo of a selection without changing its pitch");
 }
 
-wxString EffectChangeTempo::ManualPage()
+ManualPageID EffectChangeTempo::ManualPage()
 {
-   return wxT("Change_Tempo");
+   return L"Change_Tempo";
 }
 
 // EffectDefinitionInterface implementation

src/effects/ChangeTempo.h

@@ -40,7 +40,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/ClickRemoval.cpp

@@ -93,9 +93,9 @@ TranslatableString EffectClickRemoval::GetDescription()
    return XO("Click Removal is designed to remove clicks on audio tracks");
 }
 
-wxString EffectClickRemoval::ManualPage()
+ManualPageID EffectClickRemoval::ManualPage()
 {
-   return wxT("Click_Removal");
+   return L"Click_Removal";
 }
 
 // EffectDefinitionInterface implementation

src/effects/ClickRemoval.h

@@ -35,7 +35,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/Compressor.cpp

@@ -115,9 +115,9 @@ TranslatableString EffectCompressor::GetDescription()
    return XO("Compresses the dynamic range of audio");
 }
 
-wxString EffectCompressor::ManualPage()
+ManualPageID EffectCompressor::ManualPage()
 {
-   return wxT("Compressor");
+   return L"Compressor";
 }
 
 // EffectDefinitionInterface implementation

src/effects/Compressor.h

@@ -31,7 +31,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/Contrast.cpp

@@ -361,7 +361,7 @@ void ContrastDialog::OnGetURL(wxCommandEvent & WXUNUSED(event))
 {
    // Original help page is back on-line (March 2016), but the manual should be more reliable.
    // http://www.eramp.com/WCAG_2_audio_contrast_tool_help.htm
-   HelpSystem::ShowHelp(this, wxT("Contrast"));
+   HelpSystem::ShowHelp(this, L"Contrast");
 }
 
 void ContrastDialog::OnClose(wxCommandEvent & WXUNUSED(event))

src/effects/Distortion.cpp

@@ -198,9 +198,9 @@ TranslatableString EffectDistortion::GetDescription()
    return XO("Waveshaping distortion effect");
 }
 
-wxString EffectDistortion::ManualPage()
+ManualPageID EffectDistortion::ManualPage()
 {
-   return wxT("Distortion");
+   return L"Distortion";
 }
 
 // EffectDefinitionInterface implementation

src/effects/Distortion.h

@@ -65,7 +65,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/DtmfGen.cpp

@@ -110,9 +110,9 @@ TranslatableString EffectDtmf::GetDescription()
    return XO("Generates dual-tone multi-frequency (DTMF) tones like those produced by the keypad on telephones");
 }
 
-wxString EffectDtmf::ManualPage()
+ManualPageID EffectDtmf::ManualPage()
 {
-   return wxT("DTMF_Tones");
+   return L"DTMF_Tones";
 }
 
 // EffectDefinitionInterface implementation

src/effects/DtmfGen.h

@@ -34,7 +34,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/Echo.cpp

@@ -67,9 +67,9 @@ TranslatableString EffectEcho::GetDescription()
    return XO("Repeats the selected audio again and again");
 }
 
-wxString EffectEcho::ManualPage()
+ManualPageID EffectEcho::ManualPage()
 {
-   return wxT("Echo");
+   return L"Echo";
 }
 
 // EffectDefinitionInterface implementation

src/effects/Echo.h

@@ -28,7 +28,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/Effect.cpp

@@ -1168,14 +1168,14 @@ bool Effect::HasFactoryDefaults()
    return HasPrivateConfigGroup(GetFactoryDefaultsGroup());
 }
 
-wxString Effect::ManualPage()
+ManualPageID Effect::ManualPage()
 {
-   return wxEmptyString;
+   return {};
 }
 
-wxString Effect::HelpPage()
+FilePath Effect::HelpPage()
 {
-   return wxEmptyString;
+   return {};
 }
 
 void Effect::SetUIFlags(unsigned flags) {

src/effects/Effect.h

@@ -237,9 +237,9 @@ class AUDACITY_DLL_API Effect /* not final */ : public wxEvtHandler,
    virtual bool HasFactoryDefaults();
 
    // Name of page in the Audacity alpha manual
-   virtual wxString ManualPage();
+   virtual ManualPageID ManualPage();
    // Fully qualified local help file name
-   virtual wxString HelpPage();
+   virtual FilePath HelpPage();
 
    virtual void SetUIFlags(unsigned flags);
    virtual unsigned TestUIFlags(unsigned mask);

src/effects/EffectManager.cpp

@@ -135,7 +135,7 @@ TranslatableString EffectManager::GetCommandDescription(const PluginID & ID)
    return {};
 }
 
-wxString EffectManager::GetCommandUrl(const PluginID & ID)
+ManualPageID EffectManager::GetCommandUrl(const PluginID & ID)
 {
    Effect* pEff = GetEffect(ID);
    if( pEff )
@@ -190,7 +190,8 @@ void EffectManager::GetCommandDefinition(const PluginID & ID, const CommandConte
       S.EndArray();
       S.EndField();
    }
-   S.AddItem( GetCommandUrl( ID ), "url" );
+   // use GET() to expose some details to macro programming users
+   S.AddItem( GetCommandUrl( ID ).GET(), "url" );
    // The tip is a translated string!
    S.AddItem( GetCommandTip( ID ).Translation(), "tip" );
    S.EndStruct();

src/effects/EffectManager.h

@@ -96,7 +96,7 @@ public:
    TranslatableString GetCommandName(const PluginID & ID);
    CommandID GetCommandIdentifier(const PluginID & ID);
    TranslatableString GetCommandDescription(const PluginID & ID);
-   wxString GetCommandUrl(const PluginID & ID);
+   ManualPageID GetCommandUrl(const PluginID & ID);
    TranslatableString GetCommandTip(const PluginID & ID);
    // flags control which commands are included.
    void GetCommandDefinition(const PluginID & ID, const CommandContext & context, int flags);

src/effects/Equalization.cpp

@@ -348,14 +348,14 @@ TranslatableString EffectEqualization::GetDescription()
    return XO("Adjusts the volume levels of particular frequencies");
 }
 
-wxString EffectEqualization::ManualPage()
+ManualPageID EffectEqualization::ManualPage()
 {
    // Bug 2509: Must use _ and not space in names.
    if( mOptions == kEqOptionGraphic )
-      return wxT("Graphic_EQ");
+      return L"Graphic_EQ";
    if( mOptions == kEqOptionCurve )
-      return wxT("Filter_Curve_EQ");
-   return wxT("Equalization");
+      return L"Filter_Curve_EQ";
+   return L"Equalization";
 }
 
 // EffectDefinitionInterface implementation

src/effects/Equalization.h

@@ -103,7 +103,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/FindClipping.cpp

@@ -68,9 +68,9 @@ TranslatableString EffectFindClipping::GetDescription()
    return XO("Creates labels where clipping is detected");
 }
 
-wxString EffectFindClipping::ManualPage()
+ManualPageID EffectFindClipping::ManualPage()
 {
-   return wxT("Find_Clipping");
+   return L"Find_Clipping";
 }
 
 // EffectDefinitionInterface implementation

src/effects/FindClipping.h

@@ -30,7 +30,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/Loudness.cpp

@@ -93,9 +93,9 @@ TranslatableString EffectLoudness::GetDescription()
    return XO("Sets the loudness of one or more tracks");
 }
 
-wxString EffectLoudness::ManualPage()
+ManualPageID EffectLoudness::ManualPage()
 {
-   return wxT("Loudness_Normalization");
+   return L"Loudness_Normalization";
 }
 
 // EffectDefinitionInterface implementation

src/effects/Loudness.h

@@ -38,7 +38,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/Noise.cpp

@@ -91,9 +91,9 @@ TranslatableString EffectNoise::GetDescription()
    return XO("Generates one of three different types of noise");
 }
 
-wxString EffectNoise::ManualPage()
+ManualPageID EffectNoise::ManualPage()
 {
-   return wxT("Noise");
+   return L"Noise";
 }
 
 // EffectDefinitionInterface implementation

src/effects/Noise.h

@@ -30,7 +30,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/Normalize.cpp

@@ -78,9 +78,9 @@ TranslatableString EffectNormalize::GetDescription()
    return XO("Sets the peak amplitude of one or more tracks");
 }
 
-wxString EffectNormalize::ManualPage()
+ManualPageID EffectNormalize::ManualPage()
 {
-   return wxT("Normalize");
+   return L"Normalize";
 }
 
 // EffectDefinitionInterface implementation

src/effects/Normalize.h

@@ -32,7 +32,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/Paulstretch.cpp

@@ -117,9 +117,9 @@ TranslatableString EffectPaulstretch::GetDescription()
    return XO("Paulstretch is only for an extreme time-stretch or \"stasis\" effect");
 }
 
-wxString EffectPaulstretch::ManualPage()
+ManualPageID EffectPaulstretch::ManualPage()
 {
-   return wxT("Paulstretch");
+   return L"Paulstretch";
 }
 
 // EffectDefinitionInterface implementation

src/effects/Paulstretch.h

@@ -26,7 +26,7 @@ public:
 
    ComponentInterfaceSymbol GetSymbol() override;
    TranslatableString GetDescription() override;
-   wxString ManualPage() override;
+   ManualPageID ManualPage() override;
 
    // EffectDefinitionInterface implementation
 

src/effects/Phaser.cpp

@@ -115,9 +115,9 @@ TranslatableString EffectPhaser::GetDescription()
    return XO("Combines phase-shifted signals with the original signal");
 }