SettingBase Class Reference

Base class for settings objects. It holds a configuration key path. More...

#include <Prefs.h>

Inheritance diagram for SettingBase:

Collaboration diagram for SettingBase:

Public Member Functions
	SettingBase (const char *path)
	SettingBase (const wxChar *path)
	SettingBase (const wxString &path)
audacity::BasicSettings *	GetConfig () const
const SettingPath &	GetPath () const
bool	Delete ()
	Delete the key if present, and return true iff it was. More...

Protected Member Functions
	SettingBase (const SettingBase &)=default

Protected Attributes
const SettingPath	mPath

Detailed Description

Base class for settings objects. It holds a configuration key path.

Definition at line 79 of file Prefs.h.

Constructor & Destructor Documentation

SettingBase() [1/4]

SettingBase::SettingBase ( const char *  path )

inline

Definition at line 82 of file Prefs.h.

: mPath{ path } {}

SettingBase() [2/4]

SettingBase::SettingBase ( const wxChar *  path )

inline

Definition at line 83 of file Prefs.h.

: mPath{ path } {}

SettingBase() [3/4]

SettingBase::SettingBase ( const wxString &  path )

inline

Definition at line 84 of file Prefs.h.

: mPath{ path } {}

SettingBase() [4/4]

SettingBase::SettingBase ( const SettingBase &  )

protecteddefault

Member Function Documentation

Delete()

bool SettingBase::Delete

(

)

Delete the key if present, and return true iff it was.

Definition at line 549 of file Prefs.cpp.

{
   auto config = GetConfig();
   return config && config->DeleteEntry( GetPath() );
}

References GetConfig(), and GetPath().

Referenced by TracksPrefs::Commit().

Here is the call graph for this function:

Here is the caller graph for this function:

GetConfig()

audacity::BasicSettings * SettingBase::GetConfig

(

)

const

Definition at line 544 of file Prefs.cpp.

{
   return gPrefs;
}

References gPrefs.

Referenced by Delete(), Setting< T >::DoWrite(), Setting< T >::ReadWithDefault(), and Setting< T >::Write().

Here is the caller graph for this function:

GetPath()

const SettingPath & SettingBase::GetPath ( ) const

inline

Definition at line 88 of file Prefs.h.

{ return mPath; }

Referenced by Delete(), ShuttleGuiBase::TieCheckBox(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieCheckBox(), ShuttleGuiBase::TieCheckBoxOnRight(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieCheckBoxOnRight(), ShuttleGuiBase::TieIntegerTextBox(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieIntegerTextBox(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieNumberAsChoice(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieNumericTextBox(), ShuttleGuiBase::TieNumericTextBox(), ShuttleGuiBase::TieSlider(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieSlider(), ShuttleGuiBase::TieSpinCtrl(), anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieSpinCtrl(), ShuttleGuiBase::TieTextBox(), and anonymous_namespace{GetInfoCommand.cpp}::ShuttleGuiGetDefinition::TieTextBox().

Here is the caller graph for this function:

Member Data Documentation

mPath

const SettingPath SettingBase::mPath

protected

Definition at line 95 of file Prefs.h.

Referenced by Setting< T >::DoWrite(), and Setting< T >::ReadWithDefault().

---

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

• Prefs.h
• Prefs.cpp