gui-notification-facade.h

Go to the documentation of this file.

/*
  GUI-NOTIFICATION-FACADE.h  -  access point for pushing 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.

*/

#ifndef STAGE_GUI_NOTIFICATION_H
#define STAGE_GUI_NOTIFICATION_H



#ifdef __cplusplus  /* ============== C++ Interface ================= */

#include "lib/depend.hpp"
#include "lib/idi/entry-id.hpp"

#include <string>


namespace lib {
  namespace diff {
    class GenNode;
    class MutationMessage;
} }
namespace stage {
  
  using std::string;
  using lib::diff::GenNode;
  using lib::diff::MutationMessage;
  
  using ID = lib::idi::BareEntryID const&;
  
  enum NotifyLevel {
      NOTE_INFO,   
      NOTE_WARN,   
      NOTE_ERROR   
  };
  
  
  /*****************************************************************/
  class GuiNotification
    {
    protected:
      virtual ~GuiNotification() {}   
      friend class lib::DependencyFactory<GuiNotification>;
      
    public:
      static lib::Depend<GuiNotification> facade;
      
      
      virtual void displayInfo (NotifyLevel, string const& text) =0;
      
      virtual void markError (ID uiElement, string const& text)  =0;
      
      virtual void markNote  (ID uiElement, string const& text)  =0;
      
      virtual void mark      (ID uiElement, GenNode&& stateMark) =0;
      
      virtual void mutate (ID uiElement, MutationMessage&&)      =0;
      
      virtual void triggerGuiShutdown (string const& cause)      =0;
      
    };
  
  
  
} // namespace stage


extern "C" {
#endif /* =========================== CL Interface ===================== */

  
#include "common/interface.h"
#include "lib/hash-value.h"


LUMIERA_INTERFACE_DECLARE (lumieraorg_GuiNotification, 0,
                           LUMIERA_INTERFACE_SLOT (void, displayInfo,        (uint, const char*)),
                           LUMIERA_INTERFACE_SLOT (void, markError,          (const void*, const char*)),  
                           LUMIERA_INTERFACE_SLOT (void, markNote,           (const void*, const char*)),
                           LUMIERA_INTERFACE_SLOT (void, mark,               (const void*, void*)),
                           LUMIERA_INTERFACE_SLOT (void, mutate,             (const void*, void*)),
                           LUMIERA_INTERFACE_SLOT (void, triggerGuiShutdown, (const char*)),
);


#ifdef __cplusplus
}// extern "C"
#endif
#endif /*STAGE_GUI_NOTIFICATION_H*/