KActivities::Stats::Query Class Reference

#include <KActivities/Stats/Query>

Public Member Functions
	Query (const Query &source)
	Query (Query &&source)
	Query (Terms::Select selection=Terms::AllResources)
QStringList	activities () const
void	addActivities (const QStringList &activities)
void	addAgents (const QStringList &agents)
void	addTitleFilters (const QStringList &urlFilters)
void	addTypes (const QStringList &types)
void	addUrlFilters (const QStringList &urlFilters)
QStringList	agents () const
void	clearActivities ()
void	clearAgents ()
void	clearTitleFilters ()
void	clearTypes ()
void	clearUrlFilters ()
QDate	dateEnd () const
QDate	dateStart () const
int	limit () const
int	offset () const
bool	operator!= (const Query &right) const
Query &	operator= (Query source)
bool	operator== (const Query &right) const
Terms::Order	ordering () const
void	removeActivities (const QStringList &activities)
void	removeAgents (const QStringList &agents)
void	removeTypes (const QStringList &types)
void	removeUrlFilters (const QStringList &urlFilters)
Terms::Select	selection () const
void	setActivities (const Terms::Activity &activities)
void	setAgents (const Terms::Agent &agents)
void	setDate (const Terms::Date &date)
void	setDateEnd (QDate date)
void	setDateStart (QDate date)
void	setLimit (int limit)
void	setOffset (int offset)
void	setOrdering (Terms::Order ordering)
void	setSelection (Terms::Select selection)
void	setTitleFilters (const Terms::Title &title)
void	setTypes (const Terms::Type &types)
void	setUrlFilters (const Terms::Url &urlFilters)
QStringList	titleFilters () const
QStringList	types () const
QStringList	urlFilters () const

Detailed Description

The activities system tracks resources (documents, contacts, etc.) that the user has used.

It also allows linking resources to specific activities (like bookmarks, favorites, etc.).

The Query class specifies which resources to return - the previously used ones, the linked ones, or to combine these two.

It allows filtering the results depending on the resource type, the agent (application that reported the usage event, see KActivities::ResourceInstance) and the activity the resource has been used in, or linked to. It also allows filtering on the URL of the resource.

While it can be explicitly instantiated, a preferred approach is to use the pipe syntax like this:

auto query = UsedResources
                | RecentlyUsedFirst
                | Agent::any()
                | Type::any()
                | Activity::current();

Definition at line 53 of file query.h.

Constructor & Destructor Documentation

Query() [1/3]

KActivities::Stats::Query::Query

(

Terms::Select

selection = Terms::AllResources

)

Definition at line 78 of file query.cpp.

Query() [2/3]

KActivities::Stats::Query::Query

(

Query &&

source

)

Definition at line 84 of file query.cpp.

Query() [3/3]

KActivities::Stats::Query::Query

(

const Query &

source

)

Definition at line 90 of file query.cpp.

~Query()

KActivities::Stats::Query::~Query

(

)

Definition at line 101 of file query.cpp.

Member Function Documentation

dateEnd()

QDate KActivities::Stats::Query::dateEnd

(

)

const

Definition at line 216 of file query.cpp.

dateStart()

QDate KActivities::Stats::Query::dateStart

(

)

const

Definition at line 211 of file query.cpp.

limit()

int KActivities::Stats::Query::limit

(

)

const

Definition at line 200 of file query.cpp.

offset()

int KActivities::Stats::Query::offset

(

)

const

Definition at line 205 of file query.cpp.

operator!=()

bool KActivities::Stats::Query::operator!=

(

const Query &

right

)

const

Definition at line 118 of file query.cpp.

operator=()

Query & KActivities::Stats::Query::operator=

(

Query

source

)

Definition at line 95 of file query.cpp.

operator==()

bool KActivities::Stats::Query::operator==

(

const Query &

right

)

const

Definition at line 106 of file query.cpp.

ordering()

Terms::Order KActivities::Stats::Query::ordering

(

)

const

Definition at line 190 of file query.cpp.

selection()

Terms::Select KActivities::Stats::Query::selection

(

)

const

Definition at line 195 of file query.cpp.

setActivities()

void KActivities::Stats::Query::setActivities

(

const Terms::Activity &

activities

)

Since

5.62

setAgents()

void KActivities::Stats::Query::setAgents

(

const Terms::Agent &

agents

)

Since

5.62

setDate()

void KActivities::Stats::Query::setDate

(

const Terms::Date &

date

)

Since

5.62

Definition at line 174 of file query.cpp.

setDateEnd()

void KActivities::Stats::Query::setDateEnd

(

QDate

date

)

Definition at line 185 of file query.cpp.

setDateStart()

void KActivities::Stats::Query::setDateStart

(

QDate

date

)

Definition at line 180 of file query.cpp.

setLimit()

void KActivities::Stats::Query::setLimit

(

int

limit

)

Definition at line 164 of file query.cpp.

setOffset()

void KActivities::Stats::Query::setOffset

(

int

offset

)

Definition at line 169 of file query.cpp.

setSelection()

void KActivities::Stats::Query::setSelection

(

Terms::Select

selection

)

Definition at line 159 of file query.cpp.

setTypes()

void KActivities::Stats::Query::setTypes

(

const Terms::Type &

types

)

Since

5.62

setUrlFilters()

void KActivities::Stats::Query::setUrlFilters

(

const Terms::Url &

urlFilters

)

Since

5.62

---

The documentation for this class was generated from the following files:

• query.h
• query.cpp