ml::DialogRequest Struct Reference

Interface for components that want the root shell to present a confirm/cancel dialog on their behalf. More...

#include <Malena/Traits/Communication/DialogRequest.h>

Public Types
enum class	Hook { SHOW }

Public Member Functions
virtual	~DialogRequest ()=default
virtual const std::string &	getCancelLabel ()=0
virtual const std::string &	getConfirmLabel ()=0
virtual ml::Core *	getContent ()
virtual const std::string &	getMessage ()=0
virtual std::function< void()>	getOnConfirm ()=0
virtual std::function< void()>	getOnReject ()=0
virtual std::string	getTitle ()

Detailed Description

Interface for components that want the root shell to present a confirm/cancel dialog on their behalf.

Inherit DialogRequest alongside Hookable and call sendHook(ml::DialogRequest::Hook::SHOW) to ask whatever shell is listening to display a modal with your message and labels.

The shell subscribes with:

onHook(ml::DialogRequest::Hook::SHOW, [this](ml::DialogRequest& d) {
    _modal.setConfirmLabel(d.getConfirmLabel());
    _modal.setCancelLabel(d.getCancelLabel());
    _modal.setContent(_text);
    _text.setString(d.getMessage());
    if (auto cb = d.getOnConfirm()) _modal.onConfirm(std::move(cb));
    if (auto cb = d.getOnReject())  _modal.onDismiss(std::move(cb));
    _modal.show();
});

See also

Hookable, Modal

Definition at line 40 of file DialogRequest.h.

Member Enumeration Documentation

Hook

enum class ml::DialogRequest::Hook

strong

Enumerator
SHOW

Definition at line 42 of file DialogRequest.h.

Constructor & Destructor Documentation

~DialogRequest()

virtual ml::DialogRequest::~DialogRequest ( )

virtualdefault

Member Function Documentation

getCancelLabel()

virtual const std::string & ml::DialogRequest::getCancelLabel ( )

pure virtual

getConfirmLabel()

virtual const std::string & ml::DialogRequest::getConfirmLabel ( )

pure virtual

getContent()

virtual ml::Core * ml::DialogRequest::getContent ( )

inlinevirtual

Definition at line 52 of file DialogRequest.h.

getMessage()

virtual const std::string & ml::DialogRequest::getMessage ( )

pure virtual

getOnConfirm()

virtual std::function< void()> ml::DialogRequest::getOnConfirm ( )

pure virtual

getOnReject()

virtual std::function< void()> ml::DialogRequest::getOnReject ( )

pure virtual

getTitle()

virtual std::string ml::DialogRequest::getTitle ( )

inlinevirtual

Definition at line 51 of file DialogRequest.h.

---

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

• Traits/Communication/DialogRequest.h