ProjectNumericFormats Class Reference

#include <ProjectNumericFormats.h>

Inheritance diagram for ProjectNumericFormats:

Collaboration diagram for ProjectNumericFormats:

Public Member Functions
	ProjectNumericFormats (const AudacityProject &project)
	~ProjectNumericFormats () override
void	SetSelectionFormat (const NumericFormatID &format)
NumericFormatID	GetSelectionFormat () const
void	SetAudioTimeFormat (const NumericFormatID &format)
NumericFormatID	GetAudioTimeFormat () const
void	SetFrequencySelectionFormatName (const NumericFormatID &format)
NumericFormatID	GetFrequencySelectionFormatName () const
void	SetBandwidthSelectionFormatName (const NumericFormatID &format)
NumericFormatID	GetBandwidthSelectionFormatName () const
NumericFormatSymbol	LookupFormat (const NumericConverterType &type, const wxString &identifier)
Public Member Functions inherited from ClientData::Base
virtual	~Base ()
Public Member Functions inherited from Observer::Publisher< ProjectNumericFormatsEvent >
	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 ProjectNumericFormats &	Get (AudacityProject &project)
static const ProjectNumericFormats &	Get (const AudacityProject &project)

Private Attributes
const AudacityProject &	mProject
NumericFormatID	mSelectionFormat
NumericFormatID	mFrequencySelectionFormatName
NumericFormatID	mBandwidthSelectionFormatName
NumericFormatID	mAudioTimeFormat

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

Detailed Description

Definition at line 31 of file ProjectNumericFormats.h.

Constructor & Destructor Documentation

ProjectNumericFormats()

ProjectNumericFormats::ProjectNumericFormats ( const AudacityProject &  project )

explicit

Definition at line 39 of file ProjectNumericFormats.cpp.

   : mProject { project }
   , mSelectionFormat{
      gPrefs->Read(wxT("/SelectionFormat"), wxT(""))
   }
   , mFrequencySelectionFormatName{
      gPrefs->Read(wxT("/FrequencySelectionFormatName"), wxT(""))
   }
   , mBandwidthSelectionFormatName{
      gPrefs->Read(wxT("/BandwidthSelectionFormatName"), wxT(""))
   }
   , mAudioTimeFormat{
      gPrefs->Read(wxT("/AudioTimeFormat"), wxT("hh:mm:ss"))
   }
{}

~ProjectNumericFormats()

ProjectNumericFormats::~ProjectNumericFormats ( )

overridedefault

Member Function Documentation

Get() [1/2]

ProjectNumericFormats & ProjectNumericFormats::Get ( AudacityProject &  project )

static

Definition at line 28 of file ProjectNumericFormats.cpp.

{
   return project.AttachedObjects::Get<ProjectNumericFormats&>(key);
}

References key, and project.

Referenced by SelectionBar::AddTime(), LabelTrackView::DoEditLabels(), Get(), Effect::GetSelectionFormat(), AUPImportFileHandle::Import(), ProjectSelectionManager::OnFormatsChanged(), SpectralSelectionBar::OnFormatsChanged(), TimeToolBar::OnFormatsChanged(), SelectionBar::OnFormatsChanged(), SelectUtilities::OnSetRegion(), SelectionBar::OnUpdate(), SpectralSelectionBar::OnUpdate(), TimeToolBar::OnUpdate(), SelectionBar::Populate(), SpectralSelectionBar::Populate(), TimeToolBar::Populate(), SnapManager::Reinit(), SpectralSelectionBar::SpectralSelectionBar(), and TimeToolBar::TimeToolBar().

Here is the caller graph for this function:

Get() [2/2]

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

static

Definition at line 33 of file ProjectNumericFormats.cpp.

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

References Get(), and project.

Here is the call graph for this function:

GetAudioTimeFormat()

NumericFormatID ProjectNumericFormats::GetAudioTimeFormat

(

)

const

Definition at line 131 of file ProjectNumericFormats.cpp.

{
   return mAudioTimeFormat;
}

References mAudioTimeFormat.

GetBandwidthSelectionFormatName()

NumericFormatID ProjectNumericFormats::GetBandwidthSelectionFormatName

(

)

const

Definition at line 77 of file ProjectNumericFormats.cpp.

{
   return mBandwidthSelectionFormatName;
}

References mBandwidthSelectionFormatName.

GetFrequencySelectionFormatName()

NumericFormatID ProjectNumericFormats::GetFrequencySelectionFormatName

(

)

const

Definition at line 58 of file ProjectNumericFormats.cpp.

{
   return mFrequencySelectionFormatName;
}

References mFrequencySelectionFormatName.

GetSelectionFormat()

NumericFormatID ProjectNumericFormats::GetSelectionFormat

(

)

const

Definition at line 114 of file ProjectNumericFormats.cpp.

{
   return mSelectionFormat;
}

References mSelectionFormat.

Referenced by Effect::GetSelectionFormat().

Here is the caller graph for this function:

LookupFormat()

NumericFormatSymbol ProjectNumericFormats::LookupFormat	(	const NumericConverterType &	type,
		const wxString &	identifier
	)

Definition at line 82 of file ProjectNumericFormats.cpp.

{
   return NumericConverterFormats::Lookup(
      FormatterContext::ProjectContext(mProject), type, identifier);
}

References NumericConverterFormats::Lookup(), mProject, and FormatterContext::ProjectContext().

Here is the call graph for this function:

SetAudioTimeFormat()

void ProjectNumericFormats::SetAudioTimeFormat

(

const NumericFormatID &

format

)

Definition at line 119 of file ProjectNumericFormats.cpp.

{
   if (mAudioTimeFormat != format) {
      ProjectNumericFormatsEvent e{
         ProjectNumericFormatsEvent::ChangedAudioTimeFormat,
         mAudioTimeFormat, format
      };
      mAudioTimeFormat = format;
      Publish(e);
   }
}

References ProjectNumericFormatsEvent::ChangedAudioTimeFormat, anonymous_namespace{ExportPCM.cpp}::format, mAudioTimeFormat, and Observer::Publisher< ProjectNumericFormatsEvent >::Publish().

Here is the call graph for this function:

SetBandwidthSelectionFormatName()

void ProjectNumericFormats::SetBandwidthSelectionFormatName

(

const NumericFormatID &

format

)

Definition at line 89 of file ProjectNumericFormats.cpp.

{
   if (mBandwidthSelectionFormatName != formatName) {
      ProjectNumericFormatsEvent e{
         ProjectNumericFormatsEvent::ChangedBandwidthFormat,
         mBandwidthSelectionFormatName, formatName
      };
      mBandwidthSelectionFormatName = formatName;
      Publish(e);
   }
}

References ProjectNumericFormatsEvent::ChangedBandwidthFormat, mBandwidthSelectionFormatName, and Observer::Publisher< ProjectNumericFormatsEvent >::Publish().

Here is the call graph for this function:

SetFrequencySelectionFormatName()

void ProjectNumericFormats::SetFrequencySelectionFormatName

(

const NumericFormatID &

format

)

Definition at line 63 of file ProjectNumericFormats.cpp.

{
   if (mFrequencySelectionFormatName != formatName) {
      ProjectNumericFormatsEvent e{
         ProjectNumericFormatsEvent::ChangedFrequencyFormat,
         mFrequencySelectionFormatName, formatName
      };
      mFrequencySelectionFormatName = formatName;
      Publish(e);
   }
}

References ProjectNumericFormatsEvent::ChangedFrequencyFormat, mFrequencySelectionFormatName, and Observer::Publisher< ProjectNumericFormatsEvent >::Publish().

Here is the call graph for this function:

SetSelectionFormat()

void ProjectNumericFormats::SetSelectionFormat

(

const NumericFormatID &

format

)

Definition at line 102 of file ProjectNumericFormats.cpp.

{
   if (mSelectionFormat != format) {
      ProjectNumericFormatsEvent e{
         ProjectNumericFormatsEvent::ChangedSelectionFormat,
         mSelectionFormat, format
      };
      mSelectionFormat = format;
      Publish(e);
   }
}

References ProjectNumericFormatsEvent::ChangedSelectionFormat, anonymous_namespace{ExportPCM.cpp}::format, mSelectionFormat, and Observer::Publisher< ProjectNumericFormatsEvent >::Publish().

Here is the call graph for this function:

Member Data Documentation

mAudioTimeFormat

NumericFormatID ProjectNumericFormats::mAudioTimeFormat

private

Definition at line 65 of file ProjectNumericFormats.h.

Referenced by GetAudioTimeFormat(), and SetAudioTimeFormat().

mBandwidthSelectionFormatName

NumericFormatID ProjectNumericFormats::mBandwidthSelectionFormatName

private

Definition at line 64 of file ProjectNumericFormats.h.

Referenced by GetBandwidthSelectionFormatName(), and SetBandwidthSelectionFormatName().

mFrequencySelectionFormatName

NumericFormatID ProjectNumericFormats::mFrequencySelectionFormatName

private

Definition at line 63 of file ProjectNumericFormats.h.

Referenced by GetFrequencySelectionFormatName(), and SetFrequencySelectionFormatName().

mProject

const AudacityProject& ProjectNumericFormats::mProject

private

Definition at line 60 of file ProjectNumericFormats.h.

Referenced by LookupFormat().

mSelectionFormat

NumericFormatID ProjectNumericFormats::mSelectionFormat

private

Definition at line 62 of file ProjectNumericFormats.h.

Referenced by GetSelectionFormat(), and SetSelectionFormat().

---

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

• ProjectNumericFormats.h
• ProjectNumericFormats.cpp