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:

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 52 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 56 of file BasicUI.h.

: type{ type } {}

Member Function Documentation

Log()

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

inline

Definition at line 64 of file BasicUI.h.

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

References log.

Referenced by audacity::cloud::audiocom::sync::ProjectsListDialog::ProjectsTableData::Refresh(), and ProjectFileIO::ShowError().

Here is the caller graph for this function:

ModalHelp()

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

inline

Definition at line 61 of file BasicUI.h.

   { 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 74 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 72 of file BasicUI.h.

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

type

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

Type of help dialog.

Definition at line 70 of file BasicUI.h.

Referenced by wxWidgetsBasicUI::DoShowErrorDialog().

---

The documentation for this struct was generated from the following file:

• BasicUI.h