1/****************************************************************************
2**
3** Copyright (C) 2017 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the documentation of the Qt Toolkit.
7**
8** $QT_BEGIN_LICENSE:FDL$
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 Free Documentation License Usage
18** Alternatively, this file may be used under the terms of the GNU Free
19** Documentation License version 1.3 as published by the Free Software
20** Foundation and appearing in the file included in the packaging of
21** this file. Please review the following information to ensure
22** the GNU Free Documentation License version 1.3 requirements
23** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
24** $QT_END_LICENSE$
25**
26****************************************************************************/
27
28/*!
29\page location-cpp-qml.html
30\title Interfaces between C++ and QML Code in Qt Location
31
32\brief Some of the location QML types providing interfaces to access and modify properties in C++.
33
34\section2 Category - QPlaceCategory
35The \l {Category::category} {Category.category} property is used to provide an interface between C++ and QML code.  First a pointer to a
36Category object must be obtained from C++, then use the \l {QObject::property()}{property()} and
37\l {QObject::setProperty()}{setProperty()} functions to get and set the \c category property.
38The following gets the QPlaceCategory representing this object from C++:
39\snippet cpp/cppqml.cpp Category get
40The following sets the properties of this object based on a QPlaceCategory object from C++:
41\snippet cpp/cppqml.cpp Category set
42
43
44\section2 ContactDetail - QDeclarativeContactDetail
45The \l {ContactDetail::contactDetail} {ContactDetail.contactDetail} property is used to provide an interface between C++ and QML code.  First a pointer to a ContactDetail object must be obtained from C++, then use the
46\l {QObject::property()}{property()} and \l {QObject::setProperty()}{setProperty()} functions
47to get and set the \c contactDetail property.
48The following gets the QPlaceContactDetail representing this object from C++:
49\snippet cpp/cppqml.cpp ContactDetail get
50The following sets the properties of this object based on a QPlaceContactDetail object from
51C++:
52\snippet cpp/cppqml.cpp ContactDetail set
53
54
55\section2  Place - QPlace
56The \l {Place::place} {Place.place} property is used to provide an interface between C++ and QML code.  First a pointer to a Place object must be obtained from C++, then use the
57\l {QObject::property()}{property()} and \l {QObject::setProperty()}{setProperty()} functions
58to get and set the \c place property.
59The following gets the QPlace representing this object from C++:
60\snippet cpp/cppqml.cpp Place get
61The following sets the properties of this object based on a QPlace object from C++:
62\snippet cpp/cppqml.cpp Place set
63
64
65
66\section2  PlaceAttribute - QPlaceAttribute
67The \l {PlaceAttribute::attribute} {PlaceAttribute.attribute} property is used to provide an interface between C++ and QML code.  First a pointer to a
68PlaceAttribute object must be obtained from C++, then use the
69\l {QObject::property()}{property()} and \l {QObject::setProperty()}{setProperty()} functions
70to get and set the \c attribute property.
71The following gets the QPlaceAttribute representing this object from C++:
72\snippet cpp/cppqml.cpp PlaceAttribute get
73The following sets the properties of this object based on a QPlaceAttribute object from C++:
74\snippet cpp/cppqml.cpp PlaceAttribute set
75
76
77\section2 Icon - QPlaceIcon
78The \l {Icon::icon} {Icon.icon} property is used to provide an interface between C++ and QML code.  First a pointer to a Icon object must be obtained from C++, then use the \l {QObject::property()}{property()} and
79\l {QObject::setProperty()}{setProperty()} functions to get and set the \c icon property.
80The following gets the QPlaceIcon representing this object from C++:
81\snippet cpp/cppqml.cpp Icon get
82The following sets the properties of this object based on a QPlaceIcon object from C++:
83\snippet cpp/cppqml.cpp Icon set
84
85
86\section2 User - QPlaceUser
87The \l {User::user} {User.user} property is used to provide an interface between C++ and QML code.  First a pointer to a
88User object must be obtained from C++, then use the \l {QObject::property()}{property()} and
89\l {QObject::setProperty()}{setProperty()} functions to get and set the \c user property.
90The following gets the QPlaceUser representing this object from C++:
91\snippet cpp/cppqml.cpp User get
92The following sets the properties of this object based on a QPlaceUser object from C++:
93\snippet cpp/cppqml.cpp User set
94
95
96\section2 Ratings - QPlaceRatings
97The \l {Ratings::ratings} {Ratings.ratings} property is used to provide an interface between C++ and QML code.  First a pointer to a
98Ratings object must be obtained from C++, then use the \l {QObject::property()}{property()} and
99\l {QObject::setProperty()}{setProperty()} functions to get and set the \c ratings property.
100The following gets the QPlaceRating representing this object from C++:
101\snippet cpp/cppqml.cpp Ratings get
102The following sets the properties of this object based on a QPlaceRatings object from C++:
103\snippet cpp/cppqml.cpp Ratings set
104
105
106\section2 Supplier - QPlaceSupplier
107The \l {Supplier::supplier} {Supplier.supplier} property is used to provide an interface between C++ and QML code.  First a pointer to a
108Supplier object must be obtained from C++, then use the \l {QObject::property()}{property()} and
109\l {QObject::setProperty()}{setProperty()} functions to get and set the \c supplier property.
110The following gets the QPlaceSupplier representing this object from C++:
111\snippet cpp/cppqml.cpp Supplier get
112The following sets the properties of this object based on a QPlaceSupplier object from C++:
113\snippet cpp/cppqml.cpp Supplier set
114
115*/
116