LabelDialog Class Reference

Dialog for editing labels. More...

#include <LabelDialog.h>

Inheritance diagram for LabelDialog:

Collaboration diagram for LabelDialog:

Public Member Functions
	LabelDialog (wxWindow *parent, AudacityProject &project, TrackList *tracks, LabelTrack *selectedTrack, int index, ViewInfo &viewinfo, const NumericFormatID &format, const NumericFormatID &freqFormat)
	~LabelDialog ()
bool	Show (bool show=true) override
Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()
	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))
void	SetTitle (const TranslatableString &title)
void	SetLabel (const TranslatableString &title)
void	SetName (const TranslatableString &title)
void	SetName ()
Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)
	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete
	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete
wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete
wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	Populate ()
	Creates the dialog and its contents. More...
void	PopulateOrExchange (ShuttleGui &S)
void	PopulateLabels ()
void	OnHelp (wxCommandEvent &event)
ManualPageID	GetHelpPageName ()
bool	TransferDataToWindow () override
bool	TransferDataFromWindow () override
bool	Validate () override
void	FindAllLabels ()
void	AddLabels (const LabelTrack *t)
void	FindInitialRow ()
wxString	TrackName (int &index, const wxString &dflt=_("Label Track"))
void	OnUpdate (wxCommandEvent &event)
void	OnFreqUpdate (wxCommandEvent &event)
void	OnInsert (wxCommandEvent &event)
void	OnRemove (wxCommandEvent &event)
void	OnImport (wxCommandEvent &event)
void	OnExport (wxCommandEvent &event)
void	OnSelectCell (wxGridEvent &event)
void	OnCellChange (wxGridEvent &event)
void	OnChangeTrack (wxGridEvent &event, int row, RowData *rd)
void	OnChangeLabel (wxGridEvent &event, int row, RowData *rd)
void	OnChangeStime (wxGridEvent &event, int row, RowData *rd)
void	OnChangeEtime (wxGridEvent &event, int row, RowData *rd)
void	OnChangeLfreq (wxGridEvent &event, int row, RowData *rd)
void	OnChangeHfreq (wxGridEvent &event, int row, RowData *rd)
void	OnOK (wxCommandEvent &event)
void	OnCancel (wxCommandEvent &event)
void	ReadSize ()
void	WriteSize ()

Private Attributes
AudacityProject &	mProject
Grid *	mGrid
ChoiceEditor *	mChoiceEditor
NumericEditor *	mTimeEditor
NumericEditor *	mFrequencyEditor
RowDataArray	mData
TrackList *	mTracks
LabelTrack *	mSelectedTrack {}
int	mIndex { -1 }
ViewInfo *	mViewInfo
wxArrayString	mTrackNames
NumericFormatID	mFormat
NumericFormatID	mFreqFormat
int	mInitialRow

Detailed Description

Dialog for editing labels.

Definition at line 35 of file LabelDialog.h.

Constructor & Destructor Documentation

LabelDialog()

LabelDialog::LabelDialog	(	wxWindow *	parent,
		AudacityProject &	project,
		TrackList *	tracks,
		LabelTrack *	selectedTrack,
		int	index,
		ViewInfo &	viewinfo,
		const NumericFormatID &	format,
		const NumericFormatID &	freqFormat
	)

~LabelDialog()

LabelDialog::~LabelDialog

(

)

Definition at line 120 of file LabelDialog.cpp.

{
}

Member Function Documentation

AddLabels()

void LabelDialog::AddLabels ( const LabelTrack *  t )

private

Definition at line 467 of file LabelDialog.cpp.

{
   wxString lab;
   int tndx = 0;
   int i;
 
   // Add a NEW track name
   TrackName(tndx, t->GetName());
 
   // If editor was invoked for one label, add that one only, else add all.
   if (!mSelectedTrack || mSelectedTrack == t) {
      for (i = 0; i < t->GetNumLabels(); i++) {
         const LabelStruct *ls = t->GetLabel(i);
 
         if (mIndex < 0 || mIndex == i)
            mData.push_back(RowData(tndx, ls->title, ls->selectedRegion));
      }
   }
}

References LabelTrack::GetLabel(), Track::GetName(), LabelTrack::GetNumLabels(), mData, mIndex, mSelectedTrack, LabelStruct::selectedRegion, LabelStruct::title, and TrackName().

Referenced by FindAllLabels(), and OnImport().

Here is the call graph for this function:

Here is the caller graph for this function:

FindAllLabels()

void LabelDialog::FindAllLabels ( )

private

Definition at line 452 of file LabelDialog.cpp.

{
   // Add labels from all label tracks
   for (auto lt : mTracks->Any<const LabelTrack>()) {
      AddLabels(lt);
   }
 
   FindInitialRow();
 
   if (mData.size() == 0) {
      wxCommandEvent e;
      OnInsert(e);
   }
}

References AddLabels(), TrackList::Any(), FindInitialRow(), mData, mTracks, and OnInsert().

Referenced by PopulateLabels().

Here is the call graph for this function:

Here is the caller graph for this function:

FindInitialRow()

void LabelDialog::FindInitialRow ( )

private

Definition at line 487 of file LabelDialog.cpp.

{
   int cnt = mData.size();
   mInitialRow = -1;
 
   if (cnt == 0)
      return;
 
   // find closest previous label
 
   double distMin = std::numeric_limits<double>::max();
   double dist;
   double t0 = mViewInfo->selectedRegion.t0();
   int i;
   for (i = 0; i < cnt; i++)
   {
      dist = t0 - mData[i].selectedRegion.t0();
      if (dist >= 0.0 && dist < distMin)
      {
         mInitialRow = i;
         distMin = dist;
      }
   }
 
   // if no previous label was found, find first label
 
   if (mInitialRow == -1)
   {
      double t0Min = std::numeric_limits<double>::max();
      for (i = 0; i < cnt; i++)
      {
         if (mData[i].selectedRegion.t0() < t0Min)
         {
            mInitialRow  = i;
            t0Min = mData[i].selectedRegion.t0();
         }
      }
   }
}

References mData, mInitialRow, mViewInfo, ViewInfo::selectedRegion, and NotifyingSelectedRegion::t0().

Referenced by FindAllLabels().

Here is the call graph for this function:

Here is the caller graph for this function:

GetHelpPageName()

ManualPageID LabelDialog::GetHelpPageName ( )

inlineprivate

Definition at line 63 of file LabelDialog.h.

{return "Labels_Editor";}

Referenced by OnHelp().

Here is the caller graph for this function:

OnCancel()

void LabelDialog::OnCancel ( wxCommandEvent &  event )

private

Definition at line 939 of file LabelDialog.cpp.

{
   if (mGrid->IsCellEditControlShown()) {
      auto editor = mGrid->GetCellEditor(mGrid->GetGridCursorRow(),
         mGrid->GetGridCursorCol());
      editor->Reset();
      // To avoid memory leak, don't forget DecRef()!
      editor->DecRef();
      mGrid->HideCellEditControl();
      return;
   }
 
   WriteSize();
   // Standard handling
   EndModal(wxID_CANCEL);
 
   return;
}

References mGrid, and WriteSize().

Here is the call graph for this function:

OnCellChange()

void LabelDialog::OnCellChange ( wxGridEvent &  event )

private

Definition at line 762 of file LabelDialog.cpp.

{
   static bool guard = false;
   int row = event.GetRow();
 
   // Guard against recursion which can happen when a change to the "NEW label" row
   // is made.  When InsertRow() is done in TransferDataToWindow(), checks are made
   // within wxGrid to see if the edit control is active and since it hasn't yet
   // been marked inactive on the first time through here, we get entered again.
   // Sort of a double change.  I think this is probably a bug in wxGrid.
   if (guard) {
      return;
   }
   guard = true;
 
   // The change was to an existing label, so go process it based
   // on which column was changed.
   RowData *rd = &mData[row];
   switch (event.GetCol())
   {
      case Col_Track:
         OnChangeTrack(event, row, rd);
      break;
 
      case Col_Label:
         OnChangeLabel(event, row, rd);
      break;
 
      case Col_Stime:
         OnChangeStime(event, row, rd);
      break;
 
      case Col_Etime:
         OnChangeEtime(event, row, rd);
      break;
 
      case Col_Lfreq:
         OnChangeLfreq(event, row, rd);
      break;
 
      case Col_Hfreq:
         OnChangeHfreq(event, row, rd);
      break;
   }
 
   // Done...no need for protection anymore
   guard = false;
 
   return;
}

References Col_Etime, Col_Hfreq, Col_Label, Col_Lfreq, Col_Stime, Col_Track, mData, OnChangeEtime(), OnChangeHfreq(), OnChangeLabel(), OnChangeLfreq(), OnChangeStime(), and OnChangeTrack().

Here is the call graph for this function:

OnChangeEtime()

void LabelDialog::OnChangeEtime ( wxGridEvent &  event, int  row, RowData *  rd  )

private

Definition at line 867 of file LabelDialog.cpp.

{
   // Remember the value...no need to repopulate
   double t {};
   mGrid->GetCellValue(row, Col_Etime).ToDouble(&t);
   rd->selectedRegion.setT1(t, false);
   mGrid->SetCellValue(row, Col_Stime, wxString::Format(wxT("%g"),
                       rd->selectedRegion.t0()));
 
   return;
}

References Col_Etime, Col_Stime, mGrid, RowData::selectedRegion, SelectedRegion::setT1(), SelectedRegion::t0(), and wxT().

Referenced by OnCellChange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnChangeHfreq()

void LabelDialog::OnChangeHfreq ( wxGridEvent &  event, int  row, RowData *  rd  )

private

Definition at line 891 of file LabelDialog.cpp.

{
   // Remember the value...no need to repopulate
   double f;
   mGrid->GetCellValue(row, Col_Hfreq).ToDouble(&f);
   rd->selectedRegion.setF1(f, false);
   mGrid->SetCellValue(row, Col_Lfreq, wxString::Format(wxT("%g"),
                                                        rd->selectedRegion.f0()));
 
   return;
}

References Col_Hfreq, Col_Lfreq, SelectedRegion::f0(), mGrid, RowData::selectedRegion, SelectedRegion::setF1(), and wxT().

Referenced by OnCellChange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnChangeLabel()

void LabelDialog::OnChangeLabel ( wxGridEvent &  event, int  row, RowData *  rd  )

private

Definition at line 847 of file LabelDialog.cpp.

{
   // Remember the value...no need to repopulate
   rd->title = mGrid->GetCellValue(row, Col_Label);
 
   return;
}

References Col_Label, mGrid, and RowData::title.

Referenced by OnCellChange().

Here is the caller graph for this function:

OnChangeLfreq()

void LabelDialog::OnChangeLfreq ( wxGridEvent &  event, int  row, RowData *  rd  )

private

Definition at line 879 of file LabelDialog.cpp.

{
   // Remember the value...no need to repopulate
   double f;
   mGrid->GetCellValue(row, Col_Lfreq).ToDouble(&f);
   rd->selectedRegion.setF0(f, false);
   mGrid->SetCellValue(row, Col_Hfreq, wxString::Format(wxT("%g"),
                                                        rd->selectedRegion.f1()));
 
   return;
}

References Col_Hfreq, Col_Lfreq, SelectedRegion::f1(), mGrid, RowData::selectedRegion, SelectedRegion::setF0(), and wxT().

Referenced by OnCellChange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnChangeStime()

void LabelDialog::OnChangeStime ( wxGridEvent &  event, int  row, RowData *  rd  )

private

Definition at line 855 of file LabelDialog.cpp.

{
   // Remember the value...no need to repopulate
   double t {};
   mGrid->GetCellValue(row, Col_Stime).ToDouble(&t);
   rd->selectedRegion.setT0(t, false);
   mGrid->SetCellValue(row, Col_Etime, wxString::Format(wxT("%g"),
                       rd->selectedRegion.t1()));
 
   return;
}

References Col_Etime, Col_Stime, mGrid, RowData::selectedRegion, SelectedRegion::setT0(), SelectedRegion::t1(), and wxT().

Referenced by OnCellChange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnChangeTrack()

void LabelDialog::OnChangeTrack ( wxGridEvent &  event, int  row, RowData *  rd  )

private

Definition at line 813 of file LabelDialog.cpp.

{
   wxString val = mGrid->GetCellValue(row, Col_Track);
 
   // User selected the "New..." choice so ask for a NEW name
   if ( make_iterator_range( mTrackNames ).index( val ) == 0 ) {
      AudacityTextEntryDialog d(this,
         XO("New Label Track"),
         XO("Enter track name"),
         /* i18n-hint: (noun) it's the name of a kind of track.*/
         XO("Label Track").Translation());
 
      // User canceled so repopulating the grid will set the track
      // name to the original value
      if (d.ShowModal() == wxID_CANCEL) {
         TransferDataToWindow();
         return;
      }
 
      // Force generation of a NEW track name
      rd->index = 0;
      TrackName(rd->index, d.GetValue());
   }
   else {
      // Remember the tracks index
      rd->index = make_iterator_range( mTrackNames ).index( val );
   }
 
   // Repopulate the grid
   TransferDataToWindow();
 
   return;
}

References Col_Track, RowData::index, make_iterator_range(), mGrid, mTrackNames, TrackName(), TransferDataToWindow(), and XO().

Referenced by OnCellChange().

Here is the call graph for this function:

Here is the caller graph for this function:

OnExport()

void LabelDialog::OnExport ( wxCommandEvent &  event )

private

Definition at line 669 of file LabelDialog.cpp.

{
   int cnt = mData.size();
 
   // Silly user (could just disable the button, but that's a hassle ;-))
   if (cnt == 0) {
      AudacityMessageBox( XO("No labels to export.") );
      return;
   }
 
   // Extract the actual name.
   wxString fName = mTrackNames[mTrackNames.size() - 1].AfterFirst(wxT('-')).Mid(1);
 
   fName = SelectFile(FileNames::Operation::Export,
      XO("Export Labels As:"),
      wxEmptyString,
      fName,
      wxT("txt"),
      { FileNames::TextFiles, LabelTrack::SubripFiles, LabelTrack::WebVTTFiles },
      wxFD_SAVE | wxFD_OVERWRITE_PROMPT | wxRESIZE_BORDER,
      this);
 
   if (fName.empty())
      return;
 
   LabelFormat format = LabelTrack::FormatForFileName(fName);
 
   // Move existing files out of the way.  Otherwise wxTextFile will
   // append to (rather than replace) the current file.
 
   if (wxFileExists(fName)) {
#ifdef __WXGTK__
      wxString safetyFileName = fName + wxT("~");
#else
      wxString safetyFileName = fName + wxT(".bak");
#endif
 
      if (wxFileExists(safetyFileName))
         wxRemoveFile(safetyFileName);
 
      wxRename(fName, safetyFileName);
   }
 
   wxTextFile f(fName);
#ifdef __WXMAC__
   wxFile{}.Create(fName);
#else
   f.Create();
#endif
   f.Open();
   if (!f.IsOpened()) {
      AudacityMessageBox(
         XO("Couldn't write to file: %s").Format( fName ) );
      return;
   }
 
   // Transfer our collection to a temporary label track
   auto lt = std::make_shared<LabelTrack>();
   int i;
 
   for (i = 0; i < cnt; i++) {
      RowData &rd = mData[i];
 
      lt->AddLabel(rd.selectedRegion, rd.title);
   }
 
   // Export them and clean
   lt->Export(f, format);
 
#ifdef __WXMAC__
   f.Write(wxTextFileType_Mac);
#else
   f.Write();
#endif
   f.Close();
}

References AudacityMessageBox(), anonymous_namespace{ExportPCM.cpp}::format, LabelTrack::FormatForFileName(), mData, mTrackNames, RowData::selectedRegion, SelectFile(), LabelTrack::SubripFiles, FileNames::TextFiles, RowData::title, LabelTrack::WebVTTFiles, wxT(), and XO().

Here is the call graph for this function:

OnFreqUpdate()

void LabelDialog::OnFreqUpdate ( wxCommandEvent &  event )

private

Definition at line 538 of file LabelDialog.cpp.

{
   // Remember the NEW format and repopulate grid
   mFreqFormat = NumericConverterFormats::Lookup(
      FormatterContext::ProjectContext(mProject),
      NumericConverterType_FREQUENCY(), event.GetString()).Internal();
   TransferDataToWindow();
 
   event.Skip(false);
}

References ComponentInterfaceSymbol::Internal(), NumericConverterFormats::Lookup(), mFreqFormat, mProject, NumericConverterType_FREQUENCY(), FormatterContext::ProjectContext(), and TransferDataToWindow().

Here is the call graph for this function:

OnHelp()

void LabelDialog::OnHelp ( wxCommandEvent &  event )

private

Definition at line 284 of file LabelDialog.cpp.

{
   const auto &page = GetHelpPageName();
   HelpSystem::ShowHelp(this, page, true);
}

References GetHelpPageName(), and HelpSystem::ShowHelp().

Here is the call graph for this function:

OnImport()

void LabelDialog::OnImport ( wxCommandEvent &  event )

private

Definition at line 627 of file LabelDialog.cpp.

{
   // Ask user for a filename
   wxString fileName =
       SelectFile(FileNames::Operation::Open,
         XO("Select a text file containing labels"),
         wxEmptyString,     // Path
         wxT(""),       // Name
         wxT("txt"),   // Extension
         { FileNames::TextFiles, LabelTrack::SubripFiles, FileNames::AllFiles },
         wxRESIZE_BORDER, // Flags
         this);    // Parent
 
   // They gave us one...
   if (!fileName.empty()) {
      LabelFormat format = LabelTrack::FormatForFileName(fileName);
 
      wxTextFile f;
 
      // Get at the data
      f.Open(fileName);
      if (!f.IsOpened()) {
         AudacityMessageBox(
            XO("Could not open file: %s").Format( fileName ) );
      }
      else {
         // Create a temporary label track and load the labels
         // into it
         auto lt = std::make_shared<LabelTrack>();
         lt->Import(f, format);
 
         // Add the labels to our collection
         AddLabels(lt.get());
 
         // Done with the temporary track
     }
 
      // Repopulate the grid
      TransferDataToWindow();
   }
}

References AddLabels(), FileNames::AllFiles, AudacityMessageBox(), anonymous_namespace{ExportPCM.cpp}::format, LabelTrack::FormatForFileName(), SelectFile(), LabelTrack::SubripFiles, FileNames::TextFiles, TransferDataToWindow(), wxT(), and XO().

Here is the call graph for this function:

OnInsert()

void LabelDialog::OnInsert ( wxCommandEvent &  event )

private

Definition at line 549 of file LabelDialog.cpp.

{
   int cnt = mData.size();
   int row = 0;
   int index = 0;
 
   // Make sure the edit control isn't active before inserting any rows
   if (mGrid->IsCellEditControlShown()) {
      mGrid->HideCellEditControl();
   }
 
   // Attempt to guess which track the label should reside on
   if (cnt > 0) {
      row = mGrid->GetGridCursorRow();
      if (row > 0 && row >= cnt) {
         index = make_iterator_range( mTrackNames )
            .index( mGrid->GetCellValue(row - 1, Col_Track) );
      }
      else {
         index = make_iterator_range( mTrackNames )
            .index( mGrid->GetCellValue(row, Col_Track) );
      }
   }
 
   // Insert NEW label before or after the current row
   if (event.GetId() == ID_INSERTA && row < cnt) {
      row++;
   }
   mData.insert(mData.begin() + row, RowData(index, wxT(""), SelectedRegion()));
 
   // Repopulate the grid
   TransferDataToWindow();
 
   // Reposition cursor to NEW row/col and put user into edit mode to
   // set the label name
   mGrid->SetGridCursor(row, Col_Label);
   mGrid->EnableCellEditControl(true);
   mGrid->ShowCellEditControl();
}

References Col_Label, Col_Track, ID_INSERTA, make_iterator_range(), mData, mGrid, mTrackNames, TransferDataToWindow(), and wxT().

Referenced by FindAllLabels().

Here is the call graph for this function:

Here is the caller graph for this function:

OnOK()

void LabelDialog::OnOK ( wxCommandEvent &  event )

private

Definition at line 922 of file LabelDialog.cpp.

{
   if (mGrid->IsCellEditControlShown()) {
      mGrid->SaveEditControlValue();
      mGrid->HideCellEditControl();
      return;
   }
 
   // Standard handling
   if (Validate() && TransferDataFromWindow()) {
      WriteSize();
      EndModal(wxID_OK);
   }
 
   return;
}

References mGrid, TransferDataFromWindow(), Validate(), and WriteSize().

Here is the call graph for this function:

OnRemove()

void LabelDialog::OnRemove ( wxCommandEvent &  event )

private

Definition at line 589 of file LabelDialog.cpp.

{
   int row = mGrid->GetGridCursorRow();
   int col = mGrid->GetGridCursorCol();
   int cnt = mData.size();
 
   // Don't try to remove if no labels exist
   if (cnt == 0) {
      return;
   }
 
   // Make sure the edit control isn't active before removing rows
   if (mGrid->IsCellEditControlShown()) {
      mGrid->HideCellEditControl();
   }
 
   // Remove the row
   //RowData &rd = mData[row];
   mData.erase(mData.begin() + row);
 
   // Repopulate the grid
   TransferDataToWindow();
 
   // Reposition the cursor
   if (row > 0 && row >= --cnt) {
      row--;
   }
   mGrid->SetGridCursor(row, col);
 
   // Make sure focus isn't lost
   if (mData.size() == 0 && wxWindow::FindFocus() == mGrid->GetGridWindow()) {
      wxWindow *ok = wxWindow::FindWindowById( wxID_OK, this);
      if (ok) {
         ok->SetFocus();
      }
   }
}

References BasicUI::FindFocus(), mData, mGrid, and TransferDataToWindow().

Here is the call graph for this function:

OnSelectCell()

void LabelDialog::OnSelectCell ( wxGridEvent &  event )

private

Definition at line 746 of file LabelDialog.cpp.

{
   for (auto t: *mTracks)
      t->SetSelected( true );
 
   if (!mData.empty())
   {
      RowData &rd = mData[event.GetRow()];
      mViewInfo->selectedRegion = rd.selectedRegion;
 
      Viewport::Get(mProject).Redraw();
   }
 
   event.Skip();
}

References Viewport::Get(), mData, mProject, mTracks, mViewInfo, Viewport::Redraw(), ViewInfo::selectedRegion, and RowData::selectedRegion.

Here is the call graph for this function:

OnUpdate()

void LabelDialog::OnUpdate ( wxCommandEvent &  event )

private

Definition at line 527 of file LabelDialog.cpp.

{
   // Remember the NEW format and repopulate grid
   mFormat = NumericConverterFormats::Lookup(
      FormatterContext::ProjectContext(mProject),
      NumericConverterType_TIME(), event.GetString()).Internal();
   TransferDataToWindow();
 
   event.Skip(false);
}

References ComponentInterfaceSymbol::Internal(), NumericConverterFormats::Lookup(), mFormat, mProject, NumericConverterType_TIME(), FormatterContext::ProjectContext(), and TransferDataToWindow().

Here is the call graph for this function:

Populate()

void LabelDialog::Populate ( )

private

Creates the dialog and its contents.

Definition at line 211 of file LabelDialog.cpp.

{
 
   //------------------------- Main section --------------------
   ShuttleGui S(this, eIsCreating);
   PopulateOrExchange(S);
   // ----------------------- End of main section --------------
 
   // Go populate the macros list.
   PopulateLabels();
 
   // Layout the works
   Layout();
   //Fit();
 
   // Resize width based on width of columns and the vertical scrollbar
   wxRect r = mGrid->GetGridColLabelWindow()->GetRect();
   wxScrollBar sb(this, wxID_ANY, wxDefaultPosition, wxDefaultSize, wxSB_VERTICAL);
   r.width += sb.GetSize().GetWidth() + 6;
 
   // Add the size of the right column of buttons too...
   wxWindow * w = FindWindowById( ID_IMPORT, this );
   wxASSERT( w );
   if( w )
      r.width += w->GetSize().GetWidth();
 
   SetClientSize(r.width, 300);
 
   // Make sure it doesn't go below this size
   r = GetRect();
   SetSizeHints(r.GetWidth(), r.GetHeight());
 
   // Bug 1465
   // There might be a saved size, in which case use that.
   ReadSize();
 
   // Center on display
   Center();
}

References eIsCreating, ID_IMPORT, mGrid, PopulateLabels(), PopulateOrExchange(), ReadSize(), and S.

Here is the call graph for this function:

PopulateLabels()

void LabelDialog::PopulateLabels ( )

private

Definition at line 124 of file LabelDialog.cpp.

{
   // Build the initial (empty) grid
   mGrid->CreateGrid(0, Col_Max, wxGrid::wxGridSelectRows);
   mGrid->SetDefaultCellAlignment(wxALIGN_LEFT, wxALIGN_CENTER);
   mGrid->SetRowLabelSize(0);
 
   size_t ii = 0;
   for ( const auto &label : {
      /* i18n-hint: (noun).  A track contains waves, audio etc.*/
      XO("Track"),
      /* i18n-hint: (noun)*/
      XO("Label"),
      /* i18n-hint: (noun) of a label*/
      XO("Start Time"),
      /* i18n-hint: (noun) of a label*/
      XO("End Time"),
      /* i18n-hint: (noun) of a label*/
      XO("Low Frequency"),
      /* i18n-hint: (noun) of a label*/
      XO("High Frequency"),
   })
      mGrid->SetColLabelValue( ii++, label.Translation() );
 
   // Create and remember editors.  No need to DELETE these as the wxGrid will
   // do it for us.  (The DecRef() that is needed after GetDefaultEditorForType
   // becomes the duty of the wxGridCellAttr objects after we set them in the grid.)
   mChoiceEditor = (ChoiceEditor *) mGrid->GetDefaultEditorForType(GRID_VALUE_CHOICE);
   mTimeEditor = static_cast<NumericEditor*>
      (mGrid->GetDefaultEditorForType(GRID_VALUE_TIME));
   mFrequencyEditor = static_cast<NumericEditor *>
      (mGrid->GetDefaultEditorForType(GRID_VALUE_FREQUENCY));
 
   // Initialize and set the track name column attributes
   wxGridCellAttr *attr;
   mGrid->SetColAttr(Col_Track, (attr = safenew wxGridCellAttr));
   attr->SetEditor(mChoiceEditor);
   mTrackNames.push_back(_("New..."));
 
   // Initialize and set the time column attributes
   mGrid->SetColAttr(Col_Stime, (attr = safenew wxGridCellAttr));
   // Don't need DecRef() after this GetDefaultRendererForType.
   attr->SetRenderer(mGrid->GetDefaultRendererForType(GRID_VALUE_TIME));
   attr->SetEditor(mTimeEditor);
   attr->SetAlignment(wxALIGN_CENTER, wxALIGN_CENTER);
 
   mGrid->SetColAttr(Col_Etime, attr->Clone());
 
   // Initialize and set the frequency column attributes
   mGrid->SetColAttr(Col_Lfreq, (attr = safenew wxGridCellAttr));
   // Don't need DecRef() after this GetDefaultRendererForType.
   attr->SetRenderer(mGrid->GetDefaultRendererForType(GRID_VALUE_FREQUENCY));
   attr->SetEditor(mFrequencyEditor);
   attr->SetAlignment(wxALIGN_CENTER, wxALIGN_CENTER);
 
   mGrid->SetColAttr(Col_Hfreq, attr->Clone());
 
   // Seems there's a bug in wxGrid.  Adding only 1 row does not
   // allow SetCellSize() to work properly and you will not get
   // the expected 1 row by 4 column cell.
   //
   // So, we set the minimum row height to 0 and basically hide
   // the extra row by setting its height to 0.  And not allowing the
   // rows to be manually resized prevents the user from ever seeing
   // the extra row.
   mGrid->SetRowMinimalAcceptableHeight(0);
   mGrid->EnableDragRowSize(false);
 
   // Locate all labels in current track list
   FindAllLabels();
 
   // Populate the grid
   TransferDataToWindow();
 
   // Resize the label name column and ensure it doesn't go below an
   // arbitrary width.
   //
   // This should not be in TransferDataToWindow() since a user might
   // resize the column and we'd resize it back to the minimum.
   mGrid->AutoSizeColumn(Col_Label, false );
   mGrid->SetColSize(Col_Label, wxMax(150, mGrid->GetColSize(Col_Label)));
   mGrid->SetColMinimalWidth(Col_Label, mGrid->GetColSize(Col_Label));
 
}

References _, Col_Etime, Col_Hfreq, Col_Label, Col_Lfreq, Col_Max, Col_Stime, Col_Track, FindAllLabels(), GRID_VALUE_CHOICE, GRID_VALUE_FREQUENCY, GRID_VALUE_TIME, label, mChoiceEditor, mFrequencyEditor, mGrid, mTimeEditor, mTrackNames, safenew, TransferDataToWindow(), TranslatableString::Translation(), and XO().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

PopulateOrExchange()

void LabelDialog::PopulateOrExchange ( ShuttleGui &  S )

private

Definition at line 251 of file LabelDialog.cpp.

{
   S.AddFixedText(XO("Press F2 or double click to edit cell contents."));
   S.StartHorizontalLay(wxEXPAND,1);
   {
      S.StartVerticalLay(wxEXPAND,1);
      {
         mGrid = safenew Grid(
            FormatterContext::ProjectContext(mProject), S.GetParent(),
            wxID_ANY);
         S.Prop(1).AddWindow(mGrid);
      }
      S.EndVerticalLay();
      S.StartVerticalLay(0);
      {
         //S.Id(ID_INSERTA).AddButton(XO("&Insert"), wxALIGN_LEFT);
         S.Id(ID_INSERTB).AddButton(XXO("&Insert"), wxALIGN_LEFT);
         //S.Id(EditButtonID).AddButton(XO("&Edit"), wxALIGN_LEFT);
         S.Id(ID_REMOVE).AddButton(XXO("De&lete"), wxALIGN_LEFT);
         S.Id(ID_IMPORT).AddButton(XXO("I&mport..."), wxALIGN_LEFT);
         S.Id(ID_EXPORT).AddButton(XXO("&Export..."), wxALIGN_LEFT);
      }
      S.EndVerticalLay();
   }
   S.EndHorizontalLay();
 
   S.StartHorizontalLay(wxALIGN_RIGHT, false);
   {
      S.AddStandardButtons( eOkButton | eCancelButton | eHelpButton);
   }
   S.EndHorizontalLay();
}

References eCancelButton, eHelpButton, eOkButton, ID_EXPORT, ID_IMPORT, ID_INSERTB, ID_REMOVE, mGrid, mProject, FormatterContext::ProjectContext(), S, safenew, XO(), and XXO().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

ReadSize()

void LabelDialog::ReadSize ( )

private

Definition at line 903 of file LabelDialog.cpp.

                          {
   wxSize sz = GetSize();
   int prefWidth, prefHeight;
   gPrefs->Read(wxT("/LabelEditor/Width"), &prefWidth, sz.x);
   gPrefs->Read(wxT("/LabelEditor/Height"), &prefHeight, sz.y);
 
   wxRect screenRect(wxGetClientDisplayRect());
   wxSize prefSize = wxSize(prefWidth, prefHeight);
   prefSize.DecTo(screenRect.GetSize());
   SetSize(prefSize);
}

References gPrefs, audacity::BasicSettings::Read(), and wxT().

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

Show()

bool LabelDialog::Show ( bool  show = true )

override

Definition at line 351 of file LabelDialog.cpp.

{
   bool ret = wxDialogWrapper::Show(show);
 
#if defined(__WXMAC__) || defined(__WXGTK__)
   if (show) {
      mGrid->SetFocus();   // Required for Linux and Mac.
   }
#endif
 
   // Set initial row
   // (This will not work until the grid is actually displayed)
   if (show && mInitialRow != -1) {
      mGrid->GoToCell(mInitialRow, Col_Label);
   }
 
   return ret;
}

References Col_Label, mGrid, mInitialRow, and ExportProgressUI::Show().

Here is the call graph for this function:

TrackName()

wxString LabelDialog::TrackName ( int &  index, const wxString &  dflt = _("Label Track")  )

private

Definition at line 440 of file LabelDialog.cpp.

{
   // Generate a NEW track name if the passed index is out of range
   if (index < 1 || index >= (int)mTrackNames.size()) {
      index = mTrackNames.size();
      mTrackNames.push_back(wxString::Format(wxT("%d - %s"), index, dflt));
   }
 
   // Return the track name
   return mTrackNames[index];
}

References mTrackNames, and wxT().

Referenced by AddLabels(), OnChangeTrack(), and TransferDataToWindow().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferDataFromWindow()

bool LabelDialog::TransferDataFromWindow ( )

overrideprivate

Definition at line 370 of file LabelDialog.cpp.

{
   int cnt = mData.size();
   int i;
   int tndx = 0;
 
   // Clear label tracks of labels
   for (auto lt : mTracks->Any<LabelTrack>()) {
      ++tndx;
      if (!mSelectedTrack) {
         for (i = lt->GetNumLabels() - 1; i >= 0 ; i--) {
            lt->DeleteLabel(i);
         }
      }
      else if (mSelectedTrack == lt && mIndex > -1) {
         lt->DeleteLabel(mIndex);
      }
      else
         // Do nothing to the nonselected tracks
         ;
   }
 
   // Create any added tracks
   while (tndx < (int)mTrackNames.size() - 1) {
 
      // Extract the name
      wxString name = mTrackNames[tndx + 1].AfterFirst(wxT('-')).Mid(1);
 
      // Create the NEW track and add to track list
      auto newTrack = std::make_shared<LabelTrack>();
      newTrack->SetName(name);
      mTracks->Add( newTrack );
      tndx++;
   }
 
   // Repopulate with updated labels
   for (i = 0; i < cnt; i++) {
      RowData &rd = mData[i];
 
      // Look for track with matching index
      tndx = 1;
      LabelTrack *lt{};
      for (auto t : mTracks->Any<LabelTrack>()) {
         lt = t;
         if (rd.index == tndx++) {
            break;
         }
      }
      wxASSERT(lt);
      if (!lt)
         return false;
 
      // Add the label to it
      lt->AddLabel(rd.selectedRegion, rd.title);
      LabelTrackView::Get( *lt ).ResetTextSelection();
   }
 
   return true;
}

References TrackList::Add(), TrackList::Any(), LabelTrackView::Get(), RowData::index, mData, mIndex, mSelectedTrack, mTrackNames, mTracks, name, LabelTrackView::ResetTextSelection(), RowData::selectedRegion, RowData::title, and wxT().

Referenced by OnOK().

Here is the call graph for this function:

Here is the caller graph for this function:

TransferDataToWindow()

bool LabelDialog::TransferDataToWindow ( )

overrideprivate

Definition at line 291 of file LabelDialog.cpp.

{
   int cnt = mData.size();
   int i;
 
   // Set the editor parameters.  Do this each time since they may change
   // due to NEW tracks and change in NumericTextCtrl format.
   mChoiceEditor->SetChoices(mTrackNames);
   mTimeEditor->SetFormat(mFormat);
   mFrequencyEditor->SetFormat(mFreqFormat);
 
   // Disable redrawing until we're done
   mGrid->BeginBatch();
 
   // Delete all rows
   if (mGrid->GetNumberRows()) {
      mGrid->DeleteRows(0, mGrid->GetNumberRows());
   }
 
   // Add the exact number that we'll need
   mGrid->InsertRows(0, cnt);
 
   // Populate the rows
   for (i = 0; i < cnt; i++) {
      RowData &rd = mData[i];
 
      // Set the cell contents
      mGrid->SetCellValue(i, Col_Track, TrackName(rd.index));
      mGrid->SetCellValue(i, Col_Label, rd.title);
      mGrid->SetCellValue(i, Col_Stime,
         wxString::Format(wxT("%g"), rd.selectedRegion.t0()));
      mGrid->SetCellValue(i, Col_Etime,
         wxString::Format(wxT("%g"), rd.selectedRegion.t1()));
      mGrid->SetCellValue(i, Col_Lfreq,
         wxString::Format(wxT("%g"), rd.selectedRegion.f0()));
      mGrid->SetCellValue(i, Col_Hfreq,
         wxString::Format(wxT("%g"), rd.selectedRegion.f1()));
   }
 
   // Autosize all the rows
   mGrid->AutoSizeRows(true);
 
   // Resize the track name column.  Use a wxChoice to determine the maximum
   // width needed.
   wxChoice tc(this, wxID_ANY, wxDefaultPosition, wxDefaultSize, mTrackNames);
   mGrid->SetColSize(Col_Track, tc.GetSize().x);
   mGrid->SetColMinimalWidth(Col_Track, tc.GetSize().x);
 
   // Autosize the time columns and set their minimal widths
   mGrid->AutoSizeColumn(Col_Stime);
   mGrid->AutoSizeColumn(Col_Etime);
   mGrid->AutoSizeColumn(Col_Lfreq);
   mGrid->AutoSizeColumn(Col_Hfreq);
 
   // We're done, so allow the grid to redraw
   mGrid->EndBatch();
 
   return true;
}

References Col_Etime, Col_Hfreq, Col_Label, Col_Lfreq, Col_Stime, Col_Track, SelectedRegion::f0(), SelectedRegion::f1(), RowData::index, mChoiceEditor, mData, mFormat, mFreqFormat, mFrequencyEditor, mGrid, mTimeEditor, mTrackNames, RowData::selectedRegion, ChoiceEditor::SetChoices(), NumericEditor::SetFormat(), SelectedRegion::t0(), SelectedRegion::t1(), RowData::title, TrackName(), and wxT().

Referenced by OnChangeTrack(), OnFreqUpdate(), OnImport(), OnInsert(), OnRemove(), OnUpdate(), and PopulateLabels().

Here is the call graph for this function:

Here is the caller graph for this function:

Validate()

bool LabelDialog::Validate ( )

overrideprivate

Definition at line 430 of file LabelDialog.cpp.

{
   if (mGrid->IsCellEditControlShown()) {
      mGrid->HideCellEditControl();
      mGrid->SaveEditControlValue();
   }
 
   return true;
}

References mGrid.

Referenced by OnOK().

Here is the caller graph for this function:

WriteSize()

void LabelDialog::WriteSize ( )

private

Definition at line 915 of file LabelDialog.cpp.

                           {
   wxSize sz = GetSize();
   gPrefs->Write(wxT("/LabelEditor/Width"), sz.x);
   gPrefs->Write(wxT("/LabelEditor/Height"), sz.y);
   gPrefs->Flush();
}

References audacity::BasicSettings::Flush(), gPrefs, audacity::BasicSettings::Write(), and wxT().

Referenced by OnCancel(), and OnOK().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mChoiceEditor

ChoiceEditor* LabelDialog::mChoiceEditor

private

Definition at line 98 of file LabelDialog.h.

Referenced by PopulateLabels(), and TransferDataToWindow().

mData

RowDataArray LabelDialog::mData

private

Definition at line 102 of file LabelDialog.h.

Referenced by AddLabels(), FindAllLabels(), FindInitialRow(), OnCellChange(), OnExport(), OnInsert(), OnRemove(), OnSelectCell(), TransferDataFromWindow(), and TransferDataToWindow().

mFormat

NumericFormatID LabelDialog::mFormat

private

Definition at line 109 of file LabelDialog.h.

Referenced by OnUpdate(), and TransferDataToWindow().

mFreqFormat

NumericFormatID LabelDialog::mFreqFormat

private

Definition at line 109 of file LabelDialog.h.

Referenced by OnFreqUpdate(), and TransferDataToWindow().

mFrequencyEditor

NumericEditor* LabelDialog::mFrequencyEditor

private

Definition at line 100 of file LabelDialog.h.

Referenced by PopulateLabels(), and TransferDataToWindow().

mGrid

Grid* LabelDialog::mGrid

private

Definition at line 97 of file LabelDialog.h.

Referenced by OnCancel(), OnChangeEtime(), OnChangeHfreq(), OnChangeLabel(), OnChangeLfreq(), OnChangeStime(), OnChangeTrack(), OnInsert(), OnOK(), OnRemove(), Populate(), PopulateLabels(), PopulateOrExchange(), Show(), TransferDataToWindow(), and Validate().

mIndex

int LabelDialog::mIndex { -1 }

private

Definition at line 106 of file LabelDialog.h.

Referenced by AddLabels(), and TransferDataFromWindow().

mInitialRow

int LabelDialog::mInitialRow

private

Definition at line 111 of file LabelDialog.h.

Referenced by FindInitialRow(), and Show().

mProject

AudacityProject& LabelDialog::mProject

private

Definition at line 95 of file LabelDialog.h.

Referenced by OnFreqUpdate(), OnSelectCell(), OnUpdate(), and PopulateOrExchange().

mSelectedTrack

LabelTrack* LabelDialog::mSelectedTrack {}

private

Definition at line 105 of file LabelDialog.h.

Referenced by AddLabels(), and TransferDataFromWindow().

mTimeEditor

NumericEditor* LabelDialog::mTimeEditor

private

Definition at line 99 of file LabelDialog.h.

Referenced by PopulateLabels(), and TransferDataToWindow().

mTrackNames

wxArrayString LabelDialog::mTrackNames

private

Definition at line 108 of file LabelDialog.h.

Referenced by OnChangeTrack(), OnExport(), OnInsert(), PopulateLabels(), TrackName(), TransferDataFromWindow(), and TransferDataToWindow().

mTracks

TrackList* LabelDialog::mTracks

private

Definition at line 104 of file LabelDialog.h.

Referenced by FindAllLabels(), OnSelectCell(), and TransferDataFromWindow().

mViewInfo

ViewInfo* LabelDialog::mViewInfo

private

Definition at line 107 of file LabelDialog.h.

Referenced by FindInitialRow(), and OnSelectCell().

---

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

• LabelDialog.h
• LabelDialog.cpp