blob: e45cedba42a3582e6663486d49205f82b6796090 (
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
108
109
110
111
112
113
114
115
116
117
118
119
|
/****************************************************************************
**
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtLocation module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt 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$
**
****************************************************************************/
#include "qdeclarativecontactdetails_p.h"
#include <QPlaceContactDetail>
QT_BEGIN_NAMESPACE
/*!
\qmltype ContactDetails
\instantiates QDeclarativeContactDetails
\inqmlmodule QtLocation
\ingroup qml-QtLocation5-places
\ingroup qml-QtLocation5-places-data
\since QtLocation 5.5
\brief The ContactDetails type holds contact details for a \l Place.
The ContactDetails type is a map of \l contactDetail objects.
To access contact details in the map use the \l keys() method to get the list of keys stored in
the map and then use the \c {[]} operator to access the \l contactDetail items.
The following keys are defined in the API. \l Plugin implementations are free to define
additional keys.
\list
\li phone
\li fax
\li email
\li website
\endlist
ContactDetails instances are only ever used in the context of \l {Place}{Places}. It is not possible
to create a ContactDetails instance directly or re-assign ContactDetails instances to \l {Place}{Places}.
Modification of ContactDetails can only be accomplished via Javascript.
\section1 Examples
The following example shows how to access all \l {contactDetail}{contact details}
and print them to the console:
\snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml ContactDetails read
The returned list of contact details is an \l {QObjectList-based model}{object list} and so can be used directly as a data model. For example, the
following demonstrates how to display a list of contact phone numbers in a list view:
\snippet declarative/places.qml QtQuick import
\snippet declarative/maps.qml QtLocation import
\codeline
\snippet declarative/places.qml ContactDetails phoneList
The following example demonstrates how to assign a single phone number to a place in JavaScript:
\snippet declarative/places.qml ContactDetails write single
The following demonstrates how to assign multiple phone numbers to a place in JavaScript:
\snippet declarative/places.qml ContactDetails write multiple
*/
/*!
\qmlmethod variant ContactDetails::keys()
Returns an array of contact detail keys currently stored in the map.
*/
QDeclarativeContactDetails::QDeclarativeContactDetails(QObject *parent)
: QQmlPropertyMap(parent)
{
}
QVariant QDeclarativeContactDetails::updateValue(const QString &, const QVariant &input)
{
if (input.metaType() == QMetaType::fromType<QPlaceContactDetail>()) {
QVariantList varList;
varList.append(input);
return varList;
}
return input;
}
QT_END_NAMESPACE
|
