akonadi
Akonadi::CollectionView Class Reference
A view to show a collection tree provided by a CollectionModel. More...
#include <collectionview.h>
Inherits QTreeView.
Signals | |
void | clicked (const Akonadi::Collection &collection) |
void | currentChanged (const Akonadi::Collection &collection) |
Public Member Functions | |
CollectionView (KXMLGUIClient *xmlGuiClient, QWidget *parent=0) | |
CollectionView (KXmlGuiWindow *xmlGuiWindow, QWidget *parent=0) | |
CollectionView (QWidget *parent=0) | |
virtual void | setModel (QAbstractItemModel *model) |
void | setXmlGuiClient (KXMLGUIClient *xmlGuiClient) |
void | setXmlGuiWindow (KXmlGuiWindow *xmlGuiWindow) |
virtual | ~CollectionView () |
Protected Member Functions | |
virtual void | contextMenuEvent (QContextMenuEvent *event) |
virtual void | dragLeaveEvent (QDragLeaveEvent *event) |
virtual void | dragMoveEvent (QDragMoveEvent *event) |
virtual void | dropEvent (QDropEvent *event) |
Detailed Description
A view to show a collection tree provided by a CollectionModel.
When a KXmlGuiWindow is passed to the constructor, the XMLGUI defined context menu akonadi_collectionview_contextmenu
is used if available.
Example:
class MyWindow : public KXmlGuiWindow { public: MyWindow() : KXmlGuiWindow() { Akonadi::CollectionView *view = new Akonadi::CollectionView( this, this ); setCentralWidget( view ); Akonadi::CollectionModel *model = new Akonadi::CollectionModel( this ); view->setModel( model ); } }
Definition at line 63 of file collectionview.h.
Constructor & Destructor Documentation
CollectionView::CollectionView | ( | QWidget * | parent = 0 |
) | [explicit] |
Creates a new collection view.
- Parameters:
-
parent The parent widget.
Definition at line 132 of file collectionview.cpp.
CollectionView::CollectionView | ( | KXmlGuiWindow * | xmlGuiWindow, | |
QWidget * | parent = 0 | |||
) | [explicit] |
Creates a new collection view.
- Parameters:
-
xmlGuiWindow The KXmlGuiWindow 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. parent The parent widget.
Definition at line 147 of file collectionview.cpp.
CollectionView::CollectionView | ( | KXMLGUIClient * | xmlGuiClient, | |
QWidget * | parent = 0 | |||
) | [explicit] |
Creates a new collection view.
- Parameters:
-
xmlGuiWindow The KXmlGuiWindow 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. parent The parent widget.
Definition at line 139 of file collectionview.cpp.
CollectionView::~CollectionView | ( | ) | [virtual] |
Member Function Documentation
void Akonadi::CollectionView::clicked | ( | const Akonadi::Collection & | collection | ) | [signal] |
This signal is emitted whenever the user has clicked a collection in the view.
- Parameters:
-
collection The clicked collection.
void Akonadi::CollectionView::currentChanged | ( | const Akonadi::Collection & | collection | ) | [signal] |
This signal is emitted whenever the current collection in the view has changed.
- Parameters:
-
collection The new current collection.
void CollectionView::setXmlGuiClient | ( | KXMLGUIClient * | xmlGuiClient | ) |
Sets the KXMLGUIClient which the view is used in.
This is needed if you want to use the built-in context menu.
- Parameters:
-
xmlGuiClient The KXMLGUIClient the view is used in.
- Since:
- 4.3
Definition at line 249 of file collectionview.cpp.
void CollectionView::setXmlGuiWindow | ( | KXmlGuiWindow * | xmlGuiWindow | ) |
Sets the KXmlGuiWindow which the view is used in.
This is needed if you want to use the built-in context menu.
- Parameters:
-
xmlGuiWindow The KXmlGuiWindow the view is used in.
Definition at line 254 of file collectionview.cpp.
The documentation for this class was generated from the following files: