Issue #2625: Provide correct behavior of arrow of current feature

[modules/shaper.git] / src / XGUI / XGUI_QtEvents.h

diff --git a/src/XGUI/XGUI_QtEvents.h b/src/XGUI/XGUI_QtEvents.h
index 4fdb3385744e7c20eb504db6ffc7f5acd3d3213e..04af0ce7a0257ad252722088687a33f25c59d55b 100644 (file)
--- a/src/XGUI/XGUI_QtEvents.h
+++ b/src/XGUI/XGUI_QtEvents.h
@@ -1,9 +1,22 @@
-/*
- * XGUI_QEvents.h
- *
- *  Created on: Sep 12, 2014
- *      Author: sbh
- */
+// Copyright (C) 2014-2017  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<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef XGUI_QTEVENTS_H_
 #define XGUI_QTEVENTS_H_
@@ -16,25 +29,36 @@
 #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;
 
-  PostponeMessageQtEvent(const boost::shared_ptr<Events_Message>& theMessage)
+  /// Constructor
+  /// \param theMessage an event message to send
+  PostponeMessageQtEvent(const std::shared_ptr<Events_Message>& theMessage)
       : QEvent(PostponeMessageQtEventType),
       myMessage(theMessage)
   {
   }
+
+  /// Returns type of the event
   static QEvent::Type type()
   {
     return PostponeMessageQtEventType;
   }
 
-  boost::shared_ptr<Events_Message> postponedMessage();
+  /// Returns current messasge
+  std::shared_ptr<Events_Message> postponedMessage();
 
  private:
-  boost::shared_ptr<Events_Message> myMessage;
+   /// Message
+  std::shared_ptr<Events_Message> myMessage;
 };
 
 #endif /* XGUI_QEVENTS_H_ */