aboutsummaryrefslogtreecommitdiffstats
path: root/src/datasources/examplesdatasource.h
blob: 19b57791279b948e0ab1b99527f2d5c047f9743d (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
61
62
63
64
65
66
67
68
69
/****************************************************************************
**
** Copyright (C) 2019 The Qt Company
** Contact: https://www.qt.io/licensing/
**
** This file is part of UsageStatistic plugin for Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/
#pragma once

#include <QtCore/QSet>

#include <KUserFeedback/AbstractDataSource>

namespace UsageStatistic {
namespace Internal {

//! Tracks which examples were opened by the user
class ExamplesDataSource : public QObject, public KUserFeedback::AbstractDataSource
{
    Q_OBJECT

public:
    ExamplesDataSource();
    ~ExamplesDataSource() override;

public: // AbstractDataSource interface
    QString name() const override;
    QString description() const override;

    /*! The output data format is:
     *  {
     *      "examples": []
     *  }
     *
     *  The array contains paths like "widgets/mainwindows/application/application.pro".
     *  Full paths aren't collected.
     */
    QVariant data() override;

    void loadImpl(QSettings *settings) override;
    void storeImpl(QSettings *settings) override;
    void resetImpl(QSettings *settings) override;

private: // Methods
    void updateOpenedExamples();

private: // Data
    QSet<QString> m_examplePaths;
};

} // namespace Internal
} // namespace UsageStatistic