#include "stage/ctrl/notification-hub.hpp"

Description

Service to receive and display error, warning and notification messages.

These are sent over the UI-Bus through the NotificationService; after receiving such a message, this controller ensures to display the message and alert the user, while not blocking the overall UI.

Definition at line 88 of file notification-hub.hpp.

Public Types
using	WidgetAllocator = std::function< widget::ErrorLogDisplay &(void)>

Public Types inherited from Tangible
using	ID = ctrl::BusTerm::ID

using	LuidH = lib::hash::LuidH

Public Member Functions
	NotificationHub (ID identity, ctrl::BusTerm &nexus, WidgetAllocator wa)

Public Member Functions inherited from Tangible
virtual	~Tangible ()
	this is an interface

void	clearErr ()
	invoke the hook to clear error markers More...

void	clearMsg ()
	invoke the hook to clear notification messages More...

ID	getID () const

void	installExpander (Expander::ProbeFun, Expander::ChangeFun)
	Configure the (optional) functionality to expand or collapse the UI-Element. More...

void	installRevealer (Revealer::RevealeItFun)
	Configure the (optional) functionality to bring the UI-Element into sight. More...

template<typename... ARGS>
void	invoke (Symbol cmdID, ARGS &&...)

void	invoke (Symbol cmdID, Rec &&arguments)
	Perform a command or action, once the execution context has been established. More...

template<typename... ARGS>
void	invoke (Symbol cmdID, ARGS &&... args)
	convenience shortcut to issue a command with several arguments

void	mark (GenNode const &)
	generic handler for all incoming "state mark" messages

void	markErr (string error)
	push an error state tag to the element More...

void	markFlash ()
	highlight the element visually to catch the user's attention More...

void	markMsg (string message)
	push a notification (or warning) message to the element. More...

	operator LuidH () const

	operator string () const
	diagnostic representation. More...

void	reset ()
	invoke the generic reset hook More...

void	slotCollapse ()
	Collapse or minimise this element and remember the collapsed state. More...

void	slotExpand ()
	Expand this element and remember the expanded state. More...

void	slotReveal ()
	Cause the element to be brought into sight. More...

Public Member Functions inherited from DiffMutable
virtual	~DiffMutable ()
	this is an interface

Private Member Functions
void	buildMutator (lib::diff::TreeMutator::Handle buffer) override
	population and manipulation of persistent content via UI-Bus

virtual bool	doClearErr () override

virtual bool	doClearMsg () override

virtual bool	doErr (string text) override

virtual void	doFlash () override

virtual void	doMark (GenNode const &stateMark) override
	adds special treatment for a state mark tagged as `"Warning"`

virtual bool	doMsg (string text) override

virtual bool	doReset () override

widget::ErrorLogDisplay &	getWidget ()

Private Attributes
WidgetAllocator	allocateWidget_
	external operation to find or allocate an log display widget

WLink< widget::ErrorLogDisplay >	widget_
	collaboration with a log display allocated elsewhere

Additional Inherited Members
Protected Types inherited from Tangible
using	GenNode = lib::diff::GenNode

using	Rec = lib::diff::Rec

Protected Member Functions inherited from Tangible
	Tangible (ID identity, ctrl::BusTerm &nexus)

virtual bool	doExpand (bool yes)
	generic default implementation of the expand/collapse functionality. More...

virtual void	doReveal ()
	generic default implementation of the "reveal" functionality. More...

Protected Attributes inherited from Tangible
Expander	expand_

Revealer	reveal_

ctrl::BusTerm	uiBus_

Inheritance diagram for NotificationHub:

Collaboration diagram for NotificationHub:

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

notification-hub.hpp

Description

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members