Lumiera  0.pre.03
»edityourfreedom«
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Controller Class Reference

#include "gui/model/controller.hpp"

Description

Todo:
write type comment...

Definition at line 59 of file controller.hpp.

Private Member Functions

virtual bool doClearErr () override
 
virtual bool doClearMsg () override
 
virtual bool doErr (string text) override
 
virtual bool doExpand (bool yes) override
 
virtual void doFlash () override
 
virtual void doMark (GenNode const &mark) override
 default implementation and catch-all handler for receiving »state mark« messages. More...
 
virtual bool doMsg (string text) override
 
virtual bool doReset () override
 
virtual void doReveal (ID child) override
 
virtual void doRevealYourself () 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...
 
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 (ID child)
 
- 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 Member Functions inherited from Tangible
 Tangible (ID identity, ctrl::BusTerm &nexus)
 
- Protected Attributes inherited from Tangible
ctrl::BusTerm uiBus_
 

Member Function Documentation

virtual bool doReset ( )
inlineoverrideprivatevirtual

Implements Tangible.

Definition at line 66 of file controller.hpp.

virtual bool doExpand ( bool  yes)
inlineoverrideprivatevirtual

Implements Tangible.

Definition at line 72 of file controller.hpp.

virtual void doReveal ( ID  child)
inlineoverrideprivatevirtual

Implements Tangible.

Definition at line 78 of file controller.hpp.

virtual void doRevealYourself ( )
inlineoverrideprivatevirtual

Implements Tangible.

Definition at line 84 of file controller.hpp.

virtual bool doMsg ( string  text)
inlineoverrideprivatevirtual

Implements Tangible.

Definition at line 90 of file controller.hpp.

virtual bool doClearMsg ( )
inlineoverrideprivatevirtual

Implements Tangible.

Definition at line 96 of file controller.hpp.

virtual bool doErr ( string  text)
inlineoverrideprivatevirtual

Implements Tangible.

Definition at line 102 of file controller.hpp.

virtual bool doClearErr ( )
inlineoverrideprivatevirtual

Implements Tangible.

Definition at line 108 of file controller.hpp.

virtual void doFlash ( )
inlineoverrideprivatevirtual

Implements Tangible.

Definition at line 114 of file controller.hpp.

virtual void doMark ( GenNode const &  stateMark)
inlineoverrideprivatevirtual

default implementation and catch-all handler for receiving »state mark« messages.

Such messages serve either to cause a presentation state effect specific to this element, or they are used to re-play a former state change to restore some specific UI state captured within a past working session. Events handled here:

  • expand with a bool argument calls the doExpand(bool) virtual function. It is up to the concrete element to give this a tangible meaning, e.g. a track might switch to detail view and a clip might reveal attached effects.
  • reset restores the element to the hard wired default, by invoking doReset()
  • revealYourself prompts the element to take the necessary actions to bring itself into view. There is no requirement for an element to even implement this call, but those which do typically know some kind of _"parent object"_ to forward this request, by invoking doReveal(myID) on this parent. For instance, a clip might ask the enclosing track, which in turn might call the enclosing timeline display for help, resulting in a scroll action to bring the clip into sight.
    Note
    this is a default implementation for a virtual function declared abstract with the intention for derived classes to tail-call this default handler.

Implements Tangible.

Definition at line 120 of file controller.hpp.

+ Inheritance diagram for Controller:
+ Collaboration diagram for Controller:

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