TimeTrackMenuTable Class Reference

#include <TimeTrackControls.h>

Inheritance diagram for TimeTrackMenuTable:

Collaboration diagram for TimeTrackMenuTable:

Static Public Member Functions
static TimeTrackMenuTable &	Instance ()
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)

Protected Member Functions
void	InitUserData (void *pUserData) override
	Called before the menu items are appended. More...
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 ()

Private Member Functions
	TimeTrackMenuTable ()
	DECLARE_POPUP_MENU (TimeTrackMenuTable)
void	OnSetTimeTrackRange (wxCommandEvent &)
void	OnTimeTrackLin (wxCommandEvent &)
void	OnTimeTrackLog (wxCommandEvent &)
void	OnTimeTrackLogInt (wxCommandEvent &)

Private Attributes
CommonTrackControls::InitMenuData *	mpData {}

Additional Inherited Members
Public Types inherited from PopupMenuTable
using	Entry = PopupMenuTableEntry
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 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 39 of file TimeTrackControls.h.

Constructor & Destructor Documentation

TimeTrackMenuTable()

TimeTrackMenuTable::TimeTrackMenuTable ( )

inlineprivate

Definition at line 41 of file TimeTrackControls.h.

      : PopupMenuTable{ "TimeTrack" }
   {}

Member Function Documentation

DECLARE_POPUP_MENU()

TimeTrackMenuTable::DECLARE_POPUP_MENU ( TimeTrackMenuTable  )

private

InitUserData()

void TimeTrackMenuTable::InitUserData ( void *  pUserData )

overrideprotectedvirtual

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 51 of file TimeTrackControls.cpp.

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

References mpData.

Instance()

TimeTrackMenuTable & TimeTrackMenuTable::Instance ( )

static

Definition at line 45 of file TimeTrackControls.cpp.

{
   static TimeTrackMenuTable instance;
   return instance;
}

Referenced by TimeTrackControls::GetMenuExtension(), and TimeTrackVZoomHandle::Release().

Here is the caller graph for this function:

OnSetTimeTrackRange()

void TimeTrackMenuTable::OnSetTimeTrackRange ( wxCommandEvent &  )

private

Definition at line 56 of file TimeTrackControls.cpp.

{
   auto &track = static_cast<TimeTrack&>(mpData->track);
   long lower = (long)(track.GetRangeLower() * 100.0 + 0.5);
   long upper = (long)(track.GetRangeUpper() * 100.0 + 0.5);
 
   // MB: these lower/upper limits match the maximum allowed range of the time track
   // envelope, but this is not strictly required
 
   wxDialogWrapper dlg(mpData->pParent, wxID_ANY, XO("Change Speed Limits"));
   dlg.SetName();
   ShuttleGui S(&dlg, eIsCreating);
   wxSpinCtrl *scLower;
   wxSpinCtrl *scUpper;
 
   S.StartVerticalLay(true);
   {
      S.StartStatic(XO("Change speed limit (%) to:"),1);
      {
         S.StartMultiColumn(2, wxEXPAND);
         {  
 
            S.SetStretchyCol(1);
 
            S.AddPrompt(XXO("Lower Speed Limit"));
            scLower = safenew wxSpinCtrl(S.GetParent(), wxID_ANY,
               wxT(""),
               wxDefaultPosition,
               wxDefaultSize,
               wxSP_ARROW_KEYS,
               TimeTrackControls::kRangeMin, TimeTrackControls::kRangeMax, lower);
            S
               .Name(XO("Lower Speed Limit"))
               .Position( wxALIGN_LEFT | wxALL )
               .AddWindow(scLower);
 
            S.AddPrompt(XXO("Upper Speed Limit"));
            scUpper = safenew wxSpinCtrl(S.GetParent(), wxID_ANY,
               wxT(""),
               wxDefaultPosition,
               wxDefaultSize,
               wxSP_ARROW_KEYS,
               TimeTrackControls::kRangeMin, TimeTrackControls::kRangeMax, upper);
            S
               .Name(XO("Upper Speed Limit"))
               .Position( wxALIGN_LEFT | wxALL )
               .AddWindow(scUpper);
            
         }
         S.EndMultiColumn();
      }
      S.EndStatic();
      S.AddStandardButtons();
   }
   S.EndVerticalLay();
 
   dlg.Layout();
   dlg.Fit();
   dlg.CenterOnParent();
   if (dlg.ShowModal() == wxID_CANCEL)
      return;
 
   while(scLower->GetValue() >= scUpper->GetValue()) {
      AudacityMessageBox(
         XO("Upper Speed Limit must be greater than the Lower Speed Limit"),
         XO("Invalid Limits"),
         wxOK | wxICON_ERROR,
         mpData->pParent);
 
      if (dlg.ShowModal() == wxID_CANCEL)
         return;
   }
 
   lower = scLower->GetValue();
   upper = scUpper->GetValue();
 
   if (lower >= TimeTrackControls::kRangeMin &&
       upper <= TimeTrackControls::kRangeMax) {
      AudacityProject *const project = &mpData->project;
      track.SetRangeLower((double)lower / 100.0);
      track.SetRangeUpper((double)upper / 100.0);
      ProjectHistory::Get( *project )
         .PushState(XO("Set range to '%ld' - '%ld'").Format( lower, upper ),
            /* i18n-hint: (verb)*/
            XO("Set Range"));
      mpData->result = RefreshCode::RefreshAll;
   }
}

References AudacityMessageBox(), eIsCreating, ProjectHistory::Get(), TimeTrackControls::kRangeMax, TimeTrackControls::kRangeMin, mpData, CommonTrackControls::InitMenuData::pParent, project, CommonTrackControls::InitMenuData::project, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, S, safenew, wxDialogWrapper::SetName(), CommonTrackControls::InitMenuData::track, wxT(), XO(), and XXO().

Here is the call graph for this function:

OnTimeTrackLin()

void TimeTrackMenuTable::OnTimeTrackLin ( wxCommandEvent &  )

private

Definition at line 145 of file TimeTrackControls.cpp.

{
   auto &track = static_cast<TimeTrack&>(mpData->track);
   track.SetDisplayLog(false);
   AudacityProject *const project = &mpData->project;
   ProjectHistory::Get( *project )
      .PushState(XO("Set time track display to linear"), XO("Set Display"));
 
   using namespace RefreshCode;
   mpData->result = RefreshAll | UpdateVRuler;
}

References ProjectHistory::Get(), mpData, project, CommonTrackControls::InitMenuData::project, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, TimeTrack::SetDisplayLog(), CommonTrackControls::InitMenuData::track, RefreshCode::UpdateVRuler, and XO().

Here is the call graph for this function:

OnTimeTrackLog()

void TimeTrackMenuTable::OnTimeTrackLog ( wxCommandEvent &  )

private

Definition at line 157 of file TimeTrackControls.cpp.

{
   auto &track = static_cast<TimeTrack&>(mpData->track);
   track.SetDisplayLog(true);
   AudacityProject *const project = &mpData->project;
   ProjectHistory::Get( *project )
      .PushState(XO("Set time track display to logarithmic"), XO("Set Display"));
 
   using namespace RefreshCode;
   mpData->result = RefreshAll | UpdateVRuler;
}

References ProjectHistory::Get(), mpData, project, CommonTrackControls::InitMenuData::project, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, TimeTrack::SetDisplayLog(), CommonTrackControls::InitMenuData::track, RefreshCode::UpdateVRuler, and XO().

Here is the call graph for this function:

OnTimeTrackLogInt()

void TimeTrackMenuTable::OnTimeTrackLogInt ( wxCommandEvent &  )

private

Definition at line 169 of file TimeTrackControls.cpp.

{
   auto &track = static_cast<TimeTrack&>(mpData->track);
   AudacityProject *const project = &mpData->project;
   if (track.GetInterpolateLog()) {
      track.SetInterpolateLog(false);
      ProjectHistory::Get( *project )
         .PushState(XO("Set time track interpolation to linear"), XO("Set Interpolation"));
   }
   else {
      track.SetInterpolateLog(true);
      ProjectHistory::Get( *project ).
         PushState(XO("Set time track interpolation to logarithmic"), XO("Set Interpolation"));
   }
   mpData->result = RefreshCode::RefreshAll;
}

References ProjectHistory::Get(), mpData, project, CommonTrackControls::InitMenuData::project, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, CommonTrackControls::InitMenuData::track, and XO().

Here is the call graph for this function:

Member Data Documentation

mpData

CommonTrackControls::InitMenuData* TimeTrackMenuTable::mpData {}

private

Definition at line 54 of file TimeTrackControls.h.

Referenced by InitUserData(), OnSetTimeTrackRange(), OnTimeTrackLin(), OnTimeTrackLog(), and OnTimeTrackLogInt().

---

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

• TimeTrackControls.h
• TimeTrackControls.cpp