|
1 /* |
|
2 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). |
|
3 * All rights reserved. |
|
4 * This component and the accompanying materials are made available |
|
5 * under the terms of "Eclipse Public License v1.0" |
|
6 * which accompanies this distribution, and is available |
|
7 * at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
8 * |
|
9 * Initial Contributors: |
|
10 * Nokia Corporation - initial contribution. |
|
11 * |
|
12 * Contributors: |
|
13 * |
|
14 * Description: |
|
15 * Email messages search implementation. |
|
16 */ |
|
17 |
|
18 #include "nmapiheaders.h" |
|
19 |
|
20 namespace EmailClientApi |
|
21 { |
|
22 |
|
23 NmApiMessageSearch::NmApiMessageSearch(QObject *parent, quint64 mailboxId) : |
|
24 NmApiMessageTask(parent) |
|
25 { |
|
26 NM_FUNCTION; |
|
27 d = new NmApiMessageSearchPrivate(mailboxId, this); |
|
28 qRegisterMetaType<NmApiMessage> ("EmailClientApi::NmApiMessage"); |
|
29 connect(d, SIGNAL(messageFound(EmailClientApi::NmApiMessage&)), this, SIGNAL(messageFound(EmailClientApi::NmApiMessage&))); |
|
30 connect(d, SIGNAL(searchComplete(int)), this, SIGNAL(searchComplete(int))); |
|
31 connect(d, SIGNAL(canceled()), this, SIGNAL(canceled())); |
|
32 } |
|
33 |
|
34 NmApiMessageSearch::~NmApiMessageSearch() |
|
35 { |
|
36 NM_FUNCTION; |
|
37 } |
|
38 |
|
39 /*! |
|
40 \fn start |
|
41 \return true if operation was started otherwise returns false. |
|
42 |
|
43 Starts search operation for given criterias if operation is not running. Only one search can be performed at a time. |
|
44 Each found message signaled with messageFound(NmApiMessage &message). |
|
45 Search completed signaled with searchComplete(int result). |
|
46 Cancellation signalled with canceled(). |
|
47 */ |
|
48 bool NmApiMessageSearch::start() |
|
49 { |
|
50 NM_FUNCTION; |
|
51 return d->start(); |
|
52 } |
|
53 |
|
54 /*! |
|
55 \fn cancel |
|
56 |
|
57 Cancels current search operation and reset criterias. If operation is not running, nothing happens except criterias are reset. |
|
58 Cancellation signalled with canceled(). |
|
59 */ |
|
60 void NmApiMessageSearch::cancel() |
|
61 { |
|
62 NM_FUNCTION; |
|
63 d->cancel(); |
|
64 } |
|
65 |
|
66 /*! |
|
67 \fn initialise |
|
68 \param searchStrings List of search criteria strings. |
|
69 \param sortCriteria Sort criteria for search. |
|
70 \return true if initializing is successfully competed otherwise returns false. |
|
71 |
|
72 Initialize search criterias. |
|
73 */ |
|
74 bool NmApiMessageSearch::initialise(const QList<QString> &searchStrings, NmApiMailSortCriteria sortCriteria) |
|
75 { |
|
76 NM_FUNCTION; |
|
77 return d->initialise(searchStrings, sortCriteria); |
|
78 } |
|
79 |
|
80 /*! |
|
81 \fn isRunning |
|
82 \return true if search operation is running otherwise returns false. |
|
83 |
|
84 Returns information about search operation running. |
|
85 */ |
|
86 bool NmApiMessageSearch::isRunning() const |
|
87 { |
|
88 NM_FUNCTION; |
|
89 return d->isRunning(); |
|
90 } |
|
91 } |