calendarlocal.h

Go to the documentation of this file.

/*
  This file is part of the kcal library.

  Copyright (c) 1998 Preston Brown <pbrown@kde.org>
  Copyright (c) 2001,2003 Cornelius Schumacher <schumacher@kde.org>

  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_CALENDARLOCAL_H
#define KCAL_CALENDARLOCAL_H

#include "calendar.h"

namespace KCal {

class CalFormat;

class KCAL_DEPRECATED_EXPORT CalendarLocal : public Calendar
{
  public:
    explicit CalendarLocal( const KDateTime::Spec &timeSpec );

    explicit CalendarLocal( const QString &timeZoneId );

    ~CalendarLocal();

    bool load( const QString &fileName, CalFormat *format = 0 );

    bool reload();

    bool save();

    bool save( const QString &fileName, CalFormat *format = 0 );

    void close();

  // Event Specific Methods //

    bool addEvent( Event *event );

    bool deleteEvent( Event *event );

    void deleteAllEvents();

    Event::List rawEvents(
      EventSortField sortField = EventSortUnsorted,
      SortDirection sortDirection = SortDirectionAscending );

    Event::List rawEvents( const QDate &start, const QDate &end,
                           const KDateTime::Spec &timeSpec = KDateTime::Spec(),
                           bool inclusive = false );

    Event::List rawEventsForDate(
      const QDate &date, const KDateTime::Spec &timeSpec = KDateTime::Spec(),
      EventSortField sortField = EventSortUnsorted,
      SortDirection sortDirection = SortDirectionAscending );

    Event::List rawEventsForDate( const KDateTime &dt );

    Event *event( const QString &uid );

  // To-do Specific Methods //

    bool addTodo( Todo *todo );

    bool deleteTodo( Todo *todo );

    void deleteAllTodos();

    Todo::List rawTodos(
      TodoSortField sortField = TodoSortUnsorted,
      SortDirection sortDirection = SortDirectionAscending );

    Todo::List rawTodosForDate( const QDate &date );

    Todo *todo( const QString &uid );

  // Journal Specific Methods //

    bool addJournal( Journal *journal );

    bool deleteJournal( Journal *journal );

    void deleteAllJournals();

    Journal::List rawJournals(
      JournalSortField sortField = JournalSortUnsorted,
      SortDirection sortDirection = SortDirectionAscending );

    Journal::List rawJournalsForDate( const QDate &date );

    Journal *journal( const QString &uid );

  // Alarm Specific Methods //

    Alarm::List alarms( const KDateTime &from, const KDateTime &to );

    Alarm::List alarmsTo( const KDateTime &to );

    void incidenceUpdated( IncidenceBase *incidenceBase );

    using QObject::event;   // prevent warning about hidden virtual method

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

}

#endif