incidenceformatter.h

Go to the documentation of this file.
00001 /*
00002   This file is part of the kcal 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 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 KCAL_INCIDENCEFORMATTER_H
00033 #define KCAL_INCIDENCEFORMATTER_H
00034 
00035 #include "kcal_export.h"
00036 #include <KDE/KDateTime>
00037 #include <QtCore/QString>
00038 
00039 namespace KCal {
00040 class Calendar;
00041 class Incidence;
00042 class IncidenceBase;
00043 
00044 class KCAL_EXPORT InvitationFormatterHelper
00045 {
00046   public:
00047     InvitationFormatterHelper() : d( 0 ) {}
00048     virtual ~InvitationFormatterHelper(){}
00049     virtual QString generateLinkURL( const QString &id );
00050     virtual QString makeLink( const QString &id, const QString &text );
00051     virtual Calendar *calendar() const;
00052 
00053   private:
00054     //@cond PRIVATE
00055     Q_DISABLE_COPY( InvitationFormatterHelper )
00056     class Private;
00057     Private *const d;
00058     //@endcond
00059 };
00060 
00070 namespace IncidenceFormatter
00071 {
00083   KCAL_EXPORT QString toolTipStr( Calendar *calendar,
00084                                   IncidenceBase *incidence,
00085                                   const QDate &date=QDate(),
00086                                   bool richText=true,
00087                                   KDateTime::Spec spec=KDateTime::Spec() );
00088 
00099   KCAL_EXPORT KDE_DEPRECATED QString toolTipStr( IncidenceBase *incidence,
00100                                                  bool richText=true,
00101                                                  KDateTime::Spec spec=KDateTime::Spec() );
00102 
00110   KCAL_EXPORT KDE_DEPRECATED QString toolTipString( IncidenceBase *incidence,
00111                                                     bool richText=true );
00112 
00124   KCAL_EXPORT QString extensiveDisplayStr( Calendar *calendar,
00125                                            IncidenceBase *incidence,
00126                                            const QDate &date=QDate(),
00127                                            KDateTime::Spec spec=KDateTime::Spec() );
00128 
00138   KCAL_EXPORT KDE_DEPRECATED QString extensiveDisplayStr( IncidenceBase *incidence,
00139                                                           KDateTime::Spec spec=KDateTime::Spec() );
00140 
00147   KCAL_EXPORT KDE_DEPRECATED QString extensiveDisplayString( IncidenceBase *incidence );
00148 
00157   KCAL_EXPORT QString mailBodyStr( IncidenceBase *incidence,
00158                                    KDateTime::Spec spec=KDateTime::Spec() );
00159 
00166   KCAL_EXPORT KDE_DEPRECATED QString mailBodyString( IncidenceBase *incidence );
00167 
00172   KCAL_EXPORT QString formatICalInvitation( QString invitation, Calendar *mCalendar,
00173                                             InvitationFormatterHelper *helper );
00177   KCAL_EXPORT QString formatICalInvitationNoHtml( QString invitation, Calendar *mCalendar,
00178                                                   InvitationFormatterHelper *helper );
00179 
00184   KCAL_EXPORT QString formatTNEFInvitation( const QByteArray &tnef, Calendar *mCalendar,
00185                                             InvitationFormatterHelper *helper );
00190   KCAL_EXPORT QString msTNEFToVPart( const QByteArray &tnef );
00191 
00198   KCAL_EXPORT QString recurrenceString( Incidence *incidence );
00199 
00208   KCAL_EXPORT QString timeToString( const KDateTime &date, bool shortfmt = true,
00209                                     const KDateTime::Spec &spec = KDateTime::Spec() );
00210 
00219   KCAL_EXPORT QString dateToString( const KDateTime &date, bool shortfmt = true,
00220                                     const KDateTime::Spec &spec = KDateTime::Spec() );
00221 
00231   KCAL_EXPORT QString dateTimeToString( const KDateTime &date,
00232                                         bool dateOnly = false,
00233                                         bool shortfmt = true,
00234                                         const KDateTime::Spec &spec = KDateTime::Spec() );
00235 
00242   KCAL_EXPORT QString resourceString( Calendar *calendar, Incidence *incidence );
00243 
00244   class EventViewerVisitor;
00245   class ScheduleMessageVisitor;
00246   class InvitationHeaderVisitor;
00247   class InvitationBodyVisitor;
00248   class IncidenceCompareVisitor;
00249   class ToolTipVisitor;
00250   class MailBodyVisitor;
00251 }
00252 
00253 }
00254 
00255 #endif
incidenceformatter.h

KCal Library

API Dox
