CommonCommandFlags.h File Reference

#include "commands/CommandFlag.h"

Include dependency graph for CommonCommandFlags.h:

Go to the source code of this file.

Functions
AUDACITY_DLL_API bool	EditableTracksSelectedPred (const AudacityProject &project)
AUDACITY_DLL_API bool	AudioIOBusyPred (const AudacityProject &project)
AUDACITY_DLL_API bool	TimeSelectedPred (const AudacityProject &project)
AUDACITY_DLL_API const CommandFlagOptions &	cutCopyOptions ()
AUDACITY_DLL_API const ReservedCommandFlag &	AudioIONotBusyFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	StereoRequiredFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	NoiseReductionTimeSelectedFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	TimeSelectedFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	WaveTracksSelectedFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	TracksExistFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	EditableTracksSelectedFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	AnyTracksSelectedFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	TrackPanelHasFocus ()
AUDACITY_DLL_API const ReservedCommandFlag &	AudioIOBusyFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	CaptureNotBusyFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	LabelTracksExistFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	UndoAvailableFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	RedoAvailableFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	ZoomInAvailableFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	ZoomOutAvailableFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	WaveTracksExistFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	IsNotSyncLockedFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	IsSyncLockedFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	NotMinimizedFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	PausedFlag ()
AUDACITY_DLL_API const ReservedCommandFlag &	NoAutoSelect ()

Function Documentation

AnyTracksSelectedFlag()

AUDACITY_DLL_API const ReservedCommandFlag & AnyTracksSelectedFlag

(

)

AudioIOBusyFlag()

AUDACITY_DLL_API const ReservedCommandFlag & AudioIOBusyFlag

(

)

AudioIOBusyPred()

AUDACITY_DLL_API 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()

AUDACITY_DLL_API const ReservedCommandFlag & AudioIONotBusyFlag

(

)

CaptureNotBusyFlag()

AUDACITY_DLL_API 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()

AUDACITY_DLL_API 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()

AUDACITY_DLL_API const ReservedCommandFlag & EditableTracksSelectedFlag

(

)

EditableTracksSelectedPred()

AUDACITY_DLL_API 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()

AUDACITY_DLL_API const ReservedCommandFlag & IsNotSyncLockedFlag

(

)

IsSyncLockedFlag()

AUDACITY_DLL_API const ReservedCommandFlag & IsSyncLockedFlag

(

)

LabelTracksExistFlag()

AUDACITY_DLL_API const ReservedCommandFlag & LabelTracksExistFlag

(

)

NoAutoSelect()

AUDACITY_DLL_API 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()

AUDACITY_DLL_API const ReservedCommandFlag & NoiseReductionTimeSelectedFlag

(

)

NotMinimizedFlag()

AUDACITY_DLL_API const ReservedCommandFlag & NotMinimizedFlag

(

)

PausedFlag()

AUDACITY_DLL_API const ReservedCommandFlag & PausedFlag

(

)

RedoAvailableFlag()

AUDACITY_DLL_API const ReservedCommandFlag & RedoAvailableFlag

(

)

StereoRequiredFlag()

AUDACITY_DLL_API const ReservedCommandFlag & StereoRequiredFlag

(

)

TimeSelectedFlag()

AUDACITY_DLL_API const ReservedCommandFlag & TimeSelectedFlag

(

)

TimeSelectedPred()

AUDACITY_DLL_API 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()

AUDACITY_DLL_API 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()

AUDACITY_DLL_API const ReservedCommandFlag & TracksExistFlag

(

)

UndoAvailableFlag()

AUDACITY_DLL_API const ReservedCommandFlag & UndoAvailableFlag

(

)

WaveTracksExistFlag()

AUDACITY_DLL_API const ReservedCommandFlag & WaveTracksExistFlag

(

)

WaveTracksSelectedFlag()

AUDACITY_DLL_API const ReservedCommandFlag & WaveTracksSelectedFlag

(

)

ZoomInAvailableFlag()

AUDACITY_DLL_API const ReservedCommandFlag & ZoomInAvailableFlag

(

)

ZoomOutAvailableFlag()

AUDACITY_DLL_API const ReservedCommandFlag & ZoomOutAvailableFlag

(

)