anonymous_namespace{HelpMenus.cpp} Namespace Reference

Classes
class	QuickFixDialog
	Class which makes a dialog for displaying quick fixes to common issues. More...

Functions
	END_EVENT_TABLE ()
void	OnQuickFix (const CommandContext &context)
void	OnQuickHelp (const CommandContext &context)
void	OnManual (const CommandContext &context)
void	OnAudioDeviceInfo (const CommandContext &context)
void	OnShowLog (const CommandContext &context)
void	OnMenuTree (const CommandContext &context)
void	OnFrameStatistics (const CommandContext &)
void	OnAbout (const CommandContext &context)
auto	HelpMenu ()

Variables
AttachedItem	sAttachment1 { Indirect(HelpMenu()) }

Function Documentation

END_EVENT_TABLE()

anonymous_namespace{HelpMenus.cpp}::END_EVENT_TABLE

(

)

HelpMenu()

auto anonymous_namespace{HelpMenus.cpp}::HelpMenu

(

)

Definition at line 412 of file HelpMenus.cpp.

{
   static auto menu = std::shared_ptr{
   Menu( wxT("Help"), XXO("&Help"),
      Section( "Basic",
         Command( wxT("QuickHelp"), XXO("&Quick Help..."), OnQuickHelp,
            AlwaysEnabledFlag ),
         Command( wxT("Manual"), XXO("&Manual..."), OnManual,
            AlwaysEnabledFlag )
      ),
 
   #ifdef __WXMAC__
      Items
   #else
      Section
   #endif
      ( "Other",
         Menu( wxT("Diagnostics"), XXO("&Diagnostics"),
            Command( wxT("DeviceInfo"), XXO("Au&dio Device Info..."),
               OnAudioDeviceInfo,
               AudioIONotBusyFlag() ),
            Command( wxT("Log"), XXO("Show &Log..."), OnShowLog,
               AlwaysEnabledFlag ),
      #if defined(HAS_CRASH_REPORT)
            Command( wxT("CrashReport"), XXO("&Generate Support Data..."),
               OnCrashReport, AlwaysEnabledFlag )
      #endif
 
      #ifdef IS_ALPHA
            ,
            // alpha-only items don't need to internationalize, so use
            // Verbatim for labels
 
            Command( wxT("RaiseSegfault"), Verbatim("Test segfault report"),
               OnSegfault, AlwaysEnabledFlag ),
 
            Command( wxT("ThrowException"), Verbatim("Test exception report"),
               OnException, AlwaysEnabledFlag ),
 
            Command( wxT("ViolateAssertion"), Verbatim("Test assertion report"),
               OnAssertion, AlwaysEnabledFlag ),
 
            // Menu explorer.  Perhaps this should become a macro command
            Command( wxT("MenuTree"), Verbatim("Menu Tree..."),
               OnMenuTree,
               AlwaysEnabledFlag ),
              
            Command(
                 wxT("FrameStatistics"), Verbatim("Frame Statistics..."),
                 OnFrameStatistics,
                 AlwaysEnabledFlag)
      #endif
         )
      ),
 
      Section( "Extra",
   #if defined(HAVE_UPDATES_CHECK)
         Command( wxT("Updates"), XXO("&Check for Updates..."),
            OnCheckForUpdates,
            AlwaysEnabledFlag ),
   #endif
         Command( wxT("About"), XXO("&About Audacity"), OnAbout,
            AlwaysEnabledFlag )
      )
   ) };
   return menu;
}

References AlwaysEnabledFlag, AudioIONotBusyFlag(), MenuRegistry::Command, MenuRegistry::Items, MenuRegistry::Menu, OnAbout(), OnAudioDeviceInfo(), OnFrameStatistics(), OnManual(), OnMenuTree(), OnQuickHelp(), OnShowLog(), MenuRegistry::Section, Verbatim(), wxT(), and XXO().

Here is the call graph for this function:

OnAbout()

void anonymous_namespace{HelpMenus.cpp}::OnAbout

(

const CommandContext &

context

)

Definition at line 378 of file HelpMenus.cpp.

{
#ifdef __WXMAC__
   // Modeless dialog, consistent with other Mac applications
   // Simulate the application Exit menu item
   wxCommandEvent evt{ wxEVT_MENU, wxID_ABOUT };
   wxTheApp->AddPendingEvent( evt );
#else
   auto &project = context.project;
   auto &window = GetProjectFrame( project );
 
   // Windows and Linux still modal.
   AboutDialog dlog( &window );
   dlog.ShowModal();
#endif
}

References GetProjectFrame(), CommandContext::project, and project.

Referenced by HelpMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

OnAudioDeviceInfo()

void anonymous_namespace{HelpMenus.cpp}::OnAudioDeviceInfo

(

const CommandContext &

context

)

Definition at line 269 of file HelpMenus.cpp.

{
   auto &project = context.project;
   auto gAudioIO = AudioIOBase::Get();
   wxString info = gAudioIO->GetDeviceInfo();
   ShowDiagnostics( project, info,
      XO("Audio Device Info"), wxT("deviceinfo.txt") );
}

References AudioIOBase::Get(), CommandContext::project, project, ShowDiagnostics(), wxT(), and XO().

Referenced by HelpMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

OnFrameStatistics()

void anonymous_namespace{HelpMenus.cpp}::OnFrameStatistics

(

const CommandContext &

)

Definition at line 366 of file HelpMenus.cpp.

{
   FrameStatisticsDialog::Show(true);
}

References FrameStatisticsDialog::Show().

Referenced by HelpMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

OnManual()

void anonymous_namespace{HelpMenus.cpp}::OnManual

(

const CommandContext &

context

)

Definition at line 261 of file HelpMenus.cpp.

{
   auto &project = context.project;
   HelpSystem::ShowHelp(
      &GetProjectFrame( project ),
      L"Main_Page");
}

References GetProjectFrame(), CommandContext::project, project, and HelpSystem::ShowHelp().

Referenced by HelpMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

OnMenuTree()

void anonymous_namespace{HelpMenus.cpp}::OnMenuTree

(

const CommandContext &

context

)

Definition at line 320 of file HelpMenus.cpp.

{
   auto &project = context.project;
   enum : unsigned { TAB = 3 };
 
   unsigned level{};
   wxString indentation;
   wxString info;
   auto Indent = [&](){ info += indentation; };
   auto Return = [&](){ info += '\n'; };
 
   using namespace MenuRegistry;
   auto visitor = Visitor<Traits>{
      std::tuple{
         [&](const MenuItem &item, const auto&) {
            Indent();
            // using GET for alpha only diagnostic tool
            info += item.name.GET();
            Return();
            indentation = wxString{ ' ', TAB * ++level };
         },
 
         [&](const SingleItem &item, const auto&) {
            // using GET for alpha only diagnostic tool
            Indent();
            info += item.name.GET();
            Return();
         },
 
         [&](const MenuItem &item, const auto&) {
            indentation = wxString{ ' ', TAB * --level };
         }
      },
      [&]() {
         static const wxString separatorName{ '=', 20 };
         Indent();
         info += separatorName;
         Return();
      }
   };
   MenuRegistry::Visit(visitor, project);
 
   ShowDiagnostics( project, info,
      Verbatim("Menu Tree"), wxT("menutree.txt"), true );
}

References CommandContext::project, project, ShowDiagnostics(), Verbatim(), MenuRegistry::Visit(), and wxT().

Referenced by HelpMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

OnQuickFix()

void anonymous_namespace{HelpMenus.cpp}::OnQuickFix

(

const CommandContext &

context

)

Definition at line 246 of file HelpMenus.cpp.

{
   auto &project = context.project;
   QuickFixDialog dlg( &GetProjectFrame( project ), project );
   dlg.ShowModal();
}

References GetProjectFrame(), CommandContext::project, and project.

Here is the call graph for this function:

OnQuickHelp()

void anonymous_namespace{HelpMenus.cpp}::OnQuickHelp

(

const CommandContext &

context

)

Definition at line 253 of file HelpMenus.cpp.

{
   auto &project = context.project;
   HelpSystem::ShowHelp(
      &GetProjectFrame( project ),
      L"Quick_Help");
}

References GetProjectFrame(), CommandContext::project, project, and HelpSystem::ShowHelp().

Referenced by HelpMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

OnShowLog()

void anonymous_namespace{HelpMenus.cpp}::OnShowLog

(

const CommandContext &

context

)

Definition at line 278 of file HelpMenus.cpp.

{
   LogWindow::Show();
}

References LogWindow::Show().

Referenced by HelpMenu().

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

sAttachment1

AttachedItem anonymous_namespace{HelpMenus.cpp}::sAttachment1 { Indirect(HelpMenu()) }

Definition at line 480 of file HelpMenus.cpp.