• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepimlibs API Reference
  • KDE Home
  • Contact Us
 

akonadi

  • Akonadi
  • SearchQuery
Public Member Functions | Static Public Member Functions | List of all members
Akonadi::SearchQuery Class Reference

#include <searchquery.h>

Public Member Functions

 SearchQuery (SearchTerm::Relation rel=SearchTerm::RelAnd)
 
 SearchQuery (const SearchQuery &other)
 
void addTerm (const QString &key, const QVariant &value, SearchTerm::Condition condition=SearchTerm::CondEqual)
 
void addTerm (const SearchTerm &term)
 
bool isNull () const
 
int limit () const
 
SearchQuery & operator= (const SearchQuery &other)
 
bool operator== (const SearchQuery &other) const
 
void setLimit (int limit)
 
void setTerm (const SearchTerm &term)
 
SearchTerm term () const
 
QByteArray toJSON () const
 

Static Public Member Functions

static SearchQuery fromJSON (const QByteArray &json)
 

Detailed Description

A query that can be passed to ItemSearchJob or others.

Since
4.13

Definition at line 128 of file searchquery.h.

Constructor & Destructor Documentation

SearchQuery::SearchQuery ( SearchTerm::Relation  rel = SearchTerm::RelAnd)

Constructs query where all added terms will be in given relation.

Definition at line 219 of file searchquery.cpp.

Member Function Documentation

void SearchQuery::addTerm ( const QString &  key,
const QVariant &  value,
SearchTerm::Condition  condition = SearchTerm::CondEqual 
)

Adds a new term.

Definition at line 255 of file searchquery.cpp.

void SearchQuery::addTerm ( const SearchTerm &  term)

Adds a new term with subterms.

Definition at line 260 of file searchquery.cpp.

int SearchQuery::limit ( ) const

Returns the maximum number of results.

The default value is -1, indicating no limit.

Definition at line 275 of file searchquery.cpp.

void SearchQuery::setLimit ( int  limit)

Sets the maximum number of results.

Note that this limit is only evaluated per search backend, so the total number of results retrieved may be larger.

Definition at line 270 of file searchquery.cpp.

void SearchQuery::setTerm ( const SearchTerm &  term)

Sets the root term.

Definition at line 265 of file searchquery.cpp.

SearchTerm SearchQuery::term ( ) const

Returns the root term.

Definition at line 250 of file searchquery.cpp.


The documentation for this class was generated from the following files:
  • searchquery.h
  • searchquery.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:38:05 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

akonadi

Skip menu "akonadi"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Modules
  • Related Pages

kdepimlibs API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal