#include "include/gui-notification-facade.h"

Description

Global access point to push state update and notification of events from the lower layers into the Lumiera GUI.

Typically, this happens asynchronously and triggered by events within the lower layers.

This is a layer separation façade interface. Clients should use the embedded facade factory, which yields a proxy routing any calls through the lumieraorg_GuiNotification interface

Exceptions

lumiera::error::State when interface is not opened

Definition at line 73 of file gui-notification-facade.h.

Public Member Functions
virtual void	displayInfo (NotifyLevel, string const &text)=0
	push a user visible notification text

virtual void	mark (ID uiElement, GenNode &&stateMark)=0
	send a generic state mark message to some element

virtual void	markError (ID uiElement, string const &text)=0
	highlight an element in the UI as problem location

virtual void	markNote (ID uiElement, string const &text)=0
	attach an warning or state information element

virtual void	mutate (ID uiElement, MutationMessage &&)=0
	push a diff message up into the user interface. More...

virtual void	triggerGuiShutdown (string const &cause)=0
	causes the GUI to shut down unconditionally More...

Static Public Attributes
static lib::Depend< GuiNotification >	facade
	static storage for the facade access front-end

Friends
class	lib::DependencyFactory< GuiNotification >

Protected Member Functions
virtual	~GuiNotification ()
	this is an interface

Member Function Documentation

◆ mutate()

virtual void mutate	(	ID	uiElement,
		MutationMessage &&
	)

pure virtual

push a diff message up into the user interface.

Remarks: this is the intended way how to populate or manipulate the contents of the user interface from lower layers. By sending a diff message, any structural or content changes can be described without actually knowing the implementation of the UI model elements subject to this change.

See also: diff-language.hpp

◆ triggerGuiShutdown()

virtual void triggerGuiShutdown ( string const & cause )

pure virtual

causes the GUI to shut down unconditionally

Parameters

cause user visible explanation of the reason causing this shutdown

Warning: since the UI is a subsystem, this call eventually terminates the whole application.

Implemented in NotificationService.

Inheritance diagram for GuiNotification:

Collaboration diagram for GuiNotification:

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

Description

Public Member Functions

Static Public Attributes

Friends

Protected Member Functions

Member Function Documentation

◆ mutate()

◆ triggerGuiShutdown()