NoteTrackMenuTable Class Reference

Inheritance diagram for NoteTrackMenuTable:

Collaboration diagram for NoteTrackMenuTable:

Static Public Member Functions
static NoteTrackMenuTable &	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
	NoteTrackMenuTable ()
	DECLARE_POPUP_MENU (NoteTrackMenuTable)
void	InitUserData (void *pUserData) override
	Called before the menu items are appended. More...
void	OnChangeOctave (wxCommandEvent &)
	Scrolls the note track up or down by an octave. More...

Private Attributes
PlayableTrackControls::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

Detailed Description

Definition at line 73 of file NoteTrackControls.cpp.

Constructor & Destructor Documentation

NoteTrackMenuTable()

NoteTrackMenuTable::NoteTrackMenuTable ( )

inlineprivate

Definition at line 75 of file NoteTrackControls.cpp.

      : PopupMenuTable{ "NoteTrack" }
   {}

Member Function Documentation

DECLARE_POPUP_MENU()

NoteTrackMenuTable::DECLARE_POPUP_MENU ( NoteTrackMenuTable  )

private

InitUserData()

void NoteTrackMenuTable::InitUserData ( void *  pUserData )

inlineoverrideprivatevirtual

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 84 of file NoteTrackControls.cpp.

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

References mpData.

Instance()

NoteTrackMenuTable & NoteTrackMenuTable::Instance ( )

static

Definition at line 94 of file NoteTrackControls.cpp.

{
   static NoteTrackMenuTable instance;
   return instance;
}

Referenced by NoteTrackControls::GetMenuExtension().

Here is the caller graph for this function:

OnChangeOctave()

void NoteTrackMenuTable::OnChangeOctave ( wxCommandEvent &  event )

private

Scrolls the note track up or down by an octave.

Definition at line 106 of file NoteTrackControls.cpp.

{
   auto &track = static_cast<NoteTrack&>(mpData->track);
 
   wxASSERT(event.GetId() == OnUpOctaveID
      || event.GetId() == OnDownOctaveID);
 
   const bool bDown = (OnDownOctaveID == event.GetId());
   NoteTrackRange::Get(track).ShiftNoteRange((bDown) ? -12 : 12);
 
   AudacityProject *const project = &mpData->project;
   ProjectHistory::Get( *project )
      .ModifyState(false);
   mpData->result = RefreshCode::RefreshAll;
}

References ProjectHistory::Get(), NoteTrackRange::Get(), ProjectHistory::ModifyState(), mpData, OnDownOctaveID, OnUpOctaveID, project, CommonTrackControls::InitMenuData::project, RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, NoteTrackRange::ShiftNoteRange(), and CommonTrackControls::InitMenuData::track.

Here is the call graph for this function:

Member Data Documentation

mpData

PlayableTrackControls::InitMenuData* NoteTrackMenuTable::mpData {}

private

Definition at line 89 of file NoteTrackControls.cpp.

Referenced by InitUserData(), and OnChangeOctave().

---

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

• NoteTrackControls.cpp