LogWindow Class Reference

Maintains the unique logging window which displays debug information. More...

#include <LogWindow.h>

Static Public Member Functions
static void	Show (bool show=true)
	Show or hide the unique logging window; create it on demand the first time it is shown. More...
static void	Destroy ()
	Destroys the log window (if any) More...

Detailed Description

Maintains the unique logging window which displays debug information.

Definition at line 15 of file LogWindow.h.

Member Function Documentation

Destroy()

void LogWindow::Destroy ( )

static

Destroys the log window (if any)

Definition at line 178 of file LogWindow.cpp.

{
   sFrame.reset();
}

References anonymous_namespace{LogWindow.cpp}::sFrame.

Referenced by QuitAudacity().

Here is the caller graph for this function:

Show()

void LogWindow::Show ( bool  show = true )

static

Show or hide the unique logging window; create it on demand the first time it is shown.

Definition at line 61 of file LogWindow.cpp.

{
   // Hide the frame if created, otherwise do nothing
   if (!show) {
      if (sFrame) {
         sFrame->Show(false);
      }
      return;
   }
 
   // If the frame already exists, refresh its contents and show it
   auto pLogger = AudacityLogger::Get();
   if (sFrame) {
      if (!sFrame->IsShown() && sText) {
         if (pLogger)
            sText->ChangeValue(pLogger->GetBuffer());
         sText->SetInsertionPointEnd();
         sText->ShowPosition(sText->GetLastPosition());
      }
      sFrame->Show();
      sFrame->Raise();
      return;
   }
 
   // This is the first use, so create the frame
   Destroy_ptr<wxFrame> frame
      { safenew wxFrame(NULL, wxID_ANY, _("Audacity Log")) };
   frame->SetName(frame->GetTitle());
   frame->SetBackgroundColour(wxSystemSettings::GetColour(wxSYS_COLOUR_3DFACE));
 
   // loads either the XPM or the windows resource, depending on the platform
   {
#if !defined(__WXMAC__) && !defined(__WXX11__)
#if defined(__WXMSW__)
      wxIcon ic{wxICON(AudacityLogo)};
#elif defined(__WXGTK__)
      wxIcon ic{wxICON(AudacityLogoAlpha)};
#else
      wxIcon ic{};
      ic.CopyFromBitmap(theTheme.Bitmap(bmpAudacityLogo48x48));
#endif
      frame->SetIcon(ic);
#endif
   }
 
   // Log text
   ShuttleGui S(frame.get(), eIsCreating);
 
   S.Style(wxNO_BORDER | wxTAB_TRAVERSAL).Prop(true).StartPanel();
   {
      S.StartVerticalLay(true);
      {
         sText = S.Style(wxTE_MULTILINE | wxHSCROLL | wxTE_READONLY | wxTE_RICH)
            .AddTextWindow({});
         
         // Populated TextWindow created above
         if (pLogger) *sText << pLogger->GetBuffer();
 
         S.AddSpace(0, 5);
         S.StartHorizontalLay(wxALIGN_CENTER, 0);
         {
            S.AddSpace(10, 0);
            S.Id(LoggerID_Save).AddButton(XXO("&Save..."));
            S.Id(LoggerID_Clear).AddButton(XXO("Cl&ear"));
            S.Id(LoggerID_Close).AddButton(XXO("&Close"));
            S.AddSpace(10, 0);
         }
         S.EndHorizontalLay();
         S.AddSpace(0, 3);
      }
      S.EndVerticalLay();
   }
   S.EndPanel();
 
   // Give a place for the menu help text to go
   // frame->CreateStatusBar();
 
   frame->Layout();
 
   // Hook into the frame events
   frame->Bind(wxEVT_CLOSE_WINDOW, OnCloseWindow );
 
   frame->Bind(   wxEVT_COMMAND_MENU_SELECTED, OnSave, LoggerID_Save);
   frame->Bind(   wxEVT_COMMAND_MENU_SELECTED, OnClear, LoggerID_Clear);
   frame->Bind(   wxEVT_COMMAND_MENU_SELECTED, OnClose, LoggerID_Close);
   frame->Bind(   wxEVT_COMMAND_BUTTON_CLICKED, OnSave, LoggerID_Save);
   frame->Bind(   wxEVT_COMMAND_BUTTON_CLICKED, OnClear, LoggerID_Clear);
   frame->Bind(   wxEVT_COMMAND_BUTTON_CLICKED, OnClose, LoggerID_Close);
 
   sFrame = std::move( frame );
 
   sFrame->Show();
 
   if (pLogger)
      pLogger->Flush();
 
   // Also create the listeners
   if (!pUpdater)
      pUpdater.emplace();
 
   if (pLogger) {
      pLogger->SetListener([]{
         if (auto pLogger = AudacityLogger::Get()) {
            if (sFrame && sFrame->IsShown()) {
               if (sText)
                  sText->ChangeValue(pLogger->GetBuffer());
               return true;
            }
         }
         return false;
      });
 
      // Initial flush populates sText
      pLogger->Flush();
   }
}

References _, ThemeBase::Bitmap(), eIsCreating, AudacityLogger::Get(), LoggerID_Clear, LoggerID_Close, LoggerID_Save, anonymous_namespace{LogWindow.cpp}::OnClear(), anonymous_namespace{LogWindow.cpp}::OnClose(), anonymous_namespace{LogWindow.cpp}::OnCloseWindow(), anonymous_namespace{LogWindow.cpp}::OnSave(), anonymous_namespace{LogWindow.cpp}::pUpdater, S, safenew, anonymous_namespace{LogWindow.cpp}::sFrame, anonymous_namespace{LogWindow.cpp}::sText, theTheme, wxEVT_COMMAND_BUTTON_CLICKED, and XXO().

Referenced by anonymous_namespace{HelpMenus.cpp}::OnShowLog(), MultiDialog::OnShowLog(), and anonymous_namespace{LogWindow.cpp}::LogWindowUpdater::UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

---

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

• LogWindow.h
• LogWindow.cpp