SetLabelCommand Class Reference

Command that sets label information. More...

#include <SetLabelCommand.h>

Inheritance diagram for SetLabelCommand:

Collaboration diagram for SetLabelCommand:

Public Member Functions
	SetLabelCommand ()
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
ManualPageID	ManualPage () override
bool	Apply (const CommandContext &context) 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	mLabelIndex
wxString	mText
double	mT0
double	mT1
bool	mbSelected
bool	bHasText
bool	bHasT0
bool	bHasT1
bool	bHasSelected

Static Public Attributes
static const ComponentInterfaceSymbol	Symbol { XO("Set Label") }

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 that sets label information.

Definition at line 22 of file SetLabelCommand.h.

Constructor & Destructor Documentation

SetLabelCommand()

SetLabelCommand::SetLabelCommand

(

)

Definition at line 40 of file SetLabelCommand.cpp.

{
}

Member Function Documentation

Apply()

bool SetLabelCommand::Apply ( const CommandContext &  context )

override

Definition at line 79 of file SetLabelCommand.cpp.

{
   // \todo we have similar code for finding the nth Label, Clip, Track etc.
   // this code could be put in subroutines/reduced.
 
   //wxString mode = GetString(wxT("Type"));
   AudacityProject * p = &context.project;
   auto &tracks = TrackList::Get( *p );
   auto &selectedRegion = ViewInfo::Get( *p ).selectedRegion;
   const LabelStruct * pLabel = nullptr;
   LabelTrack *labelTrack = nullptr;
   auto ii = mLabelIndex;
   if ( mLabelIndex >= 0 ) {
      for (auto lt : tracks.Any<LabelTrack>()) {
         const auto &labels = lt->GetLabels();
         const auto nLabels = labels.size();
         if( ii >= (int)nLabels )
            ii -= nLabels;
         else {
            labelTrack = lt;
            pLabel = &labels[ ii ];
            break;
         }
      }
   }
 
   if ( !pLabel )
   {
      context.Error(wxT("LabelIndex was invalid."));
      return false;
   }
   auto newLabel = *pLabel;
   if( bHasText )
      newLabel.title = mText;
   if( bHasT0 )
      newLabel.selectedRegion.setT0(mT0, false);
   if( bHasT1 )
      newLabel.selectedRegion.setT1(mT1, false);
   if( bHasT0 || bHasT1 )
      newLabel.selectedRegion.ensureOrdering();
   labelTrack->SetLabel( ii, newLabel );
 
   // Only one label can be selected.
   if( bHasSelected ) {
      auto &view = LabelTrackView::Get( *labelTrack );
      if( mbSelected )
      {
         view.SetNavigationIndex( ii );
         double t0 = pLabel->selectedRegion.t0();
         double t1 = pLabel->selectedRegion.t1();
         selectedRegion.setTimes( t0, t1);
      }
      else if( view.GetNavigationIndex( context.project ) == ii )
         view.SetNavigationIndex( -1 );
   }
 
   labelTrack->SortLabels();
 
   ProjectHistory::Get(context.project).PushState(
      XO("Edited Label"), XO("Label"));
 
   return true;
}

References bHasSelected, bHasT0, bHasT1, bHasText, CommandContext::Error(), ProjectHistory::Get(), ViewInfo::Get(), TrackList::Get(), LabelTrackView::Get(), mbSelected, mLabelIndex, mT0, mT1, mText, CommandContext::project, ProjectHistory::PushState(), ViewInfo::selectedRegion, tracks, wxT(), and XO().

Here is the call graph for this function:

GetDescription()

TranslatableString SetLabelCommand::GetDescription ( ) const

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 30 of file SetLabelCommand.h.

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

References XO().

Here is the call graph for this function:

GetSymbol()

ComponentInterfaceSymbol SetLabelCommand::GetSymbol ( ) const

inlineoverridevirtual

Implements AudacityCommand.

Definition at line 29 of file SetLabelCommand.h.

{return Symbol;};

References Symbol.

ManualPage()

ManualPageID SetLabelCommand::ManualPage ( )

inlineoverridevirtual

Reimplemented from AudacityCommand.

Definition at line 37 of file SetLabelCommand.h.

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

PopulateOrExchange()

void SetLabelCommand::PopulateOrExchange ( ShuttleGui &  S )

override

Definition at line 60 of file SetLabelCommand.cpp.

{
   S.AddSpace(0, 5);
 
   S.StartMultiColumn(2, wxALIGN_CENTER);
   {
      S.TieNumericTextBox( XXO("Label Index"), mLabelIndex );
   }
   S.EndMultiColumn();
   S.StartMultiColumn(3, wxALIGN_CENTER);
   {
      S.Optional( bHasText      ).TieTextBox(         XXO("Text:"),     mText );
      S.Optional( bHasT0        ).TieNumericTextBox(  XXO("Start:"),    mT0 );
      S.Optional( bHasT1        ).TieNumericTextBox(  XXO("End:"),      mT1 );
      S.Optional( bHasSelected  ).TieCheckBox(        XXO("Selected"),  mbSelected );
   }
   S.EndMultiColumn();
}

References bHasSelected, bHasT0, bHasT1, bHasText, mbSelected, mLabelIndex, mT0, mT1, mText, S, and XXO().

Here is the call graph for this function:

VisitSettings() [1/3]

bool SetLabelCommand::VisitSettings ( ConstSettingsVisitor &  )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 57 of file SetLabelCommand.cpp.

   { return VisitSettings<true>(S); }

References S.

VisitSettings() [2/3]

bool SetLabelCommand::VisitSettings ( SettingsVisitor &  )

overridevirtual

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

Reimplemented from AudacityCommand.

Definition at line 54 of file SetLabelCommand.cpp.

   { return VisitSettings<false>(S); }

References S.

VisitSettings() [3/3]

template<bool Const>

bool SetLabelCommand::VisitSettings

(

SettingsVisitorBase< Const > &

S

)

Definition at line 45 of file SetLabelCommand.cpp.

                                                                   {
   S.Define(    mLabelIndex,                            wxT("Label"), 0, 0, 10000 );
   S.OptionalY( bHasText       ).Define(  mText,        wxT("Text"),       wxString{"empty"} );
   S.OptionalY( bHasT0         ).Define(  mT0,          wxT("Start"),      0.0, 0.0, 100000.0);
   S.OptionalY( bHasT1         ).Define(  mT1,          wxT("End"),        0.0, 0.0, 100000.0);
   S.OptionalN( bHasSelected   ).Define(  mbSelected,   wxT("Selected"),   false );
   return true;
};

References bHasSelected, bHasT0, bHasT1, bHasText, mbSelected, mLabelIndex, mT0, mT1, mText, S, and wxT().

Here is the call graph for this function:

Member Data Documentation

bHasSelected

bool SetLabelCommand::bHasSelected

Definition at line 54 of file SetLabelCommand.h.

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

bHasT0

bool SetLabelCommand::bHasT0

Definition at line 52 of file SetLabelCommand.h.

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

bHasT1

bool SetLabelCommand::bHasT1

Definition at line 53 of file SetLabelCommand.h.

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

bHasText

bool SetLabelCommand::bHasText

Definition at line 51 of file SetLabelCommand.h.

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

mbSelected

bool SetLabelCommand::mbSelected

Definition at line 48 of file SetLabelCommand.h.

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

mLabelIndex

int SetLabelCommand::mLabelIndex

Definition at line 44 of file SetLabelCommand.h.

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

mT0

double SetLabelCommand::mT0

Definition at line 46 of file SetLabelCommand.h.

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

mT1

double SetLabelCommand::mT1

Definition at line 47 of file SetLabelCommand.h.

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

mText

wxString SetLabelCommand::mText

Definition at line 45 of file SetLabelCommand.h.

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

Symbol

const ComponentInterfaceSymbol SetLabelCommand::Symbol { XO("Set Label") }

static

Definition at line 25 of file SetLabelCommand.h.

Referenced by GetSymbol().

---

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

• SetLabelCommand.h
• SetLabelCommand.cpp