summaryrefslogtreecommitdiffstats
path: root/src/tools/ifcodegen/templates/frontend/interface.h.jinja
blob: 79cd04353304ce23a3c8381e80267c5916417818 (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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
{#
# Copyright (C) 2021 The Qt Company Ltd.
# Copyright (C) 2019 Luxoft Sweden AB
# Copyright (C) 2018 Pelagicore AG
# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
#}
{% import 'common/qtif_macros.jinja' as qtif %}
{% set class = '{0}'.format(interface) %}
{% if interface.tags.config.zoned %}
{%   set base_class = 'QIfAbstractZonedFeature' %}
{% else %}
{%   set base_class = 'QIfAbstractFeature' %}
{% endif %}
{% set oncedefine = '{0}_{1}_H_'.format(module.module_name|upper, class|upper) %}
{% set exportsymbol = 'Q_{0}_EXPORT'.format(module|upper|replace('.', '_')) %}
{% include 'common/generated_comment.cpp.jinja' %}

#ifndef {{oncedefine}}
#define {{oncedefine}}

{% if interface.module.tags.config.module %}
#include <{{interface.module.tags.config.module}}/{{module.module_name|lower}}.h>
{% else %}
#include "{{module.module_name|lower}}.h"
{% endif %}

{% for inc in interface|struct_includes %}
{{inc}}
{% endfor %}

#include <QtInterfaceFramework/{{base_class}}>
#include <QtInterfaceFramework/QIfPendingReply>
#include <QtInterfaceFramework/QIfPagingModel>

{{ module|begin_namespace }}

class {{class}}Private;
class {{class}}BackendInterface;

class {{exportsymbol}} {{class}} : public {{base_class}}
{
    Q_OBJECT
    QML_NAMED_ELEMENT({{interface|qml_type}})
{% for property in interface.properties %}
    {{qtif.property(property)}}
{% endfor %}

public:
{% if interface.tags.config.zoned %}
    explicit {{class}}(const QString &zone = QString(), QObject *parent = nullptr);
{% else %}
    explicit {{class}}(QObject *parent = nullptr);
{% endif %}
    ~{{class}}() override;

    static void registerQmlTypes(const QString& uri, int majorVersion={{interface.module.majorVersion}}, int minorVersion={{interface.module.minorVersion}});

{% for property in interface.properties %}
    {{qtif.prop_getter(property)}};
{% endfor %}

public Q_SLOTS:
{% for operation in interface.operations %}
    {{ qtif.operation(operation) }};
{% endfor %}
{% for property in interface.properties %}
{%   if not property.readonly and not property.const and not property.type.is_model %}
    {{qtif.prop_setter(property)}};
{%   endif %}
{% endfor %}

Q_SIGNALS:
{% for signal in interface.signals %}
    {{qtif.signal(signal)}};
{% endfor %}
{% for property in interface.properties %}
    {{qtif.prop_notify(property)}};
{% endfor %}

protected:
{% if interface.tags.config.zoned %}
    QIfAbstractZonedFeature *createZoneFeature(const QString &zone) Q_DECL_OVERRIDE;
{% endif %}
    {{class}}BackendInterface *{{interface|lower}}Backend() const;

    void connectToServiceObject(QIfServiceObject *service) Q_DECL_OVERRIDE;
    void clearServiceObject() Q_DECL_OVERRIDE;

private:
{% if module.tags.config.disablePrivateIF %}
    friend class {{class}}Private;
    {{class}}Private *m_helper;
{% else %}
{% for property in interface.properties %}
{%   if interface.tags.config.zoned %}
    Q_PRIVATE_SLOT(d_func(), {{qtif.on_prop_changed(property, "", true, true)}})
{%   else %}
    Q_PRIVATE_SLOT(d_func(), {{qtif.on_prop_changed(property, "", false, true)}})
{%   endif %}
{% endfor %}
    Q_DECLARE_PRIVATE({{class}})
{% endif %}
};

{{ module|end_namespace }}

#endif // {{oncedefine}}