libkcal Library API Documentation

calfilter.h

00001 /*
00002     This file is part of libkcal.
00003 
00004     Copyright (c) 2001,2003 Cornelius Schumacher <schumacher@kde.org>
00005 
00006     This library is free software; you can redistribute it and/or
00007     modify it under the terms of the GNU Library General Public
00008     License as published by the Free Software Foundation; either
00009     version 2 of the License, or (at your option) any later version.
00010 
00011     This library is distributed in the hope that it will be useful,
00012     but WITHOUT ANY WARRANTY; without even the implied warranty of
00013     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00014     Library General Public License for more details.
00015 
00016     You should have received a copy of the GNU Library General Public License
00017     along with this library; see the file COPYING.LIB.  If not, write to
00018     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00019     Boston, MA 02111-1307, USA.
00020 */
00021 #ifndef KCAL_CALFILTER_H
00022 #define KCAL_CALFILTER_H
00023 
00024 #include <qstring.h>
00025 #include <qptrlist.h>
00026 
00027 #include "event.h"
00028 #include "todo.h"
00029 
00030 namespace KCal {
00031 
00035 class CalFilter
00036 {
00037   public:
00039     CalFilter();
00041     CalFilter(const QString &name);
00043     ~CalFilter();
00044     
00048     void setName(const QString &name) { mName = name; }
00052     QString name() const { return mName; }
00053     
00058     void apply(Event::List *eventlist);
00059     
00064     void apply(Todo::List *todolist);
00065     
00070     bool filterEvent(Event *);
00071     
00076     bool filterTodo(Todo *);
00077     
00082     bool filterIncidence(Incidence *);
00083     
00087     void setEnabled(bool);
00091     bool isEnabled();
00092 
00093 
00099     void setCategoryList(const QStringList &);
00104     QStringList categoryList();
00105     
00106     enum { HideRecurring = 1, HideCompleted = 2, ShowCategories = 4 };
00107     
00111     void setCriteria(int);
00115     int criteria();
00116     
00117   private:
00118     QString mName;
00119 
00120     int mCriteria;
00121     
00122     bool mEnabled;
00123     
00124     QStringList mCategoryList;
00125 
00126     class Private;
00127     Private *d;
00128 };
00129 
00130 }
00131 
00132 #endif
KDE Logo
This file is part of the documentation for libkcal Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:36:21 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003