incidenceformatter.h

Go to the documentation of this file.

/*
  This file is part of the kcal 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 KCAL_INCIDENCEFORMATTER_H
#define KCAL_INCIDENCEFORMATTER_H

#include "kcal_export.h"
#include <KDE/KDateTime>
#include <QtCore/QString>

namespace KCal {
class Calendar;
class Incidence;
class IncidenceBase;

class KCAL_DEPRECATED_EXPORT InvitationFormatterHelper
{
  public:
    InvitationFormatterHelper() : d( 0 ) {}
    virtual ~InvitationFormatterHelper(){}
    virtual QString generateLinkURL( const QString &id );
    virtual QString makeLink( const QString &id, const QString &text );
    virtual Calendar *calendar() const;

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

namespace IncidenceFormatter
{
  KCAL_DEPRECATED_EXPORT QString toolTipStr( Calendar *calendar,
                                  IncidenceBase *incidence,
                                  const QDate &date=QDate(),
                                  bool richText=true,
                                  KDateTime::Spec spec=KDateTime::Spec() );

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

  KCAL_DEPRECATED_EXPORT QString toolTipStr( IncidenceBase *incidence,
                                              bool richText=true,
                                              KDateTime::Spec spec=KDateTime::Spec() );

  KCAL_DEPRECATED_EXPORT QString toolTipString( IncidenceBase *incidence,
                                                bool richText=true );
  KCAL_DEPRECATED_EXPORT QString extensiveDisplayStr( Calendar *calendar,
                                           IncidenceBase *incidence,
                                           const QDate &date=QDate(),
                                           KDateTime::Spec spec=KDateTime::Spec() );

  KCAL_DEPRECATED_EXPORT QString extensiveDisplayStr( const QString &sourceName,
                                           IncidenceBase *incidence,
                                           const QDate &date=QDate(),
                                           KDateTime::Spec spec=KDateTime::Spec() );

  KCAL_DEPRECATED_EXPORT QString extensiveDisplayStr( IncidenceBase *incidence,
                                                      KDateTime::Spec spec=KDateTime::Spec() );

  KCAL_DEPRECATED_EXPORT QString extensiveDisplayString( IncidenceBase *incidence );

  KCAL_DEPRECATED_EXPORT QString mailBodyStr( IncidenceBase *incidence,
                                   KDateTime::Spec spec=KDateTime::Spec() );

  KCAL_DEPRECATED_EXPORT QString mailBodyString( IncidenceBase *incidence );

  KCAL_DEPRECATED_EXPORT QString formatICalInvitation( QString invitation, Calendar *calendar,
                                            InvitationFormatterHelper *helper );
  KCAL_DEPRECATED_EXPORT QString formatICalInvitationNoHtml(
    QString invitation, Calendar *calendar, InvitationFormatterHelper *helper );

  KCAL_DEPRECATED_EXPORT QString formatICalInvitationNoHtml( const QString &invitation,
                                                  Calendar *calendar,
                                                  InvitationFormatterHelper *helper,
                                                  const QString &sender );

  KCAL_DEPRECATED_EXPORT QString formatTNEFInvitation( const QByteArray &tnef, Calendar *mCalendar,
                                            InvitationFormatterHelper *helper );
  KCAL_DEPRECATED_EXPORT QString msTNEFToVPart( const QByteArray &tnef );

  KCAL_DEPRECATED_EXPORT QString recurrenceString( Incidence *incidence );

  KCAL_DEPRECATED_EXPORT QStringList reminderStringList( Incidence *incidence, bool shortfmt = true );

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

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

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

  KCAL_DEPRECATED_EXPORT QString resourceString( Calendar *calendar, Incidence *incidence );

  KCAL_DEPRECATED_EXPORT QString durationString( Incidence *incidence );

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

}

#endif