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
199
200
201
202
203
204
205
206
|
/*
Copyright (c) 2006 - 2007 Volker Krause <vkrause@kde.org>
Copyright (c) 2008 Stephen Kelly <steveire@gmail.com>
Copyright (c) 2009 Kevin Ottens <ervin@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_ENTITYLISTVIEW_H
#define AKONADI_ENTITYLISTVIEW_H
#include "akonadi_export.h"
#include <QtGui/QListView>
class KXMLGUIClient;
class QDragMoveEvent;
namespace Akonadi
{
class Collection;
class Item;
/**
* @short A view to show an item/collection list provided by an EntityTreeModel.
*
* When a KXmlGuiWindow is passed to the constructor, the XMLGUI
* defined context menu @c akonadi_collectionview_contextmenu or
* @c akonadi_itemview_contextmenu is used if available.
*
* Example:
*
* @code
*
* using namespace Akonadi;
*
* class MyWindow : public KXmlGuiWindow
* {
* public:
* MyWindow()
* : KXmlGuiWindow()
* {
* EntityListView *view = new EntityListView( this, this );
* setCentralWidget( view );
*
* EntityTreeModel *model = new EntityTreeModel( ... );
*
* KDescendantsProxyModel *flatModel = new KDescendantsProxyModel( this );
* flatModel->setSourceModel( model );
*
* view->setModel( flatModel );
* }
* }
*
* @endcode
*
* @author Volker Krause <vkrause@kde.org>
* @author Stephen Kelly <steveire@gmail.com>
* @since 4.4
*/
class AKONADI_EXPORT EntityListView : public QListView
{
Q_OBJECT
public:
/**
* Creates a new favorite collections view.
*
* @param parent The parent widget.
*/
explicit EntityListView( QWidget *parent = 0 );
/**
* Creates a new favorite collections view.
*
* @param xmlGuiClient The KXMLGUIClient the view is used in.
* This is needed for the XMLGUI based context menu.
* Passing 0 is ok and will disable the builtin context menu.
* @param parent The parent widget.
*/
explicit EntityListView( KXMLGUIClient *xmlGuiClient, QWidget *parent = 0 );
/**
* Destroys the favorite collections view.
*/
virtual ~EntityListView();
/**
* Sets the XML GUI client which the view is used in.
*
* This is needed if you want to use the built-in context menu.
*
* @param xmlGuiClient The KXMLGUIClient the view is used in.
*/
void setXmlGuiClient( KXMLGUIClient *xmlGuiClient );
/**
* @reimplemented
*/
virtual void setModel( QAbstractItemModel * model );
/**
* Sets whether the drop action menu is @p enabled and will
* be shown on drop operation.
*
* @since 4.7
*/
void setDropActionMenuEnabled( bool enabled );
/**
* Returns whether the drop action menu is enabled and will
* be shown on drop operation.
*
* @since 4.7
*/
bool isDropActionMenuEnabled() const;
Q_SIGNALS:
/**
* This signal is emitted whenever the user has clicked
* a collection in the view.
*
* @param collection The clicked collection.
*/
void clicked( const Akonadi::Collection &collection );
/**
* This signal is emitted whenever the user has clicked
* an item in the view.
*
* @param item The clicked item.
*/
void clicked( const Akonadi::Item &item );
/**
* This signal is emitted whenever the user has double clicked
* a collection in the view.
*
* @param collection The double clicked collection.
*/
void doubleClicked( const Akonadi::Collection &collection );
/**
* This signal is emitted whenever the user has double clicked
* an item in the view.
*
* @param item The double clicked item.
*/
void doubleClicked( const Akonadi::Item &item );
/**
* This signal is emitted whenever the current collection
* in the view has changed.
*
* @param collection The new current collection.
*/
void currentChanged( const Akonadi::Collection &collection );
/**
* This signal is emitted whenever the current item
* in the view has changed.
*
* @param item The new current item.
*/
void currentChanged( const Akonadi::Item &item );
protected:
using QListView::currentChanged;
#ifndef QT_NO_DRAGANDDROP
virtual void startDrag( Qt::DropActions supportedActions );
virtual void dropEvent( QDropEvent *event );
virtual void dragMoveEvent( QDragMoveEvent *event );
#endif
#ifndef QT_NO_CONTEXTMENU
virtual void contextMenuEvent( QContextMenuEvent *event );
#endif
private:
//@cond PRIVATE
class Private;
Private * const d;
Q_PRIVATE_SLOT( d, void itemClicked( const QModelIndex& ) )
Q_PRIVATE_SLOT( d, void itemDoubleClicked( const QModelIndex& ) )
Q_PRIVATE_SLOT( d, void itemCurrentChanged( const QModelIndex& ) )
//@endcond
};
}
#endif
|