summaryrefslogtreecommitdiff
path: root/src/tools/ivigenerator/templates/frontend/interface.h.tpl
diff options
context:
space:
mode:
Diffstat (limited to 'src/tools/ivigenerator/templates/frontend/interface.h.tpl')
-rw-r--r--src/tools/ivigenerator/templates/frontend/interface.h.tpl140
1 files changed, 140 insertions, 0 deletions
diff --git a/src/tools/ivigenerator/templates/frontend/interface.h.tpl b/src/tools/ivigenerator/templates/frontend/interface.h.tpl
new file mode 100644
index 0000000..e1dc448
--- /dev/null
+++ b/src/tools/ivigenerator/templates/frontend/interface.h.tpl
@@ -0,0 +1,140 @@
+{#
+# Copyright (C) 2019 Luxoft Sweden AB
+# Copyright (C) 2018 Pelagicore AG.
+# Contact: https://www.qt.io/licensing/
+#
+# This file is part of the QtIvi module of the Qt Toolkit.
+#
+# $QT_BEGIN_LICENSE:LGPL-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 Lesser General Public License Usage
+# Alternatively, this file may be used under the terms of the GNU Lesser
+# General Public License version 3 as published by the Free Software
+# Foundation and appearing in the file LICENSE.LGPL3 included in the
+# packaging of this file. Please review the following information to
+# ensure the GNU Lesser General Public License version 3 requirements
+# will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+#
+# GNU General Public License Usage
+# Alternatively, this file may be used under the terms of the GNU
+# General Public License version 2.0 or (at your option) the GNU General
+# Public license version 3 or 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.GPL2 and 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-2.0.html and
+# https://www.gnu.org/licenses/gpl-3.0.html.
+#
+# $QT_END_LICENSE$
+#
+# SPDX-License-Identifier: LGPL-3.0
+#}
+{% import 'common/qtivi_macros.j2' as ivi %}
+{% set class = '{0}'.format(interface) %}
+{% if interface.tags.config.zoned %}
+{% set base_class = 'QIviAbstractZonedFeature' %}
+{% else %}
+{% set base_class = 'QIviAbstractFeature' %}
+{% 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.tpl' %}
+
+#ifndef {{oncedefine}}
+#define {{oncedefine}}
+
+{% if interface.module.tags.config.module %}
+#include <{{interface.module.tags.config.module}}/{{module.module_name|lower}}module.h>
+{% else %}
+#include "{{module.module_name|lower}}module.h"
+{% endif %}
+
+{% for inc in interface|struct_includes %}
+{{inc}}
+{% endfor %}
+
+#include <QtIviCore/{{base_class}}>
+#include <QtIviCore/QIviPendingReply>
+#include <QtIviCore/QIviPagingModel>
+
+QT_BEGIN_NAMESPACE
+
+class {{class}}Private;
+class {{class}}BackendInterface;
+
+class {{exportsymbol}} {{class}} : public {{base_class}}
+{
+ Q_OBJECT
+{% for property in interface.properties %}
+ {{ivi.property(property)}}
+{% endfor %}
+ Q_CLASSINFO("IviPropertyDomains", "{{ interface.properties|json_domain|replace("\"", "\\\"") }}")
+
+public:
+{% if interface.tags.config.zoned %}
+ explicit {{class}}(const QString &zone = QString(), QObject *parent = nullptr);
+{% else %}
+ explicit {{class}}(QObject *parent = nullptr);
+{% endif %}
+ ~{{class}}();
+
+ static void registerQmlTypes(const QString& uri, int majorVersion={{interface.module.majorVersion}}, int minorVersion={{interface.module.minorVersion}});
+
+{% for property in interface.properties %}
+ {{ivi.prop_getter(property)}};
+{% endfor %}
+
+public Q_SLOTS:
+{% for operation in interface.operations %}
+ {{ ivi.operation(operation) }};
+{% endfor %}
+{% for property in interface.properties %}
+{% if not property.readonly and not property.const and not property.type.is_model %}
+ {{ivi.prop_setter(property)}};
+{% endif %}
+{% endfor %}
+
+Q_SIGNALS:
+{% for signal in interface.signals %}
+ {{ivi.signal(signal)}};
+{% endfor %}
+{% for property in interface.properties %}
+ {{ivi.prop_notify(property)}};
+{% endfor %}
+
+protected:
+{% if interface.tags.config.zoned %}
+ QIviAbstractZonedFeature *createZoneFeature(const QString &zone) Q_DECL_OVERRIDE;
+{% endif %}
+ {{class}}BackendInterface *{{interface|lower}}Backend() const;
+
+ void connectToServiceObject(QIviServiceObject *service) Q_DECL_OVERRIDE;
+ void clearServiceObject() Q_DECL_OVERRIDE;
+
+private:
+{% if module.tags.config.disablePrivateIVI %}
+ friend class {{class}}Private;
+ {{class}}Private *m_helper;
+{% else %}
+{% for property in interface.properties %}
+{% if interface.tags.config.zoned %}
+ Q_PRIVATE_SLOT(d_func(), {{ivi.on_prop_changed(property, "", true, true)}})
+{% else %}
+ Q_PRIVATE_SLOT(d_func(), {{ivi.on_prop_changed(property, "", false, true)}})
+{% endif %}
+{% endfor %}
+ Q_DECLARE_PRIVATE({{class}})
+{% endif %}
+};
+
+QT_END_NAMESPACE
+
+#endif // {{oncedefine}}