aboutsummaryrefslogtreecommitdiff
path: root/libcontextsubscriber/src/iproviderplugin.h
blob: 79ba9da5500e3facd758be2f3ccddb75d3824fe2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
/*
 * Copyright (C) 2008, 2009 Nokia Corporation.
 *
 * Contact: Marius Vollmer <marius.vollmer@nokia.com>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public License
 * version 2.1 as published by the Free Software Foundation.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA
 *
 */

#ifndef IPROVIDERPLUGIN_H
#define IPROVIDERPLUGIN_H

#include "timedvalue.h"

#include <QObject>
#include <QVariant>

namespace ContextSubscriber {

/* This is not a public API of ContextKit, please do not write third
 * party plugins for the ContextKit client library without first
 * contacting us.
 */

class IProviderPlugin : public QObject
{
    Q_OBJECT
public:
    virtual void subscribe(QSet<QString> keys) = 0;
    virtual void unsubscribe(QSet<QString> keys) = 0;
    virtual void waitUntilReadyAndBlock() { }
    virtual void waitForSubscriptionAndBlock(const QString& key) { }

Q_SIGNALS:
    void ready();
    void failed(QString error);
    void subscribeFinished(QString key);
    void subscribeFinished(QString key, TimedValue timedvalue);
    void subscribeFailed(QString failedKey, QString error);
    void valueChanged(QString key, QVariant value);
    void valueChanged(QString key, TimedValue timedvalue);
};

typedef IProviderPlugin* (*PluginFactoryFunc)(QString constructionString);

}

#endif