PLGui::MessageBox Class Reference

Message box. More...

#include <MessageBox.h>

Inheritance diagram for PLGui::MessageBox:

List of all members.

Public Member Functions
PLGUI_API	MessageBox (Widget *pParent=nullptr, EMessageBox nType=MessageBoxOk, const PLCore::String &sTitle="Message Box", const PLCore::String &sText="Message")
	Constructor.
PLGUI_API	MessageBox (EMessageBox nType, const PLCore::String &sTitle, const PLCore::String &sText)
	Constructor.
virtual PLGUI_API	~MessageBox ()
	Destructor.
PLGUI_API EMessageBox	GetType () const
	Get message box type.
PLGUI_API PLCore::String	GetText () const
	Get text.
PLGUI_API void	SetText (const PLCore::String &sText)
	Set text.
PLGUI_API PLCore::String	GetButtonText (EMessageBoxButton nButton) const
	Get button text.
PLGUI_API void	SetButtonText (EMessageBoxButton nButton, const PLCore::String &sText)
	Set button text.
void	CreateMessageBox (EMessageBox nType, const PLCore::String &sTitle, const PLCore::String &sText)
	Create message box.
void	OnButtonOk ()
	Button 'Ok' has been clicked.
void	OnButtonCancel ()
	Button 'Cancel' has been clicked.
void	OnButtonYes ()
	Button 'Yes' has been clicked.
void	OnButtonNo ()
	Button 'No' has been clicked.

---

Detailed Description

Message box.

---

Constructor & Destructor Documentation

PLGUI_API PLGui::MessageBox::MessageBox	(	Widget *	pParent = nullptr,
		EMessageBox	nType = MessageBoxOk,
		const PLCore::String &	sTitle = "Message Box",
		const PLCore::String &	sText = "Message"
	)

Constructor.

Parameters:

[in]	pParent	Pointer to parent widget
[in]	nType	Message box type
[in]	sTitle	Message box title
[in]	sText	Message box text

PLGUI_API PLGui::MessageBox::MessageBox	(	EMessageBox	nType,
		const PLCore::String &	sTitle,
		const PLCore::String &	sText
	)

Constructor.

Parameters:

[in]	nType	Message box type
[in]	sTitle	Message box title
[in]	sText	Message box text

virtual PLGUI_API PLGui::MessageBox::~MessageBox

(

)

[virtual]

Destructor.

---

Member Function Documentation

PLGUI_API EMessageBox PLGui::MessageBox::GetType

(

)

const

Get message box type.

Returns:

Type of message box

PLGUI_API PLCore::String PLGui::MessageBox::GetText

(

)

const

Get text.

Returns:

Text

PLGUI_API void PLGui::MessageBox::SetText

(

const PLCore::String &

sText

)

Set text.

Parameters:

[in]

sText

Text

PLGUI_API PLCore::String PLGui::MessageBox::GetButtonText

(

EMessageBoxButton

nButton

)

const

Get button text.

Parameters:

[in]

nButton

Button ID

Returns:

Text

PLGUI_API void PLGui::MessageBox::SetButtonText	(	EMessageBoxButton	nButton,
		const PLCore::String &	sText
	)

Set button text.

Parameters:

[in]	nButton	Button ID
[in]	sText	Text

void PLGui::MessageBox::CreateMessageBox	(	EMessageBox	nType,
		const PLCore::String &	sTitle,
		const PLCore::String &	sText
	)

Create message box.

Parameters:

[in]	nType	Message box type
[in]	sTitle	Message box title
[in]	sText	Message box text

void PLGui::MessageBox::OnButtonOk

(

)

Button 'Ok' has been clicked.

void PLGui::MessageBox::OnButtonCancel

(

)

Button 'Cancel' has been clicked.

void PLGui::MessageBox::OnButtonYes

(

)

Button 'Yes' has been clicked.

void PLGui::MessageBox::OnButtonNo

(

)

Button 'No' has been clicked.

---

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

• MessageBox.h