audacia/src/commands/PreferenceCommands.h

71 lines
2.0 KiB
C++

/**********************************************************************
Audacity: A Digital Audio Editor
Audacity(R) is copyright (c) 1999-2018 Audacity Team.
File License: wxwidgets
PreferenceCommands.h
Dan Horgan
James Crook
******************************************************************//**
\class GetPreferenceCommand
\brief Command for getting the value of a preference
\class SetPreferenceCommand
\brief Command for setting a preference to a given value
*//*******************************************************************/
#ifndef __PREFERENCE_COMMANDS__
#define __PREFERENCE_COMMANDS__
#include "Command.h"
#include "CommandType.h"
// GetPreference
class GetPreferenceCommand final : public AudacityCommand
{
public:
static const ComponentInterfaceSymbol Symbol;
// ComponentInterface overrides
ComponentInterfaceSymbol GetSymbol() override {return Symbol;};
TranslatableString GetDescription() override {return XO("Gets the value of a single preference.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
bool Apply(const CommandContext & context) override;
// AudacityCommand overrides
ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#get_preference";}
wxString mName;
};
// SetPreference
class SetPreferenceCommand final : public AudacityCommand
{
public:
static const ComponentInterfaceSymbol Symbol;
// ComponentInterface overrides
ComponentInterfaceSymbol GetSymbol() override {return Symbol;};
TranslatableString GetDescription() override {return XO("Sets the value of a single preference.");};
bool DefineParams( ShuttleParams & S ) override;
void PopulateOrExchange(ShuttleGui & S) override;
bool Apply(const CommandContext & context) override;
// AudacityCommand overrides
ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#set_preference";}
wxString mName;
wxString mValue;
bool mbReload;
bool bHasReload;
};
#endif /* End of include guard: __PREFERENCE_COMMANDS__ */