MenuCreator Class Reference

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

#include <Menus.h>

Inheritance diagram for MenuCreator:

Collaboration diagram for MenuCreator:

Public Types
enum	{ repeattypenone = 0 , repeattypeplugin = 1 , repeattypeunique = 2 , repeattypeapplymacro = 3 }

Public Member Functions
	MenuCreator ()
	~MenuCreator ()
void	CreateMenusAndCommands (AudacityProject &project)
void	RebuildMenuBar (AudacityProject &project)

Static Public Member Functions
static void	RebuildAllMenuBars ()

Public Attributes
CommandFlag	mLastFlags
PluginID	mLastGenerator {}
PluginID	mLastEffect {}
PluginID	mLastAnalyzer {}
int	mLastAnalyzerRegistration
int	mLastAnalyzerRegisteredId
PluginID	mLastTool {}
int	mLastToolRegistration
int	mLastToolRegisteredId
unsigned	mRepeatGeneratorFlags
unsigned	mRepeatEffectFlags
unsigned	mRepeatAnalyzerFlags
unsigned	mRepeatToolFlags

Detailed Description

MenuCreator is responsible for creating the main menu bar.

Definition at line 37 of file Menus.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
repeattypenone
repeattypeplugin
repeattypeunique
repeattypeapplymacro

Definition at line 59 of file Menus.h.

        {
      repeattypenone = 0,
      repeattypeplugin = 1,
      repeattypeunique = 2,
      repeattypeapplymacro = 3
   };

Constructor & Destructor Documentation

MenuCreator()

MenuCreator::MenuCreator

(

)

Definition at line 49 of file Menus.cpp.

{
   mLastAnalyzerRegistration = repeattypenone;
   mLastToolRegistration = repeattypenone;
   
   mRepeatGeneratorFlags = 0;
   mRepeatEffectFlags = 0;
   mRepeatAnalyzerFlags = 0;
   mRepeatToolFlags = 0;
}

References mLastAnalyzerRegistration, mLastToolRegistration, mRepeatAnalyzerFlags, mRepeatEffectFlags, mRepeatGeneratorFlags, mRepeatToolFlags, and repeattypenone.

~MenuCreator()

MenuCreator::~MenuCreator

(

)

Definition at line 60 of file Menus.cpp.

{
}

Member Function Documentation

CreateMenusAndCommands()

void MenuCreator::CreateMenusAndCommands

(

AudacityProject &

project

)

Definition at line 370 of file Menus.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,Karaoke,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,Screenshot") },
      }
   };
 
   auto &commandManager = CommandManager::Get( project );
 
   // The list of defaults to exclude depends on
   // preference wxT("/GUI/Shortcuts/FullDefaults"), which may have changed.
   commandManager.SetMaxList();
 
   auto menubar = commandManager.AddMenuBar(wxT("appmenu"));
   wxASSERT(menubar);
 
   MenuItemVisitor visitor{ project, commandManager };
   MenuManager::Visit( visitor );
 
   GetProjectFrame( project ).SetMenuBar(menubar.release());
 
   mLastFlags = AlwaysEnabledFlag;
 
#if defined(_DEBUG)
//   c->CheckDups();
#endif
}

References AlwaysEnabledFlag, CommandManager::Get(), GetProjectFrame(), MenuPathStart, project, MenuManager::Visit(), and wxT().

Referenced by ProjectManager::New().

Here is the call graph for this function:

Here is the caller 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 614 of file Menus.cpp.

{
   for( auto p : AllProjects{} ) {
      MenuManager::Get(*p).RebuildMenuBar(*p);
#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 MenuManager::Get(), GetProjectFrame(), and RebuildMenuBar().

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

Here is the call graph for this function:

Here is the caller graph for this function:

RebuildMenuBar()

void MenuCreator::RebuildMenuBar

(

AudacityProject &

project

)

Definition at line 486 of file Menus.cpp.

{
   // 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);
      wxASSERT((!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
   }
 
   CommandManager::Get( project ).PurgeData();
 
   CreateMenusAndCommands(project);
}

References BasicUI::FindFocus(), CommandManager::Get(), GetProjectFrame(), 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:

Member Data Documentation

mLastAnalyzer

PluginID MenuCreator::mLastAnalyzer {}

Definition at line 53 of file Menus.h.

Referenced by anonymous_namespace{PluginMenus.cpp}::AnalyzeMenu(), and anonymous_namespace{PluginMenus.cpp}::HasLastAnalyzerFlag().

mLastAnalyzerRegisteredId

int MenuCreator::mLastAnalyzerRegisteredId

Definition at line 55 of file Menus.h.

mLastAnalyzerRegistration

int MenuCreator::mLastAnalyzerRegistration

Definition at line 54 of file Menus.h.

Referenced by anonymous_namespace{PluginMenus.cpp}::HasLastAnalyzerFlag(), and MenuCreator().

mLastEffect

PluginID MenuCreator::mLastEffect {}

Definition at line 52 of file Menus.h.

Referenced by anonymous_namespace{PluginMenus.cpp}::EffectMenu(), and anonymous_namespace{PluginMenus.cpp}::HasLastEffectFlag().

mLastFlags

CommandFlag MenuCreator::mLastFlags

Definition at line 48 of file Menus.h.

mLastGenerator

PluginID MenuCreator::mLastGenerator {}

Definition at line 51 of file Menus.h.

Referenced by anonymous_namespace{PluginMenus.cpp}::GenerateMenu(), and anonymous_namespace{PluginMenus.cpp}::HasLastGeneratorFlag().

mLastTool

PluginID MenuCreator::mLastTool {}

Definition at line 56 of file Menus.h.

Referenced by PluginMenuItems().

mLastToolRegisteredId

int MenuCreator::mLastToolRegisteredId

Definition at line 58 of file Menus.h.

mLastToolRegistration

int MenuCreator::mLastToolRegistration

Definition at line 57 of file Menus.h.

Referenced by MenuCreator().

mRepeatAnalyzerFlags

unsigned MenuCreator::mRepeatAnalyzerFlags

Definition at line 67 of file Menus.h.

Referenced by MenuCreator().

mRepeatEffectFlags

unsigned MenuCreator::mRepeatEffectFlags

Definition at line 66 of file Menus.h.

Referenced by MenuCreator().

mRepeatGeneratorFlags

unsigned MenuCreator::mRepeatGeneratorFlags

Definition at line 65 of file Menus.h.

Referenced by MenuCreator().

mRepeatToolFlags

unsigned MenuCreator::mRepeatToolFlags

Definition at line 68 of file Menus.h.

Referenced by MenuCreator().

---

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

• Menus.h
• Menus.cpp