src/Events/Events_LongOp.h

   1 // Copyright (C) 2014-2022  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef EVENTS_LONGOP_H_
  21 #define EVENTS_LONGOP_H_
  22
  23 #include <Events.h>
  24 #include <Events_Message.h>
  25
  26 /**
  27  * Informs the application that the long operation is performed.
  28  * Causes waiting coursor in GUI.
  29  */
  30 class EVENTS_EXPORT Events_LongOp : public Events_Message
  31 {
  32 public:
  33   /// Default destructor
  34   virtual ~Events_LongOp();
  35   /// Returns the identifier of this event
  36   static Events_ID eventID();
  37   /// Starts the long operation
  38   static void start(void* theSender = 0);
  39   /// Stops the long operation
  40   static void end(void* theSender = 0);
  41   /// Returns true if the long operation is performed
  42   static bool isPerformed();
  43
  44 protected:
  45   /// Default constructor. Use "start" and "end" for generation.
  46   Events_LongOp(void* theSender = 0);
  47 };
  48
  49 #endif /* EVENTS_ERROR_H_ */