Akonadi

agentfactory.h
1 /*
2  This file is part of akonadiresources.
3 
4  Copyright (c) 2006 Till Adam <[email protected]>
5  Copyright (c) 2007 Volker Krause <[email protected]>
6 
7  This library is free software; you can redistribute it and/or modify it
8  under the terms of the GNU Library General Public License as published by
9  the Free Software Foundation; either version 2 of the License, or (at your
10  option) any later version.
11 
12  This library is distributed in the hope that it will be useful, but WITHOUT
13  ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14  FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
15  License for more details.
16 
17  You should have received a copy of the GNU Library General Public License
18  along with this library; see the file COPYING.LIB. If not, write to the
19  Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
20  02110-1301, USA.
21 */
22 
23 #ifndef AKONADI_AGENTFACTORY_H
24 #define AKONADI_AGENTFACTORY_H
25 
26 #include "akonadiagentbase_export.h"
27 #include "agentbase.h"
28 
29 #include <QObject>
30 
31 namespace Akonadi
32 {
33 
34 class AgentFactoryBasePrivate;
35 
43 class AKONADIAGENTBASE_EXPORT AgentFactoryBase : public QObject
44 {
45  Q_OBJECT
46 
47 public:
55  explicit AgentFactoryBase(const char *catalogName, QObject *parent = nullptr);
56 
57  ~AgentFactoryBase() override;
58 
59 public Q_SLOTS:
63  virtual QObject *createInstance(const QString &identifier) const = 0;
64 
65 protected:
66  void createComponentData(const QString &identifier) const;
67 
68 private:
69  AgentFactoryBasePrivate *const d;
70 };
71 
79 template <typename T>
81 {
82 public:
84  explicit AgentFactory(const char *catalogName, QObject *parent = nullptr)
85  : AgentFactoryBase(catalogName, parent)
86  {
87  }
88 
89  QObject *createInstance(const QString &identifier) const override
90  {
91  createComponentData(identifier);
92  T *instance = new T(identifier);
93 
94  // check if T also inherits AgentBase::Observer and
95  // if it does, automatically register it on itself
96  Akonadi::AgentBase::Observer *observer = dynamic_cast<Akonadi::AgentBase::Observer *>(instance);
97  if (observer != nullptr) {
98  instance->registerObserver(observer);
99  }
100 
101  return instance;
102  }
103 };
104 
105 }
106 
107 #endif
A factory base class for in-process agents.
Definition: agentfactory.h:43
The interface for reacting on monitored or replayed changes.
Definition: agentbase.h:190
AgentFactory(const char *catalogName, QObject *parent=nullptr)
reimplemented
Definition: agentfactory.h:84
A factory for in-process agents.
Definition: agentfactory.h:80
Helper integration between Akonadi and Qt.
QObject * createInstance(const QString &identifier) const override
Creates a new agent instance with the given identifier.
Definition: agentfactory.h:89
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Wed May 27 2020 22:43:36 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.