SelectTracksCommand Class Reference

Command for changing the selection of tracks. More...

#include <SelectCommand.h>

Inheritance diagram for SelectTracksCommand:

Collaboration diagram for SelectTracksCommand:

Public Member Functions
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
bool	Apply (const CommandContext &context) override
ManualPageID	ManualPage () 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 (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

Public Attributes
bool	bHasFirstTrack
bool	bHasNumTracks
bool	bHasMode
double	mFirstTrack
double	mNumTracks
int	mMode

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Select Tracks") }

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

Command for changing the selection of tracks.

Definition at line 80 of file SelectCommand.h.

Member Function Documentation

Apply()

bool SelectTracksCommand::Apply ( const CommandContext &  context )

override

Definition at line 254 of file SelectCommand.cpp.

{
 
   // Count selection as a do-nothing effect.
   // Used to invalidate cached selection and tracks.
   EffectOutputTracks::IncEffectCounter();
   int index = 0;
   auto &tracks = TrackList::Get( context.project );
 
   // Defaults if no value...
   if( !bHasNumTracks ) 
      mNumTracks = 1.0;
   if( !bHasFirstTrack ) 
      mFirstTrack = 0.0;
 
   // Multiple channels count as fractions of a track.
   double last = mFirstTrack + mNumTracks;
   double first = mFirstTrack;
 
   for (auto t : tracks) {
      const bool sel = first <= index && index < last;
      if (mMode == 0) // Set
         t->SetSelected(sel);
      else if(mMode == 1 && sel) // Add
         t->SetSelected(sel);
      else if(mMode == 2 && sel) // Remove
         t->SetSelected(!sel);
      ++index;
   }
   return true;
}

References bHasFirstTrack, bHasNumTracks, TrackList::Get(), EffectOutputTracks::IncEffectCounter(), mFirstTrack, mMode, mNumTracks, CommandContext::project, and tracks.

Referenced by SelectCommand::Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDescription()

TranslatableString SelectTracksCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 87 of file SelectCommand.h.

{return XO("Selects a range of tracks.");};

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol SelectTracksCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 86 of file SelectCommand.h.

{return Symbol;};

References Symbol.

ManualPage()

ManualPageID SelectTracksCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 94 of file SelectCommand.h.

{return L"Extra_Menu:_Scriptables_I#select_tracks";}

PopulateOrExchange()

void SelectTracksCommand::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 235 of file SelectCommand.cpp.

{
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(3, wxEXPAND);
   {
      S.SetStretchyCol( 2 );
      S.Optional( bHasFirstTrack).TieTextBox(XXO("First Track:"),mFirstTrack);
      S.Optional( bHasNumTracks).TieTextBox(XXO("Track Count:"),mNumTracks);
   }
   S.EndMultiColumn();
   S.StartMultiColumn(2, wxALIGN_CENTER);
   {
      // Always used, so no check box.
      S.TieChoice( XXO("Mode:"), mMode, Msgids( kModes, nModes ));
   }
   S.EndMultiColumn();
}

References bHasFirstTrack, bHasNumTracks, kModes, mFirstTrack, mMode, mNumTracks, Msgids(), nModes, S, and XXO().

Referenced by SelectCommand::PopulateOrExchange().

Here is the call graph for this function:

Here is the caller graph for this function:

VisitSettings() [1/3]

bool SelectTracksCommand::VisitSettings ( ConstSettingsVisitor &  )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 232 of file SelectCommand.cpp.

   { return VisitSettings<true>(S); }

References S.

VisitSettings() [2/3]

bool SelectTracksCommand::VisitSettings ( SettingsVisitor &  )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 229 of file SelectCommand.cpp.

   { return VisitSettings<false>(S); }

References S.

VisitSettings() [3/3]

template<bool Const>

bool SelectTracksCommand::VisitSettings

(

SettingsVisitorBase< Const > &

S

)

Definition at line 221 of file SelectCommand.cpp.

                                                                       {
   S.OptionalN( bHasFirstTrack).Define( mFirstTrack, wxT("Track"), 0.0, 0.0, 100.0);
   S.OptionalN( bHasNumTracks ).Define( mNumTracks,  wxT("TrackCount"),  1.0, 0.0, 100.0);
   S.OptionalY( bHasMode      ).DefineEnum( mMode,   wxT("Mode"), 0, kModes, nModes );
   
   return true;
}

References bHasFirstTrack, bHasMode, bHasNumTracks, kModes, mFirstTrack, mMode, mNumTracks, nModes, S, and wxT().

Referenced by SelectCommand::VisitSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

bHasFirstTrack

bool SelectTracksCommand::bHasFirstTrack

Definition at line 96 of file SelectCommand.h.

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

bHasMode

bool SelectTracksCommand::bHasMode

Definition at line 98 of file SelectCommand.h.

Referenced by VisitSettings().

bHasNumTracks

bool SelectTracksCommand::bHasNumTracks

Definition at line 97 of file SelectCommand.h.

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

mFirstTrack

double SelectTracksCommand::mFirstTrack

Definition at line 100 of file SelectCommand.h.

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

mMode

int SelectTracksCommand::mMode

Definition at line 102 of file SelectCommand.h.

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

mNumTracks

double SelectTracksCommand::mNumTracks

Definition at line 101 of file SelectCommand.h.

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

Symbol

const ComponentInterfaceSymbol SelectTracksCommand::Symbol { XO("Select Tracks") }

static

Definition at line 83 of file SelectCommand.h.

Referenced by GetSymbol().

---

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

• SelectCommand.h
• SelectCommand.cpp