MenuTable Namespace Reference

Classes
struct	AttachedItem
struct	CommandGroupItem
struct	CommandItem
struct	ConditionalGroupItem
class	FinderScope
struct	MenuItem
struct	MenuPart
struct	MenuSection
struct	SpecialItem
struct	WholeMenu

Typedefs
using	MenuItems = ConcreteGroupItem< true, ToolbarMenuVisitor >

Functions
template<typename... Args>
std::unique_ptr< MenuItems >	Items (const Identifier &internalName, Args &&... args)
template<typename... Args>
std::unique_ptr< MenuPart >	Section (const Identifier &internalName, Args &&... args)
template<typename... Args>
std::unique_ptr< MenuItem >	Menu (const Identifier &internalName, const TranslatableString &title, Args &&... args)
std::unique_ptr< MenuItem >	Menu (const Identifier &internalName, const TranslatableString &title, BaseItemPtrs &&items)
template<typename... Args>
std::unique_ptr< ConditionalGroupItem >	ConditionalItems (const Identifier &internalName, ConditionalGroupItem::Condition condition, Args &&... args)
std::unique_ptr< ConditionalGroupItem >	ConditionalItems (const Identifier &internalName, ConditionalGroupItem::Condition condition, BaseItemPtrs &&items)
template<typename... Args>
BaseItemPtr	MenuOrItems (const Identifier &internalName, const TranslatableString &title, Args &&... args)
BaseItemPtr	MenuOrItems (const Identifier &internalName, const TranslatableString &title, BaseItemPtrs &&items)
template<typename Handler >
std::unique_ptr< CommandItem >	Command (const CommandID &name, const TranslatableString &label_in, void(Handler::*pmf)(const CommandContext &), CommandFlag flags, const CommandManager::Options &options={}, CommandHandlerFinder finder=FinderScope::DefaultFinder())
std::unique_ptr< CommandItem >	Command (const CommandID &name, const TranslatableString &label_in, void(*fn)(const CommandContext &), CommandFlag flags, const CommandManager::Options &options={})
template<typename Handler >
std::unique_ptr< CommandGroupItem >	CommandGroup (const Identifier &name, std::vector< ComponentInterfaceSymbol > items, void(Handler::*pmf)(const CommandContext &), CommandFlag flags, bool isEffect=false, CommandHandlerFinder finder=FinderScope::DefaultFinder())
std::unique_ptr< CommandGroupItem >	CommandGroup (const Identifier &name, std::vector< ComponentInterfaceSymbol > items, void(*fn)(const CommandContext &), CommandFlag flags, bool isEffect=false)
std::unique_ptr< SpecialItem >	Special (const Identifier &name, const SpecialItem::Appender &fn)
void	DestroyRegistry ()

Typedef Documentation

MenuItems

using MenuTable::MenuItems = typedef ConcreteGroupItem< true, ToolbarMenuVisitor >

Definition at line 622 of file CommandManager.h.

Function Documentation

Command() [1/2]

std::unique_ptr< CommandItem > MenuTable::Command ( const CommandID &  name, const TranslatableString &  label_in, void(*)(const CommandContext &)  fn, CommandFlag  flags, const CommandManager::Options &  options = {}  )

inline

Definition at line 726 of file CommandManager.h.

                                                                {})
   {
      return std::make_unique<CommandItem>(
         name, label_in, fn, flags, options
      );
   }

Command() [2/2]

template<typename Handler >

std::unique_ptr< CommandItem > MenuTable::Command ( const CommandID &  name, const TranslatableString &  label_in, void(Handler::*)(const CommandContext &)  pmf, CommandFlag  flags, const CommandManager::Options &  options = {}, CommandHandlerFinder  finder = FinderScope::DefaultFinder()  )

inline

Precondition

finder != nullptr

Definition at line 713 of file CommandManager.h.

                                                                {},
      CommandHandlerFinder finder = FinderScope::DefaultFinder())
   {
      assert(finder);
      return std::make_unique<CommandItem>(
         name, label_in, pmf, flags, options, finder
      );
   }

Referenced by anonymous_namespace{PluginMenus.cpp}::AddEffectMenuItemGroup(), anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), ScreenshotCommand::CapturePreferences(), anonymous_namespace{ClipMenus.cpp}::ClipCursorItems(), anonymous_namespace{ClipMenus.cpp}::ClipSelectMenu(), anonymous_namespace{SelectMenus.cpp}::CursorMenu(), BuiltinCommandsModule::DiscoverPluginsAtPath(), anonymous_namespace{EditMenus.cpp}::EditMenu(), anonymous_namespace{PluginMenus.cpp}::EffectMenu(), anonymous_namespace{SelectMenus.cpp}::ExtraCursorMenu(), anonymous_namespace{DeviceToolBar.cpp}::ExtraDeviceMenu(), anonymous_namespace{EditMenus.cpp}::ExtraEditMenu(), anonymous_namespace{NavigationMenus.cpp}::ExtraFocusMenu(), anonymous_namespace{NavigationMenus.cpp}::ExtraGlobalCommands(), anonymous_namespace{ExtraMenus.cpp}::ExtraMiscItems(), anonymous_namespace{MeterToolBar.cpp}::ExtraMixerMenu(), anonymous_namespace{TranscriptionToolBar.cpp}::ExtraPlayAtSpeedItems(), anonymous_namespace{SelectMenus.cpp}::ExtraSeekMenu(), anonymous_namespace{TransportMenus.cpp}::ExtraSelectionItems(), anonymous_namespace{SelectMenus.cpp}::ExtraSelectionMenu(), anonymous_namespace{ClipMenus.cpp}::ExtraTimeShiftItems(), anonymous_namespace{ToolsToolBar.cpp}::ExtraToolsMenu(), anonymous_namespace{TrackMenus.cpp}::ExtraTrackMenu(), anonymous_namespace{TransportMenus.cpp}::ExtraTransportMenu(), anonymous_namespace{FileMenus.cpp}::FileMenu(), anonymous_namespace{PluginMenus.cpp}::GenerateMenu(), anonymous_namespace{HelpMenus.cpp}::HelpMenu(), anonymous_namespace{FileMenus.cpp}::HiddenFileMenu(), anonymous_namespace{LabelMenus.cpp}::LabelEditMenus(), TrackMenuTable::OnSetName(), PluginMenuItems(), anonymous_namespace{BatchProcessDialog.cpp}::PopulateMacrosMenu(), anonymous_namespace{Printing.cpp}::PrintingItems(), DEFINE_VERSION_CHECK::RegisterMenuItems(), anonymous_namespace{NyqBench.cpp}::RegisterMenuItems(), anonymous_namespace{SelectMenus.cpp}::SelectMenu(), MacroCommandDialog::SetCommandAndParams(), WaveTrackAffordanceControls::StartEditClipName(), anonymous_namespace{ToolbarMenus.cpp}::ToolbarsMenu(), anonymous_namespace{PluginMenus.cpp}::ToolsMenu(), anonymous_namespace{TrackMenus.cpp}::TracksMenu(), anonymous_namespace{TransportMenus.cpp}::TransportMenu(), and anonymous_namespace{ViewMenus.cpp}::ViewMenu().

Here is the caller graph for this function:

CommandGroup() [1/2]

std::unique_ptr< CommandGroupItem > MenuTable::CommandGroup ( const Identifier &  name, std::vector< ComponentInterfaceSymbol >  items, void(*)(const CommandContext &)  fn, CommandFlag  flags, bool  isEffect = false  )

inline

Definition at line 754 of file CommandManager.h.

   {
      return std::make_unique<CommandGroupItem>(
         name, move(items), fn, flags, isEffect
      );
   }

References fn, and name.

CommandGroup() [2/2]

template<typename Handler >

std::unique_ptr< CommandGroupItem > MenuTable::CommandGroup ( const Identifier &  name, std::vector< ComponentInterfaceSymbol >  items, void(Handler::*)(const CommandContext &)  pmf, CommandFlag  flags, bool  isEffect = false, CommandHandlerFinder  finder = FinderScope::DefaultFinder()  )

inline

Precondition

finder != nullptr

Definition at line 741 of file CommandManager.h.

   {
      assert(finder);
      return std::make_unique<CommandGroupItem>(
         name, move(items), pmf, flags, isEffect, finder
      );
   }

References name.

Referenced by anonymous_namespace{TrackMenus.cpp}::TracksMenu().

Here is the caller graph for this function:

ConditionalItems() [1/2]

template<typename... Args>

std::unique_ptr< ConditionalGroupItem > MenuTable::ConditionalItems ( const Identifier &  internalName, ConditionalGroupItem::Condition  condition, Args &&...  args  )

inline

Definition at line 674 of file CommandManager.h.

         { return std::make_unique<ConditionalGroupItem>(
            internalName, condition, std::forward<Args>(args)... ); }

Referenced by anonymous_namespace{ExtraMenus.cpp}::ExtraMenu(), and anonymous_namespace{FileMenus.cpp}::HiddenFileMenu().

Here is the caller graph for this function:

ConditionalItems() [2/2]

std::unique_ptr< ConditionalGroupItem > MenuTable::ConditionalItems ( const Identifier &  internalName, ConditionalGroupItem::Condition  condition, BaseItemPtrs &&  items  )

inline

Definition at line 679 of file CommandManager.h.

         { return std::make_unique<ConditionalGroupItem>(
            internalName, condition, std::move( items ) ); }

DestroyRegistry()

void MenuTable::DestroyRegistry

(

)

Definition at line 265 of file Menus.cpp.

{
   sRegistry().items.clear();
}

References Registry::GroupItem::items, and anonymous_namespace{Menus.cpp}::sRegistry().

Referenced by AudacityApp::OnExit().

Here is the call graph for this function:

Here is the caller graph for this function:

Items()

template<typename... Args>

std::unique_ptr< MenuItems > MenuTable::Items ( const Identifier &  internalName, Args &&...  args  )

inline

Definition at line 635 of file CommandManager.h.

         { return std::make_unique< MenuItems >(
            internalName, std::forward<Args>(args)... ); }

Referenced by anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), anonymous_namespace{ClipMenus.cpp}::ClipCursorItems(), anonymous_namespace{PluginMenus.cpp}::EffectMenu(), anonymous_namespace{NavigationMenus.cpp}::ExtraGlobalCommands(), anonymous_namespace{ExtraMenus.cpp}::ExtraMenu(), anonymous_namespace{ExtraMenus.cpp}::ExtraMiscItems(), anonymous_namespace{TranscriptionToolBar.cpp}::ExtraPlayAtSpeedItems(), anonymous_namespace{TransportMenus.cpp}::ExtraSelectionItems(), anonymous_namespace{ClipMenus.cpp}::ExtraTimeShiftItems(), anonymous_namespace{PluginMenus.cpp}::GenerateMenu(), anonymous_namespace{HelpMenus.cpp}::HelpMenu(), anonymous_namespace{LabelMenus.cpp}::LabelEditMenus(), MenuOrItems(), PluginMenuItems(), anonymous_namespace{PluginMenus.cpp}::PopulateEffectsMenu(), anonymous_namespace{PluginMenus.cpp}::ToolsMenu(), and MenuManager::Visit().

Here is the caller graph for this function:

Menu() [1/2]

template<typename... Args>

std::unique_ptr< MenuItem > MenuTable::Menu ( const Identifier &  internalName, const TranslatableString &  title, Args &&...  args  )

inline

Definition at line 658 of file CommandManager.h.

         { return std::make_unique<MenuItem>(
            internalName, title, std::forward<Args>(args)... ); }

References title.

Referenced by anonymous_namespace{PluginMenus.cpp}::AddEffectMenuItemGroup(), anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), anonymous_namespace{ClipMenus.cpp}::ClipSelectMenu(), anonymous_namespace{SelectMenus.cpp}::CursorMenu(), anonymous_namespace{EditMenus.cpp}::EditMenu(), anonymous_namespace{PluginMenus.cpp}::EffectMenu(), anonymous_namespace{SelectMenus.cpp}::ExtraCursorMenu(), anonymous_namespace{DeviceToolBar.cpp}::ExtraDeviceMenu(), anonymous_namespace{EditMenus.cpp}::ExtraEditMenu(), anonymous_namespace{NavigationMenus.cpp}::ExtraFocusMenu(), anonymous_namespace{ExtraMenus.cpp}::ExtraMenu(), anonymous_namespace{MeterToolBar.cpp}::ExtraMixerMenu(), anonymous_namespace{TranscriptionToolBar.cpp}::ExtraPlayAtSpeedMenu(), ExtraScriptablesIIMenu(), ExtraScriptablesIMenu(), anonymous_namespace{SelectMenus.cpp}::ExtraSeekMenu(), anonymous_namespace{SelectMenus.cpp}::ExtraSelectionMenu(), anonymous_namespace{ToolsToolBar.cpp}::ExtraToolsMenu(), anonymous_namespace{TrackMenus.cpp}::ExtraTrackMenu(), anonymous_namespace{TransportMenus.cpp}::ExtraTransportMenu(), anonymous_namespace{FileMenus.cpp}::FileMenu(), anonymous_namespace{PluginMenus.cpp}::GenerateMenu(), anonymous_namespace{HelpMenus.cpp}::HelpMenu(), anonymous_namespace{FileMenus.cpp}::HiddenFileMenu(), anonymous_namespace{LabelMenus.cpp}::LabelEditMenus(), KeyConfigPrefs::OnDefaults(), PluginMenuItems(), anonymous_namespace{SelectMenus.cpp}::SelectMenu(), anonymous_namespace{ToolbarMenus.cpp}::ToolbarsMenu(), anonymous_namespace{PluginMenus.cpp}::ToolsMenu(), anonymous_namespace{TrackMenus.cpp}::TracksMenu(), anonymous_namespace{TransportMenus.cpp}::TransportMenu(), and anonymous_namespace{ViewMenus.cpp}::ViewMenu().

Here is the caller graph for this function:

Menu() [2/2]

std::unique_ptr< MenuItem > MenuTable::Menu ( const Identifier &  internalName, const TranslatableString &  title, BaseItemPtrs &&  items  )

inline

Definition at line 662 of file CommandManager.h.

         { return std::make_unique<MenuItem>(
            internalName, title, std::move( items ) ); }

References title.

MenuOrItems() [1/2]

template<typename... Args>

BaseItemPtr MenuTable::MenuOrItems ( const Identifier &  internalName, const TranslatableString &  title, Args &&...  args  )

inline

Definition at line 693 of file CommandManager.h.

         {  if ( title.empty() )
               return Items( internalName, std::forward<Args>(args)... );
            else
               return std::make_unique<MenuItem>(
                  internalName, title, std::forward<Args>(args)... ); }

References Items(), and title.

Referenced by anonymous_namespace{PluginMenus.cpp}::AddGroupedEffectMenuItems(), and anonymous_namespace{PluginMenus.cpp}::MakeAddGroupItems().

Here is the call graph for this function:

Here is the caller graph for this function:

MenuOrItems() [2/2]

BaseItemPtr MenuTable::MenuOrItems ( const Identifier &  internalName, const TranslatableString &  title, BaseItemPtrs &&  items  )

inline

Definition at line 700 of file CommandManager.h.

         {  if ( title.empty() )
               return Items( internalName, std::move( items ) );
            else
               return std::make_unique<MenuItem>(
                  internalName, title, std::move( items ) ); }

References Items(), and title.

Here is the call graph for this function:

Section()

template<typename... Args>

std::unique_ptr< MenuPart > MenuTable::Section ( const Identifier &  internalName, Args &&...  args  )

inline

Definition at line 646 of file CommandManager.h.

         { return std::make_unique< MenuPart >(
            internalName, std::forward<Args>(args)... ); }

Referenced by anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), anonymous_namespace{EditMenus.cpp}::EditMenu(), anonymous_namespace{PluginMenus.cpp}::EffectMenu(), anonymous_namespace{ExtraMenus.cpp}::ExtraMenu(), anonymous_namespace{FileMenus.cpp}::FileMenu(), anonymous_namespace{PluginMenus.cpp}::GenerateMenu(), anonymous_namespace{HelpMenus.cpp}::HelpMenu(), anonymous_namespace{LabelMenus.cpp}::LabelEditMenus(), PluginMenuItems(), anonymous_namespace{PluginMenus.cpp}::PopulateEffectsMenu(), anonymous_namespace{Printing.cpp}::PrintingItems(), DEFINE_VERSION_CHECK::RegisterMenuItems(), anonymous_namespace{NyqBench.cpp}::RegisterMenuItems(), anonymous_namespace{SelectMenus.cpp}::SelectMenu(), anonymous_namespace{ToolbarMenus.cpp}::ToolbarsMenu(), anonymous_namespace{PluginMenus.cpp}::ToolsMenu(), anonymous_namespace{TrackMenus.cpp}::TracksMenu(), anonymous_namespace{TransportMenus.cpp}::TransportMenu(), and anonymous_namespace{ViewMenus.cpp}::ViewMenu().

Here is the caller graph for this function:

Special()

std::unique_ptr< SpecialItem > MenuTable::Special ( const Identifier &  name, const SpecialItem::Appender &  fn  )

inline

Definition at line 765 of file CommandManager.h.

         { return std::make_unique<SpecialItem>( name, fn ); }

References fn, and name.

Referenced by anonymous_namespace{EditMenus.cpp}::EditMenu(), and anonymous_namespace{FileMenus.cpp}::FileMenu().

Here is the caller graph for this function: