ShuttlePrefs Class Reference

A kind of Shuttle to exchange data with preferences e.g. the registry. More...

#include <ShuttlePrefs.h>

Public Member Functions
	ShuttlePrefs ()
	~ShuttlePrefs ()
bool	TransferBool (const wxString &Name, bool &bValue, const bool &bDefault)
bool	TransferDouble (const wxString &Name, double &dValue, const double &dDefault)
bool	TransferInt (const wxString &Name, int &iValue, const int &iDefault)
bool	TransferString (const wxString &Name, wxString &strValue, const wxString &strDefault)
bool	TransferWrappedType (const wxString &Name, WrappedType &W)
bool	ExchangeWithMaster (const wxString &Name)

Public Attributes
bool	mbStoreInClient {}
wxString	mValueString

Detailed Description

A kind of Shuttle to exchange data with preferences e.g. the registry.

This class may be used by ShuttleGui to do the two step exchange,

     Gui -- Data -- Prefs

Definition at line 17 of file ShuttlePrefs.h.

Constructor & Destructor Documentation

ShuttlePrefs()

ShuttlePrefs::ShuttlePrefs ( )

inline

Definition at line 24 of file ShuttlePrefs.h.

{}

~ShuttlePrefs()

ShuttlePrefs::~ShuttlePrefs ( )

inline

Definition at line 25 of file ShuttlePrefs.h.

{}

Member Function Documentation

ExchangeWithMaster()

bool ShuttlePrefs::ExchangeWithMaster

(

const wxString &

Name

)

Definition at line 116 of file ShuttlePrefs.cpp.

{
   // ShuttlePrefs is unusual in that it overloads ALL the Transfer functions
   // which it supports.  It doesn't do any string conversion, because wxConv will
   // do so if it is required.
   // So, ExchangeWithMaster should never get called...  Hence the ASSERT here.
   wxASSERT( false );
   return false;
}

TransferBool()

bool ShuttlePrefs::TransferBool	(	const wxString &	Name,
		bool &	bValue,
		const bool &	bDefault
	)

Definition at line 34 of file ShuttlePrefs.cpp.

{
   if( mbStoreInClient )
   {
      bValue = bDefault;
      gPrefs->Read( Name, &bValue );
   }
   else
   {
      return gPrefs->Write( Name, bValue );
   }
   return true;
}

References gPrefs, mbStoreInClient, audacity::BasicSettings::Read(), and audacity::BasicSettings::Write().

Referenced by TransferWrappedType().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferDouble()

bool ShuttlePrefs::TransferDouble	(	const wxString &	Name,
		double &	dValue,
		const double &	dDefault
	)

Definition at line 48 of file ShuttlePrefs.cpp.

{
   if( mbStoreInClient )
   {
      dValue = dDefault;
      gPrefs->Read( Name, &dValue );
   }
   else
   {
      return gPrefs->Write( Name, dValue );
   }
   return true;
}

References gPrefs, mbStoreInClient, audacity::BasicSettings::Read(), and audacity::BasicSettings::Write().

Referenced by TransferWrappedType().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferInt()

bool ShuttlePrefs::TransferInt	(	const wxString &	Name,
		int &	iValue,
		const int &	iDefault
	)

Definition at line 62 of file ShuttlePrefs.cpp.

{
   if( mbStoreInClient )
   {
      iValue = iDefault;
      gPrefs->Read( Name, &iValue );
   }
   else
   {
      return gPrefs->Write( Name, iValue );
   }
   return true;
}

References gPrefs, mbStoreInClient, audacity::BasicSettings::Read(), and audacity::BasicSettings::Write().

Referenced by TransferWrappedType().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferString()

bool ShuttlePrefs::TransferString	(	const wxString &	Name,
		wxString &	strValue,
		const wxString &	strDefault
	)

Definition at line 76 of file ShuttlePrefs.cpp.

{
   if( mbStoreInClient )
   {
      strValue = strDefault;
      gPrefs->Read( Name, &strValue );
   }
   else
   {
      return gPrefs->Write( Name, strValue );
   }
   return true;
}

References gPrefs, mbStoreInClient, audacity::BasicSettings::Read(), and audacity::BasicSettings::Write().

Referenced by TransferWrappedType().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferWrappedType()

bool ShuttlePrefs::TransferWrappedType	(	const wxString &	Name,
		WrappedType &	W
	)

Definition at line 90 of file ShuttlePrefs.cpp.

{
   switch( W.eWrappedType )
   {
   case eWrappedString:
      return TransferString( Name, *W.mpStr, *W.mpStr );
      break;
   case eWrappedInt:
      return TransferInt( Name, *W.mpInt, *W.mpInt );
      break;
   case eWrappedDouble:
      return TransferDouble( Name, *W.mpDouble, *W.mpDouble );
      break;
   case eWrappedBool:
      return TransferBool( Name, *W.mpBool, *W.mpBool );
      break;
   case eWrappedEnum:
      wxASSERT( false );
      break;
   default:
      wxASSERT( false );
      break;
   }
   return false;
}

References eWrappedBool, eWrappedDouble, eWrappedEnum, eWrappedInt, eWrappedString, TransferBool(), TransferDouble(), TransferInt(), TransferString(), and W.

Here is the call graph for this function:

Member Data Documentation

mbStoreInClient

bool ShuttlePrefs::mbStoreInClient {}

Definition at line 20 of file ShuttlePrefs.h.

Referenced by TransferBool(), TransferDouble(), TransferInt(), and TransferString().

mValueString

wxString ShuttlePrefs::mValueString

Definition at line 21 of file ShuttlePrefs.h.

---

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

• ShuttlePrefs.h
• ShuttlePrefs.cpp