SelectTimeCommand Class Reference

Command for changing the time selection. More...

#include <SelectCommand.h>

Inheritance diagram for SelectTimeCommand:

Collaboration diagram for SelectTimeCommand:

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	bHasT0
bool	bHasT1
bool	bHasFromEnd
bool	bHasRelativeSpec
double	mT0
double	mT1
int	mRelativeTo
bool	mFromEnd

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

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 time selection.

Definition at line 27 of file SelectCommand.h.

Member Function Documentation

Apply()

bool SelectTimeCommand::Apply ( const CommandContext &  context )

override

Definition at line 104 of file SelectCommand.cpp.

                                                           {
   // Many commands need focus on track panel.
   // No harm in setting it with a scripted select.
   TrackPanel::Get( context.project ).SetFocus();
   if( !bHasT0 && !bHasT1 )
      return true;
 
   // Defaults if no value...
   if( !bHasT0 )
      mT0 = 0.0;
   if( !bHasT1 )
      mT1 = 0.0;
   if( !bHasRelativeSpec )
      mRelativeTo = 0;
 
   AudacityProject * p = &context.project;
   double end = TrackList::Get(*p).GetEndTime();
   double t0;
   double t1;
 
   auto &selectedRegion = ViewInfo::Get( *p ).selectedRegion;
   switch( bHasRelativeSpec ? mRelativeTo : 0 ){
   default:
   case 0: //project start
      t0 = mT0;
      t1 = mT1;
      break;
   case 1: //project
      t0 = mT0;
      t1 = end + mT1;
      break;
   case 2: //project end;
      t0 = end - mT0;
      t1 = end - mT1;
      break;
   case 3: //selection start
      t0 = mT0 + selectedRegion.t0();
      t1 = mT1 + selectedRegion.t0();
      break;
   case 4: //selection
      t0 = mT0 + selectedRegion.t0();
      t1 = mT1 + selectedRegion.t1();
      break;
   case 5: //selection end
      t0 =  selectedRegion.t1() - mT0;
      t1 =  selectedRegion.t1() - mT1;
      break;
   }
 
   selectedRegion.setTimes( t0, t1 );
   return true;
}

References bHasRelativeSpec, bHasT0, bHasT1, details::end(), ViewInfo::Get(), TrackList::Get(), TrackPanel::Get(), TrackList::GetEndTime(), mRelativeTo, mT0, mT1, CommandContext::project, and ViewInfo::selectedRegion.

Referenced by SelectCommand::Apply().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDescription()

TranslatableString SelectTimeCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 34 of file SelectCommand.h.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol SelectTimeCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 33 of file SelectCommand.h.

{return Symbol;};

References Symbol.

ManualPage()

ManualPageID SelectTimeCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 42 of file SelectCommand.h.

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

PopulateOrExchange()

void SelectTimeCommand::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 87 of file SelectCommand.cpp.

{
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(3, wxEXPAND);
   {
      S.SetStretchyCol( 2 );
      S.Optional( bHasT0 ).TieTextBox(XXO("Start Time:"), mT0);
      S.Optional( bHasT1 ).TieTextBox(XXO("End Time:"),   mT1);
      // Chooses what time is relative to.
      S.Optional( bHasRelativeSpec ).TieChoice(
         XXO("Relative To:"),
         mRelativeTo, Msgids( kRelativeTo, nRelativeTos ));
   }
   S.EndMultiColumn();
}

References bHasRelativeSpec, bHasT0, bHasT1, kRelativeTo, mRelativeTo, Msgids(), mT0, mT1, nRelativeTos, 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 SelectTimeCommand::VisitSettings ( ConstSettingsVisitor &  )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 84 of file SelectCommand.cpp.

   { return VisitSettings<true>(S); }

References S.

VisitSettings() [2/3]

bool SelectTimeCommand::VisitSettings ( SettingsVisitor &  )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 81 of file SelectCommand.cpp.

   { return VisitSettings<false>(S); }

References S.

VisitSettings() [3/3]

template<bool Const>

bool SelectTimeCommand::VisitSettings

(

SettingsVisitorBase< Const > &

S

)

Definition at line 72 of file SelectCommand.cpp.

                                                                     {
   // Allow selection down to -ve 100seconds.
   // Typically used to expand/contract selections by a small amount.
   S.OptionalY( bHasT0           ).Define( mT0, wxT("Start"), 0.0, -100.0, (double)FLT_MAX);
   S.OptionalY( bHasT1           ).Define( mT1, wxT("End"), 0.0, -100.0, (double)FLT_MAX);
   S.OptionalN( bHasRelativeSpec ).DefineEnum( mRelativeTo,   wxT("RelativeTo"), 0, kRelativeTo, nRelativeTos );
   return true;
}

References bHasRelativeSpec, bHasT0, bHasT1, kRelativeTo, mRelativeTo, mT0, mT1, nRelativeTos, 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

bHasFromEnd

bool SelectTimeCommand::bHasFromEnd

Definition at line 46 of file SelectCommand.h.

bHasRelativeSpec

bool SelectTimeCommand::bHasRelativeSpec

Definition at line 47 of file SelectCommand.h.

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

bHasT0

bool SelectTimeCommand::bHasT0

Definition at line 44 of file SelectCommand.h.

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

bHasT1

bool SelectTimeCommand::bHasT1

Definition at line 45 of file SelectCommand.h.

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

mFromEnd

bool SelectTimeCommand::mFromEnd

Definition at line 52 of file SelectCommand.h.

mRelativeTo

int SelectTimeCommand::mRelativeTo

Definition at line 51 of file SelectCommand.h.

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

mT0

double SelectTimeCommand::mT0

Definition at line 49 of file SelectCommand.h.

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

mT1

double SelectTimeCommand::mT1

Definition at line 50 of file SelectCommand.h.

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

Symbol

const ComponentInterfaceSymbol SelectTimeCommand::Symbol { XO("Select Time") }

static

Definition at line 30 of file SelectCommand.h.

Referenced by GetSymbol().

---

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

• SelectCommand.h
• SelectCommand.cpp