calfilter.h

/*
    This file is part of libkcal.
 
    Copyright (c) 2001,2003,2004 Cornelius Schumacher <schumacher@kde.org>
    Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com>
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.
 
    This library 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
    Library General Public License for more details.
 
    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
#ifndef KCAL_CALFILTER_H
#define KCAL_CALFILTER_H
 
#include <tqstring.h>
#include <tqptrlist.h>
 
#include "event.h"
#include "todo.h"
#include "journal.h"
#include "libkcal_export.h"
 
namespace KCal {

class LIBKCAL_EXPORT CalFilter
{
  public:
    CalFilter();
    CalFilter( const TQString &name );
    ~CalFilter();

    void setName( const TQString &name ) { mName = name; }
    TQString name() const { return mName; }

    void apply( Event::List *eventlist ) const;

    void apply( Todo::List *todolist ) const;

    void apply( Journal::List *journallist) const;

    bool filterIncidence( Incidence * ) const;

    void setEnabled( bool );
    bool isEnabled() const;
 

    void setCategoryList( const TQStringList & );
    TQStringList categoryList() const;

    void setEmailList( const TQStringList & );
    TQStringList emailList() const;
 
    enum { HideRecurring = 1, HideCompleted = 2, ShowCategories = 4,
           HideInactiveTodos = 8, HideTodosWithoutAttendeeInEmailList = 16 };

    void setCriteria( int );
    int criteria() const;

    void setCompletedTimeSpan( int timespan );
    int completedTimeSpan() const;
 
  private:
    TQString mName;
 
    int mCriteria;
 
    bool mEnabled;
 
    TQStringList mCategoryList;
    TQStringList mEmailList;
    int mCompletedTimeSpan;
 
    class Private;
    Private *d;
};
 
}
 
#endif