Divide::GUIMessageBox Class Reference

#include <GUIMessageBox.h>

Inheritance diagram for Divide::GUIMessageBox:

Public Types
enum class	MessageType : U8 { MESSAGE_INFO = 0 , MESSAGE_WARNING = 1 , MESSAGE_ERROR = 2 }

Public Member Functions
virtual	~GUIMessageBox () override
bool	onConfirm (const CEGUI::EventArgs &) noexcept
void	setTitle (const string &titleText)
void	setMessage (const string &message)
void	setOffset (vec2< I32 > offsetFromCentre)
void	setMessageType (MessageType type)
void	show () noexcept
	GUIMessageBox (const string &name, const string &title, const string &message, vec2< I32 > offsetFromCentre=vec2< I32 >(0), CEGUI::Window *parent=nullptr)
Public Member Functions inherited from Divide::GUIElementBase< GUIType::GUI_MESSAGE_BOX >
	GUIElementBase (const string &name, CEGUI::Window *const parent)
GUIType	type () const noexcept override
Public Member Functions inherited from Divide::GUIElement
	GUIElement (string name, CEGUI::Window *parent) noexcept
virtual void	setTooltip (const string &tooltipText)
	PROPERTY_RW (string, name, "")
	VIRTUAL_PROPERTY_RW (bool, visible, true)
	VIRTUAL_PROPERTY_RW (bool, active, false)
virtual GUIType	type () const noexcept
Public Member Functions inherited from Divide::GUIDWrapper
	GUIDWrapper () noexcept
	GUIDWrapper (const GUIDWrapper &old) noexcept
	GUIDWrapper (GUIDWrapper &&old) noexcept
virtual	~GUIDWrapper ()=default
FORCE_INLINE I64	getGUID () const noexcept
GUIDWrapper &	operator= (const GUIDWrapper &old)=delete
GUIDWrapper &	operator= (GUIDWrapper &&other)=delete

Protected Member Functions
void	visible (bool visible) noexcept override
void	active (bool active) noexcept override

Protected Attributes
vec2< I32 >	_offsetFromCentre
CEGUI::Window *	_msgBoxWindow
CEGUI::Event::Connection	_confirmEvent
Protected Attributes inherited from Divide::GUIElement
CEGUI::Window *	_parent
Protected Attributes inherited from Divide::GUIDWrapper
const I64	_guid

Friends
class	GUI
class	GUIInterface
class	SceneGUIElements

Additional Inherited Members
Static Public Member Functions inherited from Divide::GUIDWrapper
static I64	generateGUID () noexcept
Static Public Attributes inherited from Divide::GUIElementBase< GUIType::GUI_MESSAGE_BOX >
static constexpr GUIType	Type
Static Public Attributes inherited from Divide::GUIElement
static constexpr GUIType	Type = GUIType::COUNT

Detailed Description

Definition at line 47 of file GUIMessageBox.h.

Member Enumeration Documentation

MessageType

enum class Divide::GUIMessageBox::MessageType : U8

strong

Enumerator
MESSAGE_INFO
MESSAGE_WARNING
MESSAGE_ERROR

Definition at line 53 of file GUIMessageBox.h.

Constructor & Destructor Documentation

~GUIMessageBox()

Divide::GUIMessageBox::~GUIMessageBox ( )

overridevirtual

Definition at line 33 of file GUIMessageBox.cpp.

GUIMessageBox()

Divide::GUIMessageBox::GUIMessageBox	(	const string &	name,
		const string &	title,
		const string &	message,
		vec2< I32 >	offsetFromCentre = vec2<I32>(0),
		CEGUI::Window *	parent = nullptr
	)

Definition at line 7 of file GUIMessageBox.cpp.

Member Function Documentation

active()

void Divide::GUIMessageBox::active ( bool  active )

overrideprotectednoexcept

Definition at line 55 of file GUIMessageBox.cpp.

onConfirm()

bool Divide::GUIMessageBox::onConfirm ( const CEGUI::EventArgs &  )

noexcept

Definition at line 41 of file GUIMessageBox.cpp.

setMessage()

void Divide::GUIMessageBox::setMessage

(

const string &

message

)

Definition at line 68 of file GUIMessageBox.cpp.

setMessageType()

void Divide::GUIMessageBox::setMessageType

(

MessageType

type

)

Definition at line 83 of file GUIMessageBox.cpp.

setOffset()

void Divide::GUIMessageBox::setOffset

(

vec2< I32 >

offsetFromCentre

)

Definition at line 74 of file GUIMessageBox.cpp.

setTitle()

void Divide::GUIMessageBox::setTitle

(

const string &

titleText

)

Definition at line 62 of file GUIMessageBox.cpp.

show()

void Divide::GUIMessageBox::show ( )

inlinenoexcept

Definition at line 66 of file GUIMessageBox.h.

visible()

void Divide::GUIMessageBox::visible ( bool  visible )

overrideprotectednoexcept

Definition at line 47 of file GUIMessageBox.cpp.

Friends And Related Function Documentation

GUI

friend class GUI

friend

Definition at line 48 of file GUIMessageBox.h.

GUIInterface

friend class GUIInterface

friend

Definition at line 49 of file GUIMessageBox.h.

SceneGUIElements

friend class SceneGUIElements

friend

Definition at line 50 of file GUIMessageBox.h.

Member Data Documentation

_confirmEvent

CEGUI::Event::Connection Divide::GUIMessageBox::_confirmEvent

protected

Definition at line 84 of file GUIMessageBox.h.

_msgBoxWindow

CEGUI::Window* Divide::GUIMessageBox::_msgBoxWindow

protected

Definition at line 83 of file GUIMessageBox.h.

_offsetFromCentre

vec2<I32> Divide::GUIMessageBox::_offsetFromCentre

protected

Definition at line 82 of file GUIMessageBox.h.

---

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

• G:/Divide-Framework/Source/GUI/Headers/GUIMessageBox.h
• G:/Divide-Framework/Source/GUI/GUIMessageBox.cpp