Helper class, don't construct this directly. More...

#include <wml_exception.hpp>

Inheritance diagram for wml_exception:

Public Types
enum class	error_type { INVALID_WML = 0 , GUI_LAYOUT_FAILURE = -1 }

Public Member Functions
	wml_exception (const std::string &user_msg, const std::string &dev_msg, const error_type error_type=error_type::INVALID_WML)

	~wml_exception () noexcept

void	show () const
	Shows the error in a dialog. More...

Public Attributes
std::string	user_message
	The message for the user explaining what went wrong. More...

std::string	dev_message
	The message for developers telling which problem was triggered, this shouldn't be translated. More...

error_type	type
	Indicates the category of the error handled by this expection. More...

Detailed Description

Helper class, don't construct this directly.

Definition at line 99 of file wml_exception.hpp.

Member Enumeration Documentation

◆ error_type

enum wml_exception::error_type

strong

Enumerator
INVALID_WML
GUI_LAYOUT_FAILURE

Definition at line 102 of file wml_exception.hpp.

Constructor & Destructor Documentation

◆ wml_exception()

wml_exception::wml_exception	(	const std::string &	user_msg,
		const std::string &	dev_msg,
		const error_type	error_type = `error_type::INVALID_WML`
	)

inline

Definition at line 107 of file wml_exception.hpp.

◆ ~wml_exception()

wml_exception::~wml_exception ( )

inlinenoexcept

Definition at line 118 of file wml_exception.hpp.

Member Function Documentation

◆ show()

void wml_exception::show ( ) const

Shows the error in a dialog.

Definition at line 60 of file wml_exception.cpp.

References _(), dev_message, gui2::show_error_message(), and user_message.

Member Data Documentation

◆ dev_message

std::string wml_exception::dev_message

The message for developers telling which problem was triggered, this shouldn't be translated.

It's hard for a dev to parse errors in foreign tongues.

Definition at line 131 of file wml_exception.hpp.

Referenced by show().

◆ type

error_type wml_exception::type

Indicates the category of the error handled by this expection.

Useful to detect the type of error without checking the detailed messages, especially in unit tests.

Definition at line 138 of file wml_exception.hpp.

◆ user_message

std::string wml_exception::user_message

The message for the user explaining what went wrong.

This message can be translated so the user gets a explanation in his/her native tongue.

Definition at line 124 of file wml_exception.hpp.