Audacity  3.0.3
SetProjectCommand.h
Go to the documentation of this file.
1 /**********************************************************************
2 
3  Audacity - A Digital Audio Editor
4  Copyright 1999-2018 Audacity Team
5  License: wxwidgets
6 
7  Dan Horgan
8  James Crook
9 
10 ******************************************************************//*******************************************************************/
16 
17 #ifndef __SET_PROJECT_COMMAND__
18 #define __SET_PROJECT_COMMAND__
19 
20 #include "Command.h"
21 #include "CommandType.h"
22 
24 {
25 public:
27 
29  // ComponentInterface overrides
31  TranslatableString GetDescription() override {return XO("Sets various values for a project.");};
32  bool DefineParams( ShuttleParams & S ) override;
33  void PopulateOrExchange(ShuttleGui & S) override;
34 
35  // AudacityCommand overrides
36  ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#set_project";}
37 
38  bool Apply(const CommandContext & context) override;
39 
40 public:
41 
42  wxString mName;
43  int mPosX;
44  int mPosY;
45  int mWidth;
46  int mHeight;
47  double mRate;
48 
49 // For tracking optional parameters.
50  bool bHasName;
51  bool bHasSizing;
52  bool bHasRate;
53 };
54 
55 
56 #endif /* End of include guard: __SETTRACKINFOCOMMAND__ */
TranslatableString
Holds a msgid for the translation catalog; may also bind format arguments.
Definition: TranslatableString.h:32
SetProjectCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: SetProjectCommand.cpp:54
SetProjectCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: SetProjectCommand.cpp:44
SetProjectCommand::SetProjectCommand
SetProjectCommand()
Definition: SetProjectCommand.cpp:39
XO
#define XO(s)
Definition: Internat.h:31
SetProjectCommand::bHasRate
bool bHasRate
Definition: SetProjectCommand.h:52
ShuttleParams
Shuttle that deals with parameters. This is a base class with lots of virtual functions that do nothi...
Definition: Shuttle.h:62
SetProjectCommand::mPosY
int mPosY
Definition: SetProjectCommand.h:44
ComponentInterfaceSymbol
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Definition: ComponentInterfaceSymbol.h:27
SetProjectCommand::GetSymbol
ComponentInterfaceSymbol GetSymbol() override
Definition: SetProjectCommand.h:30
CommandContext
CommandContext provides additional information to an 'Apply()' command. It provides the project,...
Definition: CommandContext.h:34
SetProjectCommand::bHasName
bool bHasName
Definition: SetProjectCommand.h:50
AudacityCommand
Base class for command in Audacity.
Definition: AudacityCommand.h:41
SetProjectCommand
Command that sets project information.
Definition: SetProjectCommand.h:24
SetProjectCommand::mPosX
int mPosX
Definition: SetProjectCommand.h:43
SetProjectCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: SetProjectCommand.h:26
SetProjectCommand::mRate
double mRate
Definition: SetProjectCommand.h:47
SetProjectCommand::bHasSizing
bool bHasSizing
Definition: SetProjectCommand.h:51
CommandType.h
Contains declarations for CommandType class.
TaggedIdentifier< ManualPageIDTag >
SetProjectCommand::mWidth
int mWidth
Definition: SetProjectCommand.h:45
SetProjectCommand::GetDescription
TranslatableString GetDescription() override
Definition: SetProjectCommand.h:31
SetProjectCommand::mHeight
int mHeight
Definition: SetProjectCommand.h:46
Command.h
Contains declaration of Command base class.
SetProjectCommand::ManualPage
ManualPageID ManualPage() override
Definition: SetProjectCommand.h:36
SetProjectCommand::mName
wxString mName
Definition: SetProjectCommand.h:42
SetProjectCommand::Apply
bool Apply(const CommandContext &context) override
Definition: SetProjectCommand.cpp:75
ShuttleGui
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:631