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
|
/*
Copyright (c) 2009 Tobias Koenig <tokoe@kde.org>
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_COLLECTIONCOMBOBOX_H
#define AKONADI_COLLECTIONCOMBOBOX_H
#include "akonadi_export.h"
#include <akonadi/collection.h>
#include <kcombobox.h>
class QAbstractItemModel;
namespace Akonadi {
/**
* @short A combobox for selecting an Akonadi collection.
*
* This widget provides a combobox to select a collection
* from the Akonadi storage.
* The available collections can be filtered by mime type and
* access rights.
*
* Example:
*
* @code
*
* using namespace Akonadi;
*
* QStringList contentMimeTypes;
* contentMimeTypes << KABC::Addressee::mimeType();
* contentMimeTypes << KABC::ContactGroup::mimeType();
*
* CollectionComboBox *box = new CollectionComboBox( this );
* box->setMimeTypeFilter( contentMimeTypes );
* box->setAccessRightsFilter( Collection::CanCreateItem );
* ...
*
* const Collection collection = box->currentCollection();
*
* @endcode
*
* @author Tobias Koenig <tokoe@kde.org>
* @since 4.4
*/
class AKONADI_EXPORT CollectionComboBox : public KComboBox
{
Q_OBJECT
public:
/**
* Creates a new collection combobox.
*
* @param parent The parent widget.
*/
explicit CollectionComboBox( QWidget *parent = 0 );
/**
* Creates a new collection combobox with a custom @p model.
*
* The filtering by content mime type and access rights is done
* on top of the custom model.
*
* @param model The custom model to use.
* @param parent The parent widget.
*/
explicit CollectionComboBox( QAbstractItemModel *model, QWidget *parent = 0 );
/**
* Destroys the collection combobox.
*/
~CollectionComboBox();
/**
* Sets the content @p mimetypes the collections shall be filtered by.
*/
void setMimeTypeFilter( const QStringList &mimetypes );
/**
* Returns the content mimetype the collections are filtered by.
* Don't assume this list has the original order.
*/
QStringList mimeTypeFilter() const;
/**
* Sets the access @p rights the collections shall be filtered by.
*/
void setAccessRightsFilter( Collection::Rights rights );
/**
* Returns the access rights the collections are filtered by.
*/
Collection::Rights accessRightsFilter() const;
/**
* Sets the @p collection that shall be selected by default.
*/
void setDefaultCollection( const Collection &collection );
/**
* Returns the current selection.
*/
Akonadi::Collection currentCollection() const;
Q_SIGNALS:
/**
* This signal is emitted whenever the current selection
* has been changed.
*
* @param collection The current selection.
*/
void currentChanged( const Akonadi::Collection &collection );
private:
//@cond PRIVATE
class Private;
Private* const d;
Q_PRIVATE_SLOT( d, void activated( int ) )
Q_PRIVATE_SLOT( d, void activated( const QModelIndex& ) )
//@endcond
};
}
#endif
|