src/Events/Events_LongOp.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef EVENTS_LONGOP_H_
  22 #define EVENTS_LONGOP_H_
  23
  24 #include <Events.h>
  25 #include <Events_Message.h>
  26
  27 /**
  28  * Informs the application that the long operation is performed.
  29  * Causes waiting coursor in GUI.
  30  */
  31 class EVENTS_EXPORT Events_LongOp : public Events_Message
  32 {
  33 public:
  34   /// Default destructor
  35   virtual ~Events_LongOp();
  36   /// Returns the identifier of this event
  37   static Events_ID eventID();
  38   /// Starts the long operation
  39   static void start(void* theSender = 0);
  40   /// Stops the long operation
  41   static void end(void* theSender = 0);
  42   /// Returns true if the long operation is performed
  43   static bool isPerformed();
  44
  45 protected:
  46   /// Default constructor. Use "start" and "end" for generation.
  47   Events_LongOp(void* theSender = 0);
  48 };
  49
  50 #endif /* EVENTS_ERROR_H_ */