• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KCal Library

  • kcal
calfilter.h
Go to the documentation of this file.
1/*
2 This file is part of the kcal library.
3
4 Copyright (c) 2001,2003,2004 Cornelius Schumacher <schumacher@kde.org>
5 Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com>
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Library General Public
9 License as published by the Free Software Foundation; either
10 version 2 of the License, or (at your option) any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Library General Public License for more details.
16
17 You should have received a copy of the GNU Library General Public License
18 along with this library; see the file COPYING.LIB. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA.
21*/
31#ifndef KCAL_CALFILTER_H
32#define KCAL_CALFILTER_H
33
34#include <QtCore/QString>
35
36#include "kcal_export.h"
37#include "event.h"
38#include "todo.h"
39#include "journal.h"
40
41namespace KCal {
42
57class KCAL_DEPRECATED_EXPORT CalFilter
58{
59 public:
63 enum Criteria {
64 HideRecurring = 1,
65 HideCompletedTodos = 2,
66 ShowCategories = 4,
67 HideInactiveTodos = 8,
68 HideNoMatchingAttendeeTodos = 16
69 };
70
74 CalFilter();
75
81 explicit CalFilter( const QString &name );
82
86 ~CalFilter();
87
94 void setName( const QString &name );
95
100 QString name() const;
101
109 void setCriteria( int criteria );
110
115 int criteria() const;
116
123 void apply( Event::List *eventList ) const;
124
131 void apply( Todo::List *todoList ) const;
132
139 void apply( Journal::List *journalList ) const;
140
147 bool filterIncidence( Incidence *incidence ) const;
148
155 void setEnabled( bool enabled );
156
161 bool isEnabled() const;
162
170 void setCategoryList( const QStringList &categoryList );
171
176 QStringList categoryList() const;
177
185 void setEmailList( const QStringList &emailList );
186
191 QStringList emailList() const;
192
203 void setCompletedTimeSpan( int timespan );
204
209 int completedTimeSpan() const;
210
216 //KDE5: make const
217 bool operator==( const CalFilter &filter ); //krazy:exclude=operators
218
219 private:
220 //@cond PRIVATE
221 Q_DISABLE_COPY( CalFilter )
222 class Private;
223 Private *const d;
224 //@endcond
225};
226
227}
228
229#endif
KCal::CalFilter
Provides a filter for calendars.
Definition: calfilter.h:58
KCal::CalFilter::Criteria
Criteria
Filtering Criteria.
Definition: calfilter.h:63
KCal::Incidence
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
Definition: incidence.h:70
KCal::ListBase
This class provides a template for lists of pointers.
Definition: listbase.h:45
event.h
This file is part of the API for handling calendar data and defines the Event class.
journal.h
This file is part of the API for handling calendar data and defines the Journal class.
todo.h
This file is part of the API for handling calendar data and defines the Todo class.
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCal Library

Skip menu "KCal Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
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