Audacity 3.2.0
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 () const override
TranslatableString GetDescription () const override
template<bool Const>
bool VisitSettings (SettingsVisitorBase< Const > &S)
bool VisitSettings (SettingsVisitor &S) override
bool VisitSettings (ConstSettingsVisitor &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 () const override
VendorSymbol GetVendor () const override
wxString GetVersion () const override
ComponentInterfaceSymbol GetSymbol () const override=0
virtual TranslatableString GetDescription () const override
virtual ManualPageID ManualPage ()
virtual bool IsBatchProcessing () const
virtual void SetBatchProcessing (bool start)
virtual bool Apply (const CommandContext &WXUNUSED(context))
bool ShowInterface (wxWindow *parent, bool forceModal=false)
wxDialog * CreateUI (wxWindow *parent, AudacityCommand *client)
bool SaveSettingsAsString (wxString &parms)
bool LoadSettingsFromString (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 ()
virtual bool VisitSettings (SettingsVisitor &)
virtual bool VisitSettings (ConstSettingsVisitor &)
- Public Member Functions inherited from ComponentInterface
virtual ~ComponentInterface ()
virtual PluginPath GetPath () const =0
virtual ComponentInterfaceSymbol GetSymbol () const =0
virtual VendorSymbol GetVendor () const =0
virtual wxString GetVersion () const =0
virtual TranslatableString GetDescription () const =0
TranslatableString GetName () const

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 }
- Protected Attributes inherited from AudacityCommand
wxDialog * mUIDialog
wxWindow * mUIParent

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.

44 mInfoType = 0;

References mInfoType.

Member Function Documentation

◆ Apply()

bool GetTrackInfoCommand::Apply ( const CommandContext context)

Definition at line 73 of file GetTrackInfoCommand.cpp.

75 return false;

◆ GetDescription()

TranslatableString GetTrackInfoCommand::GetDescription ( ) const

Reimplemented from AudacityCommand.

Definition at line 30 of file GetTrackInfoCommand.h.

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

References XO().

Here is the call graph for this function:

◆ GetSymbol()

ComponentInterfaceSymbol GetTrackInfoCommand::GetSymbol ( ) const

Implements AudacityCommand.

Definition at line 29 of file GetTrackInfoCommand.h.

29{return Symbol;};
static const ComponentInterfaceSymbol Symbol

References Symbol.

◆ ManualPage()

ManualPageID GetTrackInfoCommand::ManualPage ( )

Reimplemented from AudacityCommand.

Definition at line 37 of file GetTrackInfoCommand.h.

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

◆ PopulateOrExchange()

void GetTrackInfoCommand::PopulateOrExchange ( ShuttleGui S)

Definition at line 60 of file GetTrackInfoCommand.cpp.

62 S.AddSpace(0, 5);
64 S.StartMultiColumn(2, wxALIGN_CENTER);
65 {
66 S.TieChoice( XXO("Types:"), mInfoType, Msgids( kTypes, nTypes ));
67 }
68 S.EndMultiColumn();
XXO("&Cut/Copy/Paste Toolbar")
static const EnumValueSymbol kTypes[nTypes]
const int nTypes
TranslatableStrings Msgids(const EnumValueSymbol strings[], size_t nStrings)
Convenience function often useful when adding choice controls.
#define S(N)
Definition: ToChars.cpp:64

References kTypes, mInfoType, Msgids(), nTypes, S, and XXO().

Here is the call graph for this function:

◆ VisitSettings() [1/3]

bool GetTrackInfoCommand::VisitSettings ( ConstSettingsVisitor )

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 57 of file GetTrackInfoCommand.cpp.

58 { return VisitSettings<true>(S); }

References S.

◆ VisitSettings() [2/3]

bool GetTrackInfoCommand::VisitSettings ( SettingsVisitor )

Visit settings, if defined. false means no defined settings. Default implementation returns false

Reimplemented from AudacityCommand.

Definition at line 54 of file GetTrackInfoCommand.cpp.

55 { return VisitSettings<false>(S); }

References S.

◆ VisitSettings() [3/3]

template<bool Const>
bool GetTrackInfoCommand::VisitSettings ( SettingsVisitorBase< Const > &  S)

Definition at line 48 of file GetTrackInfoCommand.cpp.

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

References kTypes, mInfoType, nTypes, S, and wxT().

Here is the call graph for this function:

Member Data Documentation

◆ mInfoType

int GetTrackInfoCommand::mInfoType

Definition at line 41 of file GetTrackInfoCommand.h.

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

◆ 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: