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

messagelist

  • MessageList
  • Core
  • Filter
Signals | Public Member Functions | List of all members
MessageList::Core::Filter Class Reference

#include <filter.h>

Inheritance diagram for MessageList::Core::Filter:
Inheritance graph
[legend]

Signals

void finished ()
 

Public Member Functions

 Filter ()
 
void clear ()
 
bool isEmpty () const
 
bool match (const MessageItem *item) const
 
const QString & searchString () const
 
void setCurrentFolder (const KUrl &url)
 
void setSearchString (const QString &search)
 
void setStatus (const Akonadi::MessageStatus &status)
 
void setTagId (const QString &tagId)
 
Akonadi::MessageStatus status () const
 
const QString & tagId () const
 

Detailed Description

This class is responsable of matching messages that should be displayed in the View.

It's used mainly by Model and Widget.

Definition at line 51 of file filter.h.

Constructor & Destructor Documentation

Filter::Filter ( )

Definition at line 38 of file filter.cpp.

Member Function Documentation

void Filter::clear ( )

Clears this filter (sets status to 0, search string and tag id to empty strings)

Definition at line 109 of file filter.cpp.

void MessageList::Core::Filter::finished ( )
signal
bool Filter::isEmpty ( ) const

Returns true if this filter is empty (0 status mask, empty search string and empty tag) and it's useless to call match() that will always return true.

Definition at line 95 of file filter.cpp.

bool Filter::match ( const MessageItem *  item) const

Returns true if the specified parameters match this filter and false otherwise.

The msg pointer must not be null.

Definition at line 61 of file filter.cpp.

const QString& MessageList::Core::Filter::searchString ( ) const
inline

Returns the currently set search string.

Definition at line 85 of file filter.h.

void Filter::setCurrentFolder ( const KUrl &  url)

Sets the current folder of this filter.

Definition at line 119 of file filter.cpp.

void Filter::setSearchString ( const QString &  search)

Sets the search string for this filter.

Definition at line 124 of file filter.cpp.

void MessageList::Core::Filter::setStatus ( const Akonadi::MessageStatus &  status)
inline

Sets the status mask for this filter.

Definition at line 74 of file filter.h.

void MessageList::Core::Filter::setTagId ( const QString &  tagId)
inline

Sets the id of a MessageItem::Tag that the matching messages must contain.

Definition at line 102 of file filter.h.

Akonadi::MessageStatus MessageList::Core::Filter::status ( ) const
inline

Returns the currently set status mask.

Definition at line 68 of file filter.h.

const QString& MessageList::Core::Filter::tagId ( ) const
inline

Returns the currently set MessageItem::Tag id.

Definition at line 96 of file filter.h.


The documentation for this class was generated from the following files:
  • filter.h
  • filter.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:55:32 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

messagelist

Skip menu "messagelist"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members

kdepim API Reference

Skip menu "kdepim API Reference"
  • akonadi_next
  • akregator
  • blogilo
  • calendarsupport
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt2
  • kjots
  • kleopatra
  • kmail
  • knode
  • knotes
  • kontact
  • korgac
  • korganizer
  • ktimetracker
  • libkdepim
  • libkleo
  • libkpgp
  • mailcommon
  • messagelist
  • messageviewer

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