KCal Library

incidenceformatter.h

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-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 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_DEPRECATED 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_DEPRECATED QString toolTipStr( Calendar *calendar,
00084                                   IncidenceBase *incidence,
00085                                   const QDate &date=QDate(),
00086                                   bool richText=true,
00087                                   KDateTime::Spec spec=KDateTime::Spec() );
00088 
00101   KCAL_EXPORT_DEPRECATED QString toolTipStr( const QString &sourceName,
00102                                   IncidenceBase *incidence,
00103                                   const QDate &date=QDate(),
00104                                   bool richText=true,
00105                                   KDateTime::Spec spec=KDateTime::Spec() );
00106 
00117   KCAL_EXPORT_DEPRECATED QString toolTipStr( IncidenceBase *incidence,
00118                                               bool richText=true,
00119                                               KDateTime::Spec spec=KDateTime::Spec() );
00120 
00128   KCAL_EXPORT_DEPRECATED QString toolTipString( IncidenceBase *incidence,
00129                                                 bool richText=true );
00141   KCAL_EXPORT_DEPRECATED QString extensiveDisplayStr( Calendar *calendar,
00142                                            IncidenceBase *incidence,
00143                                            const QDate &date=QDate(),
00144                                            KDateTime::Spec spec=KDateTime::Spec() );
00145 
00157   KCAL_EXPORT_DEPRECATED QString extensiveDisplayStr( const QString &sourceName,
00158                                            IncidenceBase *incidence,
00159                                            const QDate &date=QDate(),
00160                                            KDateTime::Spec spec=KDateTime::Spec() );
00161 
00171   KCAL_EXPORT_DEPRECATED QString extensiveDisplayStr( IncidenceBase *incidence,
00172                                                       KDateTime::Spec spec=KDateTime::Spec() );
00173 
00180   KCAL_EXPORT_DEPRECATED QString extensiveDisplayString( IncidenceBase *incidence );
00181 
00190   KCAL_EXPORT_DEPRECATED QString mailBodyStr( IncidenceBase *incidence,
00191                                    KDateTime::Spec spec=KDateTime::Spec() );
00192 
00199   KCAL_EXPORT_DEPRECATED QString mailBodyString( IncidenceBase *incidence );
00200 
00210   KCAL_EXPORT_DEPRECATED QString formatICalInvitation( QString invitation, Calendar *calendar,
00211                                             InvitationFormatterHelper *helper );
00225   KCAL_EXPORT_DEPRECATED QString KDE_DEPRECATED formatICalInvitationNoHtml(
00226     QString invitation, Calendar *calendar, InvitationFormatterHelper *helper );
00227 
00241   KCAL_EXPORT_DEPRECATED QString formatICalInvitationNoHtml( const QString &invitation,
00242                                                   Calendar *calendar,
00243                                                   InvitationFormatterHelper *helper,
00244                                                   const QString &sender );
00245 
00250   KCAL_EXPORT_DEPRECATED QString formatTNEFInvitation( const QByteArray &tnef, Calendar *mCalendar,
00251                                             InvitationFormatterHelper *helper );
00256   KCAL_EXPORT_DEPRECATED QString msTNEFToVPart( const QByteArray &tnef );
00257 
00264   KCAL_EXPORT_DEPRECATED QString recurrenceString( Incidence *incidence );
00265 
00275   KCAL_EXPORT_DEPRECATED QStringList reminderStringList( Incidence *incidence, bool shortfmt = true );
00276 
00285   KCAL_EXPORT_DEPRECATED QString timeToString( const KDateTime &date, bool shortfmt = true,
00286                                     const KDateTime::Spec &spec = KDateTime::Spec() );
00287 
00296   KCAL_EXPORT_DEPRECATED QString dateToString( const KDateTime &date, bool shortfmt = true,
00297                                     const KDateTime::Spec &spec = KDateTime::Spec() );
00298 
00308   KCAL_EXPORT_DEPRECATED QString dateTimeToString( const KDateTime &date,
00309                                         bool dateOnly = false,
00310                                         bool shortfmt = true,
00311                                         const KDateTime::Spec &spec = KDateTime::Spec() );
00312 
00319   KCAL_EXPORT_DEPRECATED QString resourceString( Calendar *calendar, Incidence *incidence );
00320 
00327   KCAL_EXPORT_DEPRECATED QString durationString( Incidence *incidence );
00328 
00329   class EventViewerVisitor;
00330   class ScheduleMessageVisitor;
00331   class InvitationHeaderVisitor;
00332   class InvitationBodyVisitor;
00333   class IncidenceCompareVisitor;
00334   class ToolTipVisitor;
00335   class MailBodyVisitor;
00336 }
00337 
00338 }
00339 
00340 #endif
KCal Library

incidenceformatter.h

KCal Library

KDE-PIM Libraries
