blob: 06d30274a07e6aa7b299df7cbce956bce2aa6a07 (
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
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
|
/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** 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 Digia. For licensing terms and
** conditions see http://qt.digia.com/licensing. For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: http://www.gnu.org/copyleft/fdl.html.
** $QT_END_LICENSE$
**
****************************************************************************/
/*!
\group qml-contacts
\title QML Contacts
QML Support for the QtMobility Project Contacts API.
*/
/*!
\page qml-contacts.html
\title Contacts QML Plugin
\brief A QML plugin for the QtMobility Project Contacts API.
\section1 Overview
The identifying string for this component is \i {"QtMobility.contacts"}.
Use this in the QML \i {import} statement.
The Contacts QML plugin supplies filters to search for contacts
with particular values for various properties in the contact details. The Contact itself
is represented by a model called a \l {ContactModel}.
This model supplies a rich selection of properties to display or to use
as filter criteria. We can also construct a series of filters and combine
them using the \l {IntersectionFilter} and \l {UnionFilter}
to represent a logical 'and' and 'or' of the results. Other properties also give
control over the filter logic, such as \l {DetailRangeFilter::rangeFlags} {RangeFlags}
and the \l {DetailFilter::matchFlags}{MatchFlags}.
\section2 ContactModel element
The \l ContactModel element is used to perform the requests on a contacts store.
As an example consider the follow QML code which has a \l ContactModel element
containing a filter and a list of sort orders. The contacts will be restricted
to those living in Australia who are either male or born between 1970 and 1984.
The list of contacts in this ContactModel will firstly sort on the contacts' organization name
and then sort on the contacts' first name.
\code
import QtMobility.contacts 1.1
...
model: ContactModel {
filter: IntersectionFilter {
DetailFilter {
detail:ContactDetail.Address
field: Address.Country
value: "Australia"
}
UnionFilter {
DetailRangeFilter {
detail:ContactDetail.Birthday
field:Birthday.Birthday
min: '1970-01-01'
max: '1984-12-31'
}
DetailFilter {
detail:ContactDetail.Gender
field:Gender.Gender
value:Gender.Male
}
}
}
sortOrders: [
SortOrder {
detail:ContactDetail.Organization
field:Organization.Name
direction:Qt.AscendingOrder
},
SortOrder {
detail:ContactDetail.Name
field:Name.FirstName
direction:Qt.AscendingOrder
}
]
}
\endcode
\section2 Contact element
The \l {Contact} element represents a single contact instance from a the contacts store.
All contact details are organized as group properties. The following snippet shows how
you can construct a Contact object in QML:
\code
Rectangle {
id: topItem
width: 360
height: 640
x: 0
y: 0
Contact {
id: myContact
Name {
firstName:"John"
lastName:"Gates"
}
EmailAddress {
emailAddress:"john@example.com"
}
EmailAddress {
emailAddress:"mygmailaccount@gmail.com"
}
address.street:"53 Mysteet St"
address.locality: "My City"
address.region: "My Region"
address.postcode:"1111"
address.country:"My Country"
address.subTypes:[Address.Postal, Address.Domestic]
address.postOfficeBox:"1111"
Nickname {
nickname:"John"
}
PhoneNumber {
number: "1111111111"
subTypes:[PhoneNumber.Mobile]
}
PhoneNumber {
number: "2222222222"
subTypes:[PhoneNumber.Fax]
}
PhoneNumber {
number: "3333333333"
subTypes:[PhoneNumber.Landline]
}
}
Column {
spacing:4
//access the same property with different syntaxes
Text { text:"Name(from property name):" + myContact.name.firstName + " " + myContact.name.lastName }
Text { text:"Name(from detail type):" + myContact.detail(ContactDetail.Name).firstName + " " + myContact.name.lastName }
Text { text:"Name(from detail name):" + myContact.detail("Name").firstName + " " + myContact.name.lastName }
Text { text:"Address:" + myContact.address.street + " " + myContact.address.locality + " " + myContact.address.region + " " + myContact.address.postcode }
//If a contact contains multiple details for the same detail type, you can access them with the dynamic property names.
Text { text:"How many email accounts?:" + myContact.emails.length }
Text { text:"Email[0]:" + myContact.emails[0].emailAddress }
Text { text:"How many phone numbers?:" + myContact.phoneNumbers.length }
Text { text:"phone number[0]:" + myContact.phoneNumbers[0].number }
Text { text:"phone number[1]:" + myContact.phoneNumbers[1].number }
Text { text:"phone number[2]:" + myContact.phoneNumbers[2].number }
}
}
\endcode
\section1 Contacts Elements
\annotatedlist qml-contacts
*/
|
