Base class for the various SetTrackCommand classes.
Sbclasses provide the settings that are relevant to them. More...

#include <SetTrackInfoCommand.h>

Inheritance diagram for SetTrackBase:

Collaboration diagram for SetTrackBase:

Public Member Functions
	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

Public Attributes
int	mTrackIndex

int	mChannelIndex

bool	bHasTrackIndex

bool	bHasChannelIndex

bool	bIsSecondChannel

bool	mbPromptForTracks

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

Base class for the various SetTrackCommand classes.
Sbclasses provide the settings that are relevant to them.

Definition at line 25 of file SetTrackInfoCommand.h.

Constructor & Destructor Documentation

◆ SetTrackBase()

SetTrackBase::SetTrackBase ( )

Definition at line 55 of file SetTrackInfoCommand.cpp.

                          {
   mbPromptForTracks = true;
   bIsSecondChannel = false;
}

References bIsSecondChannel, and mbPromptForTracks.

Member Function Documentation

◆ Apply()

bool SetTrackBase::Apply ( const CommandContext & context )

override

Definition at line 106 of file SetTrackInfoCommand.cpp.

{
   long i = 0;// track counter
   long j = 0;// channel counter
   auto &tracks = TrackList::Get( context.project );
   for ( auto t : tracks.Leaders() )
   {
      auto channels = TrackList::Channels(t);
      for ( auto channel : channels ) {
         bool bThisTrack =
#ifdef USE_OWN_TRACK_SELECTION
         (bHasTrackIndex && (i==mTrackIndex)) ||
         (bHasChannelIndex && (j==mChannelIndex ) ) ||
         (!bHasTrackIndex && !bHasChannelIndex) ;
#else
         channel->GetSelected();
#endif
 
         if( bThisTrack ){
            ApplyInner( context, channel );
         }
         ++j; // count all channels
      }
      ++i; // count groups of channels
   }
   return true;
}

References ApplyInner(), bHasChannelIndex, bHasTrackIndex, TrackList::Channels(), TrackList::Get(), mChannelIndex, mTrackIndex, and CommandContext::project.

Here is the call graph for this function:

◆ ApplyInner()

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

virtual

Reimplemented in SetClipCommand, SetEnvelopeCommand, SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, and SetTrackCommand.

Definition at line 65 of file SetTrackInfoCommand.cpp.

{
      static_cast<void>(&context);
      static_cast<void>(&t);
      return true;
};

Referenced by Apply().

Here is the caller graph for this function:

◆ PopulateOrExchange()

void SetTrackBase::PopulateOrExchange ( ShuttleGui & S )

overridevirtual

Reimplemented in SetClipCommand, SetEnvelopeCommand, SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, and SetTrackCommand.

Definition at line 89 of file SetTrackInfoCommand.cpp.

{
   static_cast<void>(S);
#ifdef USE_OWN_TRACK_SELECTION
   if( !mbPromptForTracks )
      return;
   S.AddSpace(0, 5);
   S.StartMultiColumn(3, wxEXPAND);
   {
      S.SetStretchyCol( 2 );
      S.Optional( bHasTrackIndex  ).TieNumericTextBox(  XO("Track Index:"),   mTrackIndex );
      S.Optional( bHasChannelIndex).TieNumericTextBox(  XO("Channel Index:"), mChannelIndex );
   }
   S.EndMultiColumn();
#endif
}

References bHasChannelIndex, bHasTrackIndex, mbPromptForTracks, mChannelIndex, mTrackIndex, S, and XO().

Referenced by SetTrackStatusCommand::PopulateOrExchange(), SetTrackAudioCommand::PopulateOrExchange(), SetTrackVisualsCommand::PopulateOrExchange(), and SetTrackCommand::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ VisitSettings() [1/3]

bool SetTrackBase::VisitSettings ( ConstSettingsVisitor & )

overridevirtual

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

Reimplemented from AudacityCommand.

Reimplemented in SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, and SetTrackCommand.

Definition at line 86 of file SetTrackInfoCommand.cpp.

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

References S.

◆ VisitSettings() [2/3]

bool SetTrackBase::VisitSettings ( SettingsVisitor & )

overridevirtual

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

Reimplemented from AudacityCommand.

Reimplemented in SetTrackStatusCommand, SetTrackAudioCommand, SetTrackVisualsCommand, and SetTrackCommand.

Definition at line 83 of file SetTrackInfoCommand.cpp.

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

References S.

◆ VisitSettings() [3/3]

template<bool Const>

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

Definition at line 73 of file SetTrackInfoCommand.cpp.

{
   static_cast<void>(S);
#ifdef USE_OWN_TRACK_SELECTION
   S.OptionalY( bHasTrackIndex     ).Define(     mTrackIndex,     wxT("Track"),      0, 0, 100 );
   S.OptionalN( bHasChannelIndex   ).Define(     mChannelIndex,   wxT("Channel"),    0, 0, 100 );
#endif
   return true;
}