File indexing completed on 2024-05-12 16:01:30

 /*
  *  SPDX-FileCopyrightText: 2014 Dmitry Kazakov <dimula73@gmail.com>
  *
  *  SPDX-License-Identifier: GPL-2.0-or-later
  */
 
 #ifndef __KIS_DEFERRED_SIGNAL_H
 #define __KIS_DEFERRED_SIGNAL_H
 
 #include <QObject>
 
 #include <functional>
 
 /**
  * \class KisDeferredSignal
  *        \brief This class is used for calling a specified callback
  *        function (which is a std::function) after a specified time
  *        delay. The callback is called from the QTimer event, so the
  *        usage of the class does not block the Qt's event loop.
  *
  *        Usage:
  *
  *        \code{.cpp}
  *
  *        // prepare the callback function
  *        std::function<void ()> callback(
  *            std::bind(&KisCanvas2::setMonitorProfile, this,
  *                        monitorProfile, renderingIntent, conversionFlags));
  *
  *        // create the timer connected to the function
  *        KisDeferredSignal::deferSignal(1000, callback);
  *
  *        \endcode
  *
  *        TODO: rename KisDeferredSignal -> KisDeferredCallback
  */
 class KisDeferredSignal : public QObject
 {
     Q_OBJECT
 public:
     using CallbackFunction = std::function<void ()>;
 
 public:
     /**
      * Creates a timer which will call \p function after \p delay
      * milliseconds
      */
     static void deferSignal(int delay, CallbackFunction function);
 
 private Q_SLOTS:
     void timeout();
 
 private:
     KisDeferredSignal(int delay, CallbackFunction function);
 
 private:
     CallbackFunction m_function;
 };
 
 #endif /* __KIS_DEFERRED_SIGNAL_H */