SelectUtilities Namespace Reference

Namespace for functions for Select menu. More...

Functions
void	DoSelectTimeAndTracks (AudacityProject &project, bool bAllTime, bool bAllTracks)
void	SelectNone (AudacityProject &project)
void	SelectAllIfNone (AudacityProject &project)
bool	SelectAllIfNoneAndAllowed (AudacityProject &project)
void	DoListSelection (AudacityProject &project, Track &t, bool shift, bool ctrl, bool modifyState)
void	DoSelectAll (AudacityProject &project)
void	DoSelectAllAudio (AudacityProject &project)
void	DoSelectSomething (AudacityProject &project)
void	ActivatePlayRegion (AudacityProject &project)
void	InactivatePlayRegion (AudacityProject &project)
void	TogglePlayRegion (AudacityProject &project)
void	ClearPlayRegion (AudacityProject &project)
void	SetPlayRegionToSelection (AudacityProject &project)
void	OnSetRegion (AudacityProject &project, bool left, bool selection, const TranslatableString &dialogTitle)
	Adjust left or right of selection or play region. More...

Detailed Description

Namespace for functions for Select menu.

Function Documentation

ActivatePlayRegion()

AUDACITY_DLL_API void SelectUtilities::ActivatePlayRegion

(

AudacityProject &

project

)

Definition at line 168 of file SelectUtilities.cpp.

{
   auto &tracks = TrackList::Get( project );
 
   auto &viewInfo = ViewInfo::Get( project );
   auto &playRegion = viewInfo.playRegion;
   playRegion.SetActive( true );
   if (playRegion.Empty()) {
      auto &selectedRegion = viewInfo.selectedRegion;
      if (!selectedRegion.isPoint())
         playRegion.SetTimes(selectedRegion.t0(), selectedRegion.t1());
      else
         // Arbitrary first four seconds
         playRegion.SetTimes(0.0, 4.0);
   }
 
   // Ensure the proper state of looping in the menu
   CommandManager::Get(project).UpdateCheckmarks();
}

References CommandManager::Get(), ViewInfo::Get(), TrackList::Get(), project, tracks, and CommandManager::UpdateCheckmarks().

Referenced by ControlToolBar::OnLoop(), anonymous_namespace{TransportMenus.cpp}::OnSetPlayRegionIn(), anonymous_namespace{TransportMenus.cpp}::OnSetPlayRegionOut(), and TogglePlayRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

ClearPlayRegion()

AUDACITY_DLL_API void SelectUtilities::ClearPlayRegion

(

AudacityProject &

project

)

Definition at line 212 of file SelectUtilities.cpp.

{
   auto &viewInfo = ViewInfo::Get( project );
   auto &playRegion = viewInfo.playRegion;
   playRegion.Clear();
 
   if (playRegion.Active())
      InactivatePlayRegion(project);
}

References ViewInfo::Get(), InactivatePlayRegion(), and project.

Referenced by anonymous_namespace{TransportMenus.cpp}::OnClearPlayRegion(), and AdornedRulerPanel::OnClearPlayRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

DoListSelection()

AUDACITY_DLL_API void SelectUtilities::DoListSelection	(	AudacityProject &	project,
		Track &	t,
		bool	shift,
		bool	ctrl,
		bool	modifyState
	)

Definition at line 116 of file SelectUtilities.cpp.

{
   auto &tracks = TrackList::Get(project);
   auto &selectionState = SelectionState::Get(project);
   auto &viewInfo = ViewInfo::Get(project);
   auto &window = GetProjectFrame(project);
 
   auto isSyncLocked = SyncLockState::Get(project).IsSyncLocked();
   // Substitute the leader to satisfy precondition
   auto pT = *tracks.Find(&t);
   if (!pT)
      return;
 
   selectionState.HandleListSelection(
      tracks, viewInfo, *pT,
      shift, ctrl, isSyncLocked);
 
   if (!ctrl)
      TrackFocus::Get(project).Set(&t);
   window.Refresh(false);
   if (modifyState)
      ProjectHistory::Get(project).ModifyState(true);
}

References TrackFocus::Get(), ProjectHistory::Get(), ViewInfo::Get(), SelectionState::Get(), SyncLockState::Get(), TrackList::Get(), GetProjectFrame(), SyncLockState::IsSyncLocked(), ProjectHistory::ModifyState(), project, and tracks.

Referenced by SelectHandle::Click(), TrackSelectHandle::Click(), SelectButtonHandle::CommitChanges(), and MixerTrackCluster::HandleSelect().

Here is the call graph for this function:

Here is the caller graph for this function:

DoSelectAll()

AUDACITY_DLL_API void SelectUtilities::DoSelectAll

(

AudacityProject &

project

)

Definition at line 141 of file SelectUtilities.cpp.

{
   DoSelectTimeAndTracks( project, true, true );
}

References DoSelectTimeAndTracks(), and project.

Referenced by ApplyMacroDialog::OnApplyToFiles(), SelectActions::Handler::OnSelectAll(), and ProjectManager::ResetProjectToEmpty().

Here is the call graph for this function:

Here is the caller graph for this function:

DoSelectAllAudio()

AUDACITY_DLL_API void SelectUtilities::DoSelectAllAudio

(

AudacityProject &

project

)

Definition at line 146 of file SelectUtilities.cpp.

{
   DoSelectTimeAndAudioTracks( project, true, true );
}

References anonymous_namespace{SelectUtilities.cpp}::DoSelectTimeAndAudioTracks(), and project.

Referenced by SelectAllIfNone(), and SelectAllIfNoneAndAllowed().

Here is the call graph for this function:

Here is the caller graph for this function:

DoSelectSomething()

AUDACITY_DLL_API void SelectUtilities::DoSelectSomething

(

AudacityProject &

project

)

Definition at line 156 of file SelectUtilities.cpp.

{
   auto &tracks = TrackList::Get( project );
   auto &selectedRegion = ViewInfo::Get( project ).selectedRegion;
 
   bool bTime = selectedRegion.isPoint();
   bool bTracks = tracks.Selected().empty();
 
   if (bTime || bTracks)
      DoSelectTimeAndTracks(project, bTime, bTracks);
}

References DoSelectTimeAndTracks(), ViewInfo::Get(), TrackList::Get(), NotifyingSelectedRegion::isPoint(), project, ViewInfo::selectedRegion, and tracks.

Here is the call graph for this function:

DoSelectTimeAndTracks()

AUDACITY_DLL_API void SelectUtilities::DoSelectTimeAndTracks	(	AudacityProject &	project,
		bool	bAllTime,
		bool	bAllTracks
	)

Definition at line 60 of file SelectUtilities.cpp.

{
   auto &tracks = TrackList::Get( project );
   auto &selectedRegion = ViewInfo::Get( project ).selectedRegion;
 
   if( bAllTime )
      selectedRegion.setTimes(tracks.GetStartTime(), tracks.GetEndTime());
 
   if( bAllTracks ) {
      for (auto t : tracks)
         t->SetSelected(true);
 
      ProjectHistory::Get( project ).ModifyState(false);
   }
}

References ProjectHistory::Get(), ViewInfo::Get(), TrackList::Get(), ProjectHistory::ModifyState(), project, ViewInfo::selectedRegion, NotifyingSelectedRegion::setTimes(), and tracks.

Referenced by DoSelectAll(), DoSelectSomething(), SelectActions::Handler::OnSelectAllTime(), and SelectActions::Handler::OnSelectAllTracks().

Here is the call graph for this function:

Here is the caller graph for this function:

InactivatePlayRegion()

AUDACITY_DLL_API void SelectUtilities::InactivatePlayRegion

(

AudacityProject &

project

)

Definition at line 188 of file SelectUtilities.cpp.

{
   auto &viewInfo = ViewInfo::Get( project );
   auto &playRegion = viewInfo.playRegion;
   auto &selectedRegion = viewInfo.selectedRegion;
   // Set only the times that are fetched by the playback engine, but not
   // the last-active times that are used for display.
   playRegion.SetActive( false );
   playRegion.SetTimes( selectedRegion.t0(), selectedRegion.t1() );
 
   // Ensure the proper state of looping in the menu
   CommandManager::Get(project).UpdateCheckmarks();
}

References CommandManager::Get(), ViewInfo::Get(), project, and CommandManager::UpdateCheckmarks().

Referenced by ClearPlayRegion(), ControlToolBar::OnLoop(), and TogglePlayRegion().

Here is the call graph for this function:

Here is the caller graph for this function:

OnSetRegion()

AUDACITY_DLL_API void SelectUtilities::OnSetRegion	(	AudacityProject &	project,
		bool	left,
		bool	selection,
		const TranslatableString &	dialogTitle
	)

Adjust left or right of selection or play region.

Pop up a dialog if not playing or recording, else use the current play position

Definition at line 230 of file SelectUtilities.cpp.

{
   auto token = ProjectAudioIO::Get( project ).GetAudioIOToken();
   auto &viewInfo = ViewInfo::Get( project );
   auto &playRegion = viewInfo.playRegion;
   auto &selectedRegion = viewInfo.selectedRegion;
   const auto &formats = ProjectNumericFormats::Get( project );
   auto &window = GetProjectFrame( project );
 
   const auto getValue = [&]() -> double {
      if (selection) {
         if (left)
            return selectedRegion.t0();
         else
            return selectedRegion.t1();
      }
      else {
         if (left)
            return playRegion.GetStart();
         else
            return playRegion.GetEnd();
      }
   };
 
   const auto setValue = [&](double value){
      if (selection) {
         if (left)
            selectedRegion.setT0(value, false);
         else
            selectedRegion.setT1(value, false);
      }
      else {
         if (left)
            playRegion.SetStart(value);
         else
            playRegion.SetEnd(value);
      }
   };
 
   bool bSelChanged = false;
   auto gAudioIO = AudioIO::Get();
   if ((token > 0) && gAudioIO->IsStreamActive(token))
   {
      double indicator = gAudioIO->GetStreamTime();
      setValue(indicator);
      bSelChanged = true;
   }
   else
   {
      auto fmt = formats.GetSelectionFormat();
 
      TimeDialog dlg(&window, dialogTitle,
         fmt, project, getValue(), XO("Position"));
 
      if (wxID_OK == dlg.ShowModal())
      {
         //Get the value from the dialog
         setValue( std::max(0.0, dlg.GetTimeValue()) );
         bSelChanged = true;
      }
   }
 
   if (bSelChanged)
      ProjectHistory::Get( project ).ModifyState(false);
}

References AudioIO::Get(), ProjectAudioIO::Get(), ProjectNumericFormats::Get(), ProjectHistory::Get(), ViewInfo::Get(), ProjectAudioIO::GetAudioIOToken(), GetProjectFrame(), TimeDialog::GetTimeValue(), ProjectHistory::ModifyState(), project, and XO().

Referenced by SelectActions::Handler::OnSetLeftSelection(), anonymous_namespace{TransportMenus.cpp}::OnSetPlayRegionIn(), anonymous_namespace{TransportMenus.cpp}::OnSetPlayRegionOut(), and SelectActions::Handler::OnSetRightSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

SelectAllIfNone()

AUDACITY_DLL_API void SelectUtilities::SelectAllIfNone

(

AudacityProject &

project

)

Definition at line 89 of file SelectUtilities.cpp.

{
   auto &viewInfo = ViewInfo::Get( project );
   auto flags = CommandManager::Get( project ).GetUpdateFlags();
   if((flags & EditableTracksSelectedFlag()).none() ||
      viewInfo.selectedRegion.isPoint())
      DoSelectAllAudio( project );
}

References DoSelectAllAudio(), EditableTracksSelectedFlag(), CommandManager::Get(), ViewInfo::Get(), CommandManager::GetUpdateFlags(), none, and project.

Referenced by ImportCommand::Apply(), and EffectUI::DoEffect().

Here is the call graph for this function:

Here is the caller graph for this function:

SelectAllIfNoneAndAllowed()

AUDACITY_DLL_API bool SelectUtilities::SelectAllIfNoneAndAllowed

(

AudacityProject &

project

)

Definition at line 100 of file SelectUtilities.cpp.

{
   auto allowed = gPrefs->ReadBool(wxT("/GUI/SelectAllOnNone"), false);
   auto &viewInfo = ViewInfo::Get( project );
   auto flags = CommandManager::Get( project ).GetUpdateFlags();
 
   if((flags & EditableTracksSelectedFlag()).none() ||
      viewInfo.selectedRegion.isPoint()) {
      if (!allowed) {
         return false;
      }
      DoSelectAllAudio( project );
   }
   return true;
}

References DoSelectAllAudio(), EditableTracksSelectedFlag(), CommandManager::Get(), ViewInfo::Get(), CommandManager::GetUpdateFlags(), gPrefs, none, project, audacity::BasicSettings::ReadBool(), and wxT().

Referenced by MacroCommands::ApplyEffectCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

SelectNone()

AUDACITY_DLL_API void SelectUtilities::SelectNone

(

AudacityProject &

project

)

Definition at line 77 of file SelectUtilities.cpp.

{
   auto &tracks = TrackList::Get( project );
   for (auto t : tracks)
      t->SetSelected(false);
 
   auto &trackPanel = TrackPanel::Get( project );
   trackPanel.Refresh(false);
}

References TrackList::Get(), TrackPanel::Get(), project, and tracks.

Referenced by ProjectFileManager::AddImportedTracks(), anonymous_namespace{ImportMIDI.cpp}::DoImportMIDI(), anonymous_namespace{FileMenus.cpp}::OnImportLabels(), MixerBoardScrolledWindow::OnMouseEvent(), anonymous_namespace{LabelMenus.cpp}::OnNewLabelTrack(), anonymous_namespace{WaveTrackMenuItems.cpp}::OnNewStereoTrack(), anonymous_namespace{TimeTrackMenuItems.cpp}::OnNewTimeTrack(), anonymous_namespace{WaveTrackMenuItems.cpp}::OnNewWaveTrack(), and SelectActions::Handler::OnSelectNone().

Here is the call graph for this function:

Here is the caller graph for this function:

SetPlayRegionToSelection()

AUDACITY_DLL_API void SelectUtilities::SetPlayRegionToSelection

(

AudacityProject &

project

)

Definition at line 222 of file SelectUtilities.cpp.

{
   auto &viewInfo = ViewInfo::Get( project );
   auto &playRegion = viewInfo.playRegion;
   auto &selectedRegion = viewInfo.selectedRegion;
   playRegion.SetAllTimes( selectedRegion.t0(), selectedRegion.t1() );
}

References ViewInfo::Get(), and project.

Referenced by anonymous_namespace{TransportMenus.cpp}::OnSetPlayRegionToSelection(), and AdornedRulerPanel::OnSetPlayRegionToSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

TogglePlayRegion()

AUDACITY_DLL_API void SelectUtilities::TogglePlayRegion

(

AudacityProject &

project

)

Definition at line 202 of file SelectUtilities.cpp.

{
   auto &viewInfo = ViewInfo::Get( project );
   auto &playRegion = viewInfo.playRegion;
   if (playRegion.Active())
      InactivatePlayRegion(project);
   else
      ActivatePlayRegion(project);
}

References ActivatePlayRegion(), ViewInfo::Get(), InactivatePlayRegion(), and project.

Referenced by anonymous_namespace{TransportMenus.cpp}::OnTogglePlayRegion(), and AdornedRulerPanel::OnTogglePlayRegion().

Here is the call graph for this function:

Here is the caller graph for this function: