Audacity  3.0.3
Public Member Functions | Public Attributes | List of all members
BasicUI::ErrorDialogOptions Struct Reference

Options for variations of error dialogs; the default is for modal dialogs. More...

#include <BasicUI.h>

Collaboration diagram for BasicUI::ErrorDialogOptions:
[legend]

Public Member Functions

 ErrorDialogOptions ()=default
 
 ErrorDialogOptions (ErrorDialogType type)
 Non-explicit. More...
 
Chain-call style initializers
ErrorDialogOptions && ModalHelp (bool modalHelp_) &&
 
ErrorDialogOptions && Log (std::wstring log_) &&
 

Public Attributes

ErrorDialogType type { ErrorDialogType::ModalError }
 Type of help dialog. More...
 
bool modalHelp { true }
 Whether the secondary help dialog with more information should be modal. More...
 
std::wstring log
 Optional extra logging information to be shown. More...
 

Detailed Description

Options for variations of error dialogs; the default is for modal dialogs.

Definition at line 49 of file BasicUI.h.

Constructor & Destructor Documentation

◆ ErrorDialogOptions() [1/2]

BasicUI::ErrorDialogOptions::ErrorDialogOptions ( )
default

◆ ErrorDialogOptions() [2/2]

BasicUI::ErrorDialogOptions::ErrorDialogOptions ( ErrorDialogType  type)
inline

Non-explicit.

Definition at line 53 of file BasicUI.h.

53 : type{ type } {}

References type.

Member Function Documentation

◆ Log()

ErrorDialogOptions&& BasicUI::ErrorDialogOptions::Log ( std::wstring  log_) &&
inline

Definition at line 61 of file BasicUI.h.

62  { log = std::move(log_); return std::move(*this); }

References log.

Referenced by ProjectFileIO::ShowError().

Here is the caller graph for this function:

◆ ModalHelp()

ErrorDialogOptions&& BasicUI::ErrorDialogOptions::ModalHelp ( bool  modalHelp_) &&
inline

Definition at line 58 of file BasicUI.h.

59  { modalHelp = modalHelp_; return std::move(*this); }

References modalHelp.

Member Data Documentation

◆ log

std::wstring BasicUI::ErrorDialogOptions::log

Optional extra logging information to be shown.

Definition at line 71 of file BasicUI.h.

Referenced by wxWidgetsBasicUI::DoShowErrorDialog(), and Log().

◆ modalHelp

bool BasicUI::ErrorDialogOptions::modalHelp { true }

Whether the secondary help dialog with more information should be modal.

Definition at line 69 of file BasicUI.h.

Referenced by wxWidgetsBasicUI::DoShowErrorDialog(), and ModalHelp().

◆ type

ErrorDialogType BasicUI::ErrorDialogOptions::type { ErrorDialogType::ModalError }

Type of help dialog.

Definition at line 67 of file BasicUI.h.

Referenced by wxWidgetsBasicUI::DoShowErrorDialog(), and ErrorDialogOptions().


The documentation for this struct was generated from the following file:
BasicUI::ErrorDialogOptions::log
std::wstring log
Optional extra logging information to be shown.
Definition: BasicUI.h:71
BasicUI::ErrorDialogOptions::type
ErrorDialogType type
Type of help dialog.
Definition: BasicUI.h:67
BasicUI::ErrorDialogOptions::modalHelp
bool modalHelp
Whether the secondary help dialog with more information should be modal.
Definition: BasicUI.h:69