incidenceformatter.h

Go to the documentation of this file.

/*
  This file is part of the kcalutils library.

  Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
  Copyright (c) 2004 Reinhold Kainhofer <reinhold@kainhofer.com>
  Copyright (c) 2009-2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.net>

  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_INCIDENCEFORMATTER_H
#define KCALUTILS_INCIDENCEFORMATTER_H

#include "kcalutils_export.h"

#include <kcalcore/incidence.h>
#include <kcalcore/memorycalendar.h>

#include <QDate>

namespace KCalUtils {

class KCALUTILS_EXPORT InvitationFormatterHelper
{
public:
    InvitationFormatterHelper();
    virtual ~InvitationFormatterHelper();
    virtual QString generateLinkURL(const QString &id);
    virtual QString makeLink(const QString &id, const QString &text);
    virtual KCalCore::Calendar::Ptr calendar() const;

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

namespace IncidenceFormatter {

KCALUTILS_EXPORT QString toolTipStr(const QString &sourceName,
                                    const KCalCore::IncidenceBase::Ptr &incidence,
                                    const QDate &date = QDate(),
                                    bool richText = true,
                                    KDateTime::Spec spec = KDateTime::Spec());

KCALUTILS_EXPORT QString extensiveDisplayStr(const KCalCore::Calendar::Ptr &calendar,
        const KCalCore::IncidenceBase::Ptr &incidence,
        const QDate &date=QDate(),
        KDateTime::Spec spec=KDateTime::Spec());

KCALUTILS_EXPORT QString extensiveDisplayStr(const QString &sourceName,
        const KCalCore::IncidenceBase::Ptr &incidence,
        const QDate &date=QDate(),
        KDateTime::Spec spec=KDateTime::Spec());

KCALUTILS_EXPORT QString mailBodyStr(const KCalCore::IncidenceBase::Ptr &incidence,
                                     KDateTime::Spec spec=KDateTime::Spec());

KCALUTILS_EXPORT QString formatICalInvitation(
    QString invitation,
    const KCalCore::MemoryCalendar::Ptr &calendar,
    InvitationFormatterHelper *helper,
    bool outlookCompareStyle);

KCALUTILS_EXPORT QString formatICalInvitationNoHtml(
    const QString &invitation,
    const KCalCore::MemoryCalendar::Ptr &calendar,
    InvitationFormatterHelper *helper,
    const QString &sender,
    bool outlookCompareStyle);

KCALUTILS_EXPORT QString recurrenceString(const KCalCore::Incidence::Ptr &incidence);

KCALUTILS_EXPORT QStringList reminderStringList(const KCalCore::Incidence::Ptr &incidence,
        bool shortfmt = true);

KCALUTILS_EXPORT QString timeToString(const KDateTime &date, bool shortfmt = true,
                                      const KDateTime::Spec &spec = KDateTime::Spec());

KCALUTILS_EXPORT QString dateToString(const KDateTime &date, bool shortfmt = true,
                                      const KDateTime::Spec &spec = KDateTime::Spec());

KCALUTILS_EXPORT QString dateTimeToString(const KDateTime &date,
        bool dateOnly = false,
        bool shortfmt = true,
        const KDateTime::Spec &spec = KDateTime::Spec());

KCALUTILS_EXPORT QString resourceString(const KCalCore::Calendar::Ptr &calendar,
                                        const KCalCore::Incidence::Ptr &incidence);

KCALUTILS_EXPORT QString durationString(const KCalCore::Incidence::Ptr &incidence);

KCALUTILS_EXPORT QString incidenceStatusName(KCalCore::Incidence::Status status);

KCALUTILS_EXPORT QString incidenceStatusStr(const KCalCore::Incidence::Ptr &incidence);

class EventViewerVisitor;
class ScheduleMessageVisitor;
class InvitationHeaderVisitor;
class InvitationBodyVisitor;
class IncidenceCompareVisitor;
class ToolTipVisitor;
class MailBodyVisitor;
}

}

#endif