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

KCalUtils Library

  • kcalutils
incidenceformatter.h
Go to the documentation of this file.
1 /*
2  This file is part of the kcalutils 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 KCALUTILS_INCIDENCEFORMATTER_H
33 #define KCALUTILS_INCIDENCEFORMATTER_H
34 
35 #include "kcalutils_export.h"
36 
37 #include <kcalcore/incidence.h>
38 #include <kcalcore/memorycalendar.h>
39 
40 namespace KCalUtils {
41 
42 class KCALUTILS_EXPORT InvitationFormatterHelper
43 {
44  public:
45  InvitationFormatterHelper();
46  virtual ~InvitationFormatterHelper();
47  virtual QString generateLinkURL( const QString &id );
48  virtual QString makeLink( const QString &id, const QString &text );
49  virtual KCalCore::Calendar::Ptr calendar() const;
50 
51  private:
52  //@cond PRIVATE
53  Q_DISABLE_COPY( InvitationFormatterHelper )
54  class Private;
55  Private *const d;
56  //@endcond
57 };
58 
68 namespace IncidenceFormatter {
69 
82  KCALUTILS_EXPORT QString toolTipStr( const QString &sourceName,
83  const KCalCore::IncidenceBase::Ptr &incidence,
84  const QDate &date = QDate(),
85  bool richText = true,
86  KDateTime::Spec spec = KDateTime::Spec() );
87 
98  KCALUTILS_EXPORT QString extensiveDisplayStr( const KCalCore::Calendar::Ptr &calendar,
99  const KCalCore::IncidenceBase::Ptr &incidence,
100  const QDate &date=QDate(),
101  KDateTime::Spec spec=KDateTime::Spec() );
102 
113  KCALUTILS_EXPORT QString extensiveDisplayStr( const QString &sourceName,
114  const KCalCore::IncidenceBase::Ptr &incidence,
115  const QDate &date=QDate(),
116  KDateTime::Spec spec=KDateTime::Spec() );
117 
125  KCALUTILS_EXPORT QString mailBodyStr( const KCalCore::IncidenceBase::Ptr &incidence,
126  KDateTime::Spec spec=KDateTime::Spec() );
127 
139  KCALUTILS_EXPORT QString formatICalInvitation(
140  QString invitation,
141  const KCalCore::MemoryCalendar::Ptr &calendar,
142  InvitationFormatterHelper *helper,
143  bool outlookCompareStyle );
144 
159  KCALUTILS_EXPORT QString formatICalInvitationNoHtml(
160  const QString &invitation,
161  const KCalCore::MemoryCalendar::Ptr &calendar,
162  InvitationFormatterHelper *helper,
163  const QString &sender,
164  bool outlookCompareStyle );
165 
171  KCALUTILS_EXPORT QString recurrenceString( const KCalCore::Incidence::Ptr &incidence );
172 
181  KCALUTILS_EXPORT QStringList reminderStringList( const KCalCore::Incidence::Ptr &incidence,
182  bool shortfmt = true );
183 
191  KCALUTILS_EXPORT QString timeToString( const KDateTime &date, bool shortfmt = true,
192  const KDateTime::Spec &spec = KDateTime::Spec() );
193 
201  KCALUTILS_EXPORT QString dateToString( const KDateTime &date, bool shortfmt = true,
202  const KDateTime::Spec &spec = KDateTime::Spec() );
203 
212  KCALUTILS_EXPORT QString dateTimeToString( const KDateTime &date,
213  bool dateOnly = false,
214  bool shortfmt = true,
215  const KDateTime::Spec &spec = KDateTime::Spec() );
216 
222  KCALUTILS_EXPORT QString resourceString( const KCalCore::Calendar::Ptr &calendar,
223  const KCalCore::Incidence::Ptr &incidence );
224 
230  KCALUTILS_EXPORT QString durationString( const KCalCore::Incidence::Ptr &incidence );
231 
236  KCALUTILS_EXPORT QString incidenceStatusName( KCalCore::Incidence::Status status );
237 
241  KCALUTILS_EXPORT QString incidenceStatusStr( const KCalCore::Incidence::Ptr &incidence );
242 
243  class EventViewerVisitor;
244  class ScheduleMessageVisitor;
245  class InvitationHeaderVisitor;
246  class InvitationBodyVisitor;
247  class IncidenceCompareVisitor;
248  class ToolTipVisitor;
249  class MailBodyVisitor;
250 }
251 
252 }
253 
254 #endif
255 
This file is part of the KDE documentation.
Documentation copyright © 1996-2013 The KDE developers.
Generated on Sat Jul 13 2013 01:26:46 by doxygen 1.8.3.1 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCalUtils Library

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

kdepimlibs-4.10.5 API Reference

Skip menu "kdepimlibs-4.10.5 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