# Commit policy

Every non-trivial patch must go through the review before it goes into the
master branch.

    https://phabricator.kde.org/
        project:    KActivities

If you don't have an account for identity.kde.org, you can send smaller
patches to the plasma-devel@kde.org mailing list, or (please don't) directly
to the repository maintainer (see MAINTAINER file).


# Code policy

The code needs to follow KDElibs coding style. You can find more information
about the style here:

    http://techbase.kde.org/Policies/Kdelibs_Coding_Style

Macros in CMakeLists.txt should be lowercase throughout the project,
and indentation should be 3, with the closing parenthesis in the same level
as the content.

Check out the KF5 policies:

    https://community.kde.org/Frameworks/Policies

# KActivitiesStats

Library to access the usage statistics data collected by the KDE activity manager.

## Introduction

The KActivitiesStats library provides a querying mechanism for the data
that the activity manager collects - which documents hae been opened by
which applications, and what documents have been linked to which activity.
The activity manager also keeps the score for each document which gets
higher when a particular document has been often accessed or kept open
for longer periods of time. This score is also available through the
querying mechanism.

## Usage

The library provides the following important classes:

- `KActivities::Stats::ResultSet` is a low level class that provides a forward iterator to the
  list of results that match the specified query
- `KActivities::Stats::ResultWatcher` provides signals when a new resource that matches a query
  arrives, or when an existing one is gone (usage statistics cleared or some
  for other reason)
- `KActivities::Stats::ResultModel` provides a Qt data model that shows the resources that
  match the specified query. This model should be subclassed to teach it
  to handle the different resource types that you want to show as the results.

Queries are defined by the `KActivities::Stats::Query` class using a simple range-like syntax.