Salome HOME
ménage
[modules/shaper.git] / src / XGUI / XGUI_QtEvents.h
index 5c415a278fcaeaeca10a4edeb536721e629e8325..dc5797570cabc36f6d086974f3f3a12a1c18c782 100644 (file)
@@ -1,9 +1,21 @@
-/*
- * XGUI_QEvents.h
- *
- *  Created on: Sep 12, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2022  CEA/DEN, EDF R&D
+//
+// 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_QTEVENTS_H_
 #define XGUI_QTEVENTS_H_
 #include <QEvent>
 #include <QString>
 
+/**
+* \ingroup GUI
+* Class of event to send application events in multi thread environment
+*/
 class XGUI_EXPORT PostponeMessageQtEvent : public QEvent
 {
  public:
+   /// An event type
   static QEvent::Type PostponeMessageQtEventType;
 
-  //TODO(mpv): ModelAPI_Document is taken here for example
-  //the commented code should be ok when you implement boost::shared_ptr on Events_Message
-  //the same for #1-4
-  PostponeMessageQtEvent(boost::shared_ptr<ModelAPI_Document> theDoc)
-  //PostponeMessageQtEvent(boost::shared_ptr<Events_Message> theMessage)
+  /// Constructor
+  /// \param theMessage an event message to send
+  PostponeMessageQtEvent(const std::shared_ptr<Events_Message>& theMessage)
       : QEvent(PostponeMessageQtEventType),
-      //TODO(mpv): #1
-      //myMessage(theMessage)
-        myTestDoc(theDoc)
+      myMessage(theMessage)
   {
   }
+
+  /// Returns type of the event
   static QEvent::Type type()
   {
     return PostponeMessageQtEventType;
   }
 
-  //TODO(mpv): #2
-  //boost::shared_ptr<Events_Message> postponedMessage();
-  boost::shared_ptr<ModelAPI_Document> resultDoc();
+  /// Returns current messasge
+  std::shared_ptr<Events_Message> postponedMessage();
 
  private:
-  //TODO(mpv): #3
-  //boost::shared_ptr<Events_Message> myMessage;
-  boost::shared_ptr<ModelAPI_Document> myTestDoc;
+   /// Message
+  std::shared_ptr<Events_Message> myMessage;
 };
 
 #endif /* XGUI_QEVENTS_H_ */