PrefsListener Class Reference

A listener notified of changes in preferences. More...

#include <Prefs.h>

Inheritance diagram for PrefsListener:

Collaboration diagram for PrefsListener:

Classes
struct	Impl

Public Member Functions
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0

Static Public Member Functions
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Protected Member Functions
virtual void	UpdateSelectedPrefs (int id)

Private Attributes
std::unique_ptr< Impl >	mpImpl

Detailed Description

A listener notified of changes in preferences.

Definition at line 651 of file Prefs.h.

Constructor & Destructor Documentation

PrefsListener()

PrefsListener::PrefsListener

(

)

Definition at line 145 of file Prefs.cpp.

   : mpImpl{ std::make_unique<Impl>( *this ) }
{
}

~PrefsListener()

PrefsListener::~PrefsListener ( )

virtual

Definition at line 150 of file Prefs.cpp.

{
}

Member Function Documentation

Broadcast()

void PrefsListener::Broadcast ( int  id = 0 )

static

Call this static function to notify all PrefsListener objects.

Parameters

id

when positive, passed to UpdateSelectedPrefs() of all listeners, meant to indicate that only a certain subset of preferences have changed; else their UpdatePrefs() methods are called. (That is supposed to happen when the user OK's changes in the Preferences dialog.) Callbacks are delayed, in the main thread, using BasicUI::CallAfter

Definition at line 128 of file Prefs.cpp.

{
   BasicUI::CallAfter([id]{
      hub().Publish(id);
   });
}

References BasicUI::CallAfter(), anonymous_namespace{Prefs.cpp}::hub(), and Observer::Publisher< Message, NotifyAll >::Publish().

Referenced by AudioSetupToolBar::CommonMenuItemSteps(), InitPreferences(), AdornedRulerPanel::OnAutoScroll(), DeviceToolBar::OnChoice(), PrefsDialog::OnOK(), and MeterPanel::OnPreferences().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdatePrefs()

void PrefsListener::UpdatePrefs ( )

pure virtual

Implemented in CommandManager, audacity::network_manager::anonymous_namespace{CurlHandleManager.cpp}::CurlConfig, anonymous_namespace{BeatsNumericConverterFormatter.cpp}::BeatsFormatter, anonymous_namespace{ParsedNumericConverterFormatter.cpp}::ParsedNumericConverterFormatter, ProjectFileIO, ProjectStatus, ViewInfo, SpectrogramSettings, WaveformSettings, anonymous_namespace{LogWindow.cpp}::LogWindowUpdater, SpinControl, audacity::cloud::audiocom::sync::CloudSyncStatusField::StatusWidget, AdornedRulerPanel, MacrosWindow, FrequencyPlotDialog, HistoryDialog, NavigationActions::Handler, SelectActions::Handler, MixerBoard, ProjectSettings, ProjectWindow, anonymous_namespace{RealtimeEffectPanel.cpp}::EffectsMenuHelper, RealtimeEffectPanel::PrefsListenerHelper, ThemedButtonWrapper< ButtonBase >, ThemedAButtonWrapper< AButtonBase >, ThemedAButtonWrapper< AButton >, AudioSetupToolBar, ControlToolBar, CutCopyPasteToolBar, DeviceToolBar, EditToolBar, MeterToolBar, SelectionBar, SnappingToolBar, SpectralSelectionBar, TimeSignatureToolBar, TimeToolBar, ToolBar, ToolsToolBar, TranscriptionToolBar, TrackArtist, Settings, TrackPanel, NoteTrackVRulerMenuTable, WaveChannelVRulerMenuTable, TrackMenuTable, Scrubber, and MeterPanel.

Definition at line 154 of file Prefs.cpp.

{
}

Referenced by PrefsListener::Impl::OnEvent(), ThemedButtonWrapper< ButtonBase >::UpdatePrefs(), and ThemedAButtonWrapper< AButtonBase >::UpdatePrefs().

Here is the caller graph for this function:

UpdateSelectedPrefs()

void PrefsListener::UpdateSelectedPrefs ( int  id )

protectedvirtual

Reimplemented in ViewInfo, AudioSetupToolBar, DeviceToolBar, and MeterPanel.

Definition at line 158 of file Prefs.cpp.

{
}

Referenced by PrefsListener::Impl::OnEvent(), AudioSetupToolBar::UpdateSelectedPrefs(), and DeviceToolBar::UpdateSelectedPrefs().

Here is the caller graph for this function:

Member Data Documentation

mpImpl

std::unique_ptr<Impl> PrefsListener::mpImpl

private

Definition at line 680 of file Prefs.h.

---

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

• Prefs.h
• Prefs.cpp