• Skip to content
  • Skip to link menu
KDE 4.7 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • FavoriteCollectionsModel
Public Slots | Public Member Functions
Akonadi::FavoriteCollectionsModel Class Reference

#include <favoritecollectionsmodel.h>

Inheritance diagram for Akonadi::FavoriteCollectionsModel:
Inheritance graph
[legend]

List of all members.

Public Slots

void addCollection (const Collection &collection)
void removeCollection (const Collection &collection)
void setCollections (const Collection::List &collections)
void setFavoriteLabel (const Collection &collection, const QString &label)

Public Member Functions

 FavoriteCollectionsModel (QAbstractItemModel *model, const KConfigGroup &group, QObject *parent=0)
virtual ~FavoriteCollectionsModel ()
QList< Collection::Id > collectionIds () const
Collection::List collections () const
virtual QVariant data (const QModelIndex &index, int role=Qt::DisplayRole) const
virtual bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
QString favoriteLabel (const Akonadi::Collection &col)
virtual Qt::ItemFlags flags (const QModelIndex &index) const
virtual QVariant headerData (int section, Qt::Orientation orientation, int role=Qt::DisplayRole) const
virtual QStringList mimeTypes () const
virtual bool setData (const QModelIndex &index, const QVariant &value, int role=Qt::EditRole)

Detailed Description

A model that lists a set of favorite collections.

In some applications you want to provide fast access to a list of often used collections (e.g. Inboxes from different email accounts in a mail application). Therefor you can use the FavoriteCollectionsModel which stores the list of favorite collections in a given configuration file.

Example:

 using namespace Akonadi;

 EntityTreeModel *sourceModel = new EntityTreeModel( ... );

 const KConfigGroup group = KGlobal::config()->group( "Favorite Collections" );

 FavoriteCollectionsModel *model = new FavoriteCollectionsModel( sourceModel, group, this );

 EntityListView *view = new EntityListView( this );
 view->setModel( model );
Author:
Kevin Ottens <ervin@kde.org>
Since:
4.4

Constructor & Destructor Documentation

Akonadi::FavoriteCollectionsModel::FavoriteCollectionsModel ( QAbstractItemModel *  model,
const KConfigGroup &  group,
QObject *  parent = 0 
)

Creates a new favorite collections model.

Parameters:
modelThe source model where the favorite collections come from.
groupThe config group that shall be used to save the selection of favorite collections.
parentThe parent object.
virtual Akonadi::FavoriteCollectionsModel::~FavoriteCollectionsModel ( ) [virtual]

Destroys the favorite collections model.


Member Function Documentation

void Akonadi::FavoriteCollectionsModel::addCollection ( const Collection &  collection) [slot]

Adds a collection to the list of favorite collections.

QList<Collection::Id> Akonadi::FavoriteCollectionsModel::collectionIds ( ) const

Returns the list of ids of favorite collections set on the FavoriteCollectionsModel.

Note that if you want Collections with actual data you should use something like this instead:

   FavoriteCollectionsModel* favs = getFavsModel();
   Collection::List cols;
   const int rowCount = favs->rowCount();
   for (int row = 0; row < rowcount; ++row) {
     static const int column = 0;
     const QModelIndex index = favs->index(row, column);
     const Collection col = index.data(EntityTreeModel::CollectionRole).value<Collection>();
     cols << col;
   }

Note that due to the asynchronous nature of the model, this method returns collection ids of collections which may not be in the model yet. If you want the ids of the collections that are actually in the model, use a loop similar to above with the CollectionIdRole.

Akonadi::Collection::List CollectionFetchJob::collections ( ) const

Returns the list of favorite collections.

Deprecated:
Use collectionIds instead.

Definition at line 144 of file collectionfetchjob.cpp.

QString Akonadi::FavoriteCollectionsModel::favoriteLabel ( const Akonadi::Collection &  col)

Return associate label for collection.

Definition at line 229 of file favoritecollectionsmodel.cpp.

void Akonadi::FavoriteCollectionsModel::removeCollection ( const Collection &  collection) [slot]

Removes a collection from the list of favorite collections.

void Akonadi::FavoriteCollectionsModel::setCollections ( const Collection::List &  collections) [slot]

Sets the collections as favorite collections.

void Akonadi::FavoriteCollectionsModel::setFavoriteLabel ( const Collection &  collection,
const QString &  label 
) [slot]

Sets a custom label that will be used when showing the favorite collection.

Definition at line 188 of file favoritecollectionsmodel.cpp.


The documentation for this class was generated from the following files:
  • favoritecollectionsmodel.h
  • collectionfetchjob.cpp
  • favoritecollectionsmodel.cpp

akonadi

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

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.5
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal