Audacity 3.2.0
SetLabelCommand.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******************************************************************//*******************************************************************/
15
16#ifndef __SET_LABEL_COMMAND__
17#define __SET_LABEL_COMMAND__
18
19#include "Command.h"
20#include "CommandType.h"
21
23{
24public:
26
28 // ComponentInterface overrides
29 ComponentInterfaceSymbol GetSymbol() const override {return Symbol;};
30 TranslatableString GetDescription() const override {return XO("Sets various values for a label.");};
31 template<bool Const> bool VisitSettings( SettingsVisitorBase<Const> &S );
32 bool VisitSettings( SettingsVisitor & S ) override;
33 bool VisitSettings( ConstSettingsVisitor & S ) override;
34 void PopulateOrExchange(ShuttleGui & S) override;
35
36 // AudacityCommand overrides
37 ManualPageID ManualPage() override {return L"Extra_Menu:_Scriptables_I#set_label";}
38
39 bool Apply(const CommandContext & context) override;
40
41public:
42 // zero-based index of the desired label, within the concatenation of the
43 // arrays of labels of all label tracks
45 wxString mText;
46 double mT0;
47 double mT1;
49
50// For tracking optional parameters.
52 bool bHasT0;
53 bool bHasT1;
55};
56
57
58#endif /* End of include guard: __SETTRACKINFOCOMMAND__ */
Contains declaration of Command base class.
Contains declarations for CommandType class.
XO("Cut/Copy/Paste")
#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 that sets label information.
ComponentInterfaceSymbol GetSymbol() const override
TranslatableString GetDescription() const override
ManualPageID ManualPage() override
bool Apply(const CommandContext &context) override
bool VisitSettings(SettingsVisitorBase< Const > &S)
void PopulateOrExchange(ShuttleGui &S) override
static const ComponentInterfaceSymbol Symbol
Visitor of effect or command parameters. This is a base class with lots of virtual functions that do ...
Derived from ShuttleGuiBase, an Audacity specific class for shuttling data to and from GUI.
Definition: ShuttleGui.h:630
Holds a msgid for the translation catalog; may also bind format arguments.