GetPreferenceCommand Class Reference

Command for getting the value of a preference. More...

#include <PreferenceCommands.h>

Inheritance diagram for GetPreferenceCommand:

Collaboration diagram for GetPreferenceCommand:

Public Member Functions
ComponentInterfaceSymbol	GetSymbol () const override
TranslatableString	GetDescription () const override
template<bool Const>
bool	VisitSettings (SettingsVisitorBase< Const > &S)
bool	VisitSettings (SettingsVisitor &S) override
bool	VisitSettings (ConstSettingsVisitor &S) override
void	PopulateOrExchange (ShuttleGui &S) override
bool	Apply (const CommandContext &context) override
ManualPageID	ManualPage () override
Public Member Functions inherited from AudacityCommand
	AudacityCommand ()
virtual	~AudacityCommand ()
PluginPath	GetPath () const override
VendorSymbol	GetVendor () const override
wxString	GetVersion () const override
ComponentInterfaceSymbol	GetSymbol () const override=0
virtual TranslatableString	GetDescription () const override
virtual ManualPageID	ManualPage ()
virtual bool	IsBatchProcessing () const
virtual void	SetBatchProcessing (bool start)
virtual bool	Apply (const CommandContext &WXUNUSED(context))
bool	ShowInterface (wxWindow *parent, bool forceModal=false)
wxDialog *	CreateUI (wxWindow *parent, AudacityCommand *client)
bool	SaveSettingsAsString (wxString &parms)
bool	LoadSettingsFromString (const wxString &parms)
bool	DoAudacityCommand (wxWindow *parent, const CommandContext &context, bool shouldPrompt=true)
int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
virtual bool	Init ()
virtual bool	PromptUser (wxWindow *parent)
virtual bool	CheckWhetherSkipAudacityCommand ()
virtual void	End ()
virtual void	PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual bool	TransferDataToWindow ()
virtual bool	TransferDataFromWindow ()
virtual bool	VisitSettings (SettingsVisitor &)
virtual bool	VisitSettings (ConstSettingsVisitor &)
Public Member Functions inherited from ComponentInterface
virtual	~ComponentInterface ()
virtual PluginPath	GetPath () const =0
virtual ComponentInterfaceSymbol	GetSymbol () const =0
virtual VendorSymbol	GetVendor () const =0
virtual wxString	GetVersion () const =0
virtual TranslatableString	GetDescription () const =0
TranslatableString	GetName () const

Public Attributes
wxString	mName

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Get Preference") }

Additional Inherited Members
Public Types inherited from AudacityCommand
enum	: long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
Protected Attributes inherited from AudacityCommand
ProgressDialog *	mProgress
wxDialog *	mUIDialog
wxWindow *	mUIParent

Detailed Description

Command for getting the value of a preference.

Definition at line 29 of file PreferenceCommands.h.

Member Function Documentation

Apply()

bool GetPreferenceCommand::Apply ( const CommandContext &  context )

override

Definition at line 60 of file PreferenceCommands.cpp.

{
   wxString prefValue;
   if (!gPrefs->Read(mName, &prefValue))
      return false;
 
   context.Status(prefValue);
   return true;
}

References gPrefs, mName, audacity::BasicSettings::Read(), and CommandContext::Status().

Here is the call graph for this function:

GetDescription()

TranslatableString GetPreferenceCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 36 of file PreferenceCommands.h.

{return XO("Gets the value of a single preference.");};

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol GetPreferenceCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 35 of file PreferenceCommands.h.

{return Symbol;};

References Symbol.

ManualPage()

ManualPageID GetPreferenceCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 44 of file PreferenceCommands.h.

{return L"Extra_Menu:_Scriptables_I#get_preference";}

PopulateOrExchange()

void GetPreferenceCommand::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 48 of file PreferenceCommands.cpp.

{
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(2, wxALIGN_CENTER);
   {
      S.TieTextBox(XXO("Name:"),mName);
   }
   S.EndMultiColumn();
}

References mName, S, and XXO().

Here is the call graph for this function:

VisitSettings() [1/3]

bool GetPreferenceCommand::VisitSettings ( ConstSettingsVisitor &  )

overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 45 of file PreferenceCommands.cpp.

   { return VisitSettings<true>(S); }

References S.

VisitSettings() [2/3]

bool GetPreferenceCommand::VisitSettings ( SettingsVisitor &  )

overridevirtual

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 42 of file PreferenceCommands.cpp.

   { return VisitSettings<false>(S); }

References S.

VisitSettings() [3/3]

template<bool Const>

bool GetPreferenceCommand::VisitSettings

(

SettingsVisitorBase< Const > &

S

)

Definition at line 37 of file PreferenceCommands.cpp.

                                                                        {
   S.Define( mName, wxT("Name"),   wxString{} );
   return true;
}

References mName, S, and wxT().

Here is the call graph for this function:

Member Data Documentation

mName

wxString GetPreferenceCommand::mName

Definition at line 46 of file PreferenceCommands.h.

Referenced by Apply(), PopulateOrExchange(), and VisitSettings().

Symbol

const ComponentInterfaceSymbol GetPreferenceCommand::Symbol { XO("Get Preference") }

static

Definition at line 32 of file PreferenceCommands.h.

Referenced by GetSymbol().

---

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

• PreferenceCommands.h
• PreferenceCommands.cpp