Add help buttons for normal built-in effects

src/effects/AutoDuck.cpp

@@ -115,6 +115,11 @@ wxString 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()
+{
+   return wxT("Auto_Duck");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectAutoDuck::GetType()

src/effects/AutoDuck.h

@@ -38,6 +38,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/BassTreble.cpp

@@ -92,6 +92,11 @@ wxString EffectBassTreble::GetDescription()
    return XO("Simple tone control effect");
 }
 
+wxString EffectBassTreble::ManualPage()
+{
+   return wxT("Bass_and_Treble");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectBassTreble::GetType()

src/effects/BassTreble.h

@@ -51,6 +51,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/ChangePitch.cpp

@@ -126,6 +126,11 @@ wxString EffectChangePitch::GetDescription()
    return XO("Change the pitch of a track without changing its tempo");
 }
 
+wxString EffectChangePitch::ManualPage()
+{
+   return wxT("Change_Pitch");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectChangePitch::GetType()

src/effects/ChangePitch.h

@@ -48,6 +48,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/ChangeSpeed.cpp

@@ -115,6 +115,12 @@ wxString EffectChangeSpeed::GetDescription()
    return XO("Change the speed of a track, also changing its pitch");
 }
 
+wxString EffectChangeSpeed::ManualPage()
+{
+   return wxT("Change_Speed");
+}
+
+
 // EffectIdentInterface implementation
 
 EffectType EffectChangeSpeed::GetType()

src/effects/ChangeSpeed.h

@@ -37,6 +37,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/ChangeTempo.cpp

@@ -102,6 +102,11 @@ wxString EffectChangeTempo::GetDescription()
    return XO("Change the tempo of a selection without changing its pitch");
 }
 
+wxString EffectChangeTempo::ManualPage()
+{
+   return wxT("Change_Tempo");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectChangeTempo::GetType()

src/effects/ChangeTempo.h

@@ -42,6 +42,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/ClickRemoval.cpp

@@ -85,6 +85,11 @@ wxString EffectClickRemoval::GetDescription()
    return XO("Click Removal is designed to remove clicks on audio tracks");
 }
 
+wxString EffectClickRemoval::ManualPage()
+{
+   return wxT("Click_Removal");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectClickRemoval::GetType()

src/effects/ClickRemoval.h

@@ -38,6 +38,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/Compressor.cpp

@@ -107,6 +107,11 @@ wxString EffectCompressor::GetDescription()
    return XO("Compresses the dynamic range of audio");
 }
 
+wxString EffectCompressor::ManualPage()
+{
+   return wxT("Compressor");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectCompressor::GetType()

src/effects/Compressor.h

@@ -40,6 +40,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/Distortion.cpp

@@ -192,6 +192,11 @@ wxString EffectDistortion::GetDescription()
    return XO("Waveshaping distortion effect");
 }
 
+wxString EffectDistortion::ManualPage()
+{
+   return wxT("Distortion");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectDistortion::GetType()

src/effects/Distortion.h

@@ -68,6 +68,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/DtmfGen.cpp

@@ -101,6 +101,11 @@ wxString EffectDtmf::GetDescription()
    return XO("Generates dual-tone multi-frequency (DTMF) tones like those produced by the keypad on telephones");
 }
 
+wxString EffectDtmf::ManualPage()
+{
+   return wxT("Generate_Menu#dtmf");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectDtmf::GetType()

src/effects/DtmfGen.h

@@ -37,6 +37,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/Echo.cpp

@@ -60,6 +60,11 @@ wxString EffectEcho::GetDescription()
    return XO("Repeats the selected audio again and again");
 }
 
+wxString EffectEcho::ManualPage()
+{
+   return wxT("Echo");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectEcho::GetType()

src/effects/Echo.h

@@ -33,6 +33,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/Equalization.cpp

@@ -298,6 +298,11 @@ wxString EffectEqualization::GetDescription()
    return XO("Adjusts the volume levels of particular frequencies");
 }
 
+wxString EffectEqualization::ManualPage()
+{
+   return wxT("Equalization");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectEqualization::GetType()

src/effects/Equalization.h

@@ -95,6 +95,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/FindClipping.cpp

@@ -61,6 +61,11 @@ wxString EffectFindClipping::GetDescription()
    return XO("Creates labels where clipping is detected");
 }
 
+wxString EffectFindClipping::ManualPage()
+{
+   return wxT("Find_Clipping");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectFindClipping::GetType()

src/effects/FindClipping.h

@@ -32,6 +32,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/Noise.cpp

@@ -78,6 +78,11 @@ wxString EffectNoise::GetDescription()
    return XO("Generates one of three different types of noise");
 }
 
+wxString EffectNoise::ManualPage()
+{
+   return wxT("Generate_Menu#noise");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectNoise::GetType()

src/effects/Noise.h

@@ -33,6 +33,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/Normalize.cpp

@@ -68,6 +68,11 @@ wxString EffectNormalize::GetDescription()
    return XO("Sets the peak amplitude of one or more tracks");
 }
 
+wxString EffectNormalize::ManualPage()
+{
+   return wxT("Normalize");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectNormalize::GetType()

src/effects/Normalize.h

@@ -34,6 +34,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/Paulstretch.cpp

@@ -107,6 +107,11 @@ wxString EffectPaulstretch::GetDescription()
    return XO("Use Paulstretch only for an extreme time-stretch or \"stasis\" effect");
 }
 
+wxString EffectPaulstretch::ManualPage()
+{
+   return wxT("Paulstretch");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectPaulstretch::GetType()

src/effects/Paulstretch.h

@@ -28,6 +28,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/Phaser.cpp

@@ -112,6 +112,11 @@ wxString EffectPhaser::GetDescription()
    return XO("Combines phase-shifted signals with the original signal");
 }
 
+wxString EffectPhaser::ManualPage()
+{
+   return wxT("Phaser");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectPhaser::GetType()

src/effects/Phaser.h

@@ -56,6 +56,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/Repeat.cpp

@@ -67,6 +67,11 @@ wxString EffectRepeat::GetDescription()
    return XO("Repeats the selection the specified number of times");
 }
 
+wxString EffectRepeat::ManualPage()
+{
+   return wxT("Repeat");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectRepeat::GetType()

src/effects/Repeat.h

@@ -32,6 +32,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/Reverb.cpp

@@ -153,6 +153,11 @@ wxString EffectReverb::GetDescription()
    return XO("Adds ambience or a \"hall effect\"");
 }
 
+wxString EffectReverb::ManualPage()
+{
+   return wxT("Reverb");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectReverb::GetType()

src/effects/Reverb.h

@@ -50,6 +50,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/Silence.cpp

@@ -42,6 +42,12 @@ wxString EffectSilence::GetDescription()
    return XO("Creates audio of zero amplitude");
 }
 
+wxString EffectSilence::ManualPage()
+{
+   return wxT("Generate_Menu#silence");
+}
+
+
 // EffectIdentInterface implementation
 
 EffectType EffectSilence::GetType()

src/effects/Silence.h

@@ -31,6 +31,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/TimeScale.cpp

@@ -101,6 +101,11 @@ wxString EffectTimeScale::GetDescription()
    return XO("Allows continuous changes to the tempo and/or pitch");
 }
 
+wxString EffectTimeScale::ManualPage()
+{
+   return wxT("Sliding_Time_Scale_-_Pitch_Shift");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectTimeScale::GetType()

src/effects/TimeScale.h

@@ -37,6 +37,7 @@ public:
    wxString GetSymbol() override;
    wxString GetName() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/ToneGen.cpp

@@ -133,6 +133,13 @@ wxString EffectToneGen::GetDescription()
       : XO("Generates a constant frequency tone of one of four types");
 }
 
+wxString EffectToneGen::ManualPage()
+{
+   return mChirp
+      ? wxT("Generate_Menu#chirp")
+      : wxT("Generate_Menu#tone");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectToneGen::GetType()

src/effects/ToneGen.h

@@ -35,6 +35,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/TruncSilence.cpp

@@ -119,6 +119,11 @@ wxString EffectTruncSilence::GetDescription()
    return XO("Automatically reduces the length of passages where the volume is below a specified level");
 }
 
+wxString EffectTruncSilence::ManualPage()
+{
+   return wxT("Truncate_Silence");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectTruncSilence::GetType()

src/effects/TruncSilence.h

@@ -43,6 +43,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation
 

src/effects/Wahwah.cpp

@@ -103,6 +103,11 @@ wxString EffectWahwah::GetDescription()
    return XO("Rapid tone quality variations, like that guitar sound so popular in the 1970's");
 }
 
+wxString EffectWahwah::ManualPage()
+{
+   return wxT("Wahwah");
+}
+
 // EffectIdentInterface implementation
 
 EffectType EffectWahwah::GetType()

src/effects/Wahwah.h

@@ -53,6 +53,7 @@ public:
 
    wxString GetSymbol() override;
    wxString GetDescription() override;
+   wxString ManualPage() override;
 
    // EffectIdentInterface implementation