ProjectSettings Class Reference

Holds various per-project settings values, and sends events to the project when certain values change. More...

#include <ProjectSettings.h>

Inheritance diagram for ProjectSettings:

Collaboration diagram for ProjectSettings:

Public Types
enum	EventCode : int { ChangedSyncLock, ChangedProjectRate, ChangedTool }

Public Member Functions
	ProjectSettings (AudacityProject &project)
	ProjectSettings (const ProjectSettings &) PROHIBITED
ProjectSettings &	operator= (const ProjectSettings &) PROHIBITED
bool	GetTracksFitVerticallyZoomed () const
void	SetTracksFitVerticallyZoomed (bool flag)
bool	GetShowId3Dialog () const
void	SetShowId3Dialog (bool flag)
bool	IsSyncLocked () const
void	SetSyncLock (bool flag)
void	SetSnapTo (int snap)
int	GetSnapTo () const
void	SetTool (int tool)
int	GetTool () const
void	SetBrushRadius (int brushRadius)
int	GetBrushRadius () const
void	SetSmartSelection (bool isSelected)
bool	IsSmartSelection () const
void	SetOvertones (bool isSelected)
bool	IsOvertones () const
double	GetPlaySpeed () const
void	SetPlaySpeed (double value)
void	SetSelectionFormat (const NumericFormatSymbol &format)
const NumericFormatSymbol &	GetSelectionFormat () const
void	SetAudioTimeFormat (const NumericFormatSymbol &format)
const NumericFormatSymbol &	GetAudioTimeFormat () const
void	SetFrequencySelectionFormatName (const NumericFormatSymbol &format)
const NumericFormatSymbol &	GetFrequencySelectionFormatName () const
void	SetBandwidthSelectionFormatName (const NumericFormatSymbol &format)
const NumericFormatSymbol &	GetBandwidthSelectionFormatName () const
bool	IsSoloSimple () const
bool	IsSoloNone () const
bool	EmptyCanBeDirty () const
bool	GetShowSplashScreen () const
Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Static Public Member Functions
static ProjectSettings &	Get (AudacityProject &project)
static const ProjectSettings &	Get (const AudacityProject &project)

Private Member Functions
void	UpdatePrefs () override
Private Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdateSelectedPrefs (int id)

Private Attributes
AudacityProject &	mProject
NumericFormatSymbol	mSelectionFormat
NumericFormatSymbol	mFrequencySelectionFormatName
NumericFormatSymbol	mBandwidthSelectionFormatName
NumericFormatSymbol	mAudioTimeFormat
wxString	mSoloPref
std::atomic< double >	mPlaySpeed {}
int	mSnapTo
int	mCurrentTool
int	mCurrentBrushRadius
int	mCurrentBrushHop
bool	mbSmartSelection { false }
bool	mbOvertones { false }
bool	mTracksFitVerticallyZoomed { false }
bool	mShowId3Dialog { true }
bool	mIsSyncLocked { false }
bool	mEmptyCanBeDirty
bool	mShowSplashScreen

Additional Inherited Members
Static Private Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Detailed Description

Holds various per-project settings values, and sends events to the project when certain values change.

Definition at line 58 of file ProjectSettings.h.

Member Enumeration Documentation

EventCode

enum ProjectSettings::EventCode : int

Enumerator
ChangedSyncLock
ChangedProjectRate
ChangedTool

Definition at line 67 of file ProjectSettings.h.

                  : int {
      ChangedSyncLock,
      ChangedProjectRate,
      ChangedTool
   };

Constructor & Destructor Documentation

ProjectSettings() [1/2]

ProjectSettings::ProjectSettings ( AudacityProject &  project )

explicit

Definition at line 52 of file ProjectSettings.cpp.

   : mProject{ project }
   , mSelectionFormat{ NumericTextCtrl::LookupFormat(
      NumericConverter::TIME,
      gPrefs->Read(wxT("/SelectionFormat"), wxT("")))
}
, mAudioTimeFormat{ NumericTextCtrl::LookupFormat(
   NumericConverter::TIME,
   gPrefs->Read(wxT("/AudioTimeFormat"), wxT("hh:mm:ss")))
}
, mFrequencySelectionFormatName{ NumericTextCtrl::LookupFormat(
   NumericConverter::FREQUENCY,
   gPrefs->Read(wxT("/FrequencySelectionFormatName"), wxT("")) )
}
, mBandwidthSelectionFormatName{ NumericTextCtrl::LookupFormat(
   NumericConverter::BANDWIDTH,
   gPrefs->Read(wxT("/BandwidthSelectionFormatName"), wxT("")) )
}
, mSnapTo( gPrefs->Read(wxT("/SnapTo"), SNAP_OFF) )
, mCurrentBrushRadius ( 5 )
{
   gPrefs->Read(wxT("/GUI/SyncLockTracks"), &mIsSyncLocked, false);
 
   bool multiToolActive = false;
   gPrefs->Read(wxT("/GUI/ToolBars/Tools/MultiToolActive"), &multiToolActive);
 
   if (multiToolActive)
      mCurrentTool = ToolCodes::multiTool;
   else
      mCurrentTool = ToolCodes::selectTool;
 
   UpdatePrefs();
}

ProjectSettings() [2/2]

ProjectSettings::ProjectSettings

(

const ProjectSettings &

)

Member Function Documentation

EmptyCanBeDirty()

bool ProjectSettings::EmptyCanBeDirty ( ) const

inline

Definition at line 131 of file ProjectSettings.h.

{ return mEmptyCanBeDirty; }

Get() [1/2]

ProjectSettings & ProjectSettings::Get ( AudacityProject &  project )

static

Definition at line 41 of file ProjectSettings.cpp.

{
   return project.AttachedObjects::Get< ProjectSettings >(
      sProjectSettingsKey );
}

References sProjectSettingsKey.

Referenced by MacroCommands::ApplyCommandInBatchMode(), ProjectSelectionManager::AS_GetSelectionFormat(), ProjectSelectionManager::AS_GetSnapTo(), ProjectSelectionManager::AS_SetSelectionFormat(), ProjectSelectionManager::AS_SetSnapTo(), SelectHandle::Click(), TimeShiftHandle::Click(), anonymous_namespace{ClipMenus.cpp}::DoClipLeftOrRight(), LabelTrackView::DoEditLabels(), Exporter::DoEditMetadata(), SelectUtilities::DoListSelection(), ProjectAudioManager::DoRecord(), ProjectFileManager::DoSave(), TrackUtilities::DoTrackMute(), TrackUtilities::DoTrackSolo(), TrackPanel::DrawTracks(), anonymous_namespace{LabelMenus.cpp}::EditByLabel(), anonymous_namespace{LabelMenus.cpp}::EditClipboardByLabel(), ExportMultipleDialog::ExportMultipleByLabel(), ExportMultipleDialog::ExportMultipleByTrack(), Get(), Effect::GetSelectionFormat(), anonymous_namespace{SelectMenus.cpp}::GridMove(), MixerTrackCluster::HandleResize(), CommonTrackView::HitTest(), NoteTrackAffordanceControls::HitTest(), WaveTrackAffordanceControls::HitTest(), BrushHandle::HitTest(), MuteButtonHandle::HitTest(), SoloButtonHandle::HitTest(), AUPImportFileHandle::Import(), ExportFFmpeg::InitCodecs(), AudacityApp::InitPart2(), IsNotSyncLockedFlag(), IsSyncLockedFlag(), Track::IsSyncLockSelected(), MenuManager::ModifyToolbarMenus(), anonymous_namespace{SelectMenus.cpp}::MoveWhenAudioInactive(), TrackActions::Handler::MuteTracks(), MixerTrackCluster::OnButton_Mute(), ProjectManager::OnCloseWindow(), EditActions::Handler::OnPaste(), SelectActions::Handler::OnSetLeftSelection(), SelectActions::Handler::OnSetRightSelection(), TransportActions::Handler::OnTimerRecord(), ToolsToolBar::OnTool(), ViewActions::Handler::OnUndoPushed(), ProjectFileManager::OpenProjectFile(), TimeToolBar::Populate(), SelectHandle::Preview(), Exporter::Process(), EffectTruncSilence::ProcessIndependently(), SnapManager::Reinit(), StretchHandle::Release(), anonymous_namespace{SelectMenus.cpp}::SeekWhenAudioInactive(), NoteTrackAffordanceHandle::SelectAt(), Exporter::SetAutoExportOptions(), ToolsToolBar::SetCurrentTool(), TranscriptionToolBar::SetPlaySpeed(), SnapManager::Snap(), ProjectSelectionManager::SnapSelection(), ProjectSelectionManager::SSBL_GetBandwidthSelectionFormatName(), ProjectSelectionManager::SSBL_GetFrequencySelectionFormatName(), ProjectSelectionManager::SSBL_SetBandwidthSelectionFormatName(), ProjectSelectionManager::SSBL_SetFrequencySelectionFormatName(), ProjectSelectionManager::TT_GetAudioTimeFormat(), and ProjectSelectionManager::TT_SetAudioTimeFormat().

Get() [2/2]

const ProjectSettings & ProjectSettings::Get ( const AudacityProject &  project )

static

Definition at line 47 of file ProjectSettings.cpp.

{
   return Get( const_cast< AudacityProject & >( project ) );
}

References Get().

Here is the call graph for this function:

GetAudioTimeFormat()

const NumericFormatSymbol & ProjectSettings::GetAudioTimeFormat

(

)

const

Definition at line 154 of file ProjectSettings.cpp.

{
   return mAudioTimeFormat;
}

References mAudioTimeFormat.

GetBandwidthSelectionFormatName()

const NumericFormatSymbol & ProjectSettings::GetBandwidthSelectionFormatName

(

)

const

Definition at line 128 of file ProjectSettings.cpp.

{
   return mBandwidthSelectionFormatName;
}

References mBandwidthSelectionFormatName.

GetBrushRadius()

int ProjectSettings::GetBrushRadius ( ) const

inline

Definition at line 99 of file ProjectSettings.h.

{ return mCurrentBrushRadius; }

GetFrequencySelectionFormatName()

const NumericFormatSymbol & ProjectSettings::GetFrequencySelectionFormatName

(

)

const

Definition at line 116 of file ProjectSettings.cpp.

{
   return mFrequencySelectionFormatName;
}

References mFrequencySelectionFormatName.

GetPlaySpeed()

double ProjectSettings::GetPlaySpeed ( ) const

inline

Definition at line 108 of file ProjectSettings.h.

                               {
      return mPlaySpeed.load( std::memory_order_relaxed ); }

GetSelectionFormat()

const NumericFormatSymbol & ProjectSettings::GetSelectionFormat

(

)

const

Definition at line 144 of file ProjectSettings.cpp.

{
   return mSelectionFormat;
}

References mSelectionFormat.

Referenced by Effect::GetSelectionFormat().

Here is the caller graph for this function:

GetShowId3Dialog()

bool ProjectSettings::GetShowId3Dialog ( ) const

inline

Definition at line 81 of file ProjectSettings.h.

{ return mShowId3Dialog; } //lda

Referenced by Exporter::Process(), and Exporter::SetAutoExportOptions().

Here is the caller graph for this function:

GetShowSplashScreen()

bool ProjectSettings::GetShowSplashScreen ( ) const

inline

Definition at line 133 of file ProjectSettings.h.

{ return mShowSplashScreen; }

Referenced by AudacityApp::InitPart2().

Here is the caller graph for this function:

GetSnapTo()

int ProjectSettings::GetSnapTo

(

)

const

Definition at line 164 of file ProjectSettings.cpp.

{
   return mSnapTo;
}

References mSnapTo.

Referenced by SnapManager::Snap().

Here is the caller graph for this function:

GetTool()

int ProjectSettings::GetTool ( ) const

inline

Definition at line 95 of file ProjectSettings.h.

{ return mCurrentTool; }

Referenced by TimeShiftHandle::Click(), and SelectHandle::Preview().

Here is the caller graph for this function:

GetTracksFitVerticallyZoomed()

bool ProjectSettings::GetTracksFitVerticallyZoomed ( ) const

inline

Definition at line 78 of file ProjectSettings.h.

{ return mTracksFitVerticallyZoomed; } //lda

Referenced by ProjectAudioManager::DoRecord().

Here is the caller graph for this function:

IsOvertones()

bool ProjectSettings::IsOvertones ( ) const

inline

Definition at line 105 of file ProjectSettings.h.

{ return mbOvertones; }

IsSmartSelection()

bool ProjectSettings::IsSmartSelection ( ) const

inline

Definition at line 102 of file ProjectSettings.h.

{ return mbSmartSelection; }

IsSoloNone()

bool ProjectSettings::IsSoloNone ( ) const

inline

Definition at line 129 of file ProjectSettings.h.

{ return mSoloPref == wxT("None"); }

Referenced by MixerTrackCluster::HandleResize(), MuteButtonHandle::HitTest(), and SoloButtonHandle::HitTest().

Here is the caller graph for this function:

IsSoloSimple()

bool ProjectSettings::IsSoloSimple ( ) const

inline

Definition at line 128 of file ProjectSettings.h.

{ return mSoloPref == wxT("Simple"); }

Referenced by MixerTrackCluster::OnButton_Mute().

Here is the caller graph for this function:

IsSyncLocked()

bool ProjectSettings::IsSyncLocked

(

)

const

Definition at line 175 of file ProjectSettings.cpp.

{
#ifdef EXPERIMENTAL_SYNC_LOCK
   return mIsSyncLocked;
#else
   return false;
#endif
}

References mIsSyncLocked.

Referenced by TimeShiftHandle::Click(), anonymous_namespace{LabelMenus.cpp}::EditByLabel(), anonymous_namespace{LabelMenus.cpp}::EditClipboardByLabel(), IsNotSyncLockedFlag(), IsSyncLockedFlag(), and Track::IsSyncLockSelected().

Here is the caller graph for this function:

operator=()

ProjectSettings& ProjectSettings::operator=

(

const ProjectSettings &

)

SetAudioTimeFormat()

void ProjectSettings::SetAudioTimeFormat

(

const NumericFormatSymbol &

format

)

Definition at line 149 of file ProjectSettings.cpp.

{
   mAudioTimeFormat = format;
}

References format, and mAudioTimeFormat.

SetBandwidthSelectionFormatName()

void ProjectSettings::SetBandwidthSelectionFormatName

(

const NumericFormatSymbol &

format

)

Definition at line 133 of file ProjectSettings.cpp.

{
   mBandwidthSelectionFormatName = formatName;
}

References mBandwidthSelectionFormatName.

SetBrushRadius()

void ProjectSettings::SetBrushRadius ( int  brushRadius )

inline

Definition at line 98 of file ProjectSettings.h.

{ mCurrentBrushRadius = brushRadius; }

SetFrequencySelectionFormatName()

void ProjectSettings::SetFrequencySelectionFormatName

(

const NumericFormatSymbol &

format

)

Definition at line 121 of file ProjectSettings.cpp.

{
   mFrequencySelectionFormatName = formatName;
}

References mFrequencySelectionFormatName.

SetOvertones()

void ProjectSettings::SetOvertones ( bool  isSelected )

inline

Definition at line 104 of file ProjectSettings.h.

{ mbOvertones = isSelected; }

SetPlaySpeed()

void ProjectSettings::SetPlaySpeed ( double  value )

inline

Definition at line 110 of file ProjectSettings.h.

                                     {
      mPlaySpeed.store( value, std::memory_order_relaxed ); }

Referenced by TranscriptionToolBar::SetPlaySpeed().

Here is the caller graph for this function:

SetSelectionFormat()

void ProjectSettings::SetSelectionFormat

(

const NumericFormatSymbol &

format

)

Definition at line 139 of file ProjectSettings.cpp.

{
   mSelectionFormat = format;
}

References format, and mSelectionFormat.

SetShowId3Dialog()

void ProjectSettings::SetShowId3Dialog ( bool  flag )

inline

Definition at line 82 of file ProjectSettings.h.

{ mShowId3Dialog = flag; } //lda

References flag.

SetSmartSelection()

void ProjectSettings::SetSmartSelection ( bool  isSelected )

inline

Definition at line 101 of file ProjectSettings.h.

{ mbSmartSelection = isSelected; }

SetSnapTo()

void ProjectSettings::SetSnapTo

(

int

snap

)

Definition at line 159 of file ProjectSettings.cpp.

{
   mSnapTo = snap;
}

References mSnapTo.

SetSyncLock()

void ProjectSettings::SetSyncLock

(

bool

flag

)

Definition at line 184 of file ProjectSettings.cpp.

{
   auto &project = mProject;
   if (flag != mIsSyncLocked) {
      mIsSyncLocked = flag;
      Notify( project, ChangedSyncLock );
   }
}

References ChangedSyncLock, flag, mIsSyncLocked, mProject, and anonymous_namespace{ProjectSettings.cpp}::Notify().

Here is the call graph for this function:

SetTool()

void ProjectSettings::SetTool

(

int

tool

)

Definition at line 170 of file ProjectSettings.cpp.

                                      {
   mCurrentTool = tool;
   Notify( mProject, ChangedTool );
}

References ChangedTool, mCurrentTool, mProject, and anonymous_namespace{ProjectSettings.cpp}::Notify().

Referenced by ToolsToolBar::OnTool(), and ToolsToolBar::SetCurrentTool().

Here is the call graph for this function:

Here is the caller graph for this function:

SetTracksFitVerticallyZoomed()

void ProjectSettings::SetTracksFitVerticallyZoomed ( bool  flag )

inline

Definition at line 79 of file ProjectSettings.h.

{ mTracksFitVerticallyZoomed = flag; } //lda

References flag.

UpdatePrefs()

void ProjectSettings::UpdatePrefs ( )

overrideprivatevirtual

Implements PrefsListener.

Definition at line 86 of file ProjectSettings.cpp.

{
   gPrefs->Read(wxT("/AudioFiles/ShowId3Dialog"), &mShowId3Dialog, true);
   gPrefs->Read(wxT("/GUI/EmptyCanBeDirty"), &mEmptyCanBeDirty, true);
   gPrefs->Read(wxT("/GUI/ShowSplashScreen"), &mShowSplashScreen, true);
   mSoloPref = TracksBehaviorsSolo.Read();
   // Update the old default to the NEW default.
   if (mSoloPref == wxT("Standard"))
      mSoloPref = wxT("Simple");
   gPrefs->Read(wxT("/GUI/TracksFitVerticallyZoomed"),
      &mTracksFitVerticallyZoomed, false);
   //   gPrefs->Read(wxT("/GUI/UpdateSpectrogram"),
   //     &mViewInfo.bUpdateSpectrogram, true);
 
   // This code to change an empty projects rate is currently disabled, after
   // discussion.  The rule 'Default sample rate' only affects newly created
   // projects was felt to be simpler and better.
#if 0
   // The DefaultProjectSample rate is the rate for new projects.
   // Do not change this project's rate, unless there are no tracks.
   if( TrackList::Get( *this ).size() == 0){
      mRate = QualityDefaultSampleRate.Read();
      // If necessary, we change this rate in the selection toolbar too.
      auto bar = SelectionBar::Get( *this );
      bar.SetRate( mRate );
   }
#endif
}

References SelectionBar::Get(), TrackList::Get(), gPrefs, mEmptyCanBeDirty, mShowId3Dialog, mShowSplashScreen, mSoloPref, mTracksFitVerticallyZoomed, ChoiceSetting::Read(), TrackList::size(), and TracksBehaviorsSolo.

Here is the call graph for this function:

Member Data Documentation

mAudioTimeFormat

NumericFormatSymbol ProjectSettings::mAudioTimeFormat

private

Definition at line 143 of file ProjectSettings.h.

Referenced by GetAudioTimeFormat(), and SetAudioTimeFormat().

mBandwidthSelectionFormatName

NumericFormatSymbol ProjectSettings::mBandwidthSelectionFormatName

private

Definition at line 142 of file ProjectSettings.h.

Referenced by GetBandwidthSelectionFormatName(), and SetBandwidthSelectionFormatName().

mbOvertones

bool ProjectSettings::mbOvertones { false }

private

Definition at line 157 of file ProjectSettings.h.

mbSmartSelection

bool ProjectSettings::mbSmartSelection { false }

private

Definition at line 156 of file ProjectSettings.h.

mCurrentBrushHop

int ProjectSettings::mCurrentBrushHop

private

Definition at line 155 of file ProjectSettings.h.

mCurrentBrushRadius

int ProjectSettings::mCurrentBrushRadius

private

Definition at line 154 of file ProjectSettings.h.

mCurrentTool

int ProjectSettings::mCurrentTool

private

Definition at line 153 of file ProjectSettings.h.

Referenced by SetTool().

mEmptyCanBeDirty

bool ProjectSettings::mEmptyCanBeDirty

private

Definition at line 162 of file ProjectSettings.h.

Referenced by UpdatePrefs().

mFrequencySelectionFormatName

NumericFormatSymbol ProjectSettings::mFrequencySelectionFormatName

private

Definition at line 141 of file ProjectSettings.h.

Referenced by GetFrequencySelectionFormatName(), and SetFrequencySelectionFormatName().

mIsSyncLocked

bool ProjectSettings::mIsSyncLocked { false }

private

Definition at line 161 of file ProjectSettings.h.

Referenced by IsSyncLocked(), and SetSyncLock().

mPlaySpeed

std::atomic<double> ProjectSettings::mPlaySpeed {}

private

Definition at line 149 of file ProjectSettings.h.

mProject

AudacityProject& ProjectSettings::mProject

private

Definition at line 138 of file ProjectSettings.h.

Referenced by SetSyncLock(), and SetTool().

mSelectionFormat

NumericFormatSymbol ProjectSettings::mSelectionFormat

private

Definition at line 140 of file ProjectSettings.h.

Referenced by GetSelectionFormat(), and SetSelectionFormat().

mShowId3Dialog

bool ProjectSettings::mShowId3Dialog { true }

private

Definition at line 160 of file ProjectSettings.h.

Referenced by UpdatePrefs().

mShowSplashScreen

bool ProjectSettings::mShowSplashScreen

private

Definition at line 163 of file ProjectSettings.h.

Referenced by UpdatePrefs().

mSnapTo

int ProjectSettings::mSnapTo

private

Definition at line 151 of file ProjectSettings.h.

Referenced by GetSnapTo(), and SetSnapTo().

mSoloPref

wxString ProjectSettings::mSoloPref

private

Definition at line 145 of file ProjectSettings.h.

Referenced by UpdatePrefs().

mTracksFitVerticallyZoomed

bool ProjectSettings::mTracksFitVerticallyZoomed { false }

private

Definition at line 159 of file ProjectSettings.h.

Referenced by UpdatePrefs().

---

The documentation for this class was generated from the following files:

• ProjectSettings.h
• ProjectSettings.cpp