src/Events/Events_LongOp.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        Events_LongOp.h
   4 // Created:     29 Jul 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef EVENTS_LONGOP_H_
   8 #define EVENTS_LONGOP_H_
   9
  10 #include <Events.h>
  11 #include <Events_Message.h>
  12
  13 /**
  14  * Informs the application that the long operation is performed.
  15  * Causes waiting coursor in GUI.
  16  */
  17 class EVENTS_EXPORT Events_LongOp : public Events_Message
  18 {
  19 public:
  20   /// Default destructor
  21   virtual ~Events_LongOp();
  22   /// Returns the identifier of this event
  23   static Events_ID eventID();
  24   /// Starts the long operation
  25   static void start(void* theSender = 0);
  26   /// Stops the long operation
  27   static void end(void* theSender = 0);
  28   /// Returns true if the long operation is performed
  29   static bool isPerformed();
  30
  31 protected:
  32   /// Default constructor. Use "start" and "end" for generation.
  33   Events_LongOp(void* theSender = 0);
  34 };
  35
  36 #endif /* EVENTS_ERROR_H_ */