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 Member Functions
	ProjectSettings (AudacityProject &project)
	ProjectSettings (const ProjectSettings &)=delete
ProjectSettings &	operator= (const ProjectSettings &)=delete
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
bool	EmptyCanBeDirty () const
bool	GetShowSplashScreen () const
Public Member Functions inherited from ClientData::Base
virtual	~Base ()
Public Member Functions inherited from Observer::Publisher< ProjectSettingsEvent >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...
	Publisher (Publisher &&)=default
Publisher &	operator= (Publisher &&)=default
Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...
Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

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	UpdatePrefs ()=0
virtual void	UpdateSelectedPrefs (int id)

Private Attributes
AudacityProject &	mProject
int	mCurrentTool
int	mCurrentBrushRadius
int	mCurrentBrushHop
bool	mbSmartSelection { false }
bool	mbOvertones { false }
bool	mEmptyCanBeDirty
bool	mShowSplashScreen

Additional Inherited Members
Public Types inherited from Observer::Publisher< ProjectSettingsEvent >
using	message_type = ProjectSettingsEvent
using	CallbackReturn = std::conditional_t< true, void, bool >
using	Callback = std::function< CallbackReturn(const ProjectSettingsEvent &) >
	Type of functions that can be connected to the Publisher. More...
Static Public Attributes inherited from Observer::Publisher< ProjectSettingsEvent >
static constexpr bool	notifies_all
Protected Member Functions inherited from Observer::Publisher< ProjectSettingsEvent >
CallbackReturn	Publish (const ProjectSettingsEvent &message)
	Send a message to connected callbacks. More...
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 52 of file ProjectSettings.h.

Constructor & Destructor Documentation

ProjectSettings() [1/2]

ProjectSettings::ProjectSettings ( AudacityProject &  project )

explicit

Definition at line 39 of file ProjectSettings.cpp.

   : mProject{ project }
   , mCurrentBrushRadius ( 5 )
{
   bool multiToolActive = false;
   gPrefs->Read(wxT("/GUI/ToolBars/Tools/MultiToolActive"), &multiToolActive);
 
   if (multiToolActive)
      mCurrentTool = ToolCodes::multiTool;
   else
      mCurrentTool = ToolCodes::selectTool;
 
   UpdatePrefs();
}

References gPrefs, mCurrentTool, ToolCodes::multiTool, audacity::BasicSettings::Read(), ToolCodes::selectTool, UpdatePrefs(), and wxT().

Here is the call graph for this function:

ProjectSettings() [2/2]

ProjectSettings::ProjectSettings ( const ProjectSettings &  )

delete

Member Function Documentation

EmptyCanBeDirty()

bool ProjectSettings::EmptyCanBeDirty ( ) const

inline

Definition at line 80 of file ProjectSettings.h.

{ return mEmptyCanBeDirty; }

Get() [1/2]

ProjectSettings & ProjectSettings::Get ( AudacityProject &  project )

static

Definition at line 28 of file ProjectSettings.cpp.

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

References project, and sProjectSettingsKey.

Referenced by MacroCommands::ApplyCommandInBatchMode(), BrushHandleHitTest(), TimeShiftHandle::Click(), ProjectFileManager::DoSave(), ToolsToolBar::DoToolChanged(), TrackPanel::DrawTracks(), Get(), CommonChannelView::HitTest(), NoteTrackAffordanceControls::HitTest(), WaveTrackAffordanceControls::HitTest(), AudacityApp::InitPart2(), Scrubber::MaybeStartScrubbing(), anonymous_namespace{TrackMenus.cpp}::MuteTracks(), ProjectManager::OnCloseWindow(), anonymous_namespace{ToolsToolBar.cpp}::OnNextTool(), anonymous_namespace{ToolsToolBar.cpp}::OnPrevTool(), anonymous_namespace{TimerRecordDialog.cpp}::OnTimerRecord(), ToolsToolBar::OnTool(), SelectHandle::Preview(), anonymous_namespace{ToolsToolBar.cpp}::SetTool(), and ToolsToolBar::ToolsToolBar().

Here is the caller graph for this function:

Get() [2/2]

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

static

Definition at line 34 of file ProjectSettings.cpp.

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

References Get(), and project.

Here is the call graph for this function:

GetBrushRadius()

int ProjectSettings::GetBrushRadius ( ) const

inline

Definition at line 72 of file ProjectSettings.h.

{ return mCurrentBrushRadius; }

Referenced by BrushHandle::BrushHandle().

Here is the caller graph for this function:

GetShowSplashScreen()

bool ProjectSettings::GetShowSplashScreen ( ) const

inline

Definition at line 82 of file ProjectSettings.h.

{ return mShowSplashScreen; }

Referenced by AudacityApp::InitPart2().

Here is the caller graph for this function:

GetTool()

int ProjectSettings::GetTool ( ) const

inline

Definition at line 68 of file ProjectSettings.h.

{ return mCurrentTool; }

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

Here is the caller graph for this function:

IsOvertones()

bool ProjectSettings::IsOvertones ( ) const

inline

Definition at line 78 of file ProjectSettings.h.

{ return mbOvertones; }

Referenced by BrushHandle::BrushHandle().

Here is the caller graph for this function:

IsSmartSelection()

bool ProjectSettings::IsSmartSelection ( ) const

inline

Definition at line 75 of file ProjectSettings.h.

{ return mbSmartSelection; }

Referenced by BrushHandle::BrushHandle().

Here is the caller graph for this function:

operator=()

ProjectSettings & ProjectSettings::operator= ( const ProjectSettings &  )

delete

SetBrushRadius()

void ProjectSettings::SetBrushRadius ( int  brushRadius )

inline

Definition at line 71 of file ProjectSettings.h.

{ mCurrentBrushRadius = brushRadius; }

SetOvertones()

void ProjectSettings::SetOvertones ( bool  isSelected )

inline

Definition at line 77 of file ProjectSettings.h.

{ mbOvertones = isSelected; }

SetSmartSelection()

void ProjectSettings::SetSmartSelection ( bool  isSelected )

inline

Definition at line 74 of file ProjectSettings.h.

{ mbSmartSelection = isSelected; }

SetTool()

void ProjectSettings::SetTool

(

int

tool

)

Definition at line 76 of file ProjectSettings.cpp.

                                      {
   if (auto oldValue = mCurrentTool; tool != oldValue) {
      mCurrentTool = tool;
      Publish({ ProjectSettingsEvent::ChangedTool, oldValue, tool });
   }
}

References ProjectSettingsEvent::ChangedTool, mCurrentTool, and Observer::Publisher< ProjectSettingsEvent >::Publish().

Referenced by ToolsToolBar::OnTool(), and anonymous_namespace{ToolsToolBar.cpp}::SetTool().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdatePrefs()

void ProjectSettings::UpdatePrefs ( )

overrideprivatevirtual

Implements PrefsListener.

Definition at line 54 of file ProjectSettings.cpp.

{
   gPrefs->Read(wxT("/GUI/EmptyCanBeDirty"), &mEmptyCanBeDirty, true);
   gPrefs->Read(wxT("/GUI/ShowSplashScreen"), &mShowSplashScreen, true);
   //   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 TrackList::Get(), SelectionBar::Get(), gPrefs, mEmptyCanBeDirty, mShowSplashScreen, audacity::BasicSettings::Read(), and wxT().

Referenced by ProjectSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mbOvertones

bool ProjectSettings::mbOvertones { false }

private

Definition at line 93 of file ProjectSettings.h.

mbSmartSelection

bool ProjectSettings::mbSmartSelection { false }

private

Definition at line 92 of file ProjectSettings.h.

mCurrentBrushHop

int ProjectSettings::mCurrentBrushHop

private

Definition at line 91 of file ProjectSettings.h.

mCurrentBrushRadius

int ProjectSettings::mCurrentBrushRadius

private

Definition at line 90 of file ProjectSettings.h.

mCurrentTool

int ProjectSettings::mCurrentTool

private

Definition at line 89 of file ProjectSettings.h.

Referenced by ProjectSettings(), and SetTool().

mEmptyCanBeDirty

bool ProjectSettings::mEmptyCanBeDirty

private

Definition at line 95 of file ProjectSettings.h.

Referenced by UpdatePrefs().

mProject

AudacityProject& ProjectSettings::mProject

private

Definition at line 87 of file ProjectSettings.h.

mShowSplashScreen

bool ProjectSettings::mShowSplashScreen

private

Definition at line 96 of file ProjectSettings.h.

Referenced by UpdatePrefs().

---

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

• ProjectSettings.h
• ProjectSettings.cpp