WaveTrackMenuTable Struct Reference

Inheritance diagram for WaveTrackMenuTable:

Collaboration diagram for WaveTrackMenuTable:

Public Member Functions
	WaveTrackMenuTable ()
void	InitUserData (void *pUserData) override
	Called before the menu items are appended. More...
	DECLARE_POPUP_MENU (WaveTrackMenuTable)
void	OnMultiView (wxCommandEvent &event)
void	OnSetDisplay (wxCommandEvent &event)
	Set the Display mode based on the menu choice in the Track Menu. More...
void	OnChannelChange (wxCommandEvent &event)
void	OnMergeStereo (wxCommandEvent &event)
	Merge two tracks into one stereo track ?? More...
void	SplitStereo (bool stereo)
	Split a stereo track (or more-than-stereo?) into two (or more) tracks... More...
void	OnSwapChannels (wxCommandEvent &event)
	Swap the left and right channels of a stero track... More...
void	OnSplitStereo (wxCommandEvent &event)
	Split a stereo track into two tracks... More...
void	OnSplitStereoMono (wxCommandEvent &event)
	Split a stereo track into two mono tracks... More...
Public Member Functions inherited from ComputedPopupMenuTable< WaveTrackMenuTable, WaveTrackPopupMenuTable >
void	Append (const Factory &factory)
Public Member Functions inherited from WaveTrackPopupMenuTable
WaveTrack &	FindWaveTrack () const
int	ReserveId ()
	PopupMenuTable (const Identifier &id, const TranslatableString &caption={})
Public Member Functions inherited from PopupMenuTable
	PopupMenuTable (const Identifier &id, const TranslatableString &caption={})
const Identifier &	Id () const
const TranslatableString &	Caption () const
const Registry::GroupItem *	GetRegistry () const
const std::shared_ptr< Registry::GroupItem > &	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 WaveTrackMenuTable &	Instance ()
Static Public Member Functions inherited from ComputedPopupMenuTable< WaveTrackMenuTable, WaveTrackPopupMenuTable >
static Registry::BaseItemPtr	Computed (const Factory &factory)
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 >
static Registry::BaseItemPtr	Computed (const std::function< Registry::BaseItemPtr(Table &) > &factory)

Additional Inherited Members
Public Types inherited from ComputedPopupMenuTable< WaveTrackMenuTable, WaveTrackPopupMenuTable >
using	Factory = std::function< Registry::BaseItemPtr(WaveTrackMenuTable &) >
Public Types inherited from PopupMenuTable
using	Entry = PopupMenuTableEntry
Public Attributes inherited from WaveTrackPopupMenuTable
PlayableTrackControls::InitMenuData *	mpData {}
Protected Member Functions inherited from PopupMenuTable
virtual void	Populate ()=0
void	Append (Registry::BaseItemPtr 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 WaveTrackPopupMenuTable
int	mNextId = 0
Protected Attributes inherited from PopupMenuTable
std::shared_ptr< Registry::GroupItem >	mTop
std::vector< Registry::GroupItem * >	mStack
Identifier	mId
TranslatableString	mCaption
std::unique_ptr< Registry::GroupItem >	mRegistry

Detailed Description

Definition at line 492 of file WaveTrackControls.cpp.

Constructor & Destructor Documentation

WaveTrackMenuTable()

WaveTrackMenuTable::WaveTrackMenuTable ( )

inline

Definition at line 497 of file WaveTrackControls.cpp.

      : ComputedPopupMenuTable< WaveTrackMenuTable, WaveTrackPopupMenuTable >{
         MenuPathStart }
   {
      mNextId = FirstAttachedItemId;
   }

References MenuPathStart.

Member Function Documentation

DECLARE_POPUP_MENU()

WaveTrackMenuTable::DECLARE_POPUP_MENU

(

WaveTrackMenuTable

)

InitUserData()

void WaveTrackMenuTable::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 529 of file WaveTrackControls.cpp.

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

References WaveTrackPopupMenuTable::mpData.

Instance()

WaveTrackMenuTable & WaveTrackMenuTable::Instance ( )

static

Definition at line 523 of file WaveTrackControls.cpp.

{
   static WaveTrackMenuTable instance;
   return instance;
}

Referenced by WaveTrackControls::GetMenuExtension(), and GetWaveTrackMenuTable().

Here is the caller graph for this function:

OnChannelChange()

void WaveTrackMenuTable::OnChannelChange

(

wxCommandEvent &

event

)

OnMergeStereo()

void WaveTrackMenuTable::OnMergeStereo

(

wxCommandEvent &

event

)

Merge two tracks into one stereo track ??

Definition at line 810 of file WaveTrackControls.cpp.

{
   AudacityProject *const project = &mpData->project;
   auto &tracks = TrackList::Get( *project );
 
   WaveTrack *const pTrack = static_cast<WaveTrack*>(mpData->pTrack);
   wxASSERT(pTrack);
 
   auto partner = static_cast< WaveTrack * >
      ( *tracks.Find( pTrack ).advance( 1 ) );
 
   bool bBothMinimizedp =
      ((TrackView::Get( *pTrack ).GetMinimized()) &&
       (TrackView::Get( *partner ).GetMinimized()));
 
   tracks.MakeMultiChannelTrack( *pTrack, 2, false );
 
   // Set partner's parameters to match target.
   partner->Merge(*pTrack);
 
   pTrack->SetPan( 0.0f );
   partner->SetPan( 0.0f );
 
   // Set NEW track heights and minimized state
   auto
      &view = WaveTrackView::Get( *pTrack ),
      &partnerView = WaveTrackView::Get( *partner );
   view.SetMinimized(false);
   partnerView.SetMinimized(false);
   int AverageHeight = (view.GetHeight() + partnerView.GetHeight()) / 2;
   view.SetExpandedHeight(AverageHeight);
   partnerView.SetExpandedHeight(AverageHeight);
   view.SetMinimized(bBothMinimizedp);
   partnerView.SetMinimized(bBothMinimizedp);
 
   partnerView.RestorePlacements( view.SavePlacements() );
   partnerView.SetMultiView( view.GetMultiView() );
 
   ProjectHistory::Get( *project ).PushState(
      /* i18n-hint: The string names a track */
      XO("Made '%s' a stereo track").Format( pTrack->GetName() ),
      XO("Make Stereo"));
 
   using namespace RefreshCode;
   mpData->result = RefreshAll | FixScrollbars;
}

References RefreshCode::FixScrollbars, ProjectHistory::Get(), TrackList::Get(), TrackView::Get(), WaveTrackView::Get(), TrackView::GetMinimized(), Track::GetName(), WaveTrack::Merge(), WaveTrackPopupMenuTable::mpData, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, WaveTrack::SetPan(), and XO().

Here is the call graph for this function:

OnMultiView()

void WaveTrackMenuTable::OnMultiView

(

wxCommandEvent &

event

)

Definition at line 713 of file WaveTrackControls.cpp.

{
   const auto pTrack = static_cast<WaveTrack*>(mpData->pTrack);
   const auto &view = WaveTrackView::Get( *pTrack );
   bool multi = !view.GetMultiView();
   const auto &displays = view.GetDisplays();
   const auto display = displays.empty()
      ? WaveTrackViewConstants::Waveform : displays.begin()->id;
   for (const auto channel : TrackList::Channels(pTrack)) {
      auto &channelView = WaveTrackView::Get( *channel );
      channelView.SetMultiView( multi );
 
      // Whichever sub-view was on top stays on top
      // If going into Multi-view, it will be 1/nth the height.
      // If exiting multi-view, it will be full height.
      channelView.SetDisplay(display, !multi);
   }
}

References TrackList::Channels(), WaveTrackView::Get(), and WaveTrackViewConstants::Waveform.

Here is the call graph for this function:

OnSetDisplay()

void WaveTrackMenuTable::OnSetDisplay

(

wxCommandEvent &

event

)

Set the Display mode based on the menu choice in the Track Menu.

Definition at line 733 of file WaveTrackControls.cpp.

{
   int idInt = event.GetId();
   wxASSERT(idInt >= OnSetDisplayId &&
            idInt <= lastDisplayId);
   const auto pTrack = static_cast<WaveTrack*>(mpData->pTrack);
 
   auto id = AllTypes()[ idInt - OnSetDisplayId ].id;
 
   auto &view = WaveTrackView::Get( *pTrack );
   if ( view.GetMultiView() ) {
      for (auto channel : TrackList::Channels(pTrack)) {
         if ( !WaveTrackView::Get( *channel )
               .ToggleSubView( WaveTrackView::Display{ id } ) ) {
            // Trying to toggle off the last sub-view.  It was refused.
            // Decide what to do here.  Turn off multi-view instead?
            // PRL:  I don't agree that it makes sense
         }
         else
            ProjectHistory::Get( mpData->project ).ModifyState(true);
      }
   }
   else {
      const auto displays = view.GetDisplays();
      const bool wrongType =
         !(displays.size() == 1 && displays[0].id == id);
      if (wrongType) {
         for (auto channel : TrackList::Channels(pTrack)) {
            WaveTrackView::Get( *channel )
               .SetDisplay( WaveTrackView::Display{ id } );
         }
 
         AudacityProject *const project = &mpData->project;
         ProjectHistory::Get( *project ).ModifyState(true);
 
         using namespace RefreshCode;
         mpData->result = RefreshAll | UpdateVRuler;
      }
   }
}

References AllTypes(), TrackList::Channels(), ProjectHistory::Get(), WaveTrackView::Get(), id, lastDisplayId, ProjectHistory::ModifyState(), WaveTrackPopupMenuTable::mpData, OnSetDisplayId, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, WaveTrackView::SetDisplay(), and RefreshCode::UpdateVRuler.

Here is the call graph for this function:

OnSplitStereo()

void WaveTrackMenuTable::OnSplitStereo

(

wxCommandEvent &

event

)

Split a stereo track into two tracks...

Definition at line 920 of file WaveTrackControls.cpp.

{
   SplitStereo(true);
   WaveTrack *const pTrack = static_cast<WaveTrack*>(mpData->pTrack);
   AudacityProject *const project = &mpData->project;
   ProjectHistory::Get( *project ).PushState(
   /* i18n-hint: The string names a track  */
      XO("Split stereo track '%s'").Format( pTrack->GetName() ),
      XO("Split"));
 
   using namespace RefreshCode;
   mpData->result = RefreshAll | FixScrollbars;
}

References RefreshCode::FixScrollbars, ProjectHistory::Get(), Track::GetName(), WaveTrackPopupMenuTable::mpData, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, SplitStereo(), and XO().

Here is the call graph for this function:

OnSplitStereoMono()

void WaveTrackMenuTable::OnSplitStereoMono

(

wxCommandEvent &

event

)

Split a stereo track into two mono tracks...

Definition at line 935 of file WaveTrackControls.cpp.

{
   SplitStereo(false);
   WaveTrack *const pTrack = static_cast<WaveTrack*>(mpData->pTrack);
   AudacityProject *const project = &mpData->project;
   ProjectHistory::Get( *project ).PushState(
   /* i18n-hint: The string names a track  */
      XO("Split Stereo to Mono '%s'").Format( pTrack->GetName() ),
      XO("Split to Mono"));
 
   using namespace RefreshCode;
   mpData->result = RefreshAll | FixScrollbars;
}

References RefreshCode::FixScrollbars, ProjectHistory::Get(), Track::GetName(), WaveTrackPopupMenuTable::mpData, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, SplitStereo(), and XO().

Here is the call graph for this function:

OnSwapChannels()

void WaveTrackMenuTable::OnSwapChannels

(

wxCommandEvent &

event

)

Swap the left and right channels of a stero track...

Definition at line 890 of file WaveTrackControls.cpp.

{
   AudacityProject *const project = &mpData->project;
 
   WaveTrack *const pTrack = static_cast<WaveTrack*>(mpData->pTrack);
   auto channels = TrackList::Channels( pTrack );
   if (channels.size() != 2)
      return;
 
   auto &trackFocus = TrackFocus::Get( *project );
   Track *const focused = trackFocus.Get();
   const bool hasFocus = channels.contains( focused );
 
   auto partner = *channels.rbegin();
 
   if (TrackList::SwapChannels(*pTrack)) {
      auto &tracks = TrackList::Get( *project );
      if (hasFocus)
         trackFocus.Set(partner);
 
      ProjectHistory::Get( *project ).PushState(
         /* i18n-hint: The string names a track  */
         XO("Swapped Channels in '%s'").Format( pTrack->GetName() ),
         XO("Swap Channels"));
   }
 
   mpData->result = RefreshCode::RefreshAll;
}

References TrackList::Channels(), TrackFocus::Get(), ProjectHistory::Get(), TrackList::Get(), ClientData::Site< Host, ClientData, ObjectCopyingPolicy, Pointer, ObjectLockingPolicy, RegistryLockingPolicy >::Get(), Track::GetName(), WaveTrackPopupMenuTable::mpData, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, TrackList::SwapChannels(), and XO().

Here is the call graph for this function:

SplitStereo()

void WaveTrackMenuTable::SplitStereo

(

bool

stereo

)

Split a stereo track (or more-than-stereo?) into two (or more) tracks...

Definition at line 858 of file WaveTrackControls.cpp.

{
   WaveTrack *const pTrack = static_cast<WaveTrack*>(mpData->pTrack);
   wxASSERT(pTrack);
   AudacityProject *const project = &mpData->project;
   auto channels = TrackList::Channels( pTrack );
 
   int totalHeight = 0;
   int nChannels = 0;
   for (auto channel : channels) {
      // Keep original stereo track name.
      channel->SetName(pTrack->GetName());
      auto &view = TrackView::Get( *channel );
      if (stereo)
         channel->SetPanFromChannelType();
 
      //make sure no channel is smaller than its minimum height
      if (view.GetHeight() < view.GetMinimizedHeight())
         view.SetExpandedHeight(view.GetMinimizedHeight());
      totalHeight += view.GetHeight();
      ++nChannels;
   }
 
   TrackList::Get( *project ).UnlinkChannels( *pTrack );
   int averageHeight = totalHeight / nChannels;
 
   for (auto channel : channels)
      // Make tracks the same height
      TrackView::Get( *channel ).SetExpandedHeight( averageHeight );
}

References TrackList::Channels(), TrackList::Get(), TrackView::Get(), Track::GetName(), WaveTrackPopupMenuTable::mpData, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, TrackView::SetExpandedHeight(), and TrackList::UnlinkChannels().

Referenced by OnSplitStereo(), and OnSplitStereoMono().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• WaveTrackControls.cpp