Lumiera  0.pre.03
»edityourfreedom«
Controller Class Reference

#include "gui/model/controller.hpp"

Description

Todo:
write type comment...

Definition at line 61 of file controller.hpp.

Protected Member Functions

virtual void doMark (GenNode const &mark) override
 default handler for all generic mark messages. More...
 
- 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...
 

Private Member Functions

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

Additional Inherited Members

- Public Types inherited from Tangible
using ID = ctrl::BusTerm::ID
 
using LuidH = lib::hash::LuidH
 
- Public Member Functions inherited from Tangible
virtual ~Tangible ()
 this is an interface More...
 
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. More...
 
void clearErr ()
 invoke the hook to clear error markers More...
 
void clearMsg ()
 invoke the hook to clear notification messages More...
 
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 More...
 
void mark (GenNode const &)
 generic handler for all incoming "state mark" messages More...
 
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 ID () const
 
 operator LuidH () const
 
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 More...
 
- Protected Types inherited from Tangible
using GenNode = lib::diff::GenNode
 
using Rec = lib::diff::Rec
 
- Protected Attributes inherited from Tangible
Expander expand_
 
Revealer reveal_
 
ctrl::BusTerm uiBus_
 

Member Function Documentation

◆ doReset()

virtual bool doReset ( )
inlineoverrideprivatevirtual

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 68 of file controller.hpp.

◆ doMsg()

virtual bool doMsg ( string  text)
inlineoverrideprivatevirtual

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 74 of file controller.hpp.

◆ doClearMsg()

virtual bool doClearMsg ( )
inlineoverrideprivatevirtual

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 80 of file controller.hpp.

◆ doErr()

virtual bool doErr ( string  text)
inlineoverrideprivatevirtual

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 86 of file controller.hpp.

◆ doClearErr()

virtual bool doClearErr ( )
inlineoverrideprivatevirtual

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 92 of file controller.hpp.

◆ doFlash()

virtual void doFlash ( )
inlineoverrideprivatevirtual

Implements Tangible.

Reimplemented in NotificationHub.

Definition at line 98 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 109 of file controller.hpp.

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

+ Here is the call graph for this function:
+ Inheritance diagram for Controller:
+ Collaboration diagram for Controller:

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