MenuCreator is responsible for creating the main menu bar. More...

#include <MenuCreator.h>

Inheritance diagram for MenuCreator:

Collaboration diagram for MenuCreator:

Classes
struct	SpecialItem

Public Member Functions
	MenuCreator (AudacityProject &project)

	~MenuCreator () override

void	CreateMenusAndCommands ()

void	RebuildMenuBar ()

bool	ReallyDoQuickCheck () override
	Default implementation returns true. More...

void	RemoveDuplicateShortcuts ()

Public Member Functions inherited from CommandManager
	CommandManager (AudacityProject &project)

	CommandManager (const CommandManager &)=delete

CommandManager &	operator= (const CommandManager &)=delete

	~CommandManager () override

CommandFlag	GetUpdateFlags (bool quick=false) const

void	UpdatePrefs () override

bool	ReportIfActionNotAllowed (const TranslatableString &Name, CommandFlag &flags, CommandFlag flagsRqd)

bool	TryToMakeActionAllowed (CommandFlag &flags, CommandFlag flagsRqd)

AudacityProject &	GetProject ()

size_t	NCommands () const

void	PurgeData ()

void	SetCommandFlags (const CommandID &name, CommandFlag flags)

void	EnableUsingFlags (CommandFlag flags, CommandFlag strictFlags)

void	Enable (const wxString &name, bool enabled)

void	Check (const CommandID &name, bool checked)

void	Modify (const wxString &name, const TranslatableString &newLabel)
	Changes the label text of a menu item. More...

void	SetKeyFromName (const CommandID &name, const NormalizedKeyString &key)

void	SetKeyFromIndex (int i, const NormalizedKeyString &key)

bool	HandleMenuID (int id, CommandFlag flags, bool alwaysEnabled)

void	RegisterLastAnalyzer (const CommandContext &context)

void	RegisterLastTool (const CommandContext &context)

void	DoRepeatProcess (const CommandContext &context, int)

TextualCommandResult	HandleTextualCommand (const CommandID &Str, const CommandContext &context, CommandFlag flags, bool alwaysEnabled)

TranslatableStrings	GetCategories ()

void	GetAllCommandNames (CommandIDs &names, bool includeMultis) const

void	GetAllCommandLabels (TranslatableStrings &labels, std::vector< bool > &vExcludeFromMacros, bool includeMultis) const

void	GetAllCommandData (CommandIDs &names, std::vector< NormalizedKeyString > &keys, std::vector< NormalizedKeyString > &default_keys, TranslatableStrings &labels, TranslatableStrings &categories, TranslatableStrings &prefixes, bool includeMultis)

CommandID	GetNameFromNumericID (int id) const

TranslatableString	GetLabelFromName (const CommandID &name) const

TranslatableString	GetPrefixedLabelFromName (const CommandID &name) const

TranslatableString	GetCategoryFromName (const CommandID &name) const

NormalizedKeyString	GetKeyFromName (const CommandID &name) const

NormalizedKeyString	GetDefaultKeyFromName (const CommandID &name) const

bool	GetEnabled (const CommandID &name) const

int	GetNumberOfKeysRead () const

TranslatableString	ReportDuplicateShortcuts ()

void	WriteXML (XMLWriter &xmlFile) const

TranslatableString	DescribeCommandsAndShortcuts (const ComponentInterfaceSymbol commands[], size_t nCommands) const

void	UpdateCheckmarks ()

wxString	FormatLabelForMenu (const CommandID &id, const TranslatableString *pLabel) const
	Format a string appropriate for insertion in a menu. More...

void	ModifyUndoMenuItems ()

void	UpdateMenus (bool checkActive=true)

Public Member Functions inherited from XMLTagHandler
	XMLTagHandler ()

virtual	~XMLTagHandler ()

virtual bool	HandleXMLTag (const std::string_view &tag, const AttributesList &attrs)=0

virtual void	HandleXMLEndTag (const std::string_view &WXUNUSED(tag))

virtual void	HandleXMLContent (const std::string_view &WXUNUSED(content))

virtual XMLTagHandler *	HandleXMLChild (const std::string_view &tag)=0

void	ReadXMLEndTag (const char *tag)

void	ReadXMLContent (const char *s, int len)

XMLTagHandler *	ReadXMLChild (const char *tag)

Public Member Functions inherited from ClientData::Base
virtual	~Base ()

Public Member Functions inherited from Observer::Publisher< MenuUpdateMessage >
	Publisher (ExceptionPolicy *pPolicy=nullptr, Alloc a={})
	Constructor supporting type-erased custom allocation/deletion. More...

	Publisher (Publisher &&)=default

Publisher &	operator= (Publisher &&)=default

Subscription	Subscribe (Callback callback)
	Connect a callback to the Publisher; later-connected are called earlier. More...

Subscription	Subscribe (Object &obj, Return(Object::*callback)(Args...))
	Overload of Subscribe takes an object and pointer-to-member-function. More...

Static Public Member Functions
static bool	FilterKeyEvent (AudacityProject &project, const wxKeyEvent &evt, bool permit=false)

static MenuCreator &	Get (AudacityProject &project)

static const MenuCreator &	Get (const AudacityProject &project)

static void	RebuildAllMenuBars ()

Static Public Member Functions inherited from CommandManager
static CommandManager &	Get (AudacityProject &project)

static const CommandManager &	Get (const AudacityProject &project)

static const std::vector< NormalizedKeyString > &	ExcludedList ()

Static Public Attributes
static constexpr auto	Special = Callable::UniqueMaker<SpecialItem>()

Static Public Attributes inherited from Observer::Publisher< MenuUpdateMessage >
static constexpr bool	notifies_all

Private Member Functions
void	ExecuteCommand (const CommandContext &context, const wxEvent *evt, const CommandListEntry &entry) override

Additional Inherited Members
Public Types inherited from CommandManager
enum	{ repeattypenone = 0 , repeattypeplugin = 1 , repeattypeunique = 2 , repeattypeapplymacro = 3 }

enum	TextualCommandResult { CommandFailure , CommandSuccess , CommandNotFound }

Public Types inherited from Observer::Publisher< MenuUpdateMessage >
using	message_type = MenuUpdateMessage

using	CallbackReturn = std::conditional_t< true, void, bool >

using	Callback = std::function< CallbackReturn(const MenuUpdateMessage &) >
	Type of functions that can be connected to the Publisher. More...

Public Attributes inherited from CommandManager
CommandFlag	mLastFlags = AlwaysEnabledFlag

PluginID	mLastGenerator {}

PluginID	mLastEffect {}

PluginID	mLastAnalyzer {}

int	mLastAnalyzerRegistration = repeattypenone

int	mLastAnalyzerRegisteredId = -1

PluginID	mLastTool {}

int	mLastToolRegistration = repeattypenone

int	mLastToolRegisteredId = -1

unsigned	mRepeatGeneratorFlags = 0

unsigned	mRepeatEffectFlags = 0

unsigned	mRepeatAnalyzerFlags = 0

unsigned	mRepeatToolFlags = 0

int	mWhatIfNoSelection

bool	mStopIfWasPaused { true }

Protected Types inherited from CommandManager
using	CommandKeyHash = std::unordered_map< NormalizedKeyString, CommandListEntry * >

Protected Member Functions inherited from CommandManager
bool	HandleCommandEntry (const CommandListEntry entry, CommandFlag flags, bool alwaysEnabled, const wxEvent evt=nullptr, const CommandContext *pGivenContext=nullptr)

virtual void	ExecuteCommand (const CommandContext &context, const wxEvent *evt, const CommandListEntry &entry)

virtual bool	ReallyDoQuickCheck ()
	Default implementation returns true. More...

Protected Member Functions inherited from Observer::Publisher< MenuUpdateMessage >
CallbackReturn	Publish (const MenuUpdateMessage &message)
	Send a message to connected callbacks. More...

Protected Attributes inherited from CommandManager
AudacityProject &	mProject

CommandKeyHash	mCommandKeyHash

Static Protected Attributes inherited from CommandManager
static const TranslatableString	COMMAND = XO("Command")

Detailed Description

MenuCreator is responsible for creating the main menu bar.

Definition at line 18 of file MenuCreator.h.

Constructor & Destructor Documentation

◆ MenuCreator()

MenuCreator::MenuCreator ( AudacityProject & project )

Definition at line 84 of file MenuCreator.cpp.

   : CommandManager{ project }
{
}

◆ ~MenuCreator()

MenuCreator::~MenuCreator ( )

overridedefault

Member Function Documentation

◆ CreateMenusAndCommands()

void MenuCreator::CreateMenusAndCommands ( )

Definition at line 441 of file MenuCreator.cpp.

{
   {
      MenuItemVisitor visitor{ mProject };
   }
 
   mLastFlags = AlwaysEnabledFlag;
 
#if defined(_DEBUG)
//   c->CheckDups();
#endif
}

References AlwaysEnabledFlag, CommandManager::mLastFlags, and CommandManager::mProject.

Referenced by ProjectManager::New(), and RebuildMenuBar().

Here is the caller graph for this function:

◆ ExecuteCommand()

void MenuCreator::ExecuteCommand	(	const CommandContext &	context,
		const wxEvent *	evt,
		const CommandListEntry &	entry
	)

overrideprivatevirtual

Reimplemented from CommandManager.

Definition at line 490 of file MenuCreator.cpp.

{
   Journal::Output({ JournalCode, entry.name.GET() });
   return CommandManager::ExecuteCommand(context, evt, entry);
}

References entry, CommandManager::ExecuteCommand(), JournalCode, and Journal::Output().

Here is the call graph for this function:

◆ FilterKeyEvent()

bool MenuCreator::FilterKeyEvent	(	AudacityProject &	project,
		const wxKeyEvent &	evt,
		bool	permit = `false`
	)

static

Definition at line 568 of file MenuCreator.cpp.

{
   auto &cm = Get(project);
   
   auto pWindow = FindProjectFrame(&project);
   CommandListEntry *entry = cm.mCommandKeyHash[KeyEventToKeyString(evt)];
   if (entry == NULL)
   {
      return false;
   }
 
   int type = evt.GetEventType();
 
   // Global commands aren't tied to any specific project
   if (entry->isGlobal && type == wxEVT_KEY_DOWN)
   {
      // Global commands are always disabled so they do not interfere with the
      // rest of the command handling.  But, to use the common handler, we
      // enable them temporarily and then disable them again after handling.
      // LL:  Why do they need to be disabled???
      entry->enabled = false;
      auto cleanup = valueRestorer( entry->enabled, true );
      return cm.HandleCommandEntry(entry, NoFlagsSpecified, false, &evt);
   }
 
   wxWindow * pFocus = wxWindow::FindFocus();
   wxWindow * pParent = wxGetTopLevelParent( pFocus );
   bool validTarget = pParent == pWindow;
   // Bug 1557.  MixerBoard should count as 'destined for project'
   // MixerBoard IS a TopLevelWindow, and its parent is the project.
   if( pParent && pParent->GetParent() == pWindow ){
      if(auto keystrokeHandlingWindow = dynamic_cast< TopLevelKeystrokeHandlingWindow* >( pParent ))
         validTarget = keystrokeHandlingWindow->HandleCommandKeystrokes();
   }
   validTarget = validTarget && wxEventLoop::GetActive()->IsMain();
 
   // Any other keypresses must be destined for this project window
   if (!permit && !validTarget )
   {
      return false;
   }
 
   auto flags = cm.GetUpdateFlags();
 
   wxKeyEvent temp = evt;
 
   // Possibly let wxWidgets do its normal key handling IF it is one of
   // the standard navigation keys.
   if((type == wxEVT_KEY_DOWN) || (type == wxEVT_KEY_UP ))
   {
      wxWindow * pWnd = wxWindow::FindFocus();
      bool bIntercept =
         pWnd && !dynamic_cast< NonKeystrokeInterceptingWindow * >( pWnd );
 
      //wxLogDebug("Focus: %p TrackPanel: %p", pWnd, pTrackPanel );
      // We allow the keystrokes below to be handled by wxWidgets controls IF we are
      // in some sub window rather than in the TrackPanel itself.
      // Otherwise they will go to our command handler and if it handles them
      // they will NOT be available to wxWidgets.
      if( bIntercept ){
         switch( evt.GetKeyCode() ){
         case WXK_LEFT:
         case WXK_RIGHT:
         case WXK_UP:
         case WXK_DOWN:
         // Don't trap WXK_SPACE (Bug 1727 - SPACE not starting/stopping playback
         // when cursor is in a time control)
         // case WXK_SPACE:
         case WXK_TAB:
         case WXK_BACK:
         case WXK_HOME:
         case WXK_END:
         case WXK_RETURN:
         case WXK_NUMPAD_ENTER:
         case WXK_DELETE:
         case '0':
         case '1':
         case '2':
         case '3':
         case '4':
         case '5':
         case '6':
         case '7':
         case '8':
         case '9':
            return false;
         case ',':
         case '.':
            if (!evt.HasAnyModifiers())
               return false;
         }
      }
   }
 
   if (type == wxEVT_KEY_DOWN)
   {
      if (entry->skipKeydown)
      {
         return true;
      }
      return cm.HandleCommandEntry(entry, flags, false, &temp);
   }
 
   if (type == wxEVT_KEY_UP && entry->wantKeyup)
   {
      return cm.HandleCommandEntry(entry, flags, false, &temp);
   }
 
   return false;
}

References entry, BasicUI::FindFocus(), FindProjectFrame(), Get(), KeyEventToKeyString(), NoFlagsSpecified, project, and valueRestorer().

Referenced by MixerBoardFrame::OnKeyEvent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [1/2]

MenuCreator & MenuCreator::Get ( AudacityProject & project )

static

Definition at line 91 of file MenuCreator.cpp.

{
   return static_cast<MenuCreator&>(CommandManager::Get(project));
}

References CommandManager::Get(), and project.

Referenced by DoReloadPreferences(), FilterKeyEvent(), AudacityApp::InitPart2(), ProjectManager::New(), anonymous_namespace{EditMenus.cpp}::OnPreferences(), RebuildAllMenuBars(), and MacrosWindow::UpdateMenus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Get() [2/2]

const MenuCreator & MenuCreator::Get ( const AudacityProject & project )

static

Definition at line 96 of file MenuCreator.cpp.

{
   return static_cast<const MenuCreator&>(CommandManager::Get(project));
}

References CommandManager::Get(), and project.

Here is the call graph for this function:

◆ ReallyDoQuickCheck()

bool MenuCreator::ReallyDoQuickCheck ( )

overridevirtual

Default implementation returns true.

Reimplemented from CommandManager.

Definition at line 499 of file MenuCreator.cpp.

{
   return !GetProjectFrame(mProject).IsActive();
}

References GetProjectFrame(), and CommandManager::mProject.

Here is the call graph for this function:

◆ RebuildAllMenuBars()

void MenuCreator::RebuildAllMenuBars ( )

static

The following method moves to the previous track selecting and unselecting depending if you are on the start of a block or not.

Definition at line 508 of file MenuCreator.cpp.

{
   for( auto p : AllProjects{} ) {
      Get(*p).RebuildMenuBar();
#if defined(__WXGTK__)
      // Workaround for:
      //
      //   http://bugzilla.audacityteam.org/show_bug.cgi?id=458
      //
      // This workaround should be removed when Audacity updates to wxWidgets 3.x which has a fix.
      auto &window = GetProjectFrame( *p );
      wxRect r = window.GetRect();
      window.SetSize(wxSize(1,1));
      window.SetSize(r.GetSize());
#endif
   }
}

References Get(), GetProjectFrame(), and RebuildMenuBar().

Referenced by anonymous_namespace{PluginMenus.cpp}::DoManagePluginsMenu(), AudacityApp::InitPart2(), IncompatiblePluginsDialog::OnPluginManagerClicked(), anonymous_namespace{ViewMenus.cpp}::OnShowExtraMenus(), anonymous_namespace{SpectrumView.cpp}::SpectrogramSettingsHandler::OnSpectrogramSettings(), ProjectFileManager::OpenFile(), EffectsPrefs::PopulateOrExchange(), and RemoveDuplicateShortcuts().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RebuildMenuBar()

void MenuCreator::RebuildMenuBar ( )

Definition at line 461 of file MenuCreator.cpp.

{
   auto &project = mProject;
   // On OSX, we can't rebuild the menus while a modal dialog is being shown
   // since the enabled state for menus like Quit and Preference gets out of
   // sync with wxWidgets idea of what it should be.
#if defined(__WXMAC__) && defined(_DEBUG)
   {
      wxDialog *dlg =
         wxDynamicCast(wxGetTopLevelParent(wxWindow::FindFocus()), wxDialog);
      assert((!dlg || !dlg->IsModal()));
   }
#endif
 
   // Delete the menus, since we will soon recreate them.
   // Rather oddly, the menus don't vanish as a result of doing this.
   {
      auto &window = static_cast<wxFrameEx&>( GetProjectFrame( project ) );
      wxWindowPtr<wxMenuBar> menuBar{ window.GetMenuBar() };
      window.DetachMenuBar();
      // menuBar gets deleted here
   }
 
   PurgeData();
   CreateMenusAndCommands();
}

References CreateMenusAndCommands(), BasicUI::FindFocus(), GetProjectFrame(), CommandManager::mProject, project, and CommandManager::PurgeData().

Referenced by DoReloadPreferences(), anonymous_namespace{EditMenus.cpp}::OnPreferences(), RebuildAllMenuBars(), and MacrosWindow::UpdateMenus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RemoveDuplicateShortcuts()

void MenuCreator::RemoveDuplicateShortcuts ( )

Definition at line 526 of file MenuCreator.cpp.

{
   const auto disabledShortcuts = ReportDuplicateShortcuts();
   if (!disabledShortcuts.Translation().empty()) {
      TranslatableString message = XO("The following commands have had their shortcuts removed,"
      " because their default shortcut is new or changed, and is the same shortcut"
      " that you have assigned to another command.")
         + disabledShortcuts;
      AudacityMessageBox(message, XO("Shortcuts have been removed"), wxOK | wxCENTRE);
 
      gPrefs->Flush();
      RebuildAllMenuBars();
   }
}

References AudacityMessageBox(), audacity::BasicSettings::Flush(), gPrefs, RebuildAllMenuBars(), CommandManager::ReportDuplicateShortcuts(), and XO().

Referenced by AudacityApp::InitPart2().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ Special

constexpr auto MenuCreator::Special = Callable::UniqueMaker<SpecialItem>()

staticconstexpr

Definition at line 36 of file MenuCreator.h.

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

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

Classes

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ MenuCreator()

◆ ~MenuCreator()

Member Function Documentation

◆ CreateMenusAndCommands()

◆ ExecuteCommand()

◆ FilterKeyEvent()

◆ Get() [1/2]

◆ Get() [2/2]

◆ ReallyDoQuickCheck()

◆ RebuildAllMenuBars()

◆ RebuildMenuBar()

◆ RemoveDuplicateShortcuts()

Member Data Documentation

◆ Special