aboutsummaryrefslogtreecommitdiffstats
path: root/doc/examples/customruntime.qdoc
blob: 58edada5f20fc8edbd9f417b6ac10754535a8453 (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
/****************************************************************************
**
** Copyright (C) 2019 Luxoft Sweden AB
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QmlLive tool.
**
** $QT_BEGIN_LICENSE:GPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite 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 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** 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.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: GPL-3.0
**
****************************************************************************/
/*!
\example customruntime
\title Custom Runtime Example

\brief Demonstrates how to create a Custom QmlLive Runtime.

\image customruntime-example.png Screenshot of the Custom QmlLive Runtime

Creating a custom runtime with QmlLive features allows you to use your QML
view setup, combined with additional C++ code and the QmlLive system.

Start with the \l LiveNodeEngine class. We need to modify this class to be
able to receive workspace changes and active document updates. By default,
the IPC listens to port 10234.

The code snippet below shows a minimal custom QmlLive runtime:

\snippet customruntime/main.cpp 0

To specify project depedencies on platforms that support \c pkg-config,
add the following line to your project file. This is assuming QmlLive is
installed on your build host:

\code
CONFIG += link_pkgconfig
PKGCONFIG += qmllive
\endcode

In case if your system doesn't support \c pkg-config, to compile everything
directly into your application, include file \c{$(QMLLIVEPROJECT)/src/src.pri}
by adding the line into your project file:

\code
include(src.pri)
\endcode
*/