121 lines
3.4 KiB
C++
121 lines
3.4 KiB
C++
/*
|
|
TANGIBLE.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 tangible.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_MODEL_TANGIBLE_H
|
|
#define GUI_MODEL_TANGIBLE_H
|
|
|
|
|
|
#include "lib/error.hpp"
|
|
#include "gui/ctrl/bus-term.hpp"
|
|
#include "gui/interact/invocation-trail.hpp"
|
|
#include "lib/idi/entry-id.hpp"
|
|
//#include "lib/symbol.hpp"
|
|
//#include "lib/util.hpp"
|
|
|
|
#include <boost/noncopyable.hpp>
|
|
#include <sigc++/trackable.h>
|
|
#include <string>
|
|
|
|
|
|
namespace gui {
|
|
namespace model {
|
|
|
|
// 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 Tangible
|
|
: public sigc::trackable
|
|
, boost::noncopyable
|
|
{
|
|
protected:
|
|
using GenNode = lib::diff::GenNode;
|
|
using Cmd = interact::InvocationTrail;
|
|
using Rec = lib::diff::Rec;
|
|
using ID = lib::idi::BareEntryID const&;
|
|
|
|
ctrl::BusTerm uiBus_;
|
|
|
|
|
|
Tangible(ID identity, ctrl::BusTerm& nexus)
|
|
: uiBus_(nexus.attach(identity, *this))
|
|
{ }
|
|
|
|
public:
|
|
virtual ~Tangible(); ///< this is an interface
|
|
|
|
operator ID() const { return uiBus_.getID();}
|
|
|
|
void reset();
|
|
|
|
void prepareCommand (Cmd const& prototype, Rec&& arguments);
|
|
void issueCommand (Cmd const& preparedAction);
|
|
|
|
void slotExpand();
|
|
void slotCollapse();
|
|
|
|
void slotReveal(ID child);
|
|
|
|
void markMsg (string m) { this->doMsg(m); }
|
|
void markErr (string e) { this->doErr(e); }
|
|
void markFlash() { this->doFlash();}
|
|
void mark(GenNode const& n) { this->doMark(n);}
|
|
|
|
protected:
|
|
virtual void doReset() =0;
|
|
virtual void doExpand (bool yes) =0;
|
|
virtual void doReveal (ID child) =0;
|
|
virtual void doRevealYourself () =0;
|
|
|
|
virtual void doMsg (string) =0;
|
|
virtual void doErr (string) =0;
|
|
virtual void doFlash() =0;
|
|
virtual void doMark(GenNode const&) =0;
|
|
private:
|
|
};
|
|
|
|
|
|
|
|
}} // namespace gui::model
|
|
#endif /*GUI_MODEL_TANGIBLE_H*/
|