98 lines
2.5 KiB
C++
98 lines
2.5 KiB
C++
|
/*
|
||
|
|
INVOCATION-TRAIL.hpp - a tangible element of the user interface
|
||
|
|
|
||
|
|
Copyright (C) Lumiera.org
|
||
|
|
2015, Hermann Vosseler <Ichthyostega@web.de>
|
||
|
|
|
||
|
|
This program is free software; you can redistribute it and/or
|
||
|
|
modify it under the terms of the GNU General Public License as
|
||
|
|
published by the Free Software Foundation; either version 2 of
|
||
|
|
the License, or (at your option) any later version.
|
||
|
|
|
||
|
|
This program is distributed in the hope that it will be useful,
|
||
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
|
|
GNU General Public License for more details.
|
||
|
|
|
||
|
|
You should have received a copy of the GNU General Public License
|
||
|
|
along with this program; if not, write to the Free Software
|
||
|
|
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
||
|
|
|
||
|
|
*/
|
||
|
|
|
||
|
|
|
||
|
|
/** @file invocation-trail.hpp
|
||
|
|
** Abstraction: a tangible element of the User Interface.
|
||
|
|
** Any such element is connected to the UIBus...
|
||
|
|
**
|
||
|
|
** @todo as of 1/2015 this is complete WIP-WIP-WIP
|
||
|
|
**
|
||
|
|
** @see ////TODO_test usage example
|
||
|
|
**
|
||
|
|
*/
|
||
|
|
|
||
|
|
|
||
|
|
#ifndef GUI_INTERACT_INVOCATION_TRAIL_H_
|
||
|
|
#define GUI_INTERACT_INVOCATION_TRAIL_H_
|
||
|
|
|
||
|
|
|
||
|
|
#include "lib/error.hpp"
|
||
|
|
#include "gui/ctrl/bus-term.hpp"
|
||
|
|
#include "lib/idi/entry-id.hpp"
|
||
|
|
//#include "lib/symbol.hpp"
|
||
|
|
//#include "lib/util.hpp"
|
||
|
|
|
||
|
|
#include <boost/noncopyable.hpp>
|
||
|
|
#include <string>
|
||
|
|
|
||
|
|
|
||
|
|
namespace gui {
|
||
|
|
namespace interact {
|
||
|
|
|
||
|
|
// using lib::HashVal;
|
||
|
|
// using util::isnil;
|
||
|
|
using std::string;
|
||
|
|
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Interface common to all UI elements of relevance for the Lumiera application.
|
||
|
|
* Any non-local and tangible interface interaction will at some point pass through
|
||
|
|
* this foundation element, which forms the joint and attachment to the UI backbone,
|
||
|
|
* which is the [UI-Bus][ui-bus.hpp]. Any tangible element acquires a distinct identity
|
||
|
|
* and has to be formed starting from an already existing bus nexus.
|
||
|
|
*
|
||
|
|
* @todo write type comment...
|
||
|
|
*/
|
||
|
|
class InvocationTrail
|
||
|
|
: boost::noncopyable
|
||
|
|
{
|
||
|
|
protected:
|
||
|
|
|
||
|
|
Tangible(EntryID identity, ctrl::BusTerm nexus)
|
||
|
|
: uiBus_(nexus.attach(identity))
|
||
|
|
{ }
|
||
|
|
|
||
|
|
public:
|
||
|
|
virtual ~Tangible(); ///< this is an interface
|
||
|
|
|
||
|
|
void reset();
|
||
|
|
|
||
|
|
void slotExpand();
|
||
|
|
void slotReveal();
|
||
|
|
|
||
|
|
void noteMsg();
|
||
|
|
void noteErr();
|
||
|
|
void noteFlash();
|
||
|
|
void noteMark();
|
||
|
|
|
||
|
|
protected:
|
||
|
|
virtual void doExpand() =0;
|
||
|
|
virtual void doReveal() =0;
|
||
|
|
private:
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
}} // namespace gui::interact
|
||
|
|
#endif /*GUI_INTERACT_INVOCATION_TRAIL_H_*/
|