1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the Qt Designer of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:GPL-EXCEPT$
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 General Public License Usage
18** Alternatively, this file may be used under the terms of the GNU
19** General Public License version 3 as published by the Free Software
20** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
21** included in the packaging of this file. Please review the following
22** information to ensure the GNU General Public License requirements will
23** be met: https://www.gnu.org/licenses/gpl-3.0.html.
24**
25** $QT_END_LICENSE$
26**
27****************************************************************************/
28
29#ifndef ASSISTANTCLIENT_H
30#define ASSISTANTCLIENT_H
31
32#include <QtCore/qprocess.h>
33
34QT_BEGIN_NAMESPACE
35
36class QString;
37
38class AssistantClient : public QObject
39{
40 Q_OBJECT
41
42public:
43 AssistantClient();
44 ~AssistantClient();
45
46 bool showPage(const QString &path, QString *errorMessage);
47 bool activateIdentifier(const QString &identifier, QString *errorMessage);
48 bool activateKeyword(const QString &keyword, QString *errorMessage);
49
50 bool isRunning() const;
51
52 static QString documentUrl(const QString &prefix, int qtVersion = 0);
53 // Root of the Qt Designer documentation
54 static QString designerManualUrl(int qtVersion = 0);
55 // Root of the Qt Reference documentation
56 static QString qtReferenceManualUrl(int qtVersion = 0);
57
58private slots:
59 void readyReadStandardError();
60 void processTerminated(int exitCode, QProcess::ExitStatus exitStatus);
61
62private:
63 static QString binary();
64 bool sendCommand(const QString &cmd, QString *errorMessage);
65 bool ensureRunning(QString *errorMessage);
66
67 QProcess *m_process = nullptr;
68};
69
70QT_END_NAMESPACE
71
72#endif // ASSISTANTCLIENT_H
73

source code of qttools/src/designer/src/designer/assistantclient.h