Akonadi::ContactsTreeModel

Search for usage in LXR

Akonadi::ContactsTreeModel Class Reference

#include <contactstreemodel.h>

Inheritance diagram for Akonadi::ContactsTreeModel:

Public Types

enum  Column {
  FullName , FamilyName , GivenName , Birthday ,
  HomeAddress , BusinessAddress , PhoneNumbers , PreferredEmail ,
  AllEmails , Organization , Role , Homepage ,
  Note
}
 
using Columns = QList<Column>
 
enum  Roles { DateRole = EntityTreeModel::UserRole + 1 , UserRole = DateRole + 42 }
 
- Public Types inherited from Akonadi::EntityTreeModel
enum  CollectionFetchStrategy
 
enum  FetchState
 
enum  HeaderGroup
 
enum  ItemPopulationStrategy
 
enum  Roles
 
- Public Types inherited from QAbstractItemModel
enum  CheckIndexOption
 
typedef  CheckIndexOptions
 
enum  LayoutChangeHint
 
- Public Types inherited from QObject
typedef  QObjectList
 

Public Member Functions

 ContactsTreeModel (Monitor *monitor, QObject *parent=nullptr)
 
 ~ContactsTreeModel () override
 
Columns columns () const
 
void setColumns (const Columns &columns)
 
- Public Member Functions inherited from Akonadi::EntityTreeModel
 EntityTreeModel (Monitor *monitor, QObject *parent=nullptr)
 
CollectionFetchStrategy collectionFetchStrategy () const
 
bool includeRootCollection () const
 
bool isCollectionPopulated (Akonadi::Collection::Id) const
 
bool isCollectionTreeFetched () const
 
bool isFullyPopulated () const
 
ItemPopulationStrategy itemPopulationStrategy () const
 
Akonadi::CollectionFetchScope::ListFilter listFilter () const
 
QModelIndexList match (const QModelIndex &start, int role, const QVariant &value, int hits=1, Qt::MatchFlags flags=Qt::MatchFlags(Qt::MatchStartsWith|Qt::MatchWrap)) const override
 
QString rootCollectionDisplayName () const
 
void setCollectionFetchStrategy (CollectionFetchStrategy strategy)
 
void setCollectionMonitored (const Akonadi::Collection &col, bool monitored=true)
 
void setCollectionsMonitored (const Akonadi::Collection::List &collections)
 
void setIncludeRootCollection (bool include)
 
void setItemPopulationStrategy (ItemPopulationStrategy strategy)
 
void setListFilter (Akonadi::CollectionFetchScope::ListFilter filter)
 
void setRootCollectionDisplayName (const QString &name)
 
void setShowSystemEntities (bool show)
 
bool systemEntitiesShown () const
 
- Public Member Functions inherited from QAbstractItemModel
 QAbstractItemModel (QObject *parent)
 
virtual QModelIndex buddy (const QModelIndex &index) const const
 
virtual bool canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const
 
virtual bool canFetchMore (const QModelIndex &parent) const const
 
bool checkIndex (const QModelIndex &index, CheckIndexOptions options) const const
 
virtual bool clearItemData (const QModelIndex &index)
 
virtual int columnCount (const QModelIndex &parent) const const=0
 
void columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)
 
void columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)
 
void columnsInserted (const QModelIndex &parent, int first, int last)
 
void columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)
 
void columnsRemoved (const QModelIndex &parent, int first, int last)
 
virtual QVariant data (const QModelIndex &index, int role) const const=0
 
void dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles)
 
virtual bool dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)
 
virtual void fetchMore (const QModelIndex &parent)
 
virtual Qt::ItemFlags flags (const QModelIndex &index) const const
 
virtual bool hasChildren (const QModelIndex &parent) const const
 
bool hasIndex (int row, int column, const QModelIndex &parent) const const
 
virtual QVariant headerData (int section, Qt::Orientation orientation, int role) const const
 
void headerDataChanged (Qt::Orientation orientation, int first, int last)
 
virtual QModelIndex index (int row, int column, const QModelIndex &parent) const const=0
 
bool insertColumn (int column, const QModelIndex &parent)
 
virtual bool insertColumns (int column, int count, const QModelIndex &parent)
 
bool insertRow (int row, const QModelIndex &parent)
 
virtual bool insertRows (int row, int count, const QModelIndex &parent)
 
virtual QMap< int, QVariantitemData (const QModelIndex &index) const const
 
void layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)
 
void layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)
 
virtual QMimeDatamimeData (const QModelIndexList &indexes) const const
 
virtual QStringList mimeTypes () const const
 
void modelAboutToBeReset ()
 
void modelReset ()
 
bool moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)
 
virtual bool moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)
 
bool moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)
 
virtual bool moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)
 
virtual void multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const const
 
virtual QModelIndex parent (const QModelIndex &index) const const=0
 
bool removeColumn (int column, const QModelIndex &parent)
 
virtual bool removeColumns (int column, int count, const QModelIndex &parent)
 
bool removeRow (int row, const QModelIndex &parent)
 
virtual bool removeRows (int row, int count, const QModelIndex &parent)
 
virtual void revert ()
 
virtual QHash< int, QByteArrayroleNames () const const
 
virtual int rowCount (const QModelIndex &parent) const const=0
 
void rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)
 
void rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
 
void rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)
 
void rowsInserted (const QModelIndex &parent, int first, int last)
 
void rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)
 
void rowsRemoved (const QModelIndex &parent, int first, int last)
 
virtual bool setData (const QModelIndex &index, const QVariant &value, int role)
 
virtual bool setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)
 
virtual bool setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)
 
virtual QModelIndex sibling (int row, int column, const QModelIndex &index) const const
 
virtual void sort (int column, Qt::SortOrder order)
 
virtual QSize span (const QModelIndex &index) const const
 
virtual bool submit ()
 
virtual Qt::DropActions supportedDragActions () const const
 
virtual Qt::DropActions supportedDropActions () const const
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
QBindable< QStringbindableObjectName ()
 
bool blockSignals (bool block)
 
const QObjectListchildren () const const
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
 
bool disconnect (const QObject *receiver, const char *method) const const
 
void dumpObjectInfo () const const
 
void dumpObjectTree () const const
 
QList< QByteArraydynamicPropertyNames () const const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
 
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
 
QList< T > findChildren (Qt::FindChildOptions options) const const
 
bool inherits (const char *className) const const
 
void installEventFilter (QObject *filterObj)
 
bool isQuickItemType () const const
 
bool isWidgetType () const const
 
bool isWindowType () const const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const const
 
void moveToThread (QThread *targetThread)
 
QString objectName () const const
 
void objectNameChanged (const QString &objectName)
 
QObjectparent () const const
 
QVariant property (const char *name) const const
 
 Q_CLASSINFO (Name, Value)
 
 Q_EMIT Q_EMIT
 
 Q_ENUM (...)
 
 Q_ENUM_NS (...)
 
 Q_ENUMS (...)
 
 Q_FLAG (...)
 
 Q_FLAG_NS (...)
 
 Q_FLAGS (...)
 
 Q_GADGET Q_GADGET
 
 Q_GADGET_EXPORT (EXPORT_MACRO)
 
 Q_INTERFACES (...)
 
 Q_INVOKABLE Q_INVOKABLE
 
 Q_MOC_INCLUDE Q_MOC_INCLUDE
 
 Q_NAMESPACE Q_NAMESPACE
 
 Q_NAMESPACE_EXPORT (EXPORT_MACRO)
 
 Q_OBJECT Q_OBJECT
 
 Q_PROPERTY (...)
 
 Q_REVISION Q_REVISION
 
 Q_SET_OBJECT_NAME (Object)
 
 Q_SIGNAL Q_SIGNAL
 
 Q_SIGNALS Q_SIGNALS
 
 Q_SLOT Q_SLOT
 
 Q_SLOTS Q_SLOTS
 
qobject_cast (const QObject *object)
 
qobject_cast (QObject *object)
 
 QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
 
void removeEventFilter (QObject *obj)
 
void setObjectName (const QString &name)
 
void setObjectName (QAnyStringView name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool setProperty (const char *name, QVariant &&value)
 
bool signalsBlocked () const const
 
int startTimer (int interval, Qt::TimerType timerType)
 
int startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
 
QThreadthread () const const
 

Additional Inherited Members

- Properties inherited from QObject
 objectName
 
- Signals inherited from Akonadi::EntityTreeModel
void collectionFetched (int collectionId)
 
void collectionPopulated (Akonadi::Collection::Id collectionId)
 
void collectionTreeFetched (const Akonadi::Collection::List &collections)
 
- Static Public Member Functions inherited from Akonadi::EntityTreeModel
static QModelIndexList modelIndexesForItem (const QAbstractItemModel *model, const Item &item)
 
static QModelIndex modelIndexForCollection (const QAbstractItemModel *model, const Collection &collection)
 
static Collection updatedCollection (const QAbstractItemModel *model, qint64 collectionId)
 
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
 
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
 
bool disconnect (const QMetaObject::Connection &connection)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
- Public Attributes inherited from Akonadi::EntityTreeModel
 AvailablePartsRole
 
 CollectionChildOrderRole
 
 CollectionDerefRole
 
 CollectionIdRole
 
 CollectionRefRole
 
 CollectionRole
 
 CollectionTreeHeaders
 
 ColumnCountRole
 
 DisplayNameRole
 
 EndHeaderGroup
 
 EntityTreeHeaders
 
 EntityUrlRole
 
 FetchCollectionsRecursive
 
 FetchFirstLevelChildCollections
 
 FetchingState
 
 FetchNoCollections
 
 FetchStateRole
 
 IdleState
 
 ImmediatePopulation
 
 InvisibleCollectionFetch
 
 IsPopulatedRole
 
 ItemIdRole
 
 ItemListHeaders
 
 ItemRole
 
 LazyPopulation
 
 LoadedPartsRole
 
 MimeTypeRole
 
 NoItemPopulation
 
 OriginalCollectionNameRole
 
 ParentCollectionRole
 
 PendingCutRole
 
 RemoteIdRole
 
 SessionRole
 
 TerminalUserRole
 
 UnreadCountRole
 
 UserHeaders
 
 UserRole
 
- Public Attributes inherited from QAbstractItemModel
 DoNotUseParent
 
 HorizontalSortHint
 
 IndexIsValid
 
 NoLayoutChangeHint
 
 NoOption
 
 ParentIsInvalid
 
 VerticalSortHint
 
- Protected Member Functions inherited from Akonadi::EntityTreeModel
void clearAndReset ()
 
virtual QVariant entityData (const Collection &collection, int column, int role=Qt::DisplayRole) const
 
virtual QVariant entityData (const Item &item, int column, int role=Qt::DisplayRole) const
 
virtual QVariant entityHeaderData (int section, Qt::Orientation orientation, int role, HeaderGroup headerGroup) const
 
- Protected Member Functions inherited from QAbstractItemModel
void beginInsertColumns (const QModelIndex &parent, int first, int last)
 
void beginInsertRows (const QModelIndex &parent, int first, int last)
 
bool beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
 
bool beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)
 
void beginRemoveColumns (const QModelIndex &parent, int first, int last)
 
void beginRemoveRows (const QModelIndex &parent, int first, int last)
 
void beginResetModel ()
 
void changePersistentIndex (const QModelIndex &from, const QModelIndex &to)
 
void changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)
 
QModelIndex createIndex (int row, int column, const void *ptr) const const
 
QModelIndex createIndex (int row, int column, quintptr id) const const
 
void endInsertColumns ()
 
void endInsertRows ()
 
void endMoveColumns ()
 
void endMoveRows ()
 
void endRemoveColumns ()
 
void endRemoveRows ()
 
void endResetModel ()
 
QModelIndexList persistentIndexList () const const
 
virtual void resetInternalData ()
 
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
bool isSignalConnected (const QMetaMethod &signal) const const
 
int receivers (const char *signal) const const
 
QObjectsender () const const
 
int senderSignalIndex () const const
 
virtual void timerEvent (QTimerEvent *event)
 

Detailed Description

A model for contacts and contact groups as available in Akonadi.

This class provides a model for displaying the contacts and contact groups which are available from Akonadi.

Example:

// use a separated session for this model
Akonadi::Session *session = new Akonadi::Session( "MySession" );
// fetch all content of the contacts, including images
scope.fetchFullPayload( true );
// fetch the EntityDisplayAttribute, which contains custom names and icons
monitor->setSession( session );
// include fetching the collection tree
monitor->fetchCollection( true );
// set the fetch scope that shall be used
monitor->setItemFetchScope( scope );
// monitor all collections below the root collection for changes
monitor->setCollectionMonitored( Akonadi::Collection::root() );
// list only contacts and contact groups
monitor->setMimeTypeMonitored( KContacts::Addressee::mimeType(), true );
monitor->setMimeTypeMonitored( KContacts::ContactGroup::mimeType(), true );
model->setColumns( columns );
view->setModel( model );
static Collection root()
A model for contacts and contact groups as available in Akonadi.
void setColumns(const Columns &columns)
Sets the columns that the model should show.
Columns columns() const
Returns the columns that the model currently shows.
@ AllEmails
Shows all email address.
@ FullName
Shows the formatted name or, if empty, the assembled name.
void setModel(QAbstractItemModel *model) override
void fetchAttribute(bool fetch=true)
void fetchFullPayload(bool fetch=true)
void setSession(Akonadi::Session *session)
static QString mimeType()
static QString mimeType()
Author
Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org
Since
4.5

Definition at line 68 of file contactstreemodel.h.

Member Typedef Documentation

◆ Columns

Describes a list of columns of the contacts tree model.

Definition at line 146 of file contactstreemodel.h.

Member Enumeration Documentation

◆ Column

Describes the columns that can be shown by the model.

Enumerator
FullName 

Shows the formatted name or, if empty, the assembled name.

FamilyName 

Shows the family name.

GivenName 

Shows the given name.

Birthday 

Shows the birthday.

HomeAddress 

Shows the formatted home address.

BusinessAddress 

Shows the formatted business address.

PhoneNumbers 

Shows the phone numbers.

PreferredEmail 

Shows the preferred email address.

AllEmails 

Shows all email address.

Organization 

Shows organization name.

Role 

Shows the role of a contact.

Homepage 

Shows homepage url.

Note 

Shows the note.

Definition at line 76 of file contactstreemodel.h.

◆ Roles

Describes the role for contacts and contact groups.

Enumerator
DateRole 

The QDate object for the current index.

Definition at line 151 of file contactstreemodel.h.

Constructor & Destructor Documentation

◆ ContactsTreeModel()

ContactsTreeModel::ContactsTreeModel ( Monitor * monitor,
QObject * parent = nullptr )
explicit

Creates a new contacts tree model.

Parameters
monitorThe Monitor whose entities should be represented in the model.
parentThe parent object.

Definition at line 36 of file contactstreemodel.cpp.

◆ ~ContactsTreeModel()

ContactsTreeModel::~ContactsTreeModel ( )
overridedefault

Destroys the contacts tree model.

Member Function Documentation

◆ columns()

ContactsTreeModel::Columns ContactsTreeModel::columns ( ) const
nodiscard

Returns the columns that the model currently shows.

Definition at line 51 of file contactstreemodel.cpp.

◆ setColumns()

void ContactsTreeModel::setColumns ( const Columns & columns)

Sets the columns that the model should show.

Definition at line 44 of file contactstreemodel.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:05:47 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.