Search for usage in LXR

KPeople::PersonPluginManager Class Reference

#include <personpluginmanager.h>

Static Public Member Functions

static bool addContact (const QVariantMap &properties)
static void addDataSource (const QString &sourceId, BasePersonsDataSource *source)
static BasePersonsDataSource * dataSource (const QString &sourceId)
static QList< BasePersonsDataSource * > dataSourcePlugins ()
static bool deleteContact (const QString &uri)
static void setAutoloadDataSourcePlugins (bool autoloadDataSourcePlugins)
static void setDataSourcePlugins (const QHash< QString, BasePersonsDataSource * > &dataSources)

Detailed Description

This class allows applications to manage DataSource plugins.

It can be useful if an application wants to use custom DataSource, without exposing it to other KPeople-based applications (i.e. without installing a system-wide plugin)

Another use-case is that it allows to pass custom arguments to DataSources (i.e. an ItemModel which will be used as a source of data)


Definition at line 33 of file personpluginmanager.h.

Member Function Documentation

◆ addContact()

bool KPeople::PersonPluginManager::addContact ( const QVariantMap &  properties)

Creates a contact with the specified properties.

if it could be done successfully

Definition at line 107 of file personpluginmanager.cpp.

◆ addDataSource()

void PersonPluginManager::addDataSource ( const QString sourceId,
BasePersonsDataSource *  source 

Adds custom data source.

If DataSource with such sourceId was already loaded, we override it

Takes ownership of the source

Definition at line 71 of file personpluginmanager.cpp.

◆ deleteContact()

bool KPeople::PersonPluginManager::deleteContact ( const QString uri)

Deletes a contact with the specified &p uri.

if it could be done successfully

Definition at line 121 of file personpluginmanager.cpp.

◆ setAutoloadDataSourcePlugins()

void PersonPluginManager::setAutoloadDataSourcePlugins ( bool  autoloadDataSourcePlugins)

Use this if you explicitly don't want KPeople to autoload all the available data source plugins.

The default behavior is to autoload them

Definition at line 66 of file personpluginmanager.cpp.

◆ setDataSourcePlugins()

void PersonPluginManager::setDataSourcePlugins ( const QHash< QString, BasePersonsDataSource * > &  dataSources)

Instead of loading datasources from plugins, set sources manually This is for unit tests only.

Definition at line 81 of file personpluginmanager.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Dec 5 2023 04:09:08 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.