Audacity  3.0.3
GetInfoCommand.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  James Crook
8 
9 ******************************************************************//*******************************************************************/
19 
20 #ifndef __GET_INFO_COMMAND__
21 #define __GET_INFO_COMMAND__
22 
23 #include "Command.h"
24 #include "CommandType.h"
25 
26 class wxMenuBar;
27 class wxPoint;
28 
30 {
31 public:
33 
34  // ComponentInterface overrides
36  TranslatableString GetDescription() override {return XO("Gets information in JSON format.");};
37  bool DefineParams( ShuttleParams & S ) override;
38  void PopulateOrExchange(ShuttleGui & S) override;
39 
40  // AudacityCommand overrides
41  ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#get_info";}
42  bool Apply(const CommandContext &context) override;
43  bool ApplyInner(const CommandContext &context);
44 
45 public:
46  int mInfoType;
47  int mFormat;
48 
49 private:
50  bool SendCommands(const CommandContext & context, int flags);
51  bool SendMenus(const CommandContext & context);
52  bool SendPreferences(const CommandContext & context);
53  bool SendTracks(const CommandContext & context);
54  bool SendLabels(const CommandContext & context);
55  bool SendClips(const CommandContext & context);
56  bool SendEnvelopes(const CommandContext & context);
57  bool SendBoxes(const CommandContext & context);
58 
59  void ExploreMenu( const CommandContext &context, wxMenu * pMenu, int Id, int depth );
60  void ExploreTrackPanel( const CommandContext & context,
61  wxPoint P, int depth );
62  void ExploreAdornments( const CommandContext & context,
63  wxPoint P, wxWindow * pWin, int Id, int depth );
64  void ExploreWindows( const CommandContext & context,
65  wxPoint P, wxWindow * pWin, int Id, int depth );
66 
67 };
68 
69 #endif /* End of include guard: __GET_INFO_COMMAND__ */
GetInfoCommand::SendClips
bool SendClips(const CommandContext &context)
Definition: GetInfoCommand.cpp:510
TranslatableString
Holds a msgid for the translation catalog; may also bind format arguments.
Definition: TranslatableString.h:32
GetInfoCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: GetInfoCommand.h:32
GetInfoCommand::SendTracks
bool SendTracks(const CommandContext &context)
Definition: GetInfoCommand.cpp:463
GetInfoCommand::SendEnvelopes
bool SendEnvelopes(const CommandContext &context)
Definition: GetInfoCommand.cpp:535
XO
#define XO(s)
Definition: Internat.h:31
GetInfoCommand::SendBoxes
bool SendBoxes(const CommandContext &context)
Definition: GetInfoCommand.cpp:433
ShuttleParams
Shuttle that deals with parameters. This is a base class with lots of virtual functions that do nothi...
Definition: Shuttle.h:62
GetInfoCommand::SendPreferences
bool SendPreferences(const CommandContext &context)
Definition: GetInfoCommand.cpp:399
GetInfoCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: GetInfoCommand.cpp:111
GetInfoCommand
Command which outputs a list of available menu commands on the status channel.
Definition: GetInfoCommand.h:30
GetInfoCommand::ExploreMenu
void ExploreMenu(const CommandContext &context, wxMenu *pMenu, int Id, int depth)
Definition: GetInfoCommand.cpp:622
ComponentInterfaceSymbol
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Definition: ComponentInterfaceSymbol.h:27
GetInfoCommand::GetDescription
TranslatableString GetDescription() override
Definition: GetInfoCommand.h:36
GetInfoCommand::mInfoType
int mInfoType
Definition: GetInfoCommand.h:46
GetInfoCommand::ManualPage
ManualPageID ManualPage() override
Definition: GetInfoCommand.h:41
CommandContext
CommandContext provides additional information to an 'Apply()' command. It provides the project,...
Definition: CommandContext.h:34
AudacityCommand
Base class for command in Audacity.
Definition: AudacityCommand.h:41
GetInfoCommand::ExploreTrackPanel
void ExploreTrackPanel(const CommandContext &context, wxPoint P, int depth)
Definition: GetInfoCommand.cpp:698
GetInfoCommand::ExploreAdornments
void ExploreAdornments(const CommandContext &context, wxPoint P, wxWindow *pWin, int Id, int depth)
Definition: GetInfoCommand.cpp:671
GetInfoCommand::ExploreWindows
void ExploreWindows(const CommandContext &context, wxPoint P, wxWindow *pWin, int Id, int depth)
Definition: GetInfoCommand.cpp:727
GetInfoCommand::Apply
bool Apply(const CommandContext &context) override
Definition: GetInfoCommand.cpp:125
GetInfoCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: GetInfoCommand.cpp:105
CommandType.h
Contains declarations for CommandType class.
GetInfoCommand::mFormat
int mFormat
Definition: GetInfoCommand.h:47
GetInfoCommand::GetSymbol
ComponentInterfaceSymbol GetSymbol() override
Definition: GetInfoCommand.h:35
TaggedIdentifier< ManualPageIDTag >
GetInfoCommand::ApplyInner
bool ApplyInner(const CommandContext &context)
Definition: GetInfoCommand.cpp:151
GetInfoCommand::SendLabels
bool SendLabels(const CommandContext &context)
Definition: GetInfoCommand.cpp:577
Command.h
Contains declaration of Command base class.
GetInfoCommand::SendCommands
bool SendCommands(const CommandContext &context, int flags)
Definition: GetInfoCommand.cpp:415
ShuttleGui
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:631
GetInfoCommand::SendMenus
bool SendMenus(const CommandContext &context)
Definition: GetInfoCommand.cpp:169