Audacity 3.2.0
Public Member Functions | Static Public Attributes | Private Attributes | List of all members
SetTrackCommand Class Reference

A SetTrackBase that combines SetTrackStatusCommand, SetTrackAudioCommand and SetTrackVisualsCommand. More...

#include <SetTrackInfoCommand.h>

Inheritance diagram for SetTrackCommand:
[legend]
Collaboration diagram for SetTrackCommand:
[legend]

Public Member Functions

 SetTrackCommand ()
 
ComponentInterfaceSymbol GetSymbol () const override
 
TranslatableString GetDescription () const override
 
ManualPageID ManualPage () override
 
template<bool Const>
bool VisitSettings (SettingsVisitorBase< Const > &S)
 
bool VisitSettings (SettingsVisitor &S) override
 
bool VisitSettings (ConstSettingsVisitor &S) override
 
void PopulateOrExchange (ShuttleGui &S) override
 
bool ApplyInner (const CommandContext &context, Track *t) override
 
- Public Member Functions inherited from SetTrackBase
 SetTrackBase ()
 
bool Apply (const CommandContext &context) override
 
virtual bool ApplyInner (const CommandContext &context, Track *t)
 
template<bool Const>
bool VisitSettings (SettingsVisitorBase< Const > &S)
 
bool VisitSettings (SettingsVisitor &S) override
 
bool VisitSettings (ConstSettingsVisitor &S) override
 
virtual void PopulateOrExchange (ShuttleGui &S) 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
 

Static Public Attributes

static const ComponentInterfaceSymbol Symbol { XO("Set Track") }
 

Private Attributes

SetTrackStatusCommand mSetStatus
 
SetTrackAudioCommand mSetAudio
 
SetTrackVisualsCommand mSetVisuals
 

Additional Inherited Members

- Public Types inherited from AudacityCommand
enum  : long { DefaultMessageBoxStyle = wxOK | wxCENTRE }
 
- Public Attributes inherited from SetTrackBase
int mTrackIndex
 
int mChannelIndex
 
bool bHasTrackIndex
 
bool bHasChannelIndex
 
bool bIsSecondChannel
 
bool mbPromptForTracks
 
- Protected Attributes inherited from AudacityCommand
ProgressDialogmProgress
 
wxDialog * mUIDialog
 
wxWindow * mUIParent
 

Detailed Description

A SetTrackBase that combines SetTrackStatusCommand, SetTrackAudioCommand and SetTrackVisualsCommand.

Definition at line 151 of file SetTrackInfoCommand.h.

Constructor & Destructor Documentation

◆ SetTrackCommand()

SetTrackCommand::SetTrackCommand ( )

Definition at line 487 of file SetTrackInfoCommand.cpp.

488{
492}
SetTrackStatusCommand mSetStatus
SetTrackVisualsCommand mSetVisuals
SetTrackAudioCommand mSetAudio

References SetTrackBase::mbPromptForTracks, mSetAudio, mSetStatus, and mSetVisuals.

Member Function Documentation

◆ ApplyInner()

bool SetTrackCommand::ApplyInner ( const CommandContext context,
Track t 
)
inlineoverridevirtual

Reimplemented from SetTrackBase.

Definition at line 180 of file SetTrackInfoCommand.h.

180 {
184 return
185 mSetStatus.ApplyInner( context, t ) &&
186 mSetAudio.ApplyInner( context, t )&&
187 mSetVisuals.ApplyInner( context, t );
188 }
bool ApplyInner(const CommandContext &context, Track *t) override
bool ApplyInner(const CommandContext &context, Track *t) override
bool ApplyInner(const CommandContext &context, Track *t) override

References SetTrackStatusCommand::ApplyInner(), SetTrackAudioCommand::ApplyInner(), SetTrackVisualsCommand::ApplyInner(), SetTrackBase::bIsSecondChannel, mSetAudio, mSetStatus, and mSetVisuals.

Here is the call graph for this function:

◆ GetDescription()

TranslatableString SetTrackCommand::GetDescription ( ) const
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 159 of file SetTrackInfoCommand.h.

159{return XO("Sets various values for a track.");};
#define XO(s)
Definition: Internat.h:31

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol SetTrackCommand::GetSymbol ( ) const
inlineoverridevirtual

Implements AudacityCommand.

Definition at line 158 of file SetTrackInfoCommand.h.

158{return Symbol;};
static const ComponentInterfaceSymbol Symbol

References Symbol.

◆ ManualPage()

ManualPageID SetTrackCommand::ManualPage ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 161 of file SetTrackInfoCommand.h.

161{return L"Extra_Menu:_Scriptables_II#set_track";}

◆ PopulateOrExchange()

void SetTrackCommand::PopulateOrExchange ( ShuttleGui S)
inlineoverridevirtual

Reimplemented from SetTrackBase.

Definition at line 174 of file SetTrackInfoCommand.h.

174 {
179 };
#define S(N)
Definition: ToChars.cpp:64
void PopulateOrExchange(ShuttleGui &S) override
virtual void PopulateOrExchange(ShuttleGui &S) override
void PopulateOrExchange(ShuttleGui &S) override
void PopulateOrExchange(ShuttleGui &S) override

References mSetAudio, mSetStatus, mSetVisuals, SetTrackBase::PopulateOrExchange(), SetTrackStatusCommand::PopulateOrExchange(), SetTrackAudioCommand::PopulateOrExchange(), SetTrackVisualsCommand::PopulateOrExchange(), and S.

Here is the call graph for this function:

◆ VisitSettings() [1/3]

bool SetTrackCommand::VisitSettings ( ConstSettingsVisitor )
overridevirtual

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

Reimplemented from SetTrackBase.

Definition at line 496 of file SetTrackInfoCommand.cpp.

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

References S.

◆ VisitSettings() [2/3]

bool SetTrackCommand::VisitSettings ( SettingsVisitor )
overridevirtual

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

Reimplemented from SetTrackBase.

Definition at line 494 of file SetTrackInfoCommand.cpp.

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

References S.

◆ VisitSettings() [3/3]

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

Definition at line 165 of file SetTrackInfoCommand.h.

165 {
166 return
171 };
bool VisitSettings(SettingsVisitorBase< Const > &S)
bool VisitSettings(SettingsVisitorBase< Const > &S)
bool VisitSettings(SettingsVisitorBase< Const > &S)
bool VisitSettings(SettingsVisitorBase< Const > &S)

References mSetAudio, mSetStatus, mSetVisuals, S, SetTrackBase::VisitSettings(), SetTrackStatusCommand::VisitSettings(), SetTrackAudioCommand::VisitSettings(), and SetTrackVisualsCommand::VisitSettings().

Here is the call graph for this function:

Member Data Documentation

◆ mSetAudio

SetTrackAudioCommand SetTrackCommand::mSetAudio
private

◆ mSetStatus

SetTrackStatusCommand SetTrackCommand::mSetStatus
private

◆ mSetVisuals

SetTrackVisualsCommand SetTrackCommand::mSetVisuals
private

◆ Symbol

const ComponentInterfaceSymbol SetTrackCommand::Symbol { XO("Set Track") }
static

Definition at line 154 of file SetTrackInfoCommand.h.

Referenced by GetSymbol().


The documentation for this class was generated from the following files: