1/****************************************************************************
2**
3** Copyright (C) 2018 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QML preview debug service.
7**
8** $QT_BEGIN_LICENSE:LGPL$
9** Commercial License Usage
10** Licensees holding valid commercial Qt licenses may use this file in
11** accordance with the commercial license agreement provided with the
12** Software or, alternatively, in accordance with the terms contained in
13** a written agreement between you and The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
17** GNU Lesser General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU Lesser
19** General Public License version 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40#ifndef QQMLPREVIEWSERVICE_H
41#define QQMLPREVIEWSERVICE_H
42
43//
44// W A R N I N G
45// -------------
46//
47// This file is not part of the Qt API. It exists purely as an
48// implementation detail. This header file may change from version to
49// version without notice, or even be removed.
50//
51// We mean it.
52//
53
54#include "qqmlpreviewhandler.h"
55#include "qqmlpreviewfileengine.h"
56#include <private/qqmldebugserviceinterfaces_p.h>
57
58QT_BEGIN_NAMESPACE
59
60class QQmlPreviewFileEngineHandler;
61class QQmlPreviewHandler;
62class QQmlPreviewServiceImpl : public QQmlDebugService
63{
64 Q_OBJECT
65
66public:
67 enum Command {
68 File,
69 Load,
70 Request,
71 Error,
72 Rerun,
73 Directory,
74 ClearCache,
75 Zoom,
76 Fps,
77 Language
78 };
79
80 static const QString s_key;
81
82 QQmlPreviewServiceImpl(QObject *parent = nullptr);
83 virtual ~QQmlPreviewServiceImpl();
84
85 void messageReceived(const QByteArray &message) override;
86 void engineAboutToBeAdded(QJSEngine *engine) override;
87 void engineAboutToBeRemoved(QJSEngine *engine) override;
88 void stateChanged(State state) override;
89
90 void forwardRequest(const QString &file);
91 void forwardError(const QString &error);
92 void forwardFps(const QQmlPreviewHandler::FpsInfo &frames);
93
94signals:
95 void error(const QString &file);
96 void file(const QString &file, const QByteArray &contents);
97 void directory(const QString &file, const QStringList &entries);
98 void load(const QUrl &url);
99 void rerun();
100 void clearCache();
101 void zoom(qreal factor);
102#if QT_CONFIG(translation)
103 void language(const QUrl &context, const QLocale &locale);
104#endif
105
106private:
107 QScopedPointer<QQmlPreviewFileEngineHandler> m_fileEngine;
108 QScopedPointer<QQmlPreviewFileLoader> m_loader;
109 QQmlPreviewHandler m_handler;
110 QUrl m_currentUrl;
111};
112
113QT_END_NAMESPACE
114
115#endif // QQMLPREVIEWSERVICE_H
116

source code of qtdeclarative/src/plugins/qmltooling/qmldbg_preview/qqmlpreviewservice.h