Ichthyostega
974c670d41
to make them stand out more prominently, some entity comments where started with a line of starts. Unfortunately, doxygen (and javadoc) only recogise comments which are started exactly with /** This caused quite some comments to be ignored by doxygen. Credits to Hendrik Boom for spotting this problem! A workaround is to end the line of stars with *//**
91 lines
3 KiB
C++
91 lines
3 KiB
C++
/*
|
|
NOTIFICATION-SERVICE.hpp - public service allowing to push information into the GUI
|
|
|
|
Copyright (C) Lumiera.org
|
|
2008, 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 notification-service.hpp
|
|
** A public service provided by the GUI, implementing the gui::GuiNotification facade interface.
|
|
** The purpose of this service is to push state update and notification of events from the lower
|
|
** layers into the Lumiera GUI. Typically, this happens asynchronously and triggered by events
|
|
** within the lower layers.
|
|
**
|
|
** This service is the implementation of a layer separation facade interface. Clients should use
|
|
** gui::GuiNotification#facade to access this service. This header defines the interface used
|
|
** to \em provide this service, not to access it.
|
|
**
|
|
** @see gui::GuiFacade
|
|
** @see guifacade.cpp starting this service
|
|
*/
|
|
|
|
|
|
#ifndef GUI_NOTIFICATION_SERVICE_H
|
|
#define GUI_NOTIFICATION_SERVICE_H
|
|
|
|
|
|
#include "include/guinotification-facade.h"
|
|
#include "common/instancehandle.hpp"
|
|
#include "lib/singleton-ref.hpp"
|
|
|
|
|
|
|
|
namespace gui {
|
|
|
|
|
|
|
|
/**************************************************//**
|
|
* Actual implementation of the GuiNotification service
|
|
* within the Lumiera GTK GUI. Creating an instance of
|
|
* this class automatically registers the interface
|
|
* with the Lumiera Interface/Plugin system and creates
|
|
* a forwarding proxy within the application core to
|
|
* route calls through this interface.
|
|
*
|
|
* @todo the ctor of this class should take references
|
|
* to any internal service providers within the
|
|
* GUI which are needed to implement the service.
|
|
*/
|
|
class NotificationService
|
|
: public GuiNotification
|
|
{
|
|
|
|
/* === Implementation of the Facade Interface === */
|
|
|
|
void displayInfo (string const& text);
|
|
void triggerGuiShutdown (string const& cause);
|
|
|
|
|
|
/* === Interface Lifecycle === */
|
|
|
|
typedef lumiera::InstanceHandle< LUMIERA_INTERFACE_INAME(lumieraorg_GuiNotification, 0)
|
|
, GuiNotification
|
|
> ServiceInstanceHandle;
|
|
|
|
lib::SingletonRef<GuiNotification> implInstance_;
|
|
ServiceInstanceHandle serviceInstance_;
|
|
|
|
public:
|
|
NotificationService();
|
|
|
|
};
|
|
|
|
|
|
|
|
} // namespace gui
|
|
#endif
|