MenuRegistry Namespace Reference

Namespaces
namespace	detail

Classes
struct	CommandGroupItem
struct	CommandItem
struct	ConditionalGroupItem
class	FinderScope
struct	ItemProperties
	A mix-in discovered by dynamic_cast; independent of the Traits. More...
struct	ItemRegistry
struct	MenuItem
struct	MenuItemData
struct	MenuItems
struct	MenuPart
struct	Options
struct	SpecialItem
struct	Traits
struct	Visitor

Typedefs
using	CheckFn = std::function< bool(AudacityProject &) >
using	Condition = std::function< bool()>
using	AttachedItem = RegisteredItem< ItemRegistry >

Functions
template<typename RegistryTraits >
static bool	IsSection (const GroupItem< RegistryTraits > &item)
MENUS_API void	Visit (Visitor< Traits > &visitor, AudacityProject &project)

Variables
Factories
The following, and Registry::Indirect(), are the functions to use directly to specify elements of menu groupings.
constexpr auto	Items = Callable::UniqueMaker<MenuItems>()
constexpr auto	Section = Callable::UniqueMaker<MenuPart>()
constexpr auto	Menu = Callable::UniqueMaker<MenuItem>()
	Items will appear in a main toolbar menu or in a sub-menu. More...
constexpr auto	ConditionalItems = Callable::UniqueMaker<ConditionalGroupItem>()
constexpr auto	Command = Callable::UniqueMaker<CommandItem>()
constexpr auto	CommandGroup

Typedef Documentation

AttachedItem

using MenuRegistry::AttachedItem = typedef RegisteredItem<ItemRegistry>

Definition at line 470 of file MenuRegistry.h.

CheckFn

using MenuRegistry::CheckFn = typedef std::function< bool(AudacityProject&) >

Definition at line 34 of file MenuRegistry.h.

Condition

using MenuRegistry::Condition = typedef std::function<bool()>

Definition at line 230 of file MenuRegistry.h.

Function Documentation

IsSection()

template<typename RegistryTraits >

static bool MenuRegistry::IsSection ( const GroupItem< RegistryTraits > &  item )

inlinestatic

Definition at line 197 of file MenuRegistry.h.

                                                                       {
      auto pProperties = dynamic_cast<const ItemProperties *>(&item);
      return pProperties && pProperties->GetProperties() ==
         ItemProperties::Section;
   }

References MenuRegistry::ItemProperties::GetProperties(), and MenuRegistry::ItemProperties::Section.

Referenced by CommandManager::Populator::DoBeginGroup(), and CommandManager::Populator::DoEndGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

Visit()

void MenuRegistry::Visit	(	Visitor< Traits > &	visitor,
		AudacityProject &	project
	)

Definition at line 193 of file MenuRegistry.cpp.

{
   // Once only, cause initial population of preferences for the ordering
   // of some menu items that used to be given in tables but are now separately
   // registered in several .cpp files; the sequence of registration depends
   // on unspecified accidents of static initialization order across
   // compilation units, so we need something specific here to preserve old
   // default appearance of menus.
   // But this needs only to mention some strings -- there is no compilation or
   // link dependency of this source file on those other implementation files.
 
   static Registry::OrderingPreferenceInitializer init{
      MenuPathStart,
      {
         {wxT(""), wxT(
"File,Edit,Select,View,Transport,Tracks,Generate,Effect,Analyze,Tools,Window,Optional,Help"
          )},
         {wxT("/Optional/Extra/Part1"), wxT(
"Transport,Tools,Mixer,Edit,PlayAtSpeed,Seek,Device,Select"
          )},
         {wxT("/Optional/Extra/Part2"), wxT(
"Navigation,Focus,Cursor,Track,Scriptables1,Scriptables2"
          )},
         {wxT("/View/Windows"), wxT("UndoHistory,MixerBoard")},
         {wxT("/Analyze/Analyzers/Windows"), wxT("ContrastAnalyser,PlotSpectrum")},
         {wxT("/Transport/Basic"), wxT("Play,Record,Scrubbing,Cursor")},
         {wxT("/View/Other/Toolbars/Toolbars/Other"), wxT(
"ShowTransportTB,ShowToolsTB,ShowRecordMeterTB,ShowPlayMeterTB,"
//"ShowMeterTB,"
"ShowMixerTB,"
"ShowEditTB,ShowTranscriptionTB,ShowScrubbingTB,ShowDeviceTB,ShowSelectionTB,"
"ShowSpectralSelectionTB") },
         {wxT("/Tracks/Add/Add"), wxT(
"NewMonoTrack,NewStereoTrack,NewLabelTrack,NewTimeTrack")},
         {wxT("/Optional/Extra/Part2/Scriptables1"), wxT(
"SelectTime,SelectFrequencies,SelectTracks,SetTrackStatus,SetTrackAudio,"
"SetTrackVisuals,GetPreference,SetPreference,SetClip,SetEnvelope,SetLabel"
"SetProject") },
         {wxT("/Optional/Extra/Part2/Scriptables2"), wxT(
"Select,SetTrack,GetInfo,Message,Help,Import2,Export2,OpenProject2,"
"SaveProject2,Drag,CompareAudio") },
      }
   };
 
   static const auto menuTree = MenuRegistry::Items( MenuPathStart );
 
   wxLogNull nolog;
   Registry::VisitWithFunctions(visitor, menuTree.get(),
      &MenuRegistry::ItemRegistry::Registry(), project);
}

References Items, MenuPathStart, project, MenuRegistry::ItemRegistry::Registry(), Registry::VisitWithFunctions(), and wxT().

Referenced by compileTest(), PluginManager::GetConfigValue(), ToolDock::LayoutToolBars(), anonymous_namespace{EditMenus.cpp}::OnCut(), anonymous_namespace{HelpMenus.cpp}::OnMenuTree(), ToolDock::PositionBar(), PluginManager::SetConfigValue(), and Tester< Const, ref >::testCase().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

Command

constexpr auto MenuRegistry::Command = Callable::UniqueMaker<CommandItem>()

constexpr

Definition at line 456 of file MenuRegistry.h.

Referenced by anonymous_namespace{MenuHelper.cpp}::AddEffectMenuItemGroup(), anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), 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{FileMenus.cpp}::ExtraExportMenu(), 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{TimelineMenus.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{Scrubbing.cpp}::KeyboardScrubbingItems(), anonymous_namespace{LabelMenus.cpp}::LabelEditMenus(), TrackMenuTable::OnSetName(), PluginMenuItems(), anonymous_namespace{BatchProcessDialog.cpp}::PopulateMacrosMenu(), DEFINE_VERSION_CHECK::RegisterMenuItems(), anonymous_namespace{NyqBench.cpp}::RegisterMenuItems(), anonymous_namespace{SelectMenus.cpp}::SelectMenu(), MacroCommandDialog::SetCommandAndParams(), anonymous_namespace{SpectrumView.cpp}::SpectralSelectionMenu(), WaveTrackAffordanceControls::StartEditClipName(), anonymous_namespace{Scrubbing.cpp}::ToolbarMenu(), 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().

CommandGroup

constexpr auto MenuRegistry::CommandGroup

constexpr

Initial value:

= Callable::UniqueMaker<CommandGroupItem,
      const Identifier &, std::vector<ComponentInterfaceSymbol>>()

Definition at line 458 of file MenuRegistry.h.

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

ConditionalItems

constexpr auto MenuRegistry::ConditionalItems = Callable::UniqueMaker<ConditionalGroupItem>()

constexpr

These items register in the CommandManager but are not shown in menus if the condition evaluates false.

The name is untranslated. Try to keep the name stable across Audacity versions. Name for conditional group must be non-empty.

Definition at line 454 of file MenuRegistry.h.

Referenced by anonymous_namespace{ExtraMenus.cpp}::ExtraMenu().

Items

constexpr auto MenuRegistry::Items = Callable::UniqueMaker<MenuItems>()

constexpr

Variadic constructor from pointers to subordinate items, which are moved into the result.

Null pointers are permitted, and ignored when building the menu. Items are spliced into the enclosing menu. The name is untranslated and may be empty, to make the group transparent in identification of items by path. Otherwise try to keep the name stable across Audacity versions.

Definition at line 427 of file MenuRegistry.h.

Referenced by anonymous_namespace{MenuHelper.cpp}::AddGroupedEffectMenuItems(), anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), anonymous_namespace{ClipMenus.cpp}::ClipCursorItems(), anonymous_namespace{PluginMenus.cpp}::EffectMenu(), anonymous_namespace{NavigationMenus.cpp}::ExtraGlobalCommands(), 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{Scrubbing.cpp}::KeyboardScrubbingItems(), anonymous_namespace{LabelMenus.cpp}::LabelEditMenus(), anonymous_namespace{MenuHelper.cpp}::MakeAddGroupItems(), audacity::cloud::audiocom::sync::anonymous_namespace{AudioComDialogBase.cpp}::Idler::OnIdle(), PluginMenuItems(), MenuHelper::PopulateEffectsMenu(), anonymous_namespace{PluginMenus.cpp}::ToolsMenu(), and Visit().

Menu

constexpr auto MenuRegistry::Menu = Callable::UniqueMaker<MenuItem>()

constexpr

Items will appear in a main toolbar menu or in a sub-menu.

The name is untranslated. Try to keep the name stable across Audacity versions. If the name of a menu is empty, then subordinate items cannot be located by path.

Definition at line 445 of file MenuRegistry.h.

Referenced by anonymous_namespace{MenuHelper.cpp}::AddEffectMenuItemGroup(), anonymous_namespace{MenuHelper.cpp}::AddGroupedEffectMenuItems(), 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{FileMenus.cpp}::ExtraExportMenu(), 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{TimelineMenus.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{LabelMenus.cpp}::LabelEditMenus(), anonymous_namespace{MenuHelper.cpp}::MakeAddGroupItems(), KeyConfigPrefs::OnDefaults(), PluginMenuItems(), anonymous_namespace{SelectMenus.cpp}::SelectMenu(), anonymous_namespace{SpectrumView.cpp}::SpectralSelectionMenu(), anonymous_namespace{Scrubbing.cpp}::ToolbarMenu(), anonymous_namespace{ToolbarMenus.cpp}::ToolbarsMenu(), anonymous_namespace{PluginMenus.cpp}::ToolsMenu(), anonymous_namespace{TrackMenus.cpp}::TracksMenu(), anonymous_namespace{TransportMenus.cpp}::TransportMenu(), RealtimeEffectListWindow::UpdateEffectMenuItems(), and anonymous_namespace{ViewMenus.cpp}::ViewMenu().

Section

constexpr auto MenuRegistry::Section = Callable::UniqueMaker<MenuPart>()

constexpr

Like Items, but insert a menu separator between the menu section and any other items or sections before or after it in the same (innermost, enclosing) menu.

It's not necessary that the sisters of sections be other sections, but it might clarify the logical groupings.

Definition at line 436 of file MenuRegistry.h.

Referenced by anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), anonymous_namespace{EditMenus.cpp}::EditMenu(), anonymous_namespace{PluginMenus.cpp}::EffectMenu(), anonymous_namespace{FileMenus.cpp}::ExtraExportMenu(), 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(), MenuHelper::PopulateEffectsMenu(), 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(), RealtimeEffectListWindow::UpdateEffectMenuItems(), and anonymous_namespace{ViewMenus.cpp}::ViewMenu().