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 QtQml module of the Qt Toolkit.
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
41#ifndef QQMLPREVIEWCLIENT_P_H
42#define QQMLPREVIEWCLIENT_P_H
43
44//
45// W A R N I N G
46// -------------
47//
48// This file is not part of the Qt API. It exists purely as an
49// implementation detail. This header file may change from version to
50// version without notice, or even be removed.
51//
52// We mean it.
53//
54
55#include <private/qqmldebugclient_p.h>
56#include <private/qqmldebugconnection_p.h>
57
58QT_BEGIN_NAMESPACE
59
60class QQmlPreviewClientPrivate;
61class QQmlPreviewClient : public QQmlDebugClient
62{
63 Q_OBJECT
64 Q_DECLARE_PRIVATE(QQmlPreviewClient)
65public:
66 enum Command {
67 File,
68 Load,
69 Request,
70 Error,
71 Rerun,
72 Directory,
73 ClearCache,
74 Zoom,
75 Fps,
76 Language
77 };
78
79 struct FpsInfo {
80 quint16 numSyncs = 0;
81 quint16 minSync = std::numeric_limits<quint16>::max();
82 quint16 maxSync = 0;
83 quint16 totalSync = 0;
84
85 quint16 numRenders = 0;
86 quint16 minRender = std::numeric_limits<quint16>::max();
87 quint16 maxRender = 0;
88 quint16 totalRender = 0;
89 };
90
91 QQmlPreviewClient(QQmlDebugConnection *parent);
92 void messageReceived(const QByteArray &message) override;
93
94 void sendDirectory(const QString &path, const QStringList &entries);
95 void sendFile(const QString &path, const QByteArray &contents);
96 void sendError(const QString &path);
97
98 void triggerLoad(const QUrl &url);
99 void triggerRerun();
100 void triggerZoom(float factor);
101 void triggerLanguage(const QUrl &url, const QString &locale);
102
103signals:
104 void request(const QString &path);
105 void error(const QString &message);
106 void fps(const FpsInfo &info);
107};
108
109QT_END_NAMESPACE
110
111#endif // QQMLPREVIEWCLIENT_P_H
112

source code of qtdeclarative/src/qmldebug/qqmlpreviewclient_p.h