File: README.md

package info (click to toggle)
kpeople 5.54.0-1
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 844 kB
  • sloc: cpp: 4,006; sh: 16; makefile: 9
file content (40 lines) | stat: -rw-r--r-- 1,404 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# KPeople

Provides access to all contacts and aggregates them by person.

## Introduction

KPeople offers unified access to our contacts from different sources, grouping
them by person while still exposing all the data.

Furthermore, KPeople will also provide facilities to integrate the data provided
in user interfaces by providing QML and Qt Widgets components.

The sources are plugin-based, allowing to easily extend the contacts collection.

## Usage

To use KPeople, you'll want to look for it using

    find_package(KF5People)

Or its qmake counterpart. Then you'll have available 3 different libraries to
depend on:
* KPeople which is the most basic one and will mainly provide PersonsModel
and PersonData. You will use them respectively in case you need information
about the full set of contacts on your system or just the one.

* KPeopleWidgets will be required in case we want to integrate it into your
QtWidgets-based application. We will mainly find the PersonDetailsView and
the MergeDialog.

* KPeopleBackend is the library used to make it possible to create backends
for KPeople. You should _only_ use it in case you are providing support for
a new backend type. *WARNING* Its ABI interfaces are not yet stable.

* Also KPeople also bundles a qml import module that can be pulled using:

    import org.kde.people 1.0

This will allow access to the KPeople data from QML code-bases.