Audacity  3.0.3
Public Member Functions | Private Attributes | List of all members
SimpleMessageBoxException Class Reference

A MessageBoxException that shows a given, unvarying string. More...

#include <AudacityException.h>

Inheritance diagram for SimpleMessageBoxException:
[legend]
Collaboration diagram for SimpleMessageBoxException:
[legend]

Public Member Functions

 SimpleMessageBoxException (ExceptionType exceptionType, const TranslatableString &message_, const TranslatableString &caption=XO("Message"), const wxString &helpUrl_="")
 
 ~SimpleMessageBoxException () override
 
 SimpleMessageBoxException (const SimpleMessageBoxException &)=default
 
SimpleMessageBoxExceptionoperator= (SimpleMessageBoxException &&) PROHIBITED
 
virtual TranslatableString ErrorMessage () const override
 Format the error message for this exception. More...
 
- Public Member Functions inherited from AudacityException
 AudacityException ()
 
virtual ~AudacityException ()=0
 

Private Attributes

TranslatableString message
 Stored message. More...
 

Additional Inherited Members

- Protected Member Functions inherited from MessageBoxException
 MessageBoxException (ExceptionType exceptionType, const TranslatableString &caption)
 If default-constructed with empty caption, it makes no message box. More...
 
 ~MessageBoxException () override
 
 MessageBoxException (const MessageBoxException &)
 
virtual wxString ErrorHelpUrl () const
 
- Protected Member Functions inherited from AudacityException
 AudacityException (const AudacityException &)=default
 Make this protected to prevent slicing copies. More...
 
 AudacityException (AudacityException &&)=delete
 Don't allow moves of this class or subclasses. More...
 
AudacityExceptionoperator= (const AudacityException &)=delete
 Disallow assignment. More...
 
- Protected Attributes inherited from MessageBoxException
wxString helpUrl { "" }
 

Detailed Description

A MessageBoxException that shows a given, unvarying string.

Definition at line 89 of file AudacityException.h.

Constructor & Destructor Documentation

◆ SimpleMessageBoxException() [1/2]

SimpleMessageBoxException::SimpleMessageBoxException ( ExceptionType  exceptionType,
const TranslatableString message_,
const TranslatableString caption = XO("Message"),
const wxString &  helpUrl_ = "" 
)
inlineexplicit
Parameters
exceptionTypeException type

Definition at line 93 of file AudacityException.h.

100  , message{ message_ }
101  {
102  helpUrl = helpUrl_;
103  }

References MessageBoxException::exceptionType.

◆ ~SimpleMessageBoxException()

SimpleMessageBoxException::~SimpleMessageBoxException ( )
override

Definition at line 59 of file AudacityException.cpp.

60 {
61 }

◆ SimpleMessageBoxException() [2/2]

SimpleMessageBoxException::SimpleMessageBoxException ( const SimpleMessageBoxException )
default

Member Function Documentation

◆ ErrorMessage()

TranslatableString SimpleMessageBoxException::ErrorMessage ( ) const
overridevirtual

Format the error message for this exception.

Implements MessageBoxException.

Definition at line 63 of file AudacityException.cpp.

64 {
65  return message;
66 }

References message.

◆ operator=()

SimpleMessageBoxException& SimpleMessageBoxException::operator= ( SimpleMessageBoxException &&  )

Member Data Documentation

◆ message

TranslatableString SimpleMessageBoxException::message
private

Stored message.

Definition at line 114 of file AudacityException.h.

Referenced by ErrorMessage().


The documentation for this class was generated from the following files:
SimpleMessageBoxException::message
TranslatableString message
Stored message.
Definition: AudacityException.h:114
MessageBoxException::exceptionType
ExceptionType exceptionType
Exception type.
Definition: AudacityException.h:81
MessageBoxException
Abstract AudacityException subclass displays a message, specified by further subclass.
Definition: AudacityException.h:58
MessageBoxException::helpUrl
wxString helpUrl
Definition: AudacityException.h:85
MessageBoxException::caption
TranslatableString caption
Stored caption.
Definition: AudacityException.h:77