Audacity  3.0.3
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 () override
 
TranslatableString GetDescription () override
 
ManualPageID ManualPage () override
 
bool DefineParams (ShuttleParams &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
 
- 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))
 

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 }
 
using VetoDialogHook = bool(*)(wxDialog *)
 
- Static Public Member Functions inherited from AudacityCommand
static VetoDialogHook SetVetoDialogHook (VetoDialogHook hook)
 
- 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
 
int mUIResultID
 

Detailed Description

A SetTrackBase that combines SetTrackStatusCommand, SetTrackAudioCommand and SetTrackVisualsCommand.

Definition at line 143 of file SetTrackInfoCommand.h.

Constructor & Destructor Documentation

◆ SetTrackCommand()

SetTrackCommand::SetTrackCommand ( )

Definition at line 460 of file SetTrackInfoCommand.cpp.

461 {
465 }

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 170 of file SetTrackInfoCommand.h.

170  {
174  return
175  mSetStatus.ApplyInner( context, t ) &&
176  mSetAudio.ApplyInner( context, t )&&
177  mSetVisuals.ApplyInner( context, t );
178  }

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

Here is the call graph for this function:

◆ DefineParams()

bool SetTrackCommand::DefineParams ( ShuttleParams S)
inlineoverridevirtual

Reimplemented from SetTrackBase.

Definition at line 157 of file SetTrackInfoCommand.h.

157  {
158  return
160  mSetStatus.DefineParams(S) &&
161  mSetAudio.DefineParams(S) &&
163  };

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

Here is the call graph for this function:

◆ GetDescription()

TranslatableString SetTrackCommand::GetDescription ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 151 of file SetTrackInfoCommand.h.

151 {return XO("Sets various values for a track.");};

References XO.

◆ GetSymbol()

ComponentInterfaceSymbol SetTrackCommand::GetSymbol ( )
inlineoverridevirtual

Implements AudacityCommand.

Definition at line 150 of file SetTrackInfoCommand.h.

150 {return Symbol;};

References Symbol.

◆ ManualPage()

ManualPageID SetTrackCommand::ManualPage ( )
inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 153 of file SetTrackInfoCommand.h.

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

◆ PopulateOrExchange()

void SetTrackCommand::PopulateOrExchange ( ShuttleGui S)
inlineoverridevirtual

Reimplemented from SetTrackBase.

Definition at line 164 of file SetTrackInfoCommand.h.

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

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 146 of file SetTrackInfoCommand.h.

Referenced by GetSymbol().


The documentation for this class was generated from the following files:
SetTrackAudioCommand::ApplyInner
bool ApplyInner(const CommandContext &context, Track *t) override
Definition: SetTrackInfoCommand.cpp:221
SetTrackBase::mbPromptForTracks
bool mbPromptForTracks
Definition: SetTrackInfoCommand.h:40
SetTrackStatusCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: SetTrackInfoCommand.cpp:130
XO
#define XO(s)
Definition: Internat.h:31
SetTrackCommand::mSetStatus
SetTrackStatusCommand mSetStatus
Definition: SetTrackInfoCommand.h:181
SetTrackCommand::mSetAudio
SetTrackAudioCommand mSetAudio
Definition: SetTrackInfoCommand.h:182
SetTrackBase::DefineParams
virtual bool DefineParams(ShuttleParams &S) override
Definition: SetTrackInfoCommand.cpp:70
SetTrackVisualsCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: SetTrackInfoCommand.cpp:306
SetTrackStatusCommand::ApplyInner
bool ApplyInner(const CommandContext &context, Track *t) override
Definition: SetTrackInfoCommand.cpp:157
SetTrackAudioCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: SetTrackInfoCommand.cpp:202
SetTrackBase::bIsSecondChannel
bool bIsSecondChannel
Definition: SetTrackInfoCommand.h:39
SetTrackCommand::mSetVisuals
SetTrackVisualsCommand mSetVisuals
Definition: SetTrackInfoCommand.h:183
SetTrackCommand::Symbol
static const ComponentInterfaceSymbol Symbol
Definition: SetTrackInfoCommand.h:146
SetTrackStatusCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: SetTrackInfoCommand.cpp:139
SetTrackVisualsCommand::ApplyInner
bool ApplyInner(const CommandContext &context, Track *t) override
Definition: SetTrackInfoCommand.cpp:373
SetTrackBase::PopulateOrExchange
virtual void PopulateOrExchange(ShuttleGui &S) override
Definition: SetTrackInfoCommand.cpp:80
SetTrackVisualsCommand::PopulateOrExchange
void PopulateOrExchange(ShuttleGui &S) override
Definition: SetTrackInfoCommand.cpp:330
SetTrackAudioCommand::DefineParams
bool DefineParams(ShuttleParams &S) override
Definition: SetTrackInfoCommand.cpp:192