blob: 614b60c20af84d838b4403c29a2ba833f996a748 (
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
|
/****************************************************************************
**
** Copyright (C) 2013 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-messaging
\title QML Messaging
QML Support for the QtMobility Project Messaging API.
*/
/*!
\page qml-messaging.html
\title Messaging QML Plugin
\brief A QML plugin for the QtMobility Project Messaging API.
\section1 Overview
The identifying string for this component is \i {"QtMobility.messaging"}.
Use this in the QML \i {import} statement.
The Messaging QML plugin supplies filters to search for messages
with particular values for various properties in the message. The Message itself
is represented by a model called a \l {MessageModel}.
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 {MessageIntersectionFilter} and \l {MessageUnionFilter}
to represent a logical 'and' and 'or' of the results. Other properties also give
control over the filter logic, such as \l {MessageFilter::negated}
and the \l {MessageFilter::comparator}{Comparators}.
\section2 Filters
A filter query is made of various parts. Below is a list of some of the
things that may be used to construct a search
\table
\header
\o Component
\o Description
\row
\o \l {MessageModel::filter}{filter}
\o This property of \l {MessageModel} acts as the container for a constructed \l {MessageFilter}.
\row
\o \l {MessageIntersectionFilter}
\o AND a list of filter conditions together.
\row
\o \l {MessageUnionFilter}
\o OR a list of filter conditions together.
\row
\o \l {MessageFilter::comparator}{comparator}
\o The boolean comparison against a \i value in the conditions e.g. \i {LessThan}
\row
\o \l {MessageFilter::type}{type}
\o Contains a set of message fields including timestamp, folder, priority.
\row
\o \l {MessageModel::sortBy}{sortBy}
\o The message field used as the basis for the sort of a result.
\row
\o \l {MessageModel::sortOrder}{sortOrder}
\o Select Ascending or Descending sort order of the sortBy data.
\endtable
As an example consider the follow QML code which has a \l MessageModel element
containing a filter. The filter is made up of an intersection of
the message \l {MessageModel::sortBy}{Size} less than 1024 AND a union
of (\l {MessageModel::sortBy}{Sender} is "martin" AND \l {MessageModel::sortBy}{Subject}
does not include "re:") OR \l {MessageModel::sortBy}{Sender} includes "don".
Notice the use of the property \l {MessageFilter::value}{value} which
contains the tested value. The \l {MessageModel} sets the
\l {MessageModel::sortBy}{sortBy}
and \l {MessageModel::sortOrder}{sortOrder} so that the results are
ordered by Timestamp in DescendingOrder.
\code
import QtMobility.messaging 1.1
model: MessageModel {
sortBy: MessageModel.Timestamp
sortOrder: MessageModel.DescendingOrder
filter: MessageIntersectionFilter {
MessageFilter {
type: MessageFilter.Size
value: 1024
comparator: MessageFilter.LessThan
}
MessageUnionFilter {
MessageIntersectionFilter {
MessageFilter {
type: MessageFilter.Sender
value: "martin"
comparator: MessageFilter.Includes
}
MessageFilter {
negated: true
type: MessageFilter.Subject
value: "re:"
comparator: MessageFilter.Includes
}
}
MessageFilter {
type: MessageFilter.Sender
value: "don"
comparator: MessageFilter.Includes
}
}
}
}
\endcode
\section2 The MessageModel Element
The \l {MessageModel} element provides access to the returned list of
results allowing both control of the list and access to the data of particular
messages.
In the following snippet of code the delegate, of the unshown ListView
element, accesses various fields of each message in the list to display
a meaningful list of message items.
\code
model: MessageModel {
sortBy: MessageModel.Timestamp
sortOrder: MessageModel.DescendingOrder
}
delegate: Item {
id: wrapper
height: 32; width: list.width
Text { id: subjText; text: subject; font.pixelSize: 13; x: 3 }
Text {
text: sender; color: "gray"; font.pixelSize: 9
x: 3; width: parent.width-100;
anchors.top: subjText.bottom; anchors.topMargin: 3
elide: Text.ElideRight
}
Text {
text: date; color: "gray"; font.pixelSize: 9
anchors.right: parent.right
anchors.top: subjText.bottom; anchors.topMargin: 3
}
}
\endcode
The code displays a list of messages showing the \i {sender} and
\i {subject} details. The \l MessageModel element also enables the use of
the platform message display tool so that after a message is selected it
can be correctly displayed.
\section1 Elements
\annotatedlist qml-messaging
*/
|
