SetTrackCommand Class Reference

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

#include <SetTrackInfoCommand.h>

Inheritance diagram for SetTrackCommand:

Collaboration diagram for SetTrackCommand:

Public Member Functions
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
bool	Apply (const CommandContext &context) final
virtual bool	ApplyInner (const CommandContext &context, Track &t)=0
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 (const CommandContext &context, bool shouldPrompt=true)
int	MessageBox (const TranslatableString &message, long style=DefaultMessageBoxStyle, const TranslatableString &titleStr={})
virtual bool	Init ()
virtual bool	PromptUser (AudacityProject &)
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 }
Protected Attributes inherited from AudacityCommand
ProgressDialog *	mProgress
wxDialog *	mUIDialog
wxWindow *	mUIParent

Detailed Description

A SetTrackBase that combines SetTrackStatusCommand, SetTrackAudioConmmand and SetTrackVisualsCommand.

Definition at line 137 of file SetTrackInfoCommand.h.

Member Function Documentation

ApplyInner()

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

inlineoverridevirtual

Implements SetTrackBase.

Definition at line 163 of file SetTrackInfoCommand.h.

                                                                      {
      return
         mSetStatus.ApplyInner(context, t) &&
         mSetAudio.ApplyInner(context, t) &&
         mSetVisuals.ApplyInner(context, t);
   }

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

Here is the call graph for this function:

GetDescription()

TranslatableString SetTrackCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 144 of file SetTrackInfoCommand.h.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol SetTrackCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 143 of file SetTrackInfoCommand.h.

{return Symbol;};

References Symbol.

ManualPage()

ManualPageID SetTrackCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 146 of file SetTrackInfoCommand.h.

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

PopulateOrExchange()

void SetTrackCommand::PopulateOrExchange ( ShuttleGui &  S )

inlineoverride

Definition at line 158 of file SetTrackInfoCommand.h.

                                                    {
      mSetStatus.PopulateOrExchange(S);
      mSetAudio.PopulateOrExchange(S);
      mSetVisuals.PopulateOrExchange(S);
   };

References mSetAudio, mSetStatus, mSetVisuals, 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 AudacityCommand.

Definition at line 426 of file SetTrackInfoCommand.cpp.

   { 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 AudacityCommand.

Definition at line 424 of file SetTrackInfoCommand.cpp.

   { return VisitSettings<false>(S); }

References S.

VisitSettings() [3/3]

template<bool Const>

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

inline

Definition at line 150 of file SetTrackInfoCommand.h.

                                                                            {
      return
         mSetStatus.VisitSettings(S) &&
         mSetAudio.VisitSettings(S) &&
         mSetVisuals.VisitSettings(S);
   };

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

Here is the call graph for this function:

Member Data Documentation

mSetAudio

SetTrackAudioCommand SetTrackCommand::mSetAudio

private

Definition at line 172 of file SetTrackInfoCommand.h.

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

mSetStatus

SetTrackStatusCommand SetTrackCommand::mSetStatus

private

Definition at line 171 of file SetTrackInfoCommand.h.

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

mSetVisuals

SetTrackVisualsCommand SetTrackCommand::mSetVisuals

private

Definition at line 173 of file SetTrackInfoCommand.h.

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

Symbol

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

static

Definition at line 140 of file SetTrackInfoCommand.h.

Referenced by GetSymbol().

---

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

• SetTrackInfoCommand.h
• SetTrackInfoCommand.cpp