RateMenuTable Struct Reference

Inheritance diagram for RateMenuTable:

Collaboration diagram for RateMenuTable:

Public Member Functions
	RateMenuTable ()
	DECLARE_POPUP_MENU (RateMenuTable)
void	InitUserData (void *pUserData) override
	Called before the menu items are appended. More...
void	SetRate (WaveTrack &track, double rate)
	Sets the sample rate for a track. More...
void	OnRateChange (wxCommandEvent &event)
void	OnRateOther (wxCommandEvent &event)
Public Member Functions inherited from PopupMenuTable
	PopupMenuTable (const Identifier &id, const TranslatableString &caption={})
const Identifier &	Id () const
const TranslatableString &	Caption () const
const auto *	GetRegistry () const
const auto &	Get (void *pUserData)
void	Clear ()
Public Member Functions inherited from PopupMenuHandler
	PopupMenuHandler ()=default
	PopupMenuHandler (const PopupMenuHandler &)=delete
PopupMenuHandler &	operator= (const PopupMenuHandler &)=delete
virtual void	InitUserData (void *pUserData)=0
	Called before the menu items are appended. More...

Static Public Member Functions
static RateMenuTable &	Instance ()
static int	IdOfRate (int rate)
	Converts a sampling rate to a wxWidgets menu item id. More...
Static Public Member Functions inherited from PopupMenuTable
static std::unique_ptr< PopupMenu >	BuildMenu (PopupMenuTable *pTable, void *pUserData=NULL)
static void	ExtendMenu (PopupMenu &menu, PopupMenuTable &otherTable)
template<typename Table , typename Factory >
static auto	Adapt (const Factory &factory)

Public Attributes
PlayableTrackControls::InitMenuData *	mpData {}

Additional Inherited Members
Public Types inherited from PopupMenuTable
using	Entry = PopupMenuTableEntry
Protected Member Functions inherited from PopupMenuTable
virtual void	Populate ()=0
template<typename Ptr >
void	Append (Ptr pItem)
void	Append (const Identifier &stringId, PopupMenuTableEntry::Type type, int id, const TranslatableString &string, wxCommandEventFunction memFn, const PopupMenuTableEntry::InitFunction &init)
void	AppendItem (const Identifier &stringId, int id, const TranslatableString &string, wxCommandEventFunction memFn, const PopupMenuTableEntry::InitFunction &init={})
void	AppendRadioItem (const Identifier &stringId, int id, const TranslatableString &string, wxCommandEventFunction memFn, const PopupMenuTableEntry::InitFunction &init={})
void	AppendCheckItem (const Identifier &stringId, int id, const TranslatableString &string, wxCommandEventFunction memFn, const PopupMenuTableEntry::InitFunction &init={})
void	BeginSection (const Identifier &name)
void	EndSection ()
Static Protected Member Functions inherited from PopupMenuTable
static TranslatableString	MakeLabel (const TranslatableString &label, bool useExtra, const TranslatableString &extra)
Protected Attributes inherited from PopupMenuTable
std::shared_ptr< PopupSubMenu >	mTop
std::vector< PopupMenuGroupItem * >	mStack
Identifier	mId
TranslatableString	mCaption
std::unique_ptr< PopupMenuGroupItem >	mRegistry

Detailed Description

Definition at line 304 of file WaveTrackControls.cpp.

Constructor & Destructor Documentation

RateMenuTable()

RateMenuTable::RateMenuTable ( )

inline

Definition at line 306 of file WaveTrackControls.cpp.

      : PopupMenuTable{ "SampleRate", XO("Rat&e") }
   {}

Member Function Documentation

DECLARE_POPUP_MENU()

RateMenuTable::DECLARE_POPUP_MENU

(

RateMenuTable

)

IdOfRate()

int RateMenuTable::IdOfRate ( int  rate )

static

Converts a sampling rate to a wxWidgets menu item id.

Definition at line 370 of file WaveTrackControls.cpp.

{
   for (int i = 0; i<nRates; i++) {
      if (gRates[i] == rate)
         return i + OnRate8ID;
   }
   return OnRateOtherID;
}

References gRates, nRates, OnRate8ID, and OnRateOtherID.

InitUserData()

void RateMenuTable::InitUserData ( void *  pUserData )

overridevirtual

Called before the menu items are appended.

Store context data, if needed. May be called more than once before the menu opens. Pointer remains valid for the duration of any callback, if PopupMenuTable::BuildMenu() is called and the result's Popup() is called before any other menus are built.

Implements PopupMenuHandler.

Definition at line 331 of file WaveTrackControls.cpp.

{
   mpData = static_cast<PlayableTrackControls::InitMenuData*>(pUserData);
}

References mpData.

Instance()

RateMenuTable & RateMenuTable::Instance ( )

static

Definition at line 325 of file WaveTrackControls.cpp.

{
   static RateMenuTable instance;
   return instance;
}

OnRateChange()

void RateMenuTable::OnRateChange

(

wxCommandEvent &

event

)

This method handles the selection from the Rate submenu of the track menu, except for "Other" (/see OnRateOther).

Definition at line 403 of file WaveTrackControls.cpp.

{
   int id = event.GetId();
   wxASSERT(id >= OnRate8ID && id <= OnRate384ID);
   auto &track = static_cast<WaveTrack&>(mpData->track);
 
   SetRate(track, gRates[id - OnRate8ID]);
 
   using namespace RefreshCode;
   mpData->result = RefreshAll | FixScrollbars;
}

References RefreshCode::FixScrollbars, gRates, mpData, OnRate384ID, OnRate8ID, RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, SetRate(), and CommonTrackControls::InitMenuData::track.

Here is the call graph for this function:

OnRateOther()

void RateMenuTable::OnRateOther

(

wxCommandEvent &

event

)

Todo:

Remove artificial constants!!

Todo:

Todo:

Make a real dialog box out of this!!

Definition at line 415 of file WaveTrackControls.cpp.

{
   auto &track = static_cast<WaveTrack&>(mpData->track);
 
   int newRate;
 
   while (true)
   {
      wxDialogWrapper dlg(mpData->pParent, wxID_ANY, XO("Set Rate"));
      dlg.SetName();
      ShuttleGui S(&dlg, eIsCreating);
      wxString rate;
      wxComboBox *cb;
 
      rate.Printf(wxT("%ld"), lrint(track.GetRate()));
 
      wxArrayStringEx rates{
         wxT("8000") ,
         wxT("11025") ,
         wxT("16000") ,
         wxT("22050") ,
         wxT("44100") ,
         wxT("48000") ,
         wxT("88200") ,
         wxT("96000") ,
         wxT("176400") ,
         wxT("192000") ,
         wxT("352800") ,
         wxT("384000") ,
      };
 
      S.StartVerticalLay(true);
      {
         S.SetBorder(10);
         S.StartHorizontalLay(wxEXPAND, false);
         {
            cb = S.AddCombo(XXO("New sample rate (Hz):"),
               rate,
               rates);
#if defined(__WXMAC__)
            // As of wxMac-2.8.12, setting manually is required
            // to handle rates not in the list.  See: Bug #427
            cb->SetValue(rate);
#endif
         }
         S.EndHorizontalLay();
         S.AddStandardButtons();
      }
      S.EndVerticalLay();
 
      dlg.SetClientSize(dlg.GetSizer()->CalcMin());
      dlg.Center();
 
      if (dlg.ShowModal() != wxID_OK)
      {
         return;  // user cancelled dialog
      }
 
      long lrate;
      if (cb->GetValue().ToLong(&lrate) && lrate >= 1 && lrate <= 1000000)
      {
         newRate = (int)lrate;
         break;
      }
 
      AudacityMessageBox(
         XO("The entered value is invalid"),
         XO("Error"),
         wxICON_ERROR,
         mpData->pParent);
   }
 
   SetRate(track, newRate);
 
   using namespace RefreshCode;
   mpData->result = RefreshAll | FixScrollbars;
}

References AudacityMessageBox(), eIsCreating, RefreshCode::FixScrollbars, WaveTrack::GetRate(), lrint, mpData, CommonTrackControls::InitMenuData::pParent, RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, S, wxDialogWrapper::SetName(), SetRate(), CommonTrackControls::InitMenuData::track, wxT(), XO(), and XXO().

Here is the call graph for this function:

SetRate()

void RateMenuTable::SetRate	(	WaveTrack &	track,
		double	rate
	)

Sets the sample rate for a track.

Definition at line 379 of file WaveTrackControls.cpp.

{
   AudacityProject *const project = &mpData->project;
   auto end1 = track.GetEndTime();
   track.SetRate(rate);
   if (SyncLockState::Get(*project).IsSyncLocked()) {
      auto end2 = track.GetEndTime();
      for (auto pLocked : SyncLock::Group(track)) {
         if (pLocked != &track)
            pLocked->SyncLockAdjust(end1, end2);
      }
   }
 
   // Separate conversion of "rate" enables changing the decimals without affecting i18n
   wxString rateString = wxString::Format(wxT("%.3f"), rate);
   ProjectHistory::Get( *project )
   /* i18n-hint: The string names a track */
      .PushState(XO("Changed '%s' to %s Hz")
         .Format(track.GetName(), rateString),
      XO("Rate Change"));
}

References ProjectHistory::Get(), SyncLockState::Get(), WaveTrack::GetEndTime(), Track::GetName(), SyncLock::Group(), SyncLockState::IsSyncLocked(), mpData, project, CommonTrackControls::InitMenuData::project, ProjectHistory::PushState(), WaveTrack::SetRate(), wxT(), and XO().

Referenced by OnRateChange(), and OnRateOther().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mpData

PlayableTrackControls::InitMenuData* RateMenuTable::mpData {}

Definition at line 315 of file WaveTrackControls.cpp.

Referenced by InitUserData(), OnRateChange(), OnRateOther(), and SetRate().

---

The documentation for this struct was generated from the following file:

• WaveTrackControls.cpp