#include "CommonCommandFlags.h"
#include <wx/frame.h>
#include "AudioIO.h"
#include "LabelTrack.h"
#include "Menus.h"
#include "Project.h"
#include "ProjectAudioIO.h"
#include "ProjectHistory.h"
#include "ProjectWindows.h"
#include "SyncLock.h"
#include "UndoManager.h"
#include "ViewInfo.h"
#include "WaveTrack.h"
#include "commands/CommandManagerWindowClasses.h"

Include dependency graph for CommonCommandFlags.cpp:

Functions
bool	EditableTracksSelectedPred (const AudacityProject &project)

bool	AnyTracksSelectedPred (const AudacityProject &project)

bool	AudioIOBusyPred (const AudacityProject &project)

bool	TimeSelectedPred (const AudacityProject &project)

const CommandFlagOptions &	cutCopyOptions ()

const ReservedCommandFlag &	AudioIONotBusyFlag ()

const ReservedCommandFlag &	StereoRequiredFlag ()

const ReservedCommandFlag &	NoiseReductionTimeSelectedFlag ()

const ReservedCommandFlag &	TimeSelectedFlag ()

const ReservedCommandFlag &	WaveTracksSelectedFlag ()

const ReservedCommandFlag &	TracksExistFlag ()

const ReservedCommandFlag &	EditableTracksSelectedFlag ()

const ReservedCommandFlag &	AnyTracksSelectedFlag ()

const ReservedCommandFlag &	TrackPanelHasFocus ()

const ReservedCommandFlag &	AudioIOBusyFlag ()

const ReservedCommandFlag &	CaptureNotBusyFlag ()

const ReservedCommandFlag &	LabelTracksExistFlag ()

const ReservedCommandFlag &	UndoAvailableFlag ()

const ReservedCommandFlag &	RedoAvailableFlag ()

const ReservedCommandFlag &	ZoomInAvailableFlag ()

const ReservedCommandFlag &	ZoomOutAvailableFlag ()

const ReservedCommandFlag &	WaveTracksExistFlag ()

const ReservedCommandFlag &	IsNotSyncLockedFlag ()

const ReservedCommandFlag &	IsSyncLockedFlag ()

const ReservedCommandFlag &	NotMinimizedFlag ()

const ReservedCommandFlag &	PausedFlag ()

const ReservedCommandFlag &	NoAutoSelect ()

Variables
const CommandFlagOptions	noiseReductionOptions

Function Documentation

◆ AnyTracksSelectedFlag()

const ReservedCommandFlag & AnyTracksSelectedFlag ( )

Definition at line 188 of file CommonCommandFlags.cpp.

                           { static ReservedCommandFlag flag{
      AnyTracksSelectedPred,
      { []( const TranslatableString &Name ){ return
         // i18n-hint: %s will be replaced by the name of an action, such as "Remove Tracks".
         XO("\"%s\" requires one or more tracks to be selected.").Format( Name );
      },"Audacity_Selection" }
   }; return flag; }

References AnyTracksSelectedPred(), flag, and XO().

Referenced by anonymous_namespace{TrackMenus.cpp}::TracksMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AnyTracksSelectedPred()

bool AnyTracksSelectedPred ( const AudacityProject & project )

Definition at line 54 of file CommonCommandFlags.cpp.

{
   auto range = TrackList::Get( project ).Selected();
   return !range.empty();
};

References TrackList::Get(), and TrackList::Selected().

Referenced by AnyTracksSelectedFlag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AudioIOBusyFlag()

const ReservedCommandFlag & AudioIOBusyFlag ( )

Definition at line 208 of file CommonCommandFlags.cpp.

                     { static ReservedCommandFlag flag{
      AudioIOBusyPred,
      CommandFlagOptions{}.QuickTest()
   }; return flag; } //lll

References AudioIOBusyPred(), flag, and CommandFlagOptions::QuickTest().

Referenced by anonymous_namespace{SelectMenus.cpp}::ExtraSeekMenu(), anonymous_namespace{TransportMenus.cpp}::ExtraTransportMenu(), and anonymous_namespace{LabelMenus.cpp}::LabelEditMenus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AudioIOBusyPred()

bool AudioIOBusyPred ( const AudacityProject & project )

Definition at line 60 of file CommonCommandFlags.cpp.

{
   return AudioIOBase::Get()->IsAudioTokenActive(
      ProjectAudioIO::Get( project ).GetAudioIOToken());
};

References AudioIOBase::Get(), ProjectAudioIO::Get(), and AudioIOBase::IsAudioTokenActive().

Referenced by AudioIOBusyFlag(), and AudioIONotBusyFlag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AudioIONotBusyFlag()

const ReservedCommandFlag & AudioIONotBusyFlag ( )

Definition at line 127 of file CommonCommandFlags.cpp.

                        { static ReservedCommandFlag flag{
      [](const AudacityProject &project ){
         return !AudioIOBusyPred( project );
      },
      CommandFlagOptions{ []( const TranslatableString& ) { return
         // This reason will not be shown, because options that require it will be greyed out.
         XO("You can only do this when playing and recording are\nstopped. (Pausing is not sufficient.)");
      } ,"FAQ:Errors:Audio Must Be Stopped"}
      .QuickTest()
      .Priority( 1 )
   }; return flag; }//lll

References AudioIOBusyPred(), flag, and XO().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CaptureNotBusyFlag()

const ReservedCommandFlag & CaptureNotBusyFlag ( )

Definition at line 213 of file CommonCommandFlags.cpp.

                        { static ReservedCommandFlag flag{
      [](const AudacityProject &){
         auto gAudioIO = AudioIO::Get();
         return !(
            gAudioIO->IsBusy() &&
            gAudioIO->GetNumCaptureChannels() > 0
         );
      }
   }; return flag; };

References flag, and AudioIO::Get().

Referenced by anonymous_namespace{TranscriptionToolBar.cpp}::ExtraPlayAtSpeedItems(), anonymous_namespace{TransportMenus.cpp}::ExtraSelectionItems(), anonymous_namespace{TransportMenus.cpp}::ExtraTransportMenu(), and anonymous_namespace{Scrubbing.cpp}::menuItems().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cutCopyOptions()

const CommandFlagOptions & cutCopyOptions ( )

Definition at line 73 of file CommonCommandFlags.cpp.

                                           {
static CommandFlagOptions result{
// In reporting the issue with cut or copy, we don't tell the user they could also select some text in a label.
   []( const TranslatableString &Name ) {
      // PRL:  These strings have hard-coded mention of a certain shortcut key,
      // thus assuming the default shortcuts.  That is questionable.
      TranslatableString format;
#ifdef EXPERIMENTAL_DA
      // i18n-hint: %s will be replaced by the name of an action, such as Normalize, Cut, Fade.
      format = XO("You must first select some audio for '%s' to act on.\n\nCtrl + A selects all audio.");
#else
#ifdef __WXMAC__
      // i18n-hint: %s will be replaced by the name of an action, such as Normalize, Cut, Fade.
      format = XO("Select the audio for %s to use (for example, Cmd + A to Select All) then try again."
      // No need to explain what a help button is for.
      // "\n\nClick the Help button to learn more about selection methods."
      );
 
#else
      // i18n-hint: %s will be replaced by the name of an action, such as Normalize, Cut, Fade.
      format = XO("Select the audio for %s to use (for example, Ctrl + A to Select All) then try again."
      // No need to explain what a help button is for.
      // "\n\nClick the Help button to learn more about selection methods."
      );
#endif
#endif
      return format.Format( Name );
   },
   "Selecting_Audio_-_the_basics",
   XO("No Audio Selected")
};
return result;
}

References format, and XO().

Referenced by anonymous_namespace{EditMenus.cpp}::CutCopyAvailableFlag(), and TimeSelectedFlag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EditableTracksSelectedFlag()

const ReservedCommandFlag & EditableTracksSelectedFlag ( )

Definition at line 180 of file CommonCommandFlags.cpp.

                                { static ReservedCommandFlag flag{
      EditableTracksSelectedPred,
      { []( const TranslatableString &Name ){ return
         // i18n-hint: %s will be replaced by the name of an action, such as "Remove Tracks".
         XO("\"%s\" requires one or more tracks to be selected.").Format( Name );
      },"Audacity_Selection" }
   }; return flag; }

References EditableTracksSelectedPred(), flag, and XO().

Referenced by anonymous_namespace{SelectMenus.cpp}::CursorMenu(), anonymous_namespace{EditMenus.cpp}::EditMenu(), anonymous_namespace{EditMenus.cpp}::ExtraEditMenu(), SelectUtilities::SelectAllIfNone(), SelectUtilities::SelectAllIfNoneAndAllowed(), anonymous_namespace{SelectMenus.cpp}::SelectMenu(), and anonymous_namespace{TrackMenus.cpp}::TracksMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EditableTracksSelectedPred()

bool EditableTracksSelectedPred ( const AudacityProject & project )

Definition at line 45 of file CommonCommandFlags.cpp.

{
   auto range = TrackList::Get( project ).Selected()
     - []( const Track *pTrack ){
        return !pTrack->SupportsBasicEditing(); };
   return !range.empty();
};

References TrackList::Get(), and TrackList::Selected().

Referenced by anonymous_namespace{EditMenus.cpp}::CutCopyAvailableFlag(), and EditableTracksSelectedFlag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsNotSyncLockedFlag()

const ReservedCommandFlag & IsNotSyncLockedFlag ( )

Definition at line 268 of file CommonCommandFlags.cpp.

                         { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         return !SyncLockState::Get( project ).IsSyncLocked();
      }
   }; return flag; }  //awd

References flag, SyncLockState::Get(), and SyncLockState::IsSyncLocked().

Here is the call graph for this function:

◆ IsSyncLockedFlag()

const ReservedCommandFlag & IsSyncLockedFlag ( )

Definition at line 274 of file CommonCommandFlags.cpp.

                      { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         return SyncLockState::Get( project ).IsSyncLocked();
      }
   }; return flag; }  //awd

References flag, SyncLockState::Get(), and SyncLockState::IsSyncLocked().

Referenced by anonymous_namespace{SelectMenus.cpp}::SelectMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ LabelTracksExistFlag()

const ReservedCommandFlag & LabelTracksExistFlag ( )

Definition at line 224 of file CommonCommandFlags.cpp.

                          { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         return !TrackList::Get( project ).Any<const LabelTrack>().empty();
      }
   }; return flag; }

References TrackList::Any(), flag, and TrackList::Get().

Referenced by anonymous_namespace{FileMenus.cpp}::FileMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NoAutoSelect()

const ReservedCommandFlag & NoAutoSelect ( )

Definition at line 301 of file CommonCommandFlags.cpp.

                  { static ReservedCommandFlag flag{
     [](const AudacityProject &){ return true; }
   }; return flag; } // jkc

References flag.

Referenced by anonymous_namespace{EditMenus.cpp}::EditMenu(), and anonymous_namespace{EditMenus.cpp}::ExtraEditMenu().

Here is the caller graph for this function:

◆ NoiseReductionTimeSelectedFlag()

const ReservedCommandFlag & NoiseReductionTimeSelectedFlag ( )

Definition at line 154 of file CommonCommandFlags.cpp.

                                    { static ReservedCommandFlag flag{
      TimeSelectedPred,
      noiseReductionOptions
   }; return flag; }

References flag, noiseReductionOptions, and TimeSelectedPred().

Referenced by anonymous_namespace{MenuHelper.cpp}::FixBatchFlags().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ NotMinimizedFlag()

const ReservedCommandFlag & NotMinimizedFlag ( )

Definition at line 280 of file CommonCommandFlags.cpp.

                      { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         const wxWindow *focus = FindProjectFrame( &project );
         if (focus) {
            while (focus && focus->GetParent())
               focus = focus->GetParent();
         }
         return (focus &&
            !static_cast<const wxTopLevelWindow*>(focus)->IsIconized()
         );
      },
      CommandFlagOptions{}.QuickTest()
   }; return flag; } // prl

References FindProjectFrame(), flag, and CommandFlagOptions::QuickTest().

Here is the call graph for this function:

◆ PausedFlag()

const ReservedCommandFlag & PausedFlag ( )

Definition at line 294 of file CommonCommandFlags.cpp.

                { static ReservedCommandFlag flag{
      [](const AudacityProject&){
         return AudioIOBase::Get()->IsPaused();
      },
      CommandFlagOptions{}.QuickTest()
   }; return flag; }

References flag, AudioIOBase::Get(), AudioIOBase::IsPaused(), and CommandFlagOptions::QuickTest().

Here is the call graph for this function:

◆ RedoAvailableFlag()

const ReservedCommandFlag & RedoAvailableFlag ( )

Definition at line 236 of file CommonCommandFlags.cpp.

                       { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         return ProjectHistory::Get( project ).RedoAvailable();
      }
   }; return flag; }

References flag, ProjectHistory::Get(), and ProjectHistory::RedoAvailable().

Referenced by anonymous_namespace{EditMenus.cpp}::EditMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StereoRequiredFlag()

const ReservedCommandFlag & StereoRequiredFlag ( )

Definition at line 139 of file CommonCommandFlags.cpp.

                        { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         // True iff at least one stereo track is selected, i.e., at least
         // one right channel is selected.
         // TODO: more-than-two-channels
         auto range = TrackList::Get( project ).Selected<const WaveTrack>()
            - &Track::IsLeader;
         return !range.empty();
      },
      { []( const TranslatableString& ) { return
         // This reason will not be shown, because the stereo-to-mono is greyed out if not allowed.
         XO("You must first select some stereo audio to perform this\naction. (You cannot use this with mono.)");
      } ,"Audacity_Selection"}
   }; return flag; }  //lda

References flag, TrackList::Get(), Track::IsLeader(), TrackList::Selected(), and XO().

Referenced by anonymous_namespace{TrackMenus.cpp}::TracksMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TimeSelectedFlag()

const ReservedCommandFlag & TimeSelectedFlag ( )

Definition at line 159 of file CommonCommandFlags.cpp.

                      { static ReservedCommandFlag flag{
      TimeSelectedPred,
      cutCopyOptions()
   }; return flag; }

References cutCopyOptions(), flag, and TimeSelectedPred().

Referenced by anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), anonymous_namespace{SelectMenus.cpp}::CursorMenu(), anonymous_namespace{EditMenus.cpp}::EditMenu(), anonymous_namespace{PluginMenus.cpp}::EffectMenu(), anonymous_namespace{EditMenus.cpp}::ExtraEditMenu(), anonymous_namespace{FileMenus.cpp}::FileMenu(), anonymous_namespace{LabelMenus.cpp}::LabelEditMenus(), EffectUIHost::OnApply(), and anonymous_namespace{ViewMenus.cpp}::ViewMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TimeSelectedPred()

bool TimeSelectedPred ( const AudacityProject & project )

Definition at line 66 of file CommonCommandFlags.cpp.

{
   // This is equivalent to check if there is a valid selection,
   // so it's used for Zoom to Selection too
   return !ViewInfo::Get( project ).selectedRegion.isPoint();
};

References ViewInfo::Get(), NotifyingSelectedRegion::isPoint(), and ViewInfo::selectedRegion.

Referenced by anonymous_namespace{EditMenus.cpp}::CutCopyAvailableFlag(), NoiseReductionTimeSelectedFlag(), and TimeSelectedFlag().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TrackPanelHasFocus()

const ReservedCommandFlag & TrackPanelHasFocus ( )

Definition at line 196 of file CommonCommandFlags.cpp.

                        { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         for (auto w = wxWindow::FindFocus(); w; w = w->GetParent()) {
            if (dynamic_cast<const NonKeystrokeInterceptingWindow*>(w))
               return true;
         }
         return false;
      },
      CommandFlagOptions{}.DisableDefaultMessage()
   }; return flag; };  //lll

References CommandFlagOptions::DisableDefaultMessage(), BasicUI::FindFocus(), and flag.

Referenced by anonymous_namespace{SelectMenus.cpp}::ExtraCursorMenu(), anonymous_namespace{NavigationMenus.cpp}::ExtraFocusMenu(), anonymous_namespace{TransportMenus.cpp}::ExtraSelectionItems(), anonymous_namespace{SelectMenus.cpp}::ExtraSelectionMenu(), anonymous_namespace{ClipMenus.cpp}::ExtraTimeShiftItems(), and anonymous_namespace{TrackMenus.cpp}::ExtraTrackMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TracksExistFlag()

const ReservedCommandFlag & TracksExistFlag ( )

Definition at line 173 of file CommonCommandFlags.cpp.

                     { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         return !TrackList::Get( project ).Any().empty();
      },
      CommandFlagOptions{}.DisableDefaultMessage()
   }; return flag; }

References TrackList::Any(), CommandFlagOptions::DisableDefaultMessage(), flag, and TrackList::Get().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UndoAvailableFlag()

const ReservedCommandFlag & UndoAvailableFlag ( )

Definition at line 230 of file CommonCommandFlags.cpp.

                       { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         return ProjectHistory::Get( project ).UndoAvailable();
      }
   }; return flag; }

References flag, ProjectHistory::Get(), and ProjectHistory::UndoAvailable().

Referenced by anonymous_namespace{EditMenus.cpp}::EditMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WaveTracksExistFlag()

const ReservedCommandFlag & WaveTracksExistFlag ( )

Definition at line 262 of file CommonCommandFlags.cpp.

                         { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         return !TrackList::Get( project ).Any<const WaveTrack>().empty();
      }
   }; return flag; }

References TrackList::Any(), flag, and TrackList::Get().

Referenced by anonymous_namespace{ClipMenus.cpp}::ClipCursorItems(), anonymous_namespace{ClipMenus.cpp}::ClipSelectMenu(), anonymous_namespace{TransportMenus.cpp}::ExtraTransportMenu(), anonymous_namespace{FileMenus.cpp}::FileMenu(), anonymous_namespace{LabelMenus.cpp}::LabelEditMenus(), anonymous_namespace{SelectMenus.cpp}::SelectMenu(), and anonymous_namespace{TransportMenus.cpp}::TransportMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ WaveTracksSelectedFlag()

const ReservedCommandFlag & WaveTracksSelectedFlag ( )

Definition at line 164 of file CommonCommandFlags.cpp.

                            { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         return !TrackList::Get( project ).Selected<const WaveTrack>().empty();
      },
      { []( const TranslatableString& ) { return
         XO("You must first select some audio to perform this action.\n(Selecting other kinds of track won't work.)");
      } ,"Audacity_Selection"}
   }; return flag; }

References flag, TrackList::Get(), TrackList::Selected(), and XO().

Referenced by anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), anonymous_namespace{EditMenus.cpp}::EditMenu(), anonymous_namespace{PluginMenus.cpp}::EffectMenu(), anonymous_namespace{FileMenus.cpp}::FileMenu(), EffectUIHost::OnApply(), anonymous_namespace{SelectMenus.cpp}::SelectMenu(), and anonymous_namespace{TrackMenus.cpp}::TracksMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ZoomInAvailableFlag()

const ReservedCommandFlag & ZoomInAvailableFlag ( )

Definition at line 242 of file CommonCommandFlags.cpp.

                         { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         return
            ViewInfo::Get( project ).ZoomInAvailable()
         &&
            !TrackList::Get( project ).Any().empty()
         ;
      }
   }; return flag; }

References TrackList::Any(), flag, ViewInfo::Get(), TrackList::Get(), and ZoomInfo::ZoomInAvailable().

Referenced by anonymous_namespace{ViewMenus.cpp}::ViewMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ZoomOutAvailableFlag()

const ReservedCommandFlag & ZoomOutAvailableFlag ( )

Definition at line 252 of file CommonCommandFlags.cpp.

                          { static ReservedCommandFlag flag{
      [](const AudacityProject &project){
         return
            ViewInfo::Get( project ).ZoomOutAvailable()
         &&
            !TrackList::Get( project ).Any().empty()
         ;
      }
   }; return flag; }

References TrackList::Any(), flag, ViewInfo::Get(), TrackList::Get(), and ZoomInfo::ZoomOutAvailable().

Referenced by anonymous_namespace{ViewMenus.cpp}::ViewMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

◆ noiseReductionOptions

const CommandFlagOptions noiseReductionOptions

Initial value:

{
   []( const TranslatableString &Name ) {
      
      auto format = XO("Select the audio for %s to use.\n\n1. Select audio that represents noise and use %s to get your 'noise profile'.\n\n2. When you have got your noise profile, select the audio you want to change\nand use %s to change that audio.");
      return format.Format( Name, Name, Name );
   },
   "Noise_Reduction",
 
}

Definition at line 108 of file CommonCommandFlags.cpp.

Referenced by NoiseReductionTimeSelectedFlag().

Functions

Variables

Function Documentation

◆ AnyTracksSelectedFlag()

◆ AnyTracksSelectedPred()

◆ AudioIOBusyFlag()

◆ AudioIOBusyPred()

◆ AudioIONotBusyFlag()

◆ CaptureNotBusyFlag()

◆ cutCopyOptions()

◆ EditableTracksSelectedFlag()

◆ EditableTracksSelectedPred()

◆ IsNotSyncLockedFlag()

◆ IsSyncLockedFlag()

◆ LabelTracksExistFlag()

◆ NoAutoSelect()

◆ NoiseReductionTimeSelectedFlag()

◆ NotMinimizedFlag()

◆ PausedFlag()

◆ RedoAvailableFlag()

◆ StereoRequiredFlag()

◆ TimeSelectedFlag()

◆ TimeSelectedPred()

◆ TrackPanelHasFocus()

◆ TracksExistFlag()

◆ UndoAvailableFlag()

◆ WaveTracksExistFlag()

◆ WaveTracksSelectedFlag()

◆ ZoomInAvailableFlag()

◆ ZoomOutAvailableFlag()

Variable Documentation

◆ noiseReductionOptions