filter.h

/*
    This file is part of KAddressBook.
    Copyright (c) 2002 Mike Pilone <mpilone@slac.com>
 
    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
 
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    GNU General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 
    As a special exception, permission is given to link this program
    with any edition of TQt, and distribute the resulting executable,
    without including the source code for TQt in the source distribution.
*/
 
#ifndef FILTER_H
#define FILTER_H
 
#include <tqstring.h>
#include <tqstringlist.h>
#include <tqvaluelist.h>
 
#include <tdeabc/addressee.h>
#include <tdeconfig.h>
 
class Filter
{
  public:
    typedef TQValueList<Filter> List;
 
    enum MatchRule { Matching = 0, NotMatching = 1 };
 
    Filter();
    Filter( const TQString& name );
    ~Filter();
 
    void setName( const TQString &name );
 
    const TQString &name() const;
 
    bool isInternal() const;
 
    void apply( TDEABC::Addressee::List &addresseeList );
 
    bool filterAddressee( const TDEABC::Addressee &a ) const;
 
    void setEnabled( bool on );
 
    bool isEnabled() const;
 
    void setCategories( const TQStringList &list );
 
    const TQStringList &categories() const;
 
    void save( TDEConfig *config );
 
    void restore( TDEConfig *config );
 
    static void save( TDEConfig *config, const TQString &baseGroup, Filter::List &list );
 
    static Filter::List restore( TDEConfig *config, const TQString &baseGroup );
 
    void setMatchRule( MatchRule rule );
 
    MatchRule matchRule() const;
 
    bool isEmpty() const;
 
  private:
    TQString mName;
    TQStringList mCategoryList;
    MatchRule mMatchRule;
    bool mEnabled;
    bool mInternal;
    bool mIsEmpty;
};
 
#endif