calfilter.h

Go to the documentation of this file.

/*
  This file is part of the kcal library.

  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 <QtCore/QString>

#include "kcal_export.h"
#include "event.h"
#include "todo.h"
#include "journal.h"

namespace KCal {

class KCAL_DEPRECATED_EXPORT CalFilter
{
  public:
    enum Criteria {
      HideRecurring = 1,     
      HideCompletedTodos = 2,
      ShowCategories = 4,    
      HideInactiveTodos = 8, 
      HideNoMatchingAttendeeTodos = 16 
    };

    CalFilter();

    explicit CalFilter( const QString &name );

    ~CalFilter();

    void setName( const QString &name );

    QString name() const;

    void setCriteria( int criteria );

    int criteria() const;

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

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

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

    bool filterIncidence( Incidence *incidence ) const;

    void setEnabled( bool enabled );

    bool isEnabled() const;

    void setCategoryList( const QStringList &categoryList );

    QStringList categoryList() const;

    void setEmailList( const QStringList &emailList );

    QStringList emailList() const;

    void setCompletedTimeSpan( int timespan );

    int completedTimeSpan() const;

    //KDE5: make const
    bool operator==( const CalFilter &filter ); //krazy:exclude=operators

  private:
    //@cond PRIVATE
    Q_DISABLE_COPY( CalFilter )
    class Private;
    Private *const d;
    //@endcond
};

}

#endif