Akonadi::EntityTreeView Class Reference

#include <entitytreeview.h>

Inherits QTreeView.

List of all members.

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
	EntityTreeView (QWidget *parent=0)
	EntityTreeView (KXMLGUIClient *xmlGuiClient, QWidget *parent=0)
virtual	~EntityTreeView ()
bool	isDropActionMenuEnabled () const
void	setDropActionMenuEnabled (bool enabled)
virtual void	setModel (QAbstractItemModel *model)
void	setXmlGuiClient (KXMLGUIClient *xmlGuiClient)
Protected Member Functions
virtual void	contextMenuEvent (QContextMenuEvent *event)
virtual void	dragMoveEvent (QDragMoveEvent *event)
virtual void	dropEvent (QDropEvent *event)
virtual void	startDrag (Qt::DropActions supportedActions)
virtual void	timerEvent (QTimerEvent *event)

---

Detailed Description

A view to show an item/collection tree 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()
    {
      EntityTreeView *view = new EntityTreeView( this, this );
      setCentralWidget( view );

      EntityTreeModel *model = new EntityTreeModel( ... );
      view->setModel( model );
    }
 }

Author:

Volker Krause <vkrause@kde.org>

Stephen Kelly <steveire@gmail.com>

Since:

4.4

---

Constructor & Destructor Documentation

Akonadi::EntityTreeView::EntityTreeView

(

QWidget *

parent = 0

)

[explicit]

Creates a new entity tree view.

Parameters:

parent

The parent widget.

Akonadi::EntityTreeView::EntityTreeView	(	KXMLGUIClient *	xmlGuiClient,
		QWidget *	parent = 0
	)		[explicit]

Creates a new entity tree 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.

virtual Akonadi::EntityTreeView::~EntityTreeView

(

)

[virtual]

Destroys the entity tree view.

---

Member Function Documentation

void Akonadi::EntityTreeView::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::EntityTreeView::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::EntityTreeView::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::EntityTreeView::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::EntityTreeView::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::EntityTreeView::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 Akonadi::EntityTreeView::isDropActionMenuEnabled

(

)

const

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

Since:

4.5

void Akonadi::EntityTreeView::setDropActionMenuEnabled

(

bool

enabled

)

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

Since:

4.5

virtual void Akonadi::EntityTreeView::setModel

(

QAbstractItemModel *

model

)

[virtual]

void Akonadi::EntityTreeView::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.

---

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

• entitytreeview.h
• dragdropmanager.cpp