TrackMenuTable Class Reference

Inheritance diagram for TrackMenuTable:

Collaboration diagram for TrackMenuTable:

Static Public Member Functions
static TrackMenuTable &	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)

Private Member Functions
	TrackMenuTable ()
	DECLARE_POPUP_MENU (TrackMenuTable)
void	OnSetName (wxCommandEvent &)
void	OnMoveTrack (wxCommandEvent &event)
void	InitUserData (void *pUserData) override
	Called before the menu items are appended. More...
void	UpdatePrefs () override
Private Member Functions inherited from PrefsListener
	PrefsListener ()
virtual	~PrefsListener ()
virtual void	UpdatePrefs ()=0
virtual void	UpdateSelectedPrefs (int id)

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...
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
Static Private Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Detailed Description

Definition at line 82 of file CommonTrackControls.cpp.

Constructor & Destructor Documentation

TrackMenuTable()

TrackMenuTable::TrackMenuTable ( )

inlineprivate

Definition at line 86 of file CommonTrackControls.cpp.

      : PopupMenuTable{ "Track" }
   {}

Member Function Documentation

DECLARE_POPUP_MENU()

TrackMenuTable::DECLARE_POPUP_MENU ( TrackMenuTable  )

private

InitUserData()

void TrackMenuTable::InitUserData ( void *  pUserData )

overrideprivatevirtual

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 115 of file CommonTrackControls.cpp.

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

References mpData.

Instance()

TrackMenuTable & TrackMenuTable::Instance ( )

static

Definition at line 109 of file CommonTrackControls.cpp.

{
   static TrackMenuTable instance;
   return instance;
}

Referenced by CommonTrackControls::DoContextMenu().

Here is the caller graph for this function:

OnMoveTrack()

void TrackMenuTable::OnMoveTrack ( wxCommandEvent &  event )

private

Definition at line 247 of file CommonTrackControls.cpp.

{
   AudacityProject *const project = &mpData->project;
   TrackUtilities::MoveChoice choice;
   switch (event.GetId()) {
   default:
      wxASSERT(false);
   case OnMoveUpID:
      choice = TrackUtilities::OnMoveUpID; break;
   case OnMoveDownID:
      choice = TrackUtilities::OnMoveDownID; break;
   case OnMoveTopID:
      choice = TrackUtilities::OnMoveTopID; break;
   case OnMoveBottomID:
      choice = TrackUtilities::OnMoveBottomID; break;
   }
 
   TrackUtilities::DoMoveTrack(*project, mpData->pTrack, choice);
 
   // MoveTrack already refreshed TrackPanel, which means repaint will happen.
   // This is a harmless redundancy:
   mpData->result = RefreshCode::RefreshAll;
}

References TrackUtilities::DoMoveTrack(), mpData, OnMoveBottomID, TrackUtilities::OnMoveBottomID, OnMoveDownID, TrackUtilities::OnMoveDownID, OnMoveTopID, TrackUtilities::OnMoveTopID, OnMoveUpID, TrackUtilities::OnMoveUpID, project, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, RefreshCode::RefreshAll, and CommonTrackControls::InitMenuData::result.

Here is the call graph for this function:

OnSetName()

void TrackMenuTable::OnSetName ( wxCommandEvent &  )

private

Definition at line 220 of file CommonTrackControls.cpp.

{
   Track *const pTrack = mpData->pTrack;
   if (pTrack)
   {
      AudacityProject *const proj = &mpData->project;
      const wxString oldName = pTrack->GetName();
 
      SetTrackNameCommand Command;
      Command.mName = oldName;
      // Bug 1837 : We need an OK/Cancel result if we are to enter a blank string.
      bool bResult = Command.PromptUser( &GetProjectFrame( *proj ) );
      if (bResult) 
      {
         wxString newName = Command.mName;
         pTrack->SetName(newName);
 
         ProjectHistory::Get( *proj )
            .PushState(
               XO("Renamed '%s' to '%s'").Format( oldName, newName ),
               XO("Name Change"));
 
         mpData->result = RefreshCode::RefreshAll;
      }
   }
}

References MenuRegistry::Command, ProjectHistory::Get(), Track::GetName(), GetProjectFrame(), mpData, CommonTrackControls::InitMenuData::project, CommonTrackControls::InitMenuData::pTrack, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, Track::SetName(), and XO().

Here is the call graph for this function:

UpdatePrefs()

void TrackMenuTable::UpdatePrefs ( )

inlineoverrideprivatevirtual

Implements PrefsListener.

Definition at line 102 of file CommonTrackControls.cpp.

   {
      // Because labels depend on keyboard preferences
      PopupMenuTable::Clear();
   }

References PopupMenuTable::Clear().

Here is the call graph for this function:

Member Data Documentation

mpData

CommonTrackControls::InitMenuData* TrackMenuTable::mpData {}

private

Definition at line 100 of file CommonTrackControls.cpp.

Referenced by InitUserData(), OnMoveTrack(), and OnSetName().

---

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

• CommonTrackControls.cpp