File indexing completed on 2023-10-01 04:11:43

 /*
     SPDX-FileCopyrightText: 2012 Aaron Seigo <aseigo@kde.org>
 
     SPDX-License-Identifier: LGPL-2.0-or-later
 */
 
 #ifndef PLASMA_DATAENGINECONSUMER_H
 #define PLASMA_DATAENGINECONSUMER_H
 
 #include <QUrl>
 
 #include <plasma/plasma_export.h>
 
 namespace Plasma
 {
 class DataEngine;
 class DataEngineConsumerPrivate;
 
 /**
  * @class DataEngineConsumer plasma/dataengineconsumer.h <Plasma/DataEngineConsumer>
  *
  * @brief A class that makes it safe and easy to use DataEngines
  *
  * DataEngineConsumer provides access to DataEngines, which are internally reference
  * counted and shared between all users of them. The only public method provided is
  * dataEngine which returns engines upon request.
  *
  * When the DataEngineConsumer class is deleted, all engines accessed using it are
  * de-referenced and possibly deleted (in the case that there are no other users of
  * the engine in question).
  *
  * DataEngineConsumer can be subclassed by other C++ classes to allow this simple
  * API to be used directly from these classes in a convenient manner.
  **/
 class PLASMA_EXPORT DataEngineConsumer
 {
 public:
     /**
      * Constructs a DataEngineConsumer
      **/
     DataEngineConsumer();
     ~DataEngineConsumer();
 
     /**
      * Returns a Plasma::DataEngine. It never returns a null pointer, and the
      * DataEngine returned should not be deleted. All DataEngines will be dereferenced
      * once this DataEngineConsumer instance is deleted.
      *
      * It is safe and fast to request the same engine more than once.
      *
      * @param name the name of the DataEngine. This corresponds to the plugin name
      *             of the DataEngine.
      */
     DataEngine *dataEngine(const QString &name);
 
 private:
     DataEngineConsumerPrivate *const d;
 };
 
 } // namespace Plasma
 
 #endif