Controller Class Reference

#include "stage/model/controller.hpp"

Description

Todo:

write type comment...

Definition at line 52 of file controller.hpp.

Public Member Functions
	Tangible (ID identity, ctrl::BusTerm &nexus)
Public Member Functions inherited from Tangible
virtual	~Tangible ()
	this is an interface
	operator string () const
	diagnostic representation.
	operator LuidH () const
ID	getID () const
void	reset ()
	invoke the generic reset hook
void	clearMsg ()
	invoke the hook to clear notification messages
void	clearErr ()
	invoke the hook to clear error markers
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.
void	slotExpand ()
	Expand this element and remember the expanded state.
void	slotCollapse ()
	Collapse or minimise this element and remember the collapsed state.
void	slotReveal ()
	Cause the element to be brought into sight.
void	markFlash ()
	highlight the element visually to catch the user's attention
void	markMsg (string message)
	push a notification (or warning) message to the element.
void	markErr (string error)
	push an error state tag to the element
void	mark (GenNode const &)
	generic handler for all incoming "state mark" messages
void	installExpander (Expander::ProbeFun, Expander::ChangeFun)
	Configure the (optional) functionality to expand or collapse the UI-Element.
void	installRevealer (Revealer::RevealeItFun)
	Configure the (optional) functionality to bring the UI-Element into sight.
virtual void	buildMutator (lib::diff::TreeMutator::Handle)=0
	build a custom implementation of the TreeMutator interface, suitably wired to cause appropriate changes to the opaque data structure, in accordance to the semantics of the tree diff language.
template<typename... ARGS>
void	invoke (Symbol cmdID, ARGS &&... args)
	convenience shortcut to issue a command with several arguments
Public Member Functions inherited from DiffMutable
virtual	~DiffMutable ()
	this is an interface

Protected Member Functions
virtual void	doMark (GenNode const &mark) override
	default handler for all generic mark messages.
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.
virtual void	doReveal ()
	generic default implementation of the "reveal" functionality.

Private Member Functions
virtual bool	doReset () override
virtual bool	doMsg (string text) override
virtual bool	doClearMsg () override
virtual bool	doErr (string text) override
virtual bool	doClearErr () override
virtual void	doFlash () override

Additional Inherited Members
Public Types inherited from Tangible
using	ID = ctrl::BusTerm::ID
using	LuidH = lib::hash::LuidH
Protected Types inherited from Tangible
using	Rec = lib::diff::Rec
using	GenNode = lib::diff::GenNode
Protected Attributes inherited from Tangible
ctrl::BusTerm	uiBus_
Expander	expand_
Revealer	reveal_

Member Function Documentation

doReset()

virtual bool doReset ( )

inlineoverrideprivatevirtual

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 59 of file controller.hpp.

doMsg()

virtual bool doMsg ( string  text )

inlineoverrideprivatevirtual

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 65 of file controller.hpp.

doClearMsg()

virtual bool doClearMsg ( )

inlineoverrideprivatevirtual

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 71 of file controller.hpp.

doErr()

virtual bool doErr ( string  text )

inlineoverrideprivatevirtual

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 77 of file controller.hpp.

doClearErr()

virtual bool doClearErr ( )

inlineoverrideprivatevirtual

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 83 of file controller.hpp.

doFlash()

virtual void doFlash ( )

inlineoverrideprivatevirtual

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 89 of file controller.hpp.

doMark()

virtual void doMark ( GenNode const &  mark )

inlineoverrideprotectedvirtual

default handler for all generic mark messages.

Forwards to Tangible::doMark

Todo:

is there any default implementation for special messages, which might be eligible as a base class implementation??

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 100 of file controller.hpp.

References Tangible::doMark(), and Tangible::mark().

Here is the call graph for this function:

Tangible()

Tangible ( ID  identity, ctrl::BusTerm &  nexus  )

inline

Definition at line 174 of file tangible.hpp.

Inheritance diagram for Controller:

Collaboration diagram for Controller:

---

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

• controller.hpp