• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdepimlibs-4.14.10 API Reference
  • KDE Home
  • Contact Us
 

KCal Library

  • kcal
incidenceformatter.h
Go to the documentation of this file.
1/*
2 This file is part of the kcal library.
3
4 Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
5 Copyright (c) 2004 Reinhold Kainhofer <reinhold@kainhofer.com>
6 Copyright (c) 2009-2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.net>
7
8 This library is free software; you can redistribute it and/or
9 modify it under the terms of the GNU Library General Public
10 License as published by the Free Software Foundation; either
11 version 2 of the License, or (at your option) any later version.
12
13 This library is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 Library General Public License for more details.
17
18 You should have received a copy of the GNU Library General Public License
19 along with this library; see the file COPYING.LIB. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA.
22*/
32#ifndef KCAL_INCIDENCEFORMATTER_H
33#define KCAL_INCIDENCEFORMATTER_H
34
35#include "kcal_export.h"
36#include <KDE/KDateTime>
37#include <QtCore/QString>
38
39namespace KCal {
40class Calendar;
41class Incidence;
42class IncidenceBase;
43
44class KCAL_DEPRECATED_EXPORT InvitationFormatterHelper
45{
46 public:
47 InvitationFormatterHelper() : d( 0 ) {}
48 virtual ~InvitationFormatterHelper(){}
49 virtual QString generateLinkURL( const QString &id );
50 virtual QString makeLink( const QString &id, const QString &text );
51 virtual Calendar *calendar() const;
52
53 private:
54 //@cond PRIVATE
55 Q_DISABLE_COPY( InvitationFormatterHelper )
56 class Private;
57 Private *const d;
58 //@endcond
59};
60
70namespace IncidenceFormatter
71{
83 KCAL_DEPRECATED_EXPORT QString toolTipStr( Calendar *calendar,
84 IncidenceBase *incidence,
85 const QDate &date=QDate(),
86 bool richText=true,
87 KDateTime::Spec spec=KDateTime::Spec() );
88
101 KCAL_DEPRECATED_EXPORT QString toolTipStr( const QString &sourceName,
102 IncidenceBase *incidence,
103 const QDate &date=QDate(),
104 bool richText=true,
105 KDateTime::Spec spec=KDateTime::Spec() );
106
117 KCAL_DEPRECATED_EXPORT QString toolTipStr( IncidenceBase *incidence,
118 bool richText=true,
119 KDateTime::Spec spec=KDateTime::Spec() );
120
128 KCAL_DEPRECATED_EXPORT QString toolTipString( IncidenceBase *incidence,
129 bool richText=true );
141 KCAL_DEPRECATED_EXPORT QString extensiveDisplayStr( Calendar *calendar,
142 IncidenceBase *incidence,
143 const QDate &date=QDate(),
144 KDateTime::Spec spec=KDateTime::Spec() );
145
157 KCAL_DEPRECATED_EXPORT QString extensiveDisplayStr( const QString &sourceName,
158 IncidenceBase *incidence,
159 const QDate &date=QDate(),
160 KDateTime::Spec spec=KDateTime::Spec() );
161
171 KCAL_DEPRECATED_EXPORT QString extensiveDisplayStr( IncidenceBase *incidence,
172 KDateTime::Spec spec=KDateTime::Spec() );
173
180 KCAL_DEPRECATED_EXPORT QString extensiveDisplayString( IncidenceBase *incidence );
181
190 KCAL_DEPRECATED_EXPORT QString mailBodyStr( IncidenceBase *incidence,
191 KDateTime::Spec spec=KDateTime::Spec() );
192
199 KCAL_DEPRECATED_EXPORT QString mailBodyString( IncidenceBase *incidence );
200
210 KCAL_DEPRECATED_EXPORT QString formatICalInvitation( QString invitation, Calendar *calendar,
211 InvitationFormatterHelper *helper );
225 KCAL_DEPRECATED_EXPORT QString formatICalInvitationNoHtml(
226 QString invitation, Calendar *calendar, InvitationFormatterHelper *helper );
227
241 KCAL_DEPRECATED_EXPORT QString formatICalInvitationNoHtml( const QString &invitation,
242 Calendar *calendar,
243 InvitationFormatterHelper *helper,
244 const QString &sender );
245
250 KCAL_DEPRECATED_EXPORT QString formatTNEFInvitation( const QByteArray &tnef, Calendar *mCalendar,
251 InvitationFormatterHelper *helper );
256 KCAL_DEPRECATED_EXPORT QString msTNEFToVPart( const QByteArray &tnef );
257
264 KCAL_DEPRECATED_EXPORT QString recurrenceString( Incidence *incidence );
265
275 KCAL_DEPRECATED_EXPORT QStringList reminderStringList( Incidence *incidence, bool shortfmt = true );
276
285 KCAL_DEPRECATED_EXPORT QString timeToString( const KDateTime &date, bool shortfmt = true,
286 const KDateTime::Spec &spec = KDateTime::Spec() );
287
296 KCAL_DEPRECATED_EXPORT QString dateToString( const KDateTime &date, bool shortfmt = true,
297 const KDateTime::Spec &spec = KDateTime::Spec() );
298
308 KCAL_DEPRECATED_EXPORT QString dateTimeToString( const KDateTime &date,
309 bool dateOnly = false,
310 bool shortfmt = true,
311 const KDateTime::Spec &spec = KDateTime::Spec() );
312
319 KCAL_DEPRECATED_EXPORT QString resourceString( Calendar *calendar, Incidence *incidence );
320
327 KCAL_DEPRECATED_EXPORT QString durationString( Incidence *incidence );
328
329 class EventViewerVisitor;
330 class ScheduleMessageVisitor;
331 class InvitationHeaderVisitor;
332 class InvitationBodyVisitor;
333 class IncidenceCompareVisitor;
334 class ToolTipVisitor;
335 class MailBodyVisitor;
336}
337
338}
339
340#endif
KCal::Calendar
Represents the main calendar class.
Definition: calendar.h:121
KCal::IncidenceBase
An abstract class that provides a common base for all calendar incidence classes.
Definition: incidencebase.h:103
KCal::Incidence
Provides the abstract base class common to non-FreeBusy (Events, To-dos, Journals) calendar component...
Definition: incidence.h:70
KCal::IncidenceFormatter::formatTNEFInvitation
KCAL_DEPRECATED_EXPORT QString formatTNEFInvitation(const QByteArray &tnef, Calendar *mCalendar, InvitationFormatterHelper *helper)
Format a TNEF attachment to an HTML mail.
KCal::IncidenceFormatter::resourceString
KCAL_DEPRECATED_EXPORT QString resourceString(Calendar *calendar, Incidence *incidence)
Returns a Calendar Resource label name for the specified Incidence.
Definition: incidenceformatter.cpp:3784
KCal::IncidenceFormatter::dateTimeToString
KCAL_DEPRECATED_EXPORT QString dateTimeToString(const KDateTime &date, bool dateOnly=false, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec())
Build a QString date/time representation of a KDateTime object.
Definition: incidenceformatter.cpp:3759
KCal::IncidenceFormatter::mailBodyString
KCAL_DEPRECATED_EXPORT QString mailBodyString(IncidenceBase *incidence)
Create a QString representation of an Incidence in format suitable for including inside a mail messag...
Definition: incidenceformatter.cpp:3373
KCal::IncidenceFormatter::msTNEFToVPart
KCAL_DEPRECATED_EXPORT QString msTNEFToVPart(const QByteArray &tnef)
Transform a TNEF attachment to an iCal or vCard.
KCal::IncidenceFormatter::mailBodyStr
KCAL_DEPRECATED_EXPORT QString mailBodyStr(IncidenceBase *incidence, KDateTime::Spec spec=KDateTime::Spec())
Create a QString representation of an Incidence in format suitable for including inside a mail messag...
Definition: incidenceformatter.cpp:3378
KCal::IncidenceFormatter::reminderStringList
KCAL_DEPRECATED_EXPORT QStringList reminderStringList(Incidence *incidence, bool shortfmt=true)
Returns a reminder string computed for the specified Incidence.
Definition: incidenceformatter.cpp:3865
KCal::IncidenceFormatter::toolTipStr
KCAL_DEPRECATED_EXPORT QString toolTipStr(Calendar *calendar, IncidenceBase *incidence, const QDate &date=QDate(), bool richText=true, KDateTime::Spec spec=KDateTime::Spec())
Create a QString representation of an Incidence in a nice format suitable for using in a tooltip.
Definition: incidenceformatter.cpp:3198
KCal::IncidenceFormatter::toolTipString
KCAL_DEPRECATED_EXPORT QString toolTipString(IncidenceBase *incidence, bool richText=true)
Create a QString representation of an Incidence in a nice format suitable for using in a tooltip.
Definition: incidenceformatter.cpp:3181
KCal::IncidenceFormatter::recurrenceString
KCAL_DEPRECATED_EXPORT QString recurrenceString(Incidence *incidence)
Build a pretty QString representation of an Incidence's recurrence info.
Definition: incidenceformatter.cpp:3409
KCal::IncidenceFormatter::formatICalInvitationNoHtml
KCAL_DEPRECATED_EXPORT QString formatICalInvitationNoHtml(QString invitation, Calendar *calendar, InvitationFormatterHelper *helper)
Deliver an HTML formatted string displaying an invitation.
KCal::IncidenceFormatter::durationString
KCAL_DEPRECATED_EXPORT QString durationString(Incidence *incidence)
Returns a duration string computed for the specified Incidence.
Definition: incidenceformatter.cpp:3834
KCal::IncidenceFormatter::extensiveDisplayString
KCAL_DEPRECATED_EXPORT QString extensiveDisplayString(IncidenceBase *incidence)
Create a RichText QString representation of an Incidence in a nice format suitable for using in a vie...
Definition: incidenceformatter.cpp:971
KCal::IncidenceFormatter::timeToString
KCAL_DEPRECATED_EXPORT QString timeToString(const KDateTime &date, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec())
Build a QString time representation of a KDateTime object.
Definition: incidenceformatter.cpp:3720
KCal::IncidenceFormatter::formatICalInvitation
KCAL_DEPRECATED_EXPORT QString formatICalInvitation(QString invitation, Calendar *calendar, InvitationFormatterHelper *helper)
Deliver an HTML formatted string displaying an invitation.
KCal::IncidenceFormatter::extensiveDisplayStr
KCAL_DEPRECATED_EXPORT QString extensiveDisplayStr(Calendar *calendar, IncidenceBase *incidence, const QDate &date=QDate(), KDateTime::Spec spec=KDateTime::Spec())
Create a RichText QString representation of an Incidence in a nice format suitable for using in a vie...
Definition: incidenceformatter.cpp:991
KCal::IncidenceFormatter::dateToString
KCAL_DEPRECATED_EXPORT QString dateToString(const KDateTime &date, bool shortfmt=true, const KDateTime::Spec &spec=KDateTime::Spec())
Build a QString date representation of a KDateTime object.
Definition: incidenceformatter.cpp:3737
This file is part of the KDE documentation.
Documentation copyright © 1996-2022 The KDE developers.
Generated on Thu Jul 21 2022 00:00:00 by doxygen 1.9.5 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCal Library

Skip menu "KCal Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdepimlibs-4.14.10 API Reference

Skip menu "kdepimlibs-4.14.10 API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal