Events_InfoMessage.h

// Copyright (C) 2014-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library 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
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef Events_InfoMessage_H_
#define Events_InfoMessage_H_
 
#include <Events.h>
#include <Events_Message.h>
#include <Events_Loop.h>
 
#include <string>
#include <list>
 
class Events_InfoMessage: public Events_Message
{
public:
 
  explicit Events_InfoMessage(const void* theSender = 0):
    Events_Message(Events_Loop::eventByName("InfoMessage"), theSender) {}
 
  Events_InfoMessage(const std::string& theContext,
    const std::string& theMsg, const void* theSender = 0):
  Events_Message(Events_Loop::eventByName("InfoMessage"), theSender),
    myContext(theContext), myMessage(theMsg) {}
 
  virtual ~Events_InfoMessage() {}
 
  static Events_ID errorID()  { return Events_Loop::loop()->eventByName("InfoMessage"); }
 
  void  setContext(const std::string& theContext) { myContext = theContext; }
 
 
  std::string context() const { return myContext; }
 
  void setMessageString(const std::string& theMsg) { myMessage = theMsg; }
 
  std::string messageString() const { return myMessage; }
 
  Events_InfoMessage& operator=(const std::string& theMsg) {
    setMessageString(theMsg);
    return *this;
  }
 
  bool empty() const {
    return myMessage.empty();
  }
 
  void addParameter(const std::string& theParam)
  {
    myParameters.push_back(theParam);
  }
 
  EVENTS_EXPORT void addParameter(double theParam);
 
  EVENTS_EXPORT void addParameter(int theParam);
 
  std::list<std::string> parameters() const { return myParameters; }
 
  EVENTS_EXPORT Events_InfoMessage& arg(const std::wstring& theParam);
 
  Events_InfoMessage& arg(const std::string& theParam) { addParameter(theParam); return *this; }
 
  Events_InfoMessage& arg(int theParam) { addParameter(theParam); return *this; }
 
  Events_InfoMessage& arg(double theParam) { addParameter(theParam); return *this; }
 
  EVENTS_EXPORT void send();
 
private:
 
  std::string myContext;
 
  std::string myMessage;
 
  std::list<std::string> myParameters;
};
 
#endif