Akonadi::SearchQuery Class
class Akonadi::SearchQueryA query that can be passed to ItemSearchJob or others. More...
| Header: | #include <Akonadi/SearchQuery> |
| CMake: | find_package(KPim6 REQUIRED COMPONENTS AkonadiCore)target_link_libraries(mytarget PRIVATE KPim6::AkonadiCore) |
Public Functions
| SearchQuery(Akonadi::SearchTerm::Relation rel = SearchTerm::RelAnd) | |
| void | addTerm(const Akonadi::SearchTerm &term) |
| void | addTerm(const QString &key, const QVariant &value, Akonadi::SearchTerm::Condition condition = SearchTerm::CondEqual) |
| int | limit() const |
| void | setLimit(int limit) |
| void | setTerm(const Akonadi::SearchTerm &term) |
| Akonadi::SearchTerm | term() const |
Detailed Description
Member Function Documentation
[explicit] SearchQuery::SearchQuery(Akonadi::SearchTerm::Relation rel = SearchTerm::RelAnd)
Constructs query where all added terms will be in given relation
void SearchQuery::addTerm(const Akonadi::SearchTerm &term)
Adds a new term with subterms
void SearchQuery::addTerm(const QString &key, const QVariant &value, Akonadi::SearchTerm::Condition condition = SearchTerm::CondEqual)
Adds a new term.
int SearchQuery::limit() const
Returns the maximum number of results.
The default value is -1, indicating no limit.
See also setLimit().
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.
See also limit().
void SearchQuery::setTerm(const Akonadi::SearchTerm &term)
Sets the root term
See also term().
Akonadi::SearchTerm SearchQuery::term() const
Returns the root term.
See also setTerm().