WaveformVRulerMenuTable Class Reference

#include <WaveformVZoomHandle.h>

Inheritance diagram for WaveformVRulerMenuTable:

Collaboration diagram for WaveformVRulerMenuTable:

Static Public Member Functions
static PopupMenuTable &	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
	WaveformVRulerMenuTable ()
virtual	~WaveformVRulerMenuTable ()
	DECLARE_POPUP_MENU (WaveformVRulerMenuTable)
void	OnWaveformScaleType (wxCommandEvent &evt)

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 WaveChannelVRulerMenuTable
	WaveChannelVRulerMenuTable (const Identifier &id)
void	InitUserData (void *pUserData) override
	Called before the menu items are appended. More...
void	OnZoom (WaveChannelViewConstants::ZoomActions iZoomCode)
void	OnZoomFitVertical (wxCommandEvent &)
void	OnZoomReset (wxCommandEvent &)
void	OnZoomHalfWave (wxCommandEvent &)
void	OnZoomInVertical (wxCommandEvent &)
void	OnZoomOutVertical (wxCommandEvent &)
void	UpdatePrefs () override
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 WaveChannelVRulerMenuTable
InitMenuData *	mpData {}
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 79 of file WaveformVZoomHandle.h.

Constructor & Destructor Documentation

WaveformVRulerMenuTable()

WaveformVRulerMenuTable::WaveformVRulerMenuTable ( )

inlineprivate

Definition at line 81 of file WaveformVZoomHandle.h.

      : WaveChannelVRulerMenuTable{ "WaveFormVRuler" }
   {}

~WaveformVRulerMenuTable()

virtual WaveformVRulerMenuTable::~WaveformVRulerMenuTable ( )

inlineprivatevirtual

Definition at line 84 of file WaveformVZoomHandle.h.

{}

Member Function Documentation

DECLARE_POPUP_MENU()

WaveformVRulerMenuTable::DECLARE_POPUP_MENU ( WaveformVRulerMenuTable  )

private

Instance()

PopupMenuTable & WaveformVRulerMenuTable::Instance ( )

static

Definition at line 225 of file WaveformVZoomHandle.cpp.

{
   static WaveformVRulerMenuTable instance;
   return instance;
}

Referenced by WaveformVZoomHandle::Release().

Here is the caller graph for this function:

OnWaveformScaleType()

void WaveformVRulerMenuTable::OnWaveformScaleType ( wxCommandEvent &  evt )

private

Definition at line 263 of file WaveformVZoomHandle.cpp.

{
   // Assume linked track is wave or null
   const WaveformSettings::ScaleType newScaleType =
      WaveformSettings::ScaleType(
         std::max(0,
            std::min((int)(WaveformSettings::stNumScaleTypes) - 1,
               evt.GetId() - OnFirstWaveformScaleID
      )));
 
   auto &scaleType = WaveformSettings::Get(mpData->wc).scaleType;
   if (scaleType != newScaleType) {
      scaleType = newScaleType;
 
      AudacityProject *const project = &mpData->project;
      ProjectHistory::Get( *project ).ModifyState(true);
 
      using namespace RefreshCode;
      mpData->result = UpdateVRuler | RefreshAll;
   }
}

References ProjectHistory::Get(), WaveformSettings::Get(), min(), ProjectHistory::ModifyState(), OnFirstWaveformScaleID, project, RefreshCode::RefreshAll, WaveformSettings::scaleType, WaveformSettings::stNumScaleTypes, and RefreshCode::UpdateVRuler.

Here is the call graph for this function:

---

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

• WaveformVZoomHandle.h
• WaveformVZoomHandle.cpp