From e7a9c37745dac64a088b71a552b6a0207d16bb1f Mon Sep 17 00:00:00 2001 From: Steve Daulton Date: Sat, 20 May 2017 14:40:09 +0100 Subject: [PATCH] Add help buttons for normal built-in effects --- src/effects/AutoDuck.cpp | 5 +++++ src/effects/AutoDuck.h | 1 + src/effects/BassTreble.cpp | 5 +++++ src/effects/BassTreble.h | 1 + src/effects/ChangePitch.cpp | 5 +++++ src/effects/ChangePitch.h | 1 + src/effects/ChangeSpeed.cpp | 6 ++++++ src/effects/ChangeSpeed.h | 1 + src/effects/ChangeTempo.cpp | 5 +++++ src/effects/ChangeTempo.h | 1 + src/effects/ClickRemoval.cpp | 5 +++++ src/effects/ClickRemoval.h | 1 + src/effects/Compressor.cpp | 5 +++++ src/effects/Compressor.h | 1 + src/effects/Distortion.cpp | 5 +++++ src/effects/Distortion.h | 1 + src/effects/DtmfGen.cpp | 5 +++++ src/effects/DtmfGen.h | 1 + src/effects/Echo.cpp | 5 +++++ src/effects/Echo.h | 1 + src/effects/Equalization.cpp | 5 +++++ src/effects/Equalization.h | 1 + src/effects/FindClipping.cpp | 5 +++++ src/effects/FindClipping.h | 1 + src/effects/Noise.cpp | 5 +++++ src/effects/Noise.h | 1 + src/effects/Normalize.cpp | 5 +++++ src/effects/Normalize.h | 1 + src/effects/Paulstretch.cpp | 5 +++++ src/effects/Paulstretch.h | 1 + src/effects/Phaser.cpp | 5 +++++ src/effects/Phaser.h | 1 + src/effects/Repeat.cpp | 5 +++++ src/effects/Repeat.h | 1 + src/effects/Reverb.cpp | 5 +++++ src/effects/Reverb.h | 1 + src/effects/Silence.cpp | 6 ++++++ src/effects/Silence.h | 1 + src/effects/TimeScale.cpp | 5 +++++ src/effects/TimeScale.h | 1 + src/effects/ToneGen.cpp | 7 +++++++ src/effects/ToneGen.h | 1 + src/effects/TruncSilence.cpp | 5 +++++ src/effects/TruncSilence.h | 1 + src/effects/Wahwah.cpp | 5 +++++ src/effects/Wahwah.h | 1 + 46 files changed, 142 insertions(+) diff --git a/src/effects/AutoDuck.cpp b/src/effects/AutoDuck.cpp index e1fb8100e..48b0d4465 100644 --- a/src/effects/AutoDuck.cpp +++ b/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() diff --git a/src/effects/AutoDuck.h b/src/effects/AutoDuck.h index 79db8f4c0..45aede7cd 100644 --- a/src/effects/AutoDuck.h +++ b/src/effects/AutoDuck.h @@ -38,6 +38,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/BassTreble.cpp b/src/effects/BassTreble.cpp index fcc6604f5..6cd987b36 100644 --- a/src/effects/BassTreble.cpp +++ b/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() diff --git a/src/effects/BassTreble.h b/src/effects/BassTreble.h index ece660fa5..0aed2d56c 100644 --- a/src/effects/BassTreble.h +++ b/src/effects/BassTreble.h @@ -51,6 +51,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/ChangePitch.cpp b/src/effects/ChangePitch.cpp index 56b5c7817..5f0c9c284 100644 --- a/src/effects/ChangePitch.cpp +++ b/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() diff --git a/src/effects/ChangePitch.h b/src/effects/ChangePitch.h index da4843e99..9da7f6d6c 100644 --- a/src/effects/ChangePitch.h +++ b/src/effects/ChangePitch.h @@ -48,6 +48,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/ChangeSpeed.cpp b/src/effects/ChangeSpeed.cpp index d764bbce4..78fed4e4e 100644 --- a/src/effects/ChangeSpeed.cpp +++ b/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() diff --git a/src/effects/ChangeSpeed.h b/src/effects/ChangeSpeed.h index 93fddc0b1..c04b63a49 100644 --- a/src/effects/ChangeSpeed.h +++ b/src/effects/ChangeSpeed.h @@ -37,6 +37,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/ChangeTempo.cpp b/src/effects/ChangeTempo.cpp index 7e5292cb6..17ceb0ab5 100644 --- a/src/effects/ChangeTempo.cpp +++ b/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() diff --git a/src/effects/ChangeTempo.h b/src/effects/ChangeTempo.h index 33ee049f6..ba98d5845 100644 --- a/src/effects/ChangeTempo.h +++ b/src/effects/ChangeTempo.h @@ -42,6 +42,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/ClickRemoval.cpp b/src/effects/ClickRemoval.cpp index d096e86fb..fa9e3289c 100644 --- a/src/effects/ClickRemoval.cpp +++ b/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() diff --git a/src/effects/ClickRemoval.h b/src/effects/ClickRemoval.h index 73540860f..eb27f1cc8 100644 --- a/src/effects/ClickRemoval.h +++ b/src/effects/ClickRemoval.h @@ -38,6 +38,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/Compressor.cpp b/src/effects/Compressor.cpp index a5e9307e9..6a99bc7d9 100644 --- a/src/effects/Compressor.cpp +++ b/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() diff --git a/src/effects/Compressor.h b/src/effects/Compressor.h index 0cbe43896..76f37cbaa 100644 --- a/src/effects/Compressor.h +++ b/src/effects/Compressor.h @@ -40,6 +40,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/Distortion.cpp b/src/effects/Distortion.cpp index 42c6064d4..b4cfe35eb 100644 --- a/src/effects/Distortion.cpp +++ b/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() diff --git a/src/effects/Distortion.h b/src/effects/Distortion.h index 6e3bcc726..29fda2745 100644 --- a/src/effects/Distortion.h +++ b/src/effects/Distortion.h @@ -68,6 +68,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/DtmfGen.cpp b/src/effects/DtmfGen.cpp index 7f089cbfc..539ef6c58 100644 --- a/src/effects/DtmfGen.cpp +++ b/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() diff --git a/src/effects/DtmfGen.h b/src/effects/DtmfGen.h index c5a38b1ee..50f432bef 100644 --- a/src/effects/DtmfGen.h +++ b/src/effects/DtmfGen.h @@ -37,6 +37,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/Echo.cpp b/src/effects/Echo.cpp index a698e842b..fa0f4233a 100644 --- a/src/effects/Echo.cpp +++ b/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() diff --git a/src/effects/Echo.h b/src/effects/Echo.h index 0b18709b4..492e9d435 100644 --- a/src/effects/Echo.h +++ b/src/effects/Echo.h @@ -33,6 +33,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/Equalization.cpp b/src/effects/Equalization.cpp index 503083377..3feee2c24 100644 --- a/src/effects/Equalization.cpp +++ b/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() diff --git a/src/effects/Equalization.h b/src/effects/Equalization.h index 2a644231a..1e60fc01f 100644 --- a/src/effects/Equalization.h +++ b/src/effects/Equalization.h @@ -95,6 +95,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/FindClipping.cpp b/src/effects/FindClipping.cpp index 492578f0a..e888b5b58 100644 --- a/src/effects/FindClipping.cpp +++ b/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() diff --git a/src/effects/FindClipping.h b/src/effects/FindClipping.h index b5c582333..976799a8e 100644 --- a/src/effects/FindClipping.h +++ b/src/effects/FindClipping.h @@ -32,6 +32,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/Noise.cpp b/src/effects/Noise.cpp index 790779a46..cf881835b 100644 --- a/src/effects/Noise.cpp +++ b/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() diff --git a/src/effects/Noise.h b/src/effects/Noise.h index a4045a3d0..538c28b6c 100644 --- a/src/effects/Noise.h +++ b/src/effects/Noise.h @@ -33,6 +33,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/Normalize.cpp b/src/effects/Normalize.cpp index 02596fa3d..c68dff27a 100644 --- a/src/effects/Normalize.cpp +++ b/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() diff --git a/src/effects/Normalize.h b/src/effects/Normalize.h index 557c07ac2..e4b677217 100644 --- a/src/effects/Normalize.h +++ b/src/effects/Normalize.h @@ -34,6 +34,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/Paulstretch.cpp b/src/effects/Paulstretch.cpp index 72b4f66b8..91c6585ea 100644 --- a/src/effects/Paulstretch.cpp +++ b/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() diff --git a/src/effects/Paulstretch.h b/src/effects/Paulstretch.h index e908c2b78..59bd79a85 100644 --- a/src/effects/Paulstretch.h +++ b/src/effects/Paulstretch.h @@ -28,6 +28,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/Phaser.cpp b/src/effects/Phaser.cpp index 20e237b53..622cdec9f 100644 --- a/src/effects/Phaser.cpp +++ b/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() diff --git a/src/effects/Phaser.h b/src/effects/Phaser.h index 3f628be41..151a9945f 100644 --- a/src/effects/Phaser.h +++ b/src/effects/Phaser.h @@ -56,6 +56,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/Repeat.cpp b/src/effects/Repeat.cpp index e436cc5e3..0c635e3de 100644 --- a/src/effects/Repeat.cpp +++ b/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() diff --git a/src/effects/Repeat.h b/src/effects/Repeat.h index e7d88f8ad..5edb4928a 100644 --- a/src/effects/Repeat.h +++ b/src/effects/Repeat.h @@ -32,6 +32,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/Reverb.cpp b/src/effects/Reverb.cpp index e3fa56d48..8d290e09e 100644 --- a/src/effects/Reverb.cpp +++ b/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() diff --git a/src/effects/Reverb.h b/src/effects/Reverb.h index 80fc3c766..c2637f975 100644 --- a/src/effects/Reverb.h +++ b/src/effects/Reverb.h @@ -50,6 +50,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/Silence.cpp b/src/effects/Silence.cpp index 16ca05507..cddb29df5 100644 --- a/src/effects/Silence.cpp +++ b/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() diff --git a/src/effects/Silence.h b/src/effects/Silence.h index e3b0110db..097214acf 100644 --- a/src/effects/Silence.h +++ b/src/effects/Silence.h @@ -31,6 +31,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/TimeScale.cpp b/src/effects/TimeScale.cpp index 1501726ce..ec1aab8df 100644 --- a/src/effects/TimeScale.cpp +++ b/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() diff --git a/src/effects/TimeScale.h b/src/effects/TimeScale.h index 411f32a34..f3fbbe073 100644 --- a/src/effects/TimeScale.h +++ b/src/effects/TimeScale.h @@ -37,6 +37,7 @@ public: wxString GetSymbol() override; wxString GetName() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/ToneGen.cpp b/src/effects/ToneGen.cpp index e46a4b24d..1b97a2e2c 100644 --- a/src/effects/ToneGen.cpp +++ b/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() diff --git a/src/effects/ToneGen.h b/src/effects/ToneGen.h index 26ed3f849..c556246f7 100644 --- a/src/effects/ToneGen.h +++ b/src/effects/ToneGen.h @@ -35,6 +35,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/TruncSilence.cpp b/src/effects/TruncSilence.cpp index 587fa7490..bde22e29e 100644 --- a/src/effects/TruncSilence.cpp +++ b/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() diff --git a/src/effects/TruncSilence.h b/src/effects/TruncSilence.h index 39825183b..3b5780925 100644 --- a/src/effects/TruncSilence.h +++ b/src/effects/TruncSilence.h @@ -43,6 +43,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation diff --git a/src/effects/Wahwah.cpp b/src/effects/Wahwah.cpp index 73c27f29d..15cf6de91 100644 --- a/src/effects/Wahwah.cpp +++ b/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() diff --git a/src/effects/Wahwah.h b/src/effects/Wahwah.h index 440b10ced..ecd0df82b 100644 --- a/src/effects/Wahwah.h +++ b/src/effects/Wahwah.h @@ -53,6 +53,7 @@ public: wxString GetSymbol() override; wxString GetDescription() override; + wxString ManualPage() override; // EffectIdentInterface implementation