Audacity 3.2.0
Static Public Member Functions | Private Member Functions | Private Attributes | List of all members
TrackMenuTable Class Reference
Inheritance diagram for TrackMenuTable:
Collaboration diagram for TrackMenuTable:

Static Public Member Functions

static TrackMenuTableInstance ()
- Static Public Member Functions inherited from PopupMenuTable
static std::unique_ptr< PopupMenuBuildMenu (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)

Private Member Functions

 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::InitMenuDatampData {}

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 IdentifierId () const
const TranslatableStringCaption () const
const Registry::GroupItemGetRegistry () const
const std::shared_ptr< Registry::GroupItem > & Get (void *pUserData)
void Clear ()
- Public Member Functions inherited from PopupMenuHandler
 PopupMenuHandler ()=default
 PopupMenuHandler (const PopupMenuHandler &)=delete
PopupMenuHandleroperator= (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
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 PopupMenuTable
std::shared_ptr< Registry::GroupItemmTop
std::vector< Registry::GroupItem * > mStack
Identifier mId
TranslatableString mCaption
std::unique_ptr< Registry::GroupItemmRegistry
- 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 ( )

Definition at line 86 of file CommonTrackControls.cpp.

87 : PopupMenuTable{ "Track" }
88 {}

Member Function Documentation


TrackMenuTable::DECLARE_POPUP_MENU ( TrackMenuTable  )

◆ InitUserData()

void TrackMenuTable::InitUserData ( void *  pUserData)

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.

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

References mpData.

◆ Instance()

TrackMenuTable & TrackMenuTable::Instance ( )

Definition at line 109 of file CommonTrackControls.cpp.

111 static TrackMenuTable instance;
112 return instance;

Referenced by CommonTrackControls::DoContextMenu().

Here is the caller graph for this function:

◆ OnMoveTrack()

void TrackMenuTable::OnMoveTrack ( wxCommandEvent &  event)

Definition at line 249 of file CommonTrackControls.cpp.

251 AudacityProject *const project = &mpData->project;
253 switch (event.GetId()) {
254 default:
255 wxASSERT(false);
256 case OnMoveUpID:
257 choice = TrackUtilities::OnMoveUpID; break;
258 case OnMoveDownID:
259 choice = TrackUtilities::OnMoveDownID; break;
260 case OnMoveTopID:
261 choice = TrackUtilities::OnMoveTopID; break;
262 case OnMoveBottomID:
263 choice = TrackUtilities::OnMoveBottomID; break;
264 }
266 TrackUtilities::DoMoveTrack(*project, mpData->pTrack, choice);
268 // MoveTrack already refreshed TrackPanel, which means repaint will happen.
269 // This is a harmless redundancy:
@ OnMoveBottomID
@ OnMoveDownID
@ OnMoveTopID
@ OnMoveUpID
The top-level handle to an Audacity project. It serves as a source of events that other objects can b...
Definition: Project.h:90
void DoMoveTrack(AudacityProject &project, Track *target, MoveChoice choice)
Move a track up, down, to top or to bottom.

References TrackUtilities::DoMoveTrack(), mpData, OnMoveBottomID, TrackUtilities::OnMoveBottomID, OnMoveDownID, TrackUtilities::OnMoveDownID, OnMoveTopID, TrackUtilities::OnMoveTopID, OnMoveUpID, TrackUtilities::OnMoveUpID, 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 &  )

Definition at line 221 of file CommonTrackControls.cpp.

223 Track *const pTrack = mpData->pTrack;
224 if (pTrack)
225 {
226 AudacityProject *const proj = &mpData->project;
227 const wxString oldName = pTrack->GetName();
230 Command.mName = oldName;
231 // Bug 1837 : We need an OK/Cancel result if we are to enter a blank string.
232 bool bResult = Command.PromptUser( &GetProjectFrame( *proj ) );
233 if (bResult)
234 {
235 wxString newName = Command.mName;
236 for (auto channel : TrackList::Channels(pTrack))
237 channel->SetName(newName);
239 ProjectHistory::Get( *proj )
240 .PushState(
241 XO("Renamed '%s' to '%s'").Format( oldName, newName ),
242 XO("Name Change"));
245 }
246 }
AUDACITY_DLL_API wxFrame & GetProjectFrame(AudacityProject &project)
Get the top-level window associated with the project (as a wxFrame only, when you do not need to use ...
Abstract base class used in importing a file.
void PushState(const TranslatableString &desc, const TranslatableString &shortDesc)
static ProjectHistory & Get(AudacityProject &project)
Abstract base class for an object holding data associated with points on a time axis.
Definition: Track.h:226
wxString GetName() const
Definition: Track.h:467
static auto Channels(TrackType *pTrack) -> TrackIterRange< TrackType >
Definition: Track.h:1544
std::unique_ptr< CommandItem > Command(const CommandID &name, const TranslatableString &label_in, void(Handler::*pmf)(const CommandContext &), CommandFlag flags, const CommandManager::Options &options={}, CommandHandlerFinder finder=FinderScope::DefaultFinder())

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

Here is the call graph for this function:

◆ UpdatePrefs()

void TrackMenuTable::UpdatePrefs ( )

Implements PrefsListener.

Definition at line 102 of file CommonTrackControls.cpp.

103 {
104 // Because labels depend on keyboard preferences
106 }

References PopupMenuTable::Clear().

Here is the call graph for this function:

Member Data Documentation

◆ mpData

CommonTrackControls::InitMenuData* TrackMenuTable::mpData {}

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: