Audacity  3.0.3
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
GetTrackInfoCommand Class Referencefinal

Obsolete. GetInfo now does it. More...

#include <GetTrackInfoCommand.h>

Inheritance diagram for GetTrackInfoCommand:
Collaboration diagram for GetTrackInfoCommand:

Public Member Functions

 GetTrackInfoCommand ()
ComponentInterfaceSymbol GetSymbol () override
TranslatableString GetDescription () override
bool DefineParams (ShuttleParams &S) override
void PopulateOrExchange (ShuttleGui &S) override
ManualPageID ManualPage () override
bool Apply (const CommandContext &context) override
- Public Member Functions inherited from AudacityCommand
 AudacityCommand ()
virtual ~AudacityCommand ()
PluginPath GetPath () override
VendorSymbol GetVendor () override
wxString GetVersion () override
virtual bool IsBatchProcessing ()
virtual void SetBatchProcessing (bool start)
virtual bool Apply (const CommandContext &WXUNUSED(context))
bool ShowInterface (wxWindow *parent, bool forceModal=false)
virtual void SetHostUI (EffectUIHostInterface *WXUNUSED(host))
wxDialog * CreateUI (wxWindow *parent, AudacityCommand *client)
virtual bool GetAutomationParameters (wxString &parms)
virtual bool SetAutomationParameters (const wxString &parms)
bool DoAudacityCommand (wxWindow *parent, const CommandContext &context, bool shouldPrompt=true)
int MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
virtual bool Init ()
virtual bool PromptUser (wxWindow *parent)
virtual bool CheckWhetherSkipAudacityCommand ()
virtual void End ()
virtual void PopulateOrExchange (ShuttleGui &WXUNUSED(S))
virtual bool TransferDataToWindow ()
virtual bool TransferDataFromWindow ()
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
TranslatableString GetName ()
virtual bool DefineParams (ShuttleParams &WXUNUSED(S))

Public Attributes

int mInfoType

Static Public Attributes

static const ComponentInterfaceSymbol Symbol { XO("Get Track Info") }

Additional Inherited Members

- Public Types inherited from AudacityCommand
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
using VetoDialogHook = bool(*)(wxDialog *)
- Static Public Member Functions inherited from AudacityCommand
static VetoDialogHook SetVetoDialogHook (VetoDialogHook hook)
- Protected Attributes inherited from AudacityCommand
wxDialog * mUIDialog
wxWindow * mUIParent
int mUIResultID

Detailed Description

Obsolete. GetInfo now does it.

Definition at line 22 of file GetTrackInfoCommand.h.

Constructor & Destructor Documentation

◆ GetTrackInfoCommand()

GetTrackInfoCommand::GetTrackInfoCommand ( )

Definition at line 42 of file GetTrackInfoCommand.cpp.

43 {
44  mInfoType = 0;
45 }

References mInfoType.

Member Function Documentation

◆ Apply()

bool GetTrackInfoCommand::Apply ( const CommandContext context)

Definition at line 66 of file GetTrackInfoCommand.cpp.

67 {
68  return false;
69 }

◆ DefineParams()

bool GetTrackInfoCommand::DefineParams ( ShuttleParams S)

Definition at line 47 of file GetTrackInfoCommand.cpp.

47  {
48  S.DefineEnum( mInfoType, wxT("Type"), 0, kTypes, nTypes );
50  return true;
51 }

References ShuttleParams::DefineEnum(), mInfoType, and nTypes.

Here is the call graph for this function:

◆ GetDescription()

TranslatableString GetTrackInfoCommand::GetDescription ( )

Reimplemented from AudacityCommand.

Definition at line 30 of file GetTrackInfoCommand.h.

30 {return XO("Gets track values as JSON.");};

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol GetTrackInfoCommand::GetSymbol ( )

Implements AudacityCommand.

Definition at line 29 of file GetTrackInfoCommand.h.

29 {return Symbol;};

References Symbol.

◆ ManualPage()

ManualPageID GetTrackInfoCommand::ManualPage ( )

Reimplemented from AudacityCommand.

Definition at line 35 of file GetTrackInfoCommand.h.

35 {return L"Extra_Menu:_Tools#get_track_info";}

◆ PopulateOrExchange()

void GetTrackInfoCommand::PopulateOrExchange ( ShuttleGui S)

Definition at line 53 of file GetTrackInfoCommand.cpp.

54 {
55  S.AddSpace(0, 5);
57  S.StartMultiColumn(2, wxALIGN_CENTER);
58  {
59  S.TieChoice( XXO("Types:"), mInfoType, Msgids( kTypes, nTypes ));
60  }
61  S.EndMultiColumn();
62 }

References ShuttleGui::AddSpace(), ShuttleGuiBase::EndMultiColumn(), mInfoType, Msgids(), nTypes, ShuttleGuiBase::StartMultiColumn(), ShuttleGuiBase::TieChoice(), and XXO.

Here is the call graph for this function:

Member Data Documentation

◆ mInfoType

int GetTrackInfoCommand::mInfoType

Definition at line 39 of file GetTrackInfoCommand.h.

Referenced by DefineParams(), GetTrackInfoCommand(), and PopulateOrExchange().

◆ Symbol

const ComponentInterfaceSymbol GetTrackInfoCommand::Symbol { XO("Get Track Info") }

Definition at line 25 of file GetTrackInfoCommand.h.

Referenced by GetSymbol().

The documentation for this class was generated from the following files:
int mInfoType
Definition: GetTrackInfoCommand.h:39
wxSizerItem * AddSpace(int width, int height, int prop=0)
Definition: ShuttleGui.cpp:2459
#define XO(s)
Definition: Internat.h:31
void EndMultiColumn()
Definition: ShuttleGui.cpp:1238
const int nTypes
Definition: GetTrackInfoCommand.cpp:33
#define XXO(s)
Definition: Internat.h:44
void StartMultiColumn(int nCols, int PositionFlags=wxALIGN_LEFT)
Definition: ShuttleGui.cpp:1229
virtual void DefineEnum(int &var, const wxChar *key, const int vdefault, const EnumValueSymbol strings[], size_t nStrings)
Definition: Shuttle.cpp:339
TranslatableStrings Msgids(const EnumValueSymbol strings[], size_t nStrings)
Convenience function often useful when adding choice controls.
Definition: ShuttleGui.cpp:2522
Definition: Noise.cpp:34
wxChoice * TieChoice(const TranslatableString &Prompt, TranslatableString &Selected, const TranslatableStrings &choices)
Definition: ShuttleGui.cpp:1727
static const ComponentInterfaceSymbol Symbol
Definition: GetTrackInfoCommand.h:25