Salome HOME
Updated copyright comment
[modules/shaper.git] / src / XGUI / XGUI_ErrorDialog.h
index 9a5ca5803d07987aef505fba7933dc10178eb8eb..202ee8f6f55862ab00977fd229e0b12d8d319f76 100644 (file)
@@ -1,32 +1,62 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
-
-/*
- * XGUI_ErrorDialog.h
- *
- *  Created on: Apr 28, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2024  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 XGUI_ERRORDIALOG_H_
 #define XGUI_ERRORDIALOG_H_
 
 #include <XGUI.h>
 #include <QDialog>
+#include <Events_InfoMessage.h>
 
 class QTextEdit;
 
+/**
+* \ingroup GUI
+* A class of dialog to show error message
+*/
 class XGUI_ErrorDialog : public QDialog
 {
 Q_OBJECT
  public:
-  XGUI_EXPORT XGUI_ErrorDialog(QWidget* parent);XGUI_EXPORT virtual ~XGUI_ErrorDialog();
+   /// Constructor
+   /// \param parent a parent widget
+  XGUI_EXPORT XGUI_ErrorDialog(QWidget* parent);
+  XGUI_EXPORT virtual ~XGUI_ErrorDialog();
 
  public slots:
-  XGUI_EXPORT void refresh();XGUI_EXPORT void clear();XGUI_EXPORT void addError(const QString&);XGUI_EXPORT void removeError(
-      const QString&);
+   /// Update dialog box
+  XGUI_EXPORT void refresh();
+
+  /// Clear messages
+  XGUI_EXPORT void clear();
+
+  /// Add error message
+  XGUI_EXPORT void addError(std::shared_ptr<Events_InfoMessage> theMsg);
+
+  /// Remove error message
+  XGUI_EXPORT void removeError(const QString&);
 
  private:
+   /// Widget for error log
   QTextEdit* myErrorLog;
+
+  /// List of errors
   QStringList myErrors;
 };