WaveColorMenuTable Struct Reference

Inheritance diagram for WaveColorMenuTable:

Collaboration diagram for WaveColorMenuTable:

Public Member Functions
	WaveColorMenuTable ()
	DECLARE_POPUP_MENU (WaveColorMenuTable)
void	InitUserData (void *pUserData) override
	Called before the menu items are appended. More...
int	IdOfWaveColor (int WaveColor)
	Converts a WaveColor enumeration to a wxWidgets menu item Id. More...
void	OnWaveColorChange (wxCommandEvent &event)
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 Public Member Functions
static WaveColorMenuTable &	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)

Public Attributes
PlayableTrackControls::InitMenuData *	mpData {}
int	OnInstrument1ID
int	OnInstrument2ID
int	OnInstrument3ID
int	OnInstrument4ID

Additional Inherited Members
Public Types inherited from PopupMenuTable
using	Entry = PopupMenuTableEntry
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 1071 of file WaveformView.cpp.

Constructor & Destructor Documentation

WaveColorMenuTable()

WaveColorMenuTable::WaveColorMenuTable ( )

inline

Definition at line 1073 of file WaveformView.cpp.

: PopupMenuTable{ "WaveColor", XO("&Wave Color") } {}

Member Function Documentation

DECLARE_POPUP_MENU()

WaveColorMenuTable::DECLARE_POPUP_MENU

(

WaveColorMenuTable

)

IdOfWaveColor()

int WaveColorMenuTable::IdOfWaveColor

(

int

WaveColor

)

Converts a WaveColor enumeration to a wxWidgets menu item Id.

Definition at line 1142 of file WaveformView.cpp.

{  return OnInstrument1ID + WaveColor;}

InitUserData()

void WaveColorMenuTable::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 1094 of file WaveformView.cpp.

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

References mpData.

Instance()

WaveColorMenuTable & WaveColorMenuTable::Instance ( )

static

Definition at line 1088 of file WaveformView.cpp.

{
   static WaveColorMenuTable instance;
   return instance;
}

OnWaveColorChange()

void WaveColorMenuTable::OnWaveColorChange

(

wxCommandEvent &

event

)

Handles the selection from the WaveColor submenu of the track menu.

Definition at line 1147 of file WaveformView.cpp.

{
   int id = event.GetId();
   wxASSERT(id >= OnInstrument1ID && id <= OnInstrument4ID);
   auto &track = static_cast<WaveTrack&>(mpData->track);
 
   int newWaveColor = id - OnInstrument1ID;
 
   AudacityProject *const project = &mpData->project;
 
   WaveformAppearance::Get(track).SetColorIndex(newWaveColor);
 
   ProjectHistory::Get( *project )
      .PushState(XO("Changed '%s' to %s")
         .Format(track.GetName(), GetWaveColorStr(newWaveColor)),
      XO("WaveColor Change"));
 
   using namespace RefreshCode;
   mpData->result = RefreshAll | FixScrollbars;
}

References RefreshCode::FixScrollbars, ProjectHistory::Get(), WaveformAppearance::Get(), anonymous_namespace{WaveformView.cpp}::GetWaveColorStr(), mpData, OnInstrument1ID, OnInstrument4ID, project, CommonTrackControls::InitMenuData::project, ProjectHistory::PushState(), RefreshCode::RefreshAll, CommonTrackControls::InitMenuData::result, WaveformAppearance::SetColorIndex(), CommonTrackControls::InitMenuData::track, and XO().

Here is the call graph for this function:

Member Data Documentation

mpData

PlayableTrackControls::InitMenuData* WaveColorMenuTable::mpData {}

Definition at line 1080 of file WaveformView.cpp.

Referenced by InitUserData(), and OnWaveColorChange().

OnInstrument1ID

int WaveColorMenuTable::OnInstrument1ID

Definition at line 1085 of file WaveformView.cpp.

Referenced by OnWaveColorChange().

OnInstrument2ID

int WaveColorMenuTable::OnInstrument2ID

Definition at line 1085 of file WaveformView.cpp.

OnInstrument3ID

int WaveColorMenuTable::OnInstrument3ID

Definition at line 1085 of file WaveformView.cpp.

OnInstrument4ID

int WaveColorMenuTable::OnInstrument4ID

Definition at line 1085 of file WaveformView.cpp.

Referenced by OnWaveColorChange().

---

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

• WaveformView.cpp