Audacity 3.2.0
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
26class wxMenuBar;
27class wxPoint;
28
30{
31public:
33
34 // ComponentInterface overrides
35 ComponentInterfaceSymbol GetSymbol() const override {return Symbol;};
36 TranslatableString GetDescription() const override {return XO("Gets information in JSON format.");};
37 template<bool Const> bool VisitSettings( SettingsVisitorBase<Const> &S );
38 bool VisitSettings( SettingsVisitor & S ) override;
39 bool VisitSettings( ConstSettingsVisitor & S ) override;
40 void PopulateOrExchange(ShuttleGui & S) override;
41
42 // AudacityCommand overrides
43 ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_II#get_info";}
44 bool Apply(const CommandContext &context) override;
45 bool ApplyInner(const CommandContext &context);
46
47public:
50
51private:
52 bool SendCommands(const CommandContext & context, int flags);
53 bool SendMenus(const CommandContext & context);
54 bool SendPreferences(const CommandContext & context);
55 bool SendTracks(const CommandContext & context);
56 bool SendLabels(const CommandContext & context);
57 bool SendClips(const CommandContext & context);
58 bool SendEnvelopes(const CommandContext & context);
59 bool SendBoxes(const CommandContext & context);
60
61 void ExploreMenu( const CommandContext &context, wxMenu * pMenu, int Id, int depth );
62 void ExploreTrackPanel( const CommandContext & context,
63 wxPoint P, int depth );
64 void ExploreAdornments( const CommandContext & context,
65 wxPoint P, wxWindow * pWin, int Id, int depth );
66 void ExploreWindows( const CommandContext & context,
67 wxPoint P, wxWindow * pWin, int Id, int depth );
68
69};
70
71#endif /* End of include guard: __GET_INFO_COMMAND__ */
Contains declaration of Command base class.
Contains declarations for CommandType class.
XO("Cut/Copy/Paste")
#define P(T)
Definition: ToChars.cpp:56
#define S(N)
Definition: ToChars.cpp:64
Base class for command in Audacity.
CommandContext provides additional information to an 'Apply()' command. It provides the project,...
ComponentInterfaceSymbol pairs a persistent string identifier used internally with an optional,...
Command which outputs a list of available menu commands on the status channel.
void ExploreWindows(const CommandContext &context, wxPoint P, wxWindow *pWin, int Id, int depth)
bool Apply(const CommandContext &context) override
bool SendClips(const CommandContext &context)
bool SendCommands(const CommandContext &context, int flags)
bool SendEnvelopes(const CommandContext &context)
bool SendLabels(const CommandContext &context)
void ExploreMenu(const CommandContext &context, wxMenu *pMenu, int Id, int depth)
bool VisitSettings(SettingsVisitorBase< Const > &S)
void PopulateOrExchange(ShuttleGui &S) override
static const ComponentInterfaceSymbol Symbol
void ExploreTrackPanel(const CommandContext &context, wxPoint P, int depth)
bool ApplyInner(const CommandContext &context)
bool SendTracks(const CommandContext &context)
ComponentInterfaceSymbol GetSymbol() const override
bool SendBoxes(const CommandContext &context)
ManualPageID ManualPage() override
bool SendMenus(const CommandContext &context)
bool SendPreferences(const CommandContext &context)
void ExploreAdornments(const CommandContext &context, wxPoint P, wxWindow *pWin, int Id, int depth)
TranslatableString GetDescription() const override
Visitor of effect or command parameters. This is a base class with lots of virtual functions that do ...
Definition: Shuttle.h:115
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:628
Holds a msgid for the translation catalog; may also bind format arguments.