• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • ItemModel
Public Types | Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
Akonadi::ItemModel Class Reference

#include <itemmodel.h>

Inheritance diagram for Akonadi::ItemModel:
Akonadi::MessageModel

Public Types

enum  Column { Id = 0 , RemoteId , MimeType }
 
enum  Roles { IdRole = Qt::UserRole + 1 , ItemRole , MimeTypeRole , UserRole = Qt::UserRole + 42 }
 

Public Slots

void setCollection (const Akonadi::Collection &collection)
 

Signals

void collectionChanged (const Akonadi::Collection &collection)
 

Public Member Functions

 ItemModel (QObject *parent=0)
 
virtual ~ItemModel ()
 
Collection collection () const
 
virtual int columnCount (const QModelIndex &parent=QModelIndex()) const
 
virtual QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const
 
bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
 
ItemFetchScope & fetchScope ()
 
virtual Qt::ItemFlags flags (const QModelIndex &index) const
 
virtual QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
 
QModelIndex indexForItem (const Akonadi::Item &item, const int column) const
 
Item itemForIndex (const QModelIndex &index) const
 
virtual QMimeData * mimeData (const QModelIndexList &indexes) const
 
virtual QStringList mimeTypes () const
 
virtual int rowCount (const QModelIndex &parent=QModelIndex()) const
 
void setFetchScope (const ItemFetchScope &fetchScope)
 
virtual Qt::DropActions supportedDropActions () const
 

Protected Member Functions

Session * session () const
 

Detailed Description

A table model for items.

A self-updating table model that shows all items of a collection.

QTableView *view = new QTableView( this );
Akonadi::ItemModel *model = new Akonadi::ItemModel();
view->setModel( model );
model->setCollection( Akonadi::Collection::root() );
Akonadi::Collection::root
static Collection root()
Returns the root collection.
Definition: collection.cpp:192
Akonadi::ItemModel
A table model for items.
Definition: itemmodel.h:57
Akonadi::ItemModel::setCollection
void setCollection(const Akonadi::Collection &collection)
Sets the collection the model should display.
Definition: itemmodel.cpp:341
Author
Volker Krause vkrau.nosp@m.se@k.nosp@m.de.or.nosp@m.g
Deprecated:
Use Akonadi::EntityTreeModel instead

Definition at line 56 of file itemmodel.h.

Member Enumeration Documentation

◆ Column

enum Akonadi::ItemModel::Column

Describes the types of the columns in the model.

Enumerator
Id 

The unique id.

RemoteId 

The remote identifier.

MimeType 

The item's mime type.

Definition at line 64 of file itemmodel.h.

◆ Roles

enum Akonadi::ItemModel::Roles

Describes the roles of the model.

Enumerator
IdRole 

The id of the item.

ItemRole 

The item object.

MimeTypeRole 

The mime type of the item.

UserRole 

Role for user extensions.

Definition at line 73 of file itemmodel.h.

Constructor & Destructor Documentation

◆ ItemModel()

ItemModel::ItemModel ( QObject *  parent = 0)
explicit

Creates a new item model.

Parameters
parentThe parent object.

Definition at line 254 of file itemmodel.cpp.

◆ ~ItemModel()

ItemModel::~ItemModel ( )
virtual

Destroys the item model.

Definition at line 260 of file itemmodel.cpp.

Member Function Documentation

◆ collection()

Collection ItemModel::collection ( ) const

Returns the collection being displayed in the model.

Definition at line 462 of file itemmodel.cpp.

◆ collectionChanged

void Akonadi::ItemModel::collectionChanged ( const Akonadi::Collection &  collection)
signal

This signal is emitted whenever setCollection is called.

Parameters
collectionThe new collection.

◆ columnCount()

int ItemModel::columnCount ( const QModelIndex &  parent = QModelIndex()) const
virtual

Reimplemented in Akonadi::MessageModel.

Definition at line 316 of file itemmodel.cpp.

◆ data()

QVariant ItemModel::data ( const QModelIndex &  index,
int  role = Qt::DisplayRole 
) const
virtual

Reimplemented in Akonadi::MessageModel.

Definition at line 265 of file itemmodel.cpp.

◆ dropMimeData()

bool ItemModel::dropMimeData ( const QMimeData *  data,
Qt::DropAction  action,
int  row,
int  column,
const QModelIndex &  parent 
)

Definition at line 452 of file itemmodel.cpp.

◆ fetchScope()

ItemFetchScope & ItemModel::fetchScope ( )

Returns the item fetch scope.

Since this returns a reference it can be used to conveniently modify the current scope in-place, i.e. by calling a method on the returned reference without storing it in a local variable. See the ItemFetchScope documentation for an example.

Returns
a reference to the current item fetch scope.
See also
setFetchScope() for replacing the current item fetch scope.

Definition at line 386 of file itemmodel.cpp.

◆ flags()

Qt::ItemFlags ItemModel::flags ( const QModelIndex &  index) const
virtual

Definition at line 409 of file itemmodel.cpp.

◆ headerData()

QVariant ItemModel::headerData ( int  section,
Qt::Orientation  orientation,
int  role = Qt::DisplayRole 
) const
virtual

Reimplemented in Akonadi::MessageModel.

Definition at line 324 of file itemmodel.cpp.

◆ indexForItem()

QModelIndex ItemModel::indexForItem ( const Akonadi::Item &  item,
const int  column 
) const

Returns the model index for the given item, with the given column.

Parameters
itemThe item to find.
columnThe column for the returned index.

Definition at line 447 of file itemmodel.cpp.

◆ itemForIndex()

Item ItemModel::itemForIndex ( const QModelIndex &  index) const

Returns the item at the given index.

Definition at line 391 of file itemmodel.cpp.

◆ mimeData()

QMimeData * ItemModel::mimeData ( const QModelIndexList &  indexes) const
virtual

Definition at line 430 of file itemmodel.cpp.

◆ mimeTypes()

QStringList ItemModel::mimeTypes ( ) const
virtual

Reimplemented in Akonadi::MessageModel.

Definition at line 420 of file itemmodel.cpp.

◆ rowCount()

int ItemModel::rowCount ( const QModelIndex &  parent = QModelIndex()) const
virtual

Reimplemented in Akonadi::MessageModel.

Definition at line 308 of file itemmodel.cpp.

◆ session()

Session * ItemModel::session ( ) const
protected

Returns the Session object used for all operations by this model.

Definition at line 425 of file itemmodel.cpp.

◆ setCollection

void ItemModel::setCollection ( const Akonadi::Collection &  collection)
slot

Sets the collection the model should display.

If the collection has changed, the model is reset and a new message listing is requested from the Akonadi storage.

Parameters
collectionThe collection.

Definition at line 341 of file itemmodel.cpp.

◆ setFetchScope()

void ItemModel::setFetchScope ( const ItemFetchScope &  fetchScope)

Sets the item fetch scope.

The ItemFetchScope controls how much of an item's data is fetched from the server, e.g. whether to fetch the full item payload or only meta data.

Parameters
fetchScopeThe new scope for item fetch operations.
See also
fetchScope()

Definition at line 381 of file itemmodel.cpp.

◆ supportedDropActions()

Qt::DropActions ItemModel::supportedDropActions ( ) const
virtual

Definition at line 467 of file itemmodel.cpp.


The documentation for this class was generated from the following files:
  • itemmodel.h
  • itemmodel.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal