Audacity 3.2.0
Public Member Functions | Private Attributes | List of all members
ExportErrorException Class Reference

#include <ExportPlugin.h>

Collaboration diagram for ExportErrorException:
[legend]

Public Member Functions

 ExportErrorException (const wxString &errorCode)
 
 ExportErrorException (TranslatableString message, const wxString &helpPage)
 
const TranslatableStringGetMessage () const noexcept
 
const wxString & GetHelpPageId () const noexcept
 

Private Attributes

TranslatableString mMessage
 
wxString mHelpPageId
 

Detailed Description

Definition at line 53 of file ExportPlugin.h.

Constructor & Destructor Documentation

◆ ExportErrorException() [1/2]

ExportErrorException::ExportErrorException ( const wxString &  errorCode)

We have many Export errors that are essentially anonymous and are distinguished only by an error code number. Rather than repeat the code, we have it just once.

Definition at line 42 of file ExportPlugin.cpp.

43 : mMessage(XO("Unable to export.\nError %s").Format(code))
44 , mHelpPageId("Error:_Unable_to_export")
45{
46
47}
XO("Cut/Copy/Paste")
TranslatableString mMessage
Definition: ExportPlugin.h:55
Abstract base class used in importing a file.

◆ ExportErrorException() [2/2]

ExportErrorException::ExportErrorException ( TranslatableString  message,
const wxString &  helpPage 
)

Definition at line 49 of file ExportPlugin.cpp.

50 : mMessage(std::move(message))
51 , mHelpPageId(helpPage)
52{
53}

Member Function Documentation

◆ GetHelpPageId()

const wxString & ExportErrorException::GetHelpPageId ( ) const
noexcept

Definition at line 55 of file ExportPlugin.cpp.

56{
57 return mHelpPageId;
58}

References mHelpPageId.

Referenced by audacity::cloud::audiocom::sync::MixdownUploader::DataExporter::HandleExportError().

Here is the caller graph for this function:

◆ GetMessage()

const TranslatableString & ExportErrorException::GetMessage ( ) const
noexcept

Definition at line 60 of file ExportPlugin.cpp.

61{
62 return mMessage;
63}

References mMessage.

Referenced by audacity::cloud::audiocom::sync::MixdownUploader::DataExporter::HandleExportError().

Here is the caller graph for this function:

Member Data Documentation

◆ mHelpPageId

wxString ExportErrorException::mHelpPageId
private

Definition at line 56 of file ExportPlugin.h.

Referenced by GetHelpPageId().

◆ mMessage

TranslatableString ExportErrorException::mMessage
private

Definition at line 55 of file ExportPlugin.h.

Referenced by GetMessage().


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