A dialog, that has "Send", "Don't send" and help buttons. More...

#include <ErrorReportDialog.h>

Inheritance diagram for ErrorReportDialog:

Collaboration diagram for ErrorReportDialog:

Public Member Functions
	ErrorReportDialog (wxWindow *parent, const TranslatableString &dlogTitle, const TranslatableString &message, const ManualPageID &helpUrl, const wxString &log, const bool modal)

	~ErrorReportDialog ()

Public Member Functions inherited from wxDialogWrapper
	wxDialogWrapper ()

	wxDialogWrapper (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

bool	Create (wxWindow *parent, wxWindowID id, const TranslatableString &title, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxDEFAULT_DIALOG_STYLE, const TranslatableString &name=XO("Dialog"))

void	SetTitle (const TranslatableString &title)

void	SetLabel (const TranslatableString &title)

void	SetName (const TranslatableString &title)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxDialog >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	OnSend (wxCommandEvent &event)

void	OnDontSend (wxCommandEvent &event)

void	OnHelp (wxCommandEvent &event)

Private Attributes
std::unique_ptr< audacity::sentry::Report >	mReport

ManualPageID	mHelpUrl

wxTextCtrl *	mCommentsControl { nullptr }

bool	mIsModal

Detailed Description

A dialog, that has "Send", "Don't send" and help buttons.

This dialog is used in place of error dialogs for Audacity errors when Sentry reporting is enabled.

Definition at line 35 of file ErrorReportDialog.h.

Constructor & Destructor Documentation

◆ ErrorReportDialog()

ErrorReportDialog::ErrorReportDialog	(	wxWindow *	parent,
		const TranslatableString &	dlogTitle,
		const TranslatableString &	message,
		const ManualPageID &	helpUrl,
		const wxString &	log,
		const bool	modal
	)

Definition at line 68 of file ErrorReportDialog.cpp.

    : wxDialogWrapper(
         parent, wxID_ANY, dlogTitle, wxDefaultPosition, wxDefaultSize,
         wxDEFAULT_DIALOG_STYLE)
    , mHelpUrl(helpUrl)
    , mIsModal(modal)
{
   audacity::sentry::Exception ex = audacity::sentry::Exception::Create(
      audacity::ToUTF8(dlogTitle.Debug()),message.Debug());
 
   if (!log.empty())
      ex.AddData("log", log);
 
   mReport = std::make_unique<audacity::sentry::Report> (ex);
 
   ShuttleGui S(this, eIsCreating);
 
   const wxFont headingFont = wxFont(wxFontInfo(12).Bold());
   const wxFont textFont = wxFont(wxFontInfo(10));
 
   const int CollapsibleBorderSize = GetCollapsiblePaneBorder(this);
 
   S.SetBorder(0);
 
   S.StartHorizontalLay(wxEXPAND, 0);
   {
      S.AddSpace(40 - CollapsibleBorderSize, 0);
 
      S.StartVerticalLay(wxEXPAND, 0);
      {
         S.AddSpace(0, 32);
 
         S.StartHorizontalLay(wxEXPAND, 0);
         {
            S.AddSpace(CollapsibleBorderSize);
 
            S.StartVerticalLay(wxEXPAND, 0);
            {
               S.StartHorizontalLay(wxEXPAND, 1);
               {
                  S.StartVerticalLay(0);
                  {
                     wxBitmap bitmap = wxArtProvider::GetBitmap(
                        wxART_WARNING, wxART_MESSAGE_BOX, wxSize(24, 24));
 
                     S.Prop(0).AddWindow(
                        safenew wxStaticBitmap(S.GetParent(), -1, bitmap));
 
                     S.AddSpace(0, 0, 1);
                  }
                  S.EndVerticalLay();
 
                  S.AddSpace(10, 0);
 
                  S.StartVerticalLay(0);
                  {
                     S.AddSpace(0, 7);
 
                     S.Prop(1)
                        .AddVariableText(message, false, 0, 560)
                        ->SetFont(headingFont);
                  }
                  S.EndVerticalLay();
               }
               S.EndHorizontalLay();
 
               S.AddSpace(0, 20);
 
               /* i18n-hint: %s is replaced with "here" */
               AccessibleLinksFormatter errorpage(
                  XO("More information about this error may be available %s."));
               
               errorpage.FormatLink(
                  /* i18n-hint: Title of hyperlink to audacityteam.org/errors. */
                  wxT("%s"),
                  XO("here"),
                  "https://audacityteam.org/errors");
               errorpage.Populate(S);
 
               S.AddSpace(0, 12);
               S.AddVariableText(XO(
                     "Would you like to send a report to help us fix this issue?"))
                  ->SetFont(textFont);
 
               S.AddSpace(0, 6);
 
               /* i18n-hint: %s will be replaced with "our Privacy Policy" */
               AccessibleLinksFormatter privacyPolicy(
                  XO("All reports are anonymous. See %s for more info."));
 
               privacyPolicy.FormatLink(
                  /* i18n-hint: Title of hyperlink to the privacy policy. This is an object of "See". */
                  wxT("%s"),
                  XO("our Privacy Policy"),
                  "https://www.audacityteam.org/about/desktop-privacy-notice/");
 
               privacyPolicy.Populate(S);
            }
            S.EndVerticalLay();
         }
         S.EndHorizontalLay();
 
       S.AddSpace(0, 6);
 
         S.StartHorizontalLay(wxEXPAND, 0);
         {
            auto pane = safenew wxCollapsiblePane(
               S.GetParent(), wxID_ANY, XO("Problem details").Translation());
 
            S.Style(wxEXPAND | wxALIGN_LEFT);
            S.Prop(1);
            S.AddWindow(pane);
 
            ShuttleGui SI(pane->GetPane(), eIsCreating);
 
            SI.StartVerticalLay();
            {
               SI.Style(
                  wxTE_RICH | wxTE_READONLY | wxTE_MULTILINE | wxTE_DONTWRAP)
                .MinSize(wxSize(0, 152))
                .Name(XO("Problem details"))
                .AddTextBox({}, mReport->GetReportPreview(), 0);
 
               if constexpr (ErrorReportDialogHasUserComment)
               {
                  SI.AddSpace(0, 20);
 
                  SI.AddVariableText(XO("Comments"))->SetFont(textFont);
 
                  SI.AddSpace(0, 6);
 
                  mCommentsControl = SI.Style(wxTE_MULTILINE)
                                      .MinSize(wxSize(0, 76))
                                      .Name(XO("Comments"))
                                      .AddTextBox({}, {}, 0);
 
                  mCommentsControl->SetMaxLength(MaxUserCommentLength);
               }
            }
            SI.EndVerticalLay();
         }
         S.EndHorizontalLay();
 
         S.AddSpace(0, 20);
 
         S.StartHorizontalLay(wxEXPAND);
         {
            if (!mHelpUrl.empty())
            {
               wxBitmapButton* helpButton =
                  S.Id(wxID_HELP).AddBitmapButton(theTheme.Bitmap(bmpHelpIcon));
               // For screen readers
               helpButton->SetToolTip(XO("Help").Translation());
               helpButton->SetLabel(XO("Help").Translation());
            }
            
            S.AddSpace(0, 0, 1);
 
            S.Id(wxID_NO).AddButton(XC("&Don't send", "crash reporter button"));
 
            S.AddSpace(13, 0);
 
            S.Id(wxID_YES).AddButton(XC("&Send", "crash reporter button"));
         }
         S.EndHorizontalLay();
 
         S.AddSpace(0, 20);
      }
      S.EndVerticalLay();
 
      S.AddSpace(28, 0);
   }
   S.EndHorizontalLay();
 
   S.SetBorder(2);
 
   Layout();
   GetSizer()->Fit(this);
   SetMinSize(GetSize());
   Center();
}

References audacity::sentry::Exception::AddData(), ShuttleGui::AddSpace(), ShuttleGuiBase::AddTextBox(), ShuttleGuiBase::AddVariableText(), ThemeBase::Bitmap(), audacity::sentry::Exception::Create(), eIsCreating, ShuttleGuiBase::EndVerticalLay(), ErrorReportDialogHasUserComment, AccessibleLinksFormatter::FormatLink(), anonymous_namespace{ErrorReportDialog.cpp}::GetCollapsiblePaneBorder(), MaxUserCommentLength, ShuttleGui::MinSize(), ShuttleGui::Name(), AccessibleLinksFormatter::Populate(), S, safenew, ShuttleGuiBase::StartVerticalLay(), ShuttleGui::Style(), theTheme, audacity::ToUTF8(), wxT(), XC, and XO().

Here is the call graph for this function:

◆ ~ErrorReportDialog()

ErrorReportDialog::~ErrorReportDialog ( )

Definition at line 253 of file ErrorReportDialog.cpp.

254{

255}

Member Function Documentation

◆ OnDontSend()

void ErrorReportDialog::OnDontSend ( wxCommandEvent & event )

private

Definition at line 272 of file ErrorReportDialog.cpp.

{
   EndModal(true);
}

◆ OnHelp()

void ErrorReportDialog::OnHelp ( wxCommandEvent & event )

private

Definition at line 277 of file ErrorReportDialog.cpp.

{
   const auto &helpUrl = mHelpUrl.GET();
   if (helpUrl.StartsWith(wxT("innerlink:")))
   {
      HelpSystem::ShowHtmlText(
         this, TitleText(helpUrl.Mid(10)), HelpText(helpUrl.Mid(10)), false,
         true);
      return;
   }
 
   HelpSystem::ShowHelp(this, mHelpUrl, false);
}

References Identifier::GET(), HelpText(), mHelpUrl, HelpSystem::ShowHelp(), HelpSystem::ShowHtmlText(), TitleText(), and wxT().

Here is the call graph for this function:

◆ OnSend()

void ErrorReportDialog::OnSend ( wxCommandEvent & event )

private

Definition at line 257 of file ErrorReportDialog.cpp.

{
   Disable();
 
   if (mCommentsControl != nullptr)
      mReport->AddUserComment(audacity::ToUTF8(mCommentsControl->GetValue()));
 
   mReport->Send(
      [this](int code, std::string body) { 
         CallAfter([this]() { 
             EndModal(true); 
         });
   });
}

References BasicUI::CallAfter(), mCommentsControl, mReport, and audacity::ToUTF8().

Here is the call graph for this function:

Member Data Documentation

◆ mCommentsControl

wxTextCtrl* ErrorReportDialog::mCommentsControl { nullptr }

private

Definition at line 55 of file ErrorReportDialog.h.

Referenced by OnSend().

◆ mHelpUrl

ManualPageID ErrorReportDialog::mHelpUrl

private

Definition at line 53 of file ErrorReportDialog.h.

Referenced by OnHelp().

◆ mIsModal

bool ErrorReportDialog::mIsModal

private

Definition at line 57 of file ErrorReportDialog.h.

◆ mReport

std::unique_ptr<audacity::sentry::Report> ErrorReportDialog::mReport

private

Definition at line 51 of file ErrorReportDialog.h.

Referenced by OnSend().

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

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ErrorReportDialog()

◆ ~ErrorReportDialog()

Member Function Documentation

◆ OnDontSend()

◆ OnHelp()

◆ OnSend()

Member Data Documentation

◆ mCommentsControl

◆ mHelpUrl

◆ mIsModal

◆ mReport