99 lines
3 KiB
C++
99 lines
3 KiB
C++
/*
|
|
GUINOTIFICATION-FACADE.h - access point for pushing informations 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 guinotification-facade.h
|
|
** Major public Interface of the Lumiera GUI. While generally speaking, the GUI
|
|
** controls the application and thus acts on its own, it exposes some services
|
|
** usable by scripts or the two lower layers. The main purpose of these services
|
|
** is to push informations and status updates into the GUI.
|
|
**
|
|
** @see gui::GuiFacade
|
|
** @see main.cpp
|
|
*/
|
|
|
|
|
|
#ifndef GUI_GUINOTIFICATION_H
|
|
#define GUI_GUINOTIFICATION_H
|
|
|
|
|
|
|
|
#ifdef __cplusplus /* ============== C++ Interface ================= */
|
|
|
|
#include "include/interfaceproxy.hpp"
|
|
|
|
#include <string>
|
|
|
|
|
|
namespace gui {
|
|
|
|
using std::string;
|
|
|
|
|
|
/*********************************************************************
|
|
* Global access point 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 is a layer separation facade interface. Clients should use
|
|
* the embedded #facade factory, which yields a proxy routing any
|
|
* calls through the lumieraorg_GuiNotification interface
|
|
* @throws lumiera::error::State when interface is not opened
|
|
*/
|
|
class GuiNotification
|
|
{
|
|
public:
|
|
static lumiera::facade::Accessor<GuiNotification> facade;
|
|
|
|
/** push a user visible notification text */
|
|
virtual void displayInfo (string const& text) =0;
|
|
|
|
/** causes the GUI to shut down unconditionally
|
|
* @param cause user visible explanation of the
|
|
* reason causing this shutdown */
|
|
virtual void triggerGuiShutdown (string const& cause) =0;
|
|
|
|
|
|
protected:
|
|
virtual ~GuiNotification() {}
|
|
};
|
|
|
|
|
|
|
|
} // namespace gui
|
|
|
|
|
|
extern "C" {
|
|
#endif /* =========================== CL Interface ===================== */
|
|
|
|
|
|
#include "common/interface.h"
|
|
|
|
LUMIERA_INTERFACE_DECLARE (lumieraorg_GuiNotification, 0,
|
|
LUMIERA_INTERFACE_SLOT (void, displayInfo, (const char*)),
|
|
LUMIERA_INTERFACE_SLOT (void, triggerGuiShutdown, (const char*)),
|
|
);
|
|
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
#endif
|