occurrenceiterator.h

Go to the documentation of this file.

/*
  This file is part of the kcalcore library.

  Copyright (c) 2013 Christian Mollekopf <mollekopf@kolabsys.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 KCALCORE_OCCURRENCEITERATOR_H
#define KCALCORE_OCCURRENCEITERATOR_H

#include "kcalcore_export.h"
#include "incidence.h"

namespace KCalCore {

class Calendar;
class KCALCORE_EXPORT OccurrenceIterator
{
public:
    explicit OccurrenceIterator(const Calendar &calendar,
                                const KDateTime &start = KDateTime(),
                                const KDateTime &end = KDateTime());

    OccurrenceIterator(const Calendar &calendar,
                       const KCalCore::Incidence::Ptr &incidence,
                       const KDateTime &start = KDateTime(),
                       const KDateTime &end = KDateTime());
    ~OccurrenceIterator();
    bool hasNext() const;

    void next();

    Incidence::Ptr incidence() const;

    KDateTime occurrenceStartDate() const;

private:
    Q_DISABLE_COPY(OccurrenceIterator)
    //@cond PRIVATE
    class Private;
    QScopedPointer<Private> d;
    //@endcond
};

} //namespace

#endif