htmlexport.h

/*
  This file is part of the kcalutils library.

  Copyright (c) 2000-2003 Cornelius Schumacher <schumacher@kde.org>
  Copyright (C) 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 KCALUTILS_HTMLEXPORT_H
#define KCALUTILS_HTMLEXPORT_H

#include "kcalutils_export.h"

#include <kcalcore/event.h>
#include <kcalcore/incidence.h>
#include <kcalcore/todo.h>

#include <QtCore/QDateTime>
#include <QtCore/QString>

namespace KCalCore {
class MemoryCalendar;
}

class QTextStream;

namespace KCalUtils {

class HTMLExportSettings;

class KCALUTILS_EXPORT HtmlExport
{
public:
    HtmlExport(KCalCore::MemoryCalendar *calendar, HTMLExportSettings *settings);
    virtual ~HtmlExport();

    bool save(const QString &fileName = QString());

    bool save(QTextStream *ts);

    void addHoliday(const QDate &date, const QString &name);

protected:
    void createWeekView(QTextStream *ts);
    void createMonthView(QTextStream *ts);
    void createEventList(QTextStream *ts);
    void createTodoList(QTextStream *ts);
    void createJournalView(QTextStream *ts);
    void createFreeBusyView(QTextStream *ts);

    void createTodo(QTextStream *ts, const KCalCore::Todo::Ptr &todo);

    void createEvent(QTextStream *ts, const KCalCore::Event::Ptr &event,
                     const QDate &date, bool withDescription = true);

    void createFooter(QTextStream *ts);

    bool checkSecrecy(const KCalCore::Incidence::Ptr &incidence);

    void formatLocation(QTextStream *ts, const KCalCore::Incidence::Ptr &incidence);

    void formatCategories(QTextStream *ts, const KCalCore::Incidence::Ptr &incidence);

    void formatAttendees(QTextStream *ts, const KCalCore::Incidence::Ptr &incidence);

    QString breakString(const QString &text);

    QDate fromDate() const;
    QDate toDate() const;
    QString styleSheet() const;

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

}

#endif