PopupMenuTable Class Reference

#include <PopupMenuTable.h>

Inheritance diagram for PopupMenuTable:

Collaboration diagram for PopupMenuTable:

Classes
struct	AttachedItem

Public Types
using	Entry = PopupMenuTableEntry

Public Member Functions
	PopupMenuTable (const Identifier &id, const TranslatableString &caption={})
const Identifier &	Id () const
const TranslatableString &	Caption () const
const Registry::GroupItemBase *	GetRegistry () const
const std::shared_ptr< Registry::GroupItemBase > &	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 std::unique_ptr< PopupMenu >	BuildMenu (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)

Protected Member Functions
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
static TranslatableString	MakeLabel (const TranslatableString &label, bool useExtra, const TranslatableString &extra)

Protected Attributes
std::shared_ptr< Registry::GroupItemBase >	mTop
std::vector< Registry::GroupItemBase * >	mStack
Identifier	mId
TranslatableString	mCaption
std::unique_ptr< Registry::GroupItemBase >	mRegistry

Private Member Functions
void	RegisterItem (const Registry::Placement &placement, Registry::BaseItemPtr pItem)

Detailed Description

Definition at line 112 of file PopupMenuTable.h.

Member Typedef Documentation

Entry

using PopupMenuTable::Entry = PopupMenuTableEntry

Definition at line 115 of file PopupMenuTable.h.

Constructor & Destructor Documentation

PopupMenuTable()

PopupMenuTable::PopupMenuTable ( const Identifier &  id, const TranslatableString &  caption = {}  )

inline

Definition at line 118 of file PopupMenuTable.h.

                                                                             {} )
      : mId{ id }
      , mCaption{ caption }
      , mRegistry{ std::make_unique<Registry::GroupItem<>>(mId) }
   {}

Member Function Documentation

Append() [1/2]

void PopupMenuTable::Append ( const Identifier &  stringId, PopupMenuTableEntry::Type  type, int  id, const TranslatableString &  string, wxCommandEventFunction  memFn, const PopupMenuTableEntry::InitFunction &  init  )

protected

Definition at line 167 of file PopupMenuTable.cpp.

{
   Append( std::make_unique<Entry>(
      stringId, type, id, string, memFn, *this, init ) );
}

References Append().

Here is the call graph for this function:

Append() [2/2]

void PopupMenuTable::Append ( Registry::BaseItemPtr  pItem )

protected

Definition at line 162 of file PopupMenuTable.cpp.

{
   mStack.back()->items.push_back( std::move( pItem ) );
}

References mStack.

Referenced by Append().

Here is the caller graph for this function:

AppendCheckItem()

void PopupMenuTable::AppendCheckItem ( const Identifier &  stringId, int  id, const TranslatableString &  string, wxCommandEventFunction  memFn, const PopupMenuTableEntry::InitFunction &  init = {}  )

inlineprotected

Definition at line 212 of file PopupMenuTable.h.

                                                    {} )
   { Append( stringId, PopupMenuTableEntry::CheckItem, id, string, memFn, init ); }

AppendItem()

void PopupMenuTable::AppendItem ( const Identifier &  stringId, int  id, const TranslatableString &  string, wxCommandEventFunction  memFn, const PopupMenuTableEntry::InitFunction &  init = {}  )

inlineprotected

Definition at line 200 of file PopupMenuTable.h.

                                                    {} )
   { Append( stringId, PopupMenuTableEntry::Item, id, string, memFn, init ); }

AppendRadioItem()

void PopupMenuTable::AppendRadioItem ( const Identifier &  stringId, int  id, const TranslatableString &  string, wxCommandEventFunction  memFn, const PopupMenuTableEntry::InitFunction &  init = {}  )

inlineprotected

Definition at line 206 of file PopupMenuTable.h.

                                                    {} )
   { Append( stringId, PopupMenuTableEntry::RadioItem, id, string, memFn, init ); }

BeginSection()

void PopupMenuTable::BeginSection ( const Identifier &  name )

protected

Definition at line 176 of file PopupMenuTable.cpp.

{
   auto uSection = std::make_unique< PopupMenuSection >( name );
   auto section = uSection.get();
   mStack.back()->items.push_back( std::move( uSection ) );
   mStack.push_back( section );
}

References mStack, and name.

BuildMenu()

std::unique_ptr< PopupMenu > PopupMenuTable::BuildMenu ( PopupMenuTable *  pTable, void *  pUserData = NULL  )

static

Definition at line 190 of file PopupMenuTable.cpp.

{
   // Rebuild as needed each time.  That makes it safe in case of language change.
   auto theMenu = std::make_unique<PopupMenuImpl>( pUserData );
   ExtendMenu( *theMenu, *pTable );
   return theMenu;
}

References ExtendMenu().

Referenced by CommonTrackControls::DoContextMenu(), WaveTrackVZoomHandle::DoRelease(), NoteTrackVZoomHandle::Release(), and TimeTrackVZoomHandle::Release().

Here is the call graph for this function:

Here is the caller graph for this function:

Caption()

const TranslatableString & PopupMenuTable::Caption ( ) const

inline

Definition at line 130 of file PopupMenuTable.h.

{ return mCaption; }

Clear()

void PopupMenuTable::Clear ( )

inline

Definition at line 153 of file PopupMenuTable.h.

   {
      mTop.reset();
   }

Referenced by NoteTrackVRulerMenuTable::UpdatePrefs(), WaveTrackVRulerMenuTable::UpdatePrefs(), and TrackMenuTable::UpdatePrefs().

Here is the caller graph for this function:

Computed()

template<typename Table >

static Registry::BaseItemPtr PopupMenuTable::Computed ( const std::function< Registry::BaseItemPtr(Table &) > &  factory )

inlinestatic

Definition at line 161 of file PopupMenuTable.h.

   {
      using namespace Registry;
      return std::make_unique< ComputedItem >(
         [factory]( Visitor &baseVisitor ){
            auto &visitor = static_cast< PopupMenuVisitor& >( baseVisitor );
            auto &table =  static_cast< Table& >( visitor.mTable );
            return factory( table );
         }
      );
   }

References cloud::factory.

EndSection()

void PopupMenuTable::EndSection ( )

protected

Definition at line 184 of file PopupMenuTable.cpp.

{
   mStack.pop_back();
}

References mStack.

ExtendMenu()

void PopupMenuTable::ExtendMenu ( PopupMenu &  menu, PopupMenuTable &  otherTable  )

static

Definition at line 147 of file PopupMenuTable.cpp.

{
   auto &theMenu = dynamic_cast<PopupMenuImpl&>(menu);
 
   PopupMenuBuilder visitor{ table, theMenu, theMenu.pUserData };
   Registry::Visit(
      visitor, table.Get( theMenu.pUserData ).get(), table.GetRegistry() );
}

References Get(), GetRegistry(), and Registry::Visit().

Referenced by BuildMenu(), and CommonTrackControls::DoContextMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

Get()

const std::shared_ptr< Registry::GroupItemBase > & PopupMenuTable::Get ( void *  pUserData )

inline

Definition at line 144 of file PopupMenuTable.h.

   {
      if ( pUserData )
         this->InitUserData( pUserData );
      if (!mTop)
         Populate();
      return mTop;
   }

Referenced by ExtendMenu().

Here is the caller graph for this function:

GetRegistry()

const Registry::GroupItemBase * PopupMenuTable::GetRegistry ( ) const

inline

Definition at line 131 of file PopupMenuTable.h.

{ return mRegistry.get(); }

Referenced by ExtendMenu().

Here is the caller graph for this function:

Id()

const Identifier & PopupMenuTable::Id ( ) const

inline

Definition at line 129 of file PopupMenuTable.h.

{ return mId; }

MakeLabel()

static TranslatableString PopupMenuTable::MakeLabel ( const TranslatableString &  label, bool  useExtra, const TranslatableString &  extra  )

inlinestaticprotected

Definition at line 181 of file PopupMenuTable.h.

   {
      return useExtra
         ? XXO("%s (%s)").Format( label, extra )
         : label;
   }

References label, and XXO().

Here is the call graph for this function:

Populate()

virtual void PopupMenuTable::Populate ( )

protectedpure virtual

RegisterItem()

void PopupMenuTable::RegisterItem ( const Registry::Placement &  placement, Registry::BaseItemPtr  pItem  )

private

Definition at line 156 of file PopupMenuTable.cpp.

{
   Registry::RegisterItem( *mRegistry, placement, std::move( pItem ) );
}

References mRegistry, and Registry::RegisterItem().

Referenced by PopupMenuTable::AttachedItem::AttachedItem().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCaption

TranslatableString PopupMenuTable::mCaption

protected

Definition at line 223 of file PopupMenuTable.h.

mId

Identifier PopupMenuTable::mId

protected

Definition at line 222 of file PopupMenuTable.h.

mRegistry

std::unique_ptr<Registry::GroupItemBase> PopupMenuTable::mRegistry

protected

Definition at line 224 of file PopupMenuTable.h.

Referenced by RegisterItem().

mStack

std::vector< Registry::GroupItemBase* > PopupMenuTable::mStack

protected

Definition at line 221 of file PopupMenuTable.h.

Referenced by Append(), BeginSection(), and EndSection().

mTop

std::shared_ptr< Registry::GroupItemBase > PopupMenuTable::mTop

protected

Definition at line 220 of file PopupMenuTable.h.

---

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

• PopupMenuTable.h
• PopupMenuTable.cpp