KCalUtils Library

incidenceformatter.h

00001 /*
00002   This file is part of the kcalutils library.
00003 
00004   Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
00005   Copyright (c) 2004 Reinhold Kainhofer <reinhold@kainhofer.com>
00006   Copyright (c) 2009-2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.net>
00007 
00008   This library is free software; you can redistribute it and/or
00009   modify it under the terms of the GNU Library General Public
00010   License as published by the Free Software Foundation; either
00011   version 2 of the License, or (at your option) any later version.
00012 
00013   This library is distributed in the hope that it will be useful,
00014   but WITHOUT ANY WARRANTY; without even the implied warranty of
00015   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00016   Library General Public License for more details.
00017 
00018   You should have received a copy of the GNU Library General Public License
00019   along with this library; see the file COPYING.LIB.  If not, write to
00020   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
00021   Boston, MA 02110-1301, USA.
00022 */
00032 #ifndef KCALUTILS_INCIDENCEFORMATTER_H
00033 #define KCALUTILS_INCIDENCEFORMATTER_H
00034 
00035 #include "kcalutils_export.h"
00036 
00037 #include <kcalcore/incidence.h>
00038 #include <kcalcore/memorycalendar.h>
00039 
00040 namespace KCalUtils {
00041 
00042 class KCALUTILS_EXPORT InvitationFormatterHelper
00043 {
00044   public:
00045     InvitationFormatterHelper();
00046     virtual ~InvitationFormatterHelper();
00047     virtual QString generateLinkURL( const QString &id );
00048     virtual QString makeLink( const QString &id, const QString &text );
00049     virtual KCalCore::Calendar::Ptr calendar() const;
00050 
00051   private:
00052     //@cond PRIVATE
00053     Q_DISABLE_COPY( InvitationFormatterHelper )
00054     class Private;
00055     Private *const d;
00056     //@endcond
00057 };
00058 
00068 namespace IncidenceFormatter
00069 {
00081   KCALUTILS_EXPORT QString toolTipStr( const QString &sourceName,
00082                                        const KCalCore::IncidenceBase::Ptr &incidence,
00083                                        const QDate &date = QDate(),
00084                                        bool richText = true,
00085                                        KDateTime::Spec spec = KDateTime::Spec() );
00086 
00097   KCALUTILS_EXPORT QString extensiveDisplayStr( const KCalCore::Calendar::Ptr &calendar,
00098                                                 const KCalCore::IncidenceBase::Ptr &incidence,
00099                                                 const QDate &date=QDate(),
00100                                                 KDateTime::Spec spec=KDateTime::Spec() );
00101 
00112   KCALUTILS_EXPORT QString extensiveDisplayStr( const QString &sourceName,
00113                                                 const KCalCore::IncidenceBase::Ptr &incidence,
00114                                                 const QDate &date=QDate(),
00115                                                 KDateTime::Spec spec=KDateTime::Spec() );
00116 
00124   KCALUTILS_EXPORT QString mailBodyStr( const KCalCore::IncidenceBase::Ptr &incidence,
00125                                         KDateTime::Spec spec=KDateTime::Spec() );
00126 
00138   KCALUTILS_EXPORT QString formatICalInvitation(
00139     QString invitation,
00140     const KCalCore::MemoryCalendar::Ptr &calendar,
00141     InvitationFormatterHelper *helper,
00142     bool outlookCompareStyle );
00143 
00158   KCALUTILS_EXPORT QString formatICalInvitationNoHtml(
00159     const QString &invitation,
00160     const KCalCore::MemoryCalendar::Ptr &calendar,
00161     InvitationFormatterHelper *helper,
00162     const QString &sender,
00163     bool outlookCompareStyle );
00164 
00168   KCALUTILS_EXPORT QString formatTNEFInvitation( const QByteArray &tnef,
00169                                                  const KCalCore::Calendar::Ptr &mCalendar,
00170                                                  InvitationFormatterHelper *helper );
00174   KCALUTILS_EXPORT QString msTNEFToVPart( const QByteArray &tnef );
00175 
00181   KCALUTILS_EXPORT QString recurrenceString( const KCalCore::Incidence::Ptr &incidence );
00182 
00191   KCALUTILS_EXPORT QStringList reminderStringList( const KCalCore::Incidence::Ptr &incidence,
00192                                                    bool shortfmt = true );
00193 
00201   KCALUTILS_EXPORT QString timeToString( const KDateTime &date, bool shortfmt = true,
00202                                          const KDateTime::Spec &spec = KDateTime::Spec() );
00203 
00211   KCALUTILS_EXPORT QString dateToString( const KDateTime &date, bool shortfmt = true,
00212                                          const KDateTime::Spec &spec = KDateTime::Spec() );
00213 
00222   KCALUTILS_EXPORT QString dateTimeToString( const KDateTime &date,
00223                                              bool dateOnly = false,
00224                                              bool shortfmt = true,
00225                                              const KDateTime::Spec &spec = KDateTime::Spec() );
00226 
00232   KCALUTILS_EXPORT QString resourceString( const KCalCore::Calendar::Ptr &calendar,
00233                                            const KCalCore::Incidence::Ptr &incidence );
00234 
00240   KCALUTILS_EXPORT QString durationString( const KCalCore::Incidence::Ptr &incidence );
00241 
00246   KCALUTILS_EXPORT QString incidenceStatusName( KCalCore::Incidence::Status status );
00247 
00251   KCALUTILS_EXPORT QString incidenceStatusStr( const KCalCore::Incidence::Ptr &incidence );
00252 
00253   class EventViewerVisitor;
00254   class ScheduleMessageVisitor;
00255   class InvitationHeaderVisitor;
00256   class InvitationBodyVisitor;
00257   class IncidenceCompareVisitor;
00258   class ToolTipVisitor;
00259   class MailBodyVisitor;
00260 }
00261 
00262 }
00263 
00264 #endif
00265
KCalUtils Library

incidenceformatter.h

KCalUtils Library

KDE-PIM Libraries
