anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor Struct Reference

Inheritance diagram for anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor:

Collaboration diagram for anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor:

Classes
struct	CommandListEntryEx

Public Member Functions
	MenuItemVisitor (AudacityProject &proj)
	~MenuItemVisitor () override
Public Member Functions inherited from CommandManager::Populator
	Populator (AudacityProject &project, LeafVisitor leafVisitor, std::function< void()> doSeparator)
virtual	~Populator ()
Public Member Functions inherited from MenuRegistry::Visitor< MenuRegistry::Traits >
	Visitor (VisitorFunctions< MenuRegistry::Traits > functions, std::function< void()> doSeparator)
Public Member Functions inherited from Registry::VisitorFunctions< MenuRegistry::Traits >
	VisitorFunctions (Visitors &&visitors)
	Type-erasing constructor. More...
void	BeginGroup (const GroupItem< MenuRegistry::Traits > &item, const Path &path) const
	Call-through for a decorating pre-visitor. More...
void	Visit (const SingleItem &item, const Path &path) const
	Call-through for a decorating leaf-visitor. More...
void	EndGroup (const GroupItem< MenuRegistry::Traits > &item, const Path &path) const
	Call-through for a decorating post-visitor. More...
Public Member Functions inherited from MenuRegistry::detail::VisitorBase
std::pair< bool, bool >	ShouldBeginGroup (const ItemProperties *pProperties)
void	AfterBeginGroup (const ItemProperties *pProperties)
bool	ShouldEndGroup (const ItemProperties *pProperties)
bool	ShouldDoSeparator ()

Private Member Functions
std::unique_ptr< CommandManager::CommandListEntry >	AllocateEntry (const MenuRegistry::Options &options) final
void	VisitEntry (CommandManager::CommandListEntry &, const MenuRegistry::Options *pOptions) final
void	BeginMenu (const TranslatableString &tName) final
void	EndMenu () final
void	BeginMainMenu (const TranslatableString &tName)
void	EndMainMenu ()
void	BeginSubMenu (const TranslatableString &tName)
void	EndSubMenu ()
void	BeginOccultCommands () final
void	EndOccultCommands () final
std::unique_ptr< wxMenuBar >	AddMenuBar (const wxString &sMenu)
wxMenuBar *	CurrentMenuBar () const
wxMenuBar *	GetMenuBar (const wxString &sMenu) const
wxMenu *	CurrentSubMenu () const
wxMenu *	CurrentMenu () const

Private Attributes
std::vector< MenuBarListEntry >	mMenuBarList
std::vector< SubMenuListEntry >	mSubMenuList
std::unique_ptr< wxMenuBar >	mTempMenuBar
std::unique_ptr< wxMenu >	uCurrentMenu
wxMenu *	mCurrentMenu {}

Additional Inherited Members
Public Types inherited from CommandManager::Populator
using	LeafVisitor = std::function< void(const Registry::SingleItem &, const Registry::Path &)>
Public Types inherited from Registry::VisitorFunctions< MenuRegistry::Traits >
using	NodeTypes = detail::VisitedNodeTypes< MenuRegistry::Traits >
using	LeafTypes = detail::VisitedLeafTypes< MenuRegistry::Traits >
Public Attributes inherited from MenuRegistry::detail::VisitorBase
std::vector< bool >	firstItem
std::vector< bool >	needSeparator
Protected Member Functions inherited from CommandManager::Populator
void	DoBeginGroup (const MenuRegistry::GroupItem< MenuRegistry::Traits > &item)
void	DoVisit (const Registry::SingleItem &item)
void	DoEndGroup (const MenuRegistry::GroupItem< MenuRegistry::Traits > &item)
virtual void	BeginMenu (const TranslatableString &tName)
virtual void	BeginOccultCommands ()
virtual void	EndMenu ()
virtual void	EndOccultCommands ()
virtual std::unique_ptr< CommandListEntry >	AllocateEntry (const MenuRegistry::Options &options)
virtual void	VisitEntry (CommandListEntry &entry, const MenuRegistry::Options *options)
void	DoSeparator ()
const TranslatableStrings &	MenuNames () const
	Stack of names of menus that were begun and not yet ended. More...
Protected Attributes inherited from CommandManager::Populator
AudacityProject &	mProject
bool	mbSeparatorAllowed { false }

Detailed Description

Definition at line 109 of file MenuCreator.cpp.

Constructor & Destructor Documentation

MenuItemVisitor()

anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::MenuItemVisitor ( AudacityProject &  proj )

inlineexplicit

Definition at line 110 of file MenuCreator.cpp.

   : CommandManager::Populator { proj,
      // leaf visit
      [this](const auto &item, const auto&) {
         const auto pCurrentMenu = CurrentMenu();
         if (!pCurrentMenu) {
            // There may have been a mistake in the placement hint that
            // registered this single item.  It's not within any menu.
            assert(false);
         }
         else TypeSwitch::VDispatch<void, LeafTypes>(item,
            [&](const SpecialItem &special) {
               if (auto pSpecial =
                  dynamic_cast<const MenuCreator::SpecialItem*>(&special))
                  pSpecial->fn(mProject, *pCurrentMenu);
            },
            [this](auto &item){ DoVisit(item); }
         );
      },
 
      [this]{
         if (mbSeparatorAllowed)
            CurrentMenu()->AppendSeparator();
         Populator::DoSeparator();
      }
   }
   {
      auto menubar = AddMenuBar(wxT("appmenu"));
      assert(menubar);
 
      MenuRegistry::Visit(*this, mProject);
 
      GetProjectFrame(mProject).SetMenuBar(menubar.release());
   }

~MenuItemVisitor()

anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::~MenuItemVisitor ( )

overridedefault

Member Function Documentation

AddMenuBar()

std::unique_ptr< wxMenuBar > MenuItemVisitor::AddMenuBar ( const wxString &  sMenu )

private

Makes a NEW menubar for placement on the top of a project Names it according to the passed-in string argument.

If the menubar already exists, that's unexpected.

Definition at line 967 of file MenuCreator.cpp.

{
   wxMenuBar *menuBar = GetMenuBar(sMenu);
   if (menuBar) {
      wxASSERT(false);
      return {};
   }
 
   auto result = std::make_unique<wxMenuBar>();
   mMenuBarList.emplace_back(sMenu, result.get());
 
   return result;
}

AllocateEntry()

auto anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::AllocateEntry ( const MenuRegistry::Options &  options )

finalprivatevirtual

Called by DoVisit Override to make entries that carry extra information. Not called for every visit, because existing items may be reused

Postcondition

result: result != nullptr

Reimplemented from CommandManager::Populator.

Definition at line 252 of file MenuCreator.cpp.

{
   auto result = std::make_unique<CommandListEntryEx>();
   if (!options.global)
      result->menu = CurrentMenu();
   return result;
}

BeginMainMenu()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::BeginMainMenu ( const TranslatableString &  tName )

private

Definition at line 373 of file MenuCreator.cpp.

{
   uCurrentMenu = std::make_unique<wxMenu>();
   mCurrentMenu = uCurrentMenu.get();
}

BeginMenu()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::BeginMenu ( const TranslatableString &  tName )

finalprivatevirtual

Called by DoBeginGroup Default implementation does nothing

Reimplemented from CommandManager::Populator.

Definition at line 355 of file MenuCreator.cpp.

{
   if (mCurrentMenu)
      return BeginSubMenu(tName);
   else
      return BeginMainMenu(tName);
}

BeginOccultCommands()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::BeginOccultCommands ( )

finalprivatevirtual

Called by DoBeginGroup Default implementation does nothing

Reimplemented from CommandManager::Populator.

Definition at line 417 of file MenuCreator.cpp.

{
   // To do:  perhaps allow occult item switching at lower levels of the
   // menu tree.
   assert(!CurrentMenu());
 
   // Make a temporary menu bar collecting items added after.
   // This bar will be discarded but other side effects on the command
   // manager persist.
   mTempMenuBar = AddMenuBar(wxT("ext-menu"));
}

References wxT().

Here is the call graph for this function:

BeginSubMenu()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::BeginSubMenu ( const TranslatableString &  tName )

private

CurrentMenu()

wxMenu * MenuItemVisitor::CurrentMenu ( ) const

private

This returns the current menu that we're appending to - note that it could be a submenu if BeginSubMenu was called and we haven't reached EndSubMenu yet.

Definition at line 1020 of file MenuCreator.cpp.

{
   if(!mCurrentMenu)
      return NULL;
 
   wxMenu * tmpCurrentSubMenu = CurrentSubMenu();
 
   if(!tmpCurrentSubMenu)
   {
      return mCurrentMenu;
   }
 
   return tmpCurrentSubMenu;
}

CurrentMenuBar()

wxMenuBar * MenuItemVisitor::CurrentMenuBar ( ) const

private

Retrieve the 'current' menubar; either NULL or the last on in the mMenuBarList.

Definition at line 998 of file MenuCreator.cpp.

{
   if(mMenuBarList.empty())
      return NULL;
 
   return mMenuBarList.back().menubar;
}

CurrentSubMenu()

wxMenu * MenuItemVisitor::CurrentSubMenu ( ) const

private

This returns the 'Current' Submenu, which is the one at the end of the mSubMenuList (or NULL, if it doesn't exist).

Definition at line 1008 of file MenuCreator.cpp.

{
   if(mSubMenuList.empty())
      return NULL;
 
   return mSubMenuList.back().menu.get();
}

EndMainMenu()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::EndMainMenu ( )

private

EndMenu()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::EndMenu ( )

finalprivatevirtual

Called by DoEndGroup Default implementation does nothing

Reimplemented from CommandManager::Populator.

EndOccultCommands()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::EndOccultCommands ( )

finalprivatevirtual

Called by DoEndGroup Default implementation does nothing

Reimplemented from CommandManager::Populator.

Definition at line 429 of file MenuCreator.cpp.

{
   auto iter = mMenuBarList.end();
   if (iter != mMenuBarList.begin())
      mMenuBarList.erase(--iter);
   else
      assert(false);
   mTempMenuBar.reset();
}

EndSubMenu()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::EndSubMenu ( )

private

GetMenuBar()

wxMenuBar * MenuItemVisitor::GetMenuBar ( const wxString &  sMenu ) const

private

Retrieves the menubar based on the name given in AddMenuBar(name)

Definition at line 984 of file MenuCreator.cpp.

{
   for (const auto &entry : mMenuBarList)
   {
      if(entry.name == sMenu)
         return entry.menubar;
   }
 
   return NULL;
}

References entry.

VisitEntry()

void anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::VisitEntry ( CommandManager::CommandListEntry &  entry, const MenuRegistry::Options *  options  )

finalprivatevirtual

Called by DoVisit Override to intercept all visits of items; default implementation is noop

Parameters

options

null if a member of a list of commands

Reimplemented from CommandManager::Populator.

Definition at line 332 of file MenuCreator.cpp.

{
   if (!pOptions)
      // command list item
      CurrentMenu()->Append(entry.id, entry.FormatLabelForMenu());
   else if (pOptions->global)
      ;
   else {
      auto ID = entry.id;
      auto label = FormatLabelWithDisabledAccel(entry);
      auto &checker = pOptions->checker;
      if (checker) {
         CurrentMenu()->AppendCheckItem(ID, label);
         CurrentMenu()->Check(ID, checker(mProject));
      }
      else
         CurrentMenu()->Append(ID, label);
   }
}

References MenuRegistry::Options::checker, entry, anonymous_namespace{MenuCreator.cpp}::FormatLabelWithDisabledAccel(), MenuRegistry::Options::global, and label.

Here is the call graph for this function:

Member Data Documentation

mCurrentMenu

wxMenu* anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::mCurrentMenu {}

private

Definition at line 183 of file MenuCreator.cpp.

mMenuBarList

std::vector<MenuBarListEntry> anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::mMenuBarList

private

Definition at line 179 of file MenuCreator.cpp.

mSubMenuList

std::vector<SubMenuListEntry> anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::mSubMenuList

private

Definition at line 180 of file MenuCreator.cpp.

mTempMenuBar

std::unique_ptr<wxMenuBar> anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::mTempMenuBar

private

Definition at line 181 of file MenuCreator.cpp.

uCurrentMenu

std::unique_ptr<wxMenu> anonymous_namespace{MenuCreator.cpp}::MenuItemVisitor::uCurrentMenu

private

Definition at line 182 of file MenuCreator.cpp.

---

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

• MenuCreator.cpp