Akonadi::EntityListView Class Reference

#include <entitylistview.h>

Inherits QListView.

Signals
void	clicked (const Akonadi::Collection &collection)
void	clicked (const Akonadi::Item &item)
void	currentChanged (const Akonadi::Collection &collection)
void	currentChanged (const Akonadi::Item &item)
void	doubleClicked (const Akonadi::Collection &collection)
void	doubleClicked (const Akonadi::Item &item)

Public Member Functions
	EntityListView (QWidget *parent=0)
	EntityListView (KXMLGUIClient *xmlGuiClient, QWidget *parent=0)
virtual	~EntityListView ()
bool	isDropActionMenuEnabled () const
void	setDropActionMenuEnabled (bool enabled)
virtual void	setModel (QAbstractItemModel *model)
void	setXmlGuiClient (KXMLGUIClient *xmlGuiClient)
KXMLGUIClient *	xmlGuiClient () const

Protected Member Functions
virtual void	contextMenuEvent (QContextMenuEvent *event)
virtual void	dragMoveEvent (QDragMoveEvent *event)
virtual void	dropEvent (QDropEvent *event)
virtual void	startDrag (Qt::DropActions supportedActions)

Detailed Description

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 akonadi_collectionview_contextmenu or akonadi_itemview_contextmenu is used if available.

Example:

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 );
   }
}

Author

Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g

Stephen Kelly steve.nosp@m.ire@.nosp@m.gmail.nosp@m..com

Since

4.4

Definition at line 75 of file entitylistview.h.

Constructor & Destructor Documentation

EntityListView::EntityListView ( QWidget *  parent = 0 )

explicit

Creates a new favorite collections view.

Parameters

parent

The parent widget.

Definition at line 149 of file entitylistview.cpp.

EntityListView::EntityListView ( KXMLGUIClient *  xmlGuiClient, QWidget *  parent = 0  )

explicit

Creates a new favorite collections view.

Parameters

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.
parent	The parent widget.

Definition at line 157 of file entitylistview.cpp.

EntityListView::~EntityListView ( )

virtual

Destroys the favorite collections view.

Definition at line 165 of file entitylistview.cpp.

Member Function Documentation

void Akonadi::EntityListView::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::EntityListView::clicked ( const Akonadi::Item &  item )

signal

This signal is emitted whenever the user has clicked an item in the view.

Parameters

item	The clicked item.

void Akonadi::EntityListView::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 Akonadi::EntityListView::currentChanged ( const Akonadi::Item &  item )

signal

This signal is emitted whenever the current item in the view has changed.

Parameters

item	The new current item.

void Akonadi::EntityListView::doubleClicked ( const Akonadi::Collection &  collection )

signal

This signal is emitted whenever the user has double clicked a collection in the view.

Parameters

collection

The double clicked collection.

void Akonadi::EntityListView::doubleClicked ( const Akonadi::Item &  item )

signal

This signal is emitted whenever the user has double clicked an item in the view.

Parameters

item	The double clicked item.

bool EntityListView::isDropActionMenuEnabled

(

)

const

Returns whether the drop action menu is enabled and will be shown on drop operation.

Since

4.7

Definition at line 264 of file entitylistview.cpp.

void EntityListView::setDropActionMenuEnabled

(

bool

enabled

)

Sets whether the drop action menu is enabled and will be shown on drop operation.

Parameters

enabled

enables drop action menu if set as true

Since

4.7

Definition at line 257 of file entitylistview.cpp.

void EntityListView::setModel ( QAbstractItemModel *  model )

virtual

Reimplemented from superclass.

Parameters

model

the model to set

Definition at line 171 of file entitylistview.cpp.

void EntityListView::setXmlGuiClient

(

KXMLGUIClient *

xmlGuiClient

)

Sets the XML GUI client 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.

Definition at line 240 of file entitylistview.cpp.

KXMLGUIClient * EntityListView::xmlGuiClient

(

)

const

Return the XML GUI client which the view is used in.

Since

4.12

Definition at line 245 of file entitylistview.cpp.

---

The documentation for this class was generated from the following files:

• entitylistview.h
• entitylistview.cpp