Search for usage in LXR

#include <searchquery.h>

Inheritance diagram for Akonadi::EmailSearchTerm:

Public Types

enum  EmailSearchField {
  Unknown, Subject, Body, Message,
  Headers, HeaderFrom, HeaderTo, HeaderCC,
  HeaderBCC, HeaderReplyTo, HeaderOrganization, HeaderListId,
  HeaderResentFrom, HeaderXLoop, HeaderXMailingList, HeaderXSpamFlag,
  HeaderDate, HeaderOnlyDate, MessageStatus, ByteSize,
  Attachment, MessageTag
- Public Types inherited from Akonadi::SearchTerm
enum  Condition {
  CondEqual, CondGreaterThan, CondGreaterOrEqual, CondLessThan,
  CondLessOrEqual, CondContains
enum  Relation { RelAnd, RelOr }

Public Member Functions

 EmailSearchTerm (EmailSearchField field, const QVariant &value, SearchTerm::Condition condition=SearchTerm::CondEqual)
- Public Member Functions inherited from Akonadi::SearchTerm
 SearchTerm (const QString &key, const QVariant &value, SearchTerm::Condition condition=SearchTerm::CondEqual)
 SearchTerm (const SearchTerm &other)
 SearchTerm (SearchTerm::Relation relation=SearchTerm::RelAnd)
void addSubTerm (const SearchTerm &term)
SearchTerm::Condition condition () const
bool isNegated () const
bool isNull () const
QString key () const
SearchTermoperator= (const SearchTerm &other)
bool operator== (const SearchTerm &other) const
SearchTerm::Relation relation () const
void setIsNegated (bool negated)
QList< SearchTermsubTerms () const
QVariant value () const

Static Public Member Functions

static EmailSearchField fromKey (const QString &key)
static QString toKey (EmailSearchField)

Detailed Description

A search term for an email field.

This class can be used to create queries that akonadi email search backends understand.


Definition at line 180 of file searchquery.h.

Member Enumeration Documentation

◆ EmailSearchField

All fields expect a search string unless noted otherwise.

Definition at line 186 of file searchquery.h.

Constructor & Destructor Documentation

◆ EmailSearchTerm()

EmailSearchTerm::EmailSearchTerm ( EmailSearchTerm::EmailSearchField  field,
const QVariant value,
SearchTerm::Condition  condition = SearchTerm::CondEqual 

Constructs an email end term.

Definition at line 293 of file searchquery.cpp.

Member Function Documentation

◆ fromKey()

EmailSearchTerm::EmailSearchField EmailSearchTerm::fromKey ( const QString key)

Translates key to field.

Definition at line 303 of file searchquery.cpp.

◆ toKey()

QString EmailSearchTerm::toKey ( EmailSearchTerm::EmailSearchField  field)

Translates field to key.

Definition at line 298 of file searchquery.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 Oct 3 2023 04:02:01 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.