MailCommon::SearchRuleStatus Class
class MailCommon::SearchRuleStatusThis class represents a search pattern rule operating on message status. More...
| Header: | #include <MailCommon/SearchRuleStatus> |
| CMake: | find_package(KPim6MailCommon REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::MailCommon) |
| Inherits: | MailCommon::SearchRule |
Public Functions
| SearchRuleStatus(Akonadi::MessageStatus status, MailCommon::SearchRule::Function function = FuncContains) | |
| SearchRuleStatus(const QByteArray &field = QByteArray(), MailCommon::SearchRule::Function function = FuncContains, const QString &contents = QString()) |
Reimplemented Public Functions
| virtual void | addQueryTerms(Akonadi::SearchTerm &groupTerm, bool &emptyIsNotAnError) const override |
| virtual QString | informationAboutNotValidRules() const override |
| virtual bool | isEmpty() const override |
| virtual bool | matches(const Akonadi::Item &item) const override |
| virtual MailCommon::SearchRule::RequiredPart | requiredPart() const override |
Static Public Members
| Akonadi::MessageStatus | statusFromEnglishName(const QString &name) |
Detailed Description
This class represents a search to be performed against the status of a message. The status is represented by a bitfield.
Member Function Documentation
[explicit] SearchRuleStatus::SearchRuleStatus(Akonadi::MessageStatus status, MailCommon::SearchRule::Function function = FuncContains)
Constructs a search rule for a specific message status.
status The message status to search for function The function to use for searching
[explicit] SearchRuleStatus::SearchRuleStatus(const QByteArray &field = QByteArray(), MailCommon::SearchRule::Function function = FuncContains, const QString &contents = QString())
Constructs a search rule for message status.
field The field to search in function The function to use for searching contents The contents to search for
[override virtual] void SearchRuleStatus::addQueryTerms(Akonadi::SearchTerm &groupTerm, bool &emptyIsNotAnError) const
Reimplements: SearchRule::addQueryTerms(Akonadi::SearchTerm &groupTerm, bool &emptyIsNotAnError) const.
Adds query terms to the given term group.
groupTerm The search term group to add query terms to emptyIsNotAnError Whether empty values should be considered an error
[override virtual] QString SearchRuleStatus::informationAboutNotValidRules() const
Reimplements: SearchRule::informationAboutNotValidRules() const.
Returns information about validation errors in this rule.
Returns A string describing validation errors, or empty if valid
[override virtual] bool SearchRuleStatus::isEmpty() const
Reimplements: SearchRule::isEmpty() const.
Determines whether the rule is worth considering.
Returns True if the rule is empty, false otherwise
[override virtual] bool SearchRuleStatus::matches(const Akonadi::Item &item) const
Reimplements: SearchRule::matches(const Akonadi::Item &item) const.
Tries to match the rule against the Akonadi item.
item The Akonadi item to match against Returns True if the rule matches, false otherwise
[override virtual] MailCommon::SearchRule::RequiredPart SearchRuleStatus::requiredPart() const
Reimplements: SearchRule::requiredPart() const.
Returns the required part from the item that is needed for the search to operate.
[static] Akonadi::MessageStatus SearchRuleStatus::statusFromEnglishName(const QString &name)
Converts an English status name to the corresponding MessageStatus.
name The English name of the status Returns The corresponding message status