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
|
/*
Copyright (c) 2009 Stephen Kelly <steveire@gmail.com>
This library is free software; you can redistribute it and/or modify it
under the terms of the GNU Library General Public License as published by
the Free Software Foundation; either version 2 of the License, or (at your
option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public
License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to the
Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
02110-1301, USA.
*/
#ifndef AKONADI_PARTFETCHER_H
#define AKONADI_PARTFETCHER_H
#include <kjob.h>
#include "akonadi_export.h"
class QModelIndex;
namespace Akonadi
{
class Item;
class PartFetcherPrivate;
/**
* @short Convenience class for getting payload parts from an Akonadi Model.
*
* This class can be used to retrieve individual payload parts from an EntityTreeModel,
* and fetch them asynchronously from the Akonadi storage if necessary.
*
* The requested part is emitted though the partFetched signal.
*
* Example:
*
* @code
*
* const QModelIndex index = view->selectionModel()->currentIndex();
*
* PartFetcher *fetcher = new PartFetcher( index, Akonadi::MessagePart::Envelope );
* connect( fetcher, SIGNAL( result( KJob* ) ), SLOT( fetchResult( KJob* ) ) );
* fetcher->start();
*
* ...
*
* MyClass::fetchResult( KJob *job )
* {
* if ( job->error() ) {
* qDebug() << job->errorText();
* return;
* }
*
* PartFetcher *fetcher = qobject_cast<PartFetcher*>( job );
*
* const Item item = fetcher->item();
* // do something with the item
* }
*
* @endcode
*
* @author Stephen Kelly <steveire@gmail.com>
* @since 4.4
*/
class AKONADI_EXPORT PartFetcher : public KJob
{
Q_OBJECT
public:
/**
* Creates a new part fetcher.
*
* @param index The index of the item to fetch the part from.
* @param partName The name of the payload part to fetch.
* @param parent The parent object.
*/
PartFetcher( const QModelIndex &index, const QByteArray &partName, QObject *parent = 0 );
/**
* Destroys the part fetcher.
*/
virtual ~PartFetcher();
/**
* Starts the fetch operation.
*/
virtual void start();
/**
* Returns the index of the item the part was fetched from.
*/
QModelIndex index() const;
/**
* Returns the name of the part that has been fetched.
*/
QByteArray partName() const;
/**
* Returns the item that contains the fetched payload part.
*/
Item item() const;
private:
//@cond PRIVATE
Q_DECLARE_PRIVATE( Akonadi::PartFetcher )
PartFetcherPrivate *const d_ptr;
Q_PRIVATE_SLOT( d_func(), void fetchJobDone( KJob *job ) )
//@endcond
};
}
#endif
|