Examplary dialog class for the most simple kinds of dialogs. More...

#include <dialog.hpp>

Classes
struct	ConstructionArgs

Public Types
enum class	Button { Ok , Cancel , Yes , No }

enum class	ButtonConfiguration { Ok , OkCancel , YesNo , None }

Public Member Functions
	DialogController (ConstructionArgs &&args)
	Constructs a new DialogController.

void	showModal ()
	Shows the dialog as a modal dialog (blocks the UI).

void	show ()
	Shows the dialog as a non-modal dialog (does not block the UI).

void	hide ()
	Hides the dialog.

bool	isOpen () const
	Returns true if the dialog is open.

void	setClassName (std::string const &className)
	Sets the class name of the dialog.

void	setButtonClassName (std::string const &className)
	Sets the class name of the dialog buttons.

void	setTitle (std::string const &title)
	Sets the title of the dialog.

void	setBody (std::string const &body)
	Sets the body of the dialog.

void	setButtonConfiguration (ButtonConfiguration buttons)
	Sets the button configuration of the dialog.

void	setOnButtonClicked (std::function< void(Button)> const &onButtonClicked)
	Sets the callback that is called when a button is clicked.

Friends
Nui::ElementRenderer	Dialog (DialogController &controller)
	Creates a dialog element with the specified controller.

Detailed Description

Examplary dialog class for the most simple kinds of dialogs.

Member Enumeration Documentation

◆ Button

enum class Nui::Components::DialogController::Button

strong

Enumerator
Ok
Cancel
Yes
No

◆ ButtonConfiguration

enum class Nui::Components::DialogController::ButtonConfiguration

strong

Enumerator
Ok
OkCancel
YesNo
None

Constructor & Destructor Documentation

◆ DialogController()

Nui::Components::DialogController::DialogController ( ConstructionArgs && args )

explicit

Constructs a new DialogController.

Parameters

args	The intial values for the dialog.

Member Function Documentation

◆ hide()

void Nui::Components::DialogController::hide ( )

Hides the dialog.

◆ isOpen()

bool Nui::Components::DialogController::isOpen ( ) const

Returns true if the dialog is open.

◆ setBody()

void Nui::Components::DialogController::setBody ( std::string const & body )

Sets the body of the dialog.

◆ setButtonClassName()

void Nui::Components::DialogController::setButtonClassName ( std::string const & className )

Sets the class name of the dialog buttons.

◆ setButtonConfiguration()

void Nui::Components::DialogController::setButtonConfiguration ( ButtonConfiguration buttons )

Sets the button configuration of the dialog.

◆ setClassName()

void Nui::Components::DialogController::setClassName ( std::string const & className )

Sets the class name of the dialog.

◆ setOnButtonClicked()

void Nui::Components::DialogController::setOnButtonClicked ( std::function< void(Button)> const & onButtonClicked )

Sets the callback that is called when a button is clicked.

◆ setTitle()

void Nui::Components::DialogController::setTitle ( std::string const & title )

Sets the title of the dialog.

◆ show()

void Nui::Components::DialogController::show ( )

Shows the dialog as a non-modal dialog (does not block the UI).

◆ showModal()

void Nui::Components::DialogController::showModal ( )

Shows the dialog as a modal dialog (blocks the UI).

Friends And Related Symbol Documentation

◆ Dialog

Nui::ElementRenderer Dialog ( DialogController & controller )

friend

Creates a dialog element with the specified controller.