/usr/include/kcal/incidenceformatter.h is in kdepimlibs5-dev 4:4.8.5-0ubuntu0.3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 | /*
This file is part of the kcal library.
Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
Copyright (c) 2004 Reinhold Kainhofer <reinhold@kainhofer.com>
Copyright (c) 2009-2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.net>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
/**
@file
This file is part of the API for handling calendar data and provides
static functions for formatting Incidences for various purposes.
@author Cornelius Schumacher \<schumacher@kde.org\>
@author Reinhold Kainhofer \<reinhold@kainhofer.com\>
@author Allen Winter \<allen@kdab.com\>
*/
#ifndef KCAL_INCIDENCEFORMATTER_H
#define KCAL_INCIDENCEFORMATTER_H
#include "kcal_export.h"
#include <KDE/KDateTime>
#include <QtCore/QString>
namespace KCal {
class Calendar;
class Incidence;
class IncidenceBase;
class KCAL_EXPORT_DEPRECATED InvitationFormatterHelper
{
public:
InvitationFormatterHelper() : d( 0 ) {}
virtual ~InvitationFormatterHelper(){}
virtual QString generateLinkURL( const QString &id );
virtual QString makeLink( const QString &id, const QString &text );
virtual Calendar *calendar() const;
private:
//@cond PRIVATE
Q_DISABLE_COPY( InvitationFormatterHelper )
class Private;
Private *const d;
//@endcond
};
/**
@brief
Provides methods to format Incidences in various ways for display purposes.
Helpers that provides several static methods to format an Incidence in
different ways: like an HTML representation for KMail, a representation
for tool tips, or a representation for a viewer widget.
*/
namespace IncidenceFormatter
{
/**
Create a QString representation of an Incidence in a nice format
suitable for using in a tooltip.
@param incidence is a pointer to the Incidence to be formatted.
@param date is the QDate for which the toolTip should be computed; used
mainly for recurring incidences.
@param richText if yes, the QString will be created as RichText.
@param spec is an optional time specification which, when specified,
will shift the Incidence times to different timezones.
@since 4.4
*/
KCAL_EXPORT_DEPRECATED 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.
@param sourceName where the incidence is from (e.g. resource name)
@param incidence is a pointer to the Incidence to be formatted.
@param date is the QDate for which the toolTip should be computed; used
mainly for recurring incidences.
@param richText if yes, the QString will be created as RichText.
@param spec is an optional time specification which, when specified,
will shift the Incidence times to different timezones.
@since 4.5
*/
KCAL_EXPORT_DEPRECATED QString toolTipStr( const QString &sourceName,
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.
@param incidence is a pointer to the Incidence to be formatted.
@param richText if yes, the QString will be created as RichText.
@param spec is an optional time specification which, when specified,
will shift the Incidence times to different timezones.
@since 4.2
@deprecated use toolTipStr( Calendar *, IncidenceBase *, bool, KDateTime::Spec)
*/
KCAL_EXPORT_DEPRECATED QString toolTipStr( IncidenceBase *incidence,
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.
@param incidence is a pointer to the Incidence to be formatted.
@param richText if yes, the QString will be created as RichText.
@deprecated use toolTipStr( Calendar *, IncidenceBase *, bool, KDateTime::Spec)
*/
KCAL_EXPORT_DEPRECATED QString toolTipString( IncidenceBase *incidence,
bool richText=true );
/**
Create a RichText QString representation of an Incidence in a nice format
suitable for using in a viewer widget.
@param calendar is a pointer to the Calendar that owns the specified Incidence.
@param incidence is a pointer to the Incidence to be formatted.
@param date is the QDate for which the string representation should be computed;
used mainly for recurring incidences.
@param spec is an optional time specification which, when specified,
will shift the Incidence times to different timezones.
@since 4.4
*/
KCAL_EXPORT_DEPRECATED 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 viewer widget.
@param sourceName where the incidence is from (e.g. resource name)
@param incidence is a pointer to the Incidence to be formatted.
@param date is the QDate for which the string representation should be computed;
used mainly for recurring incidences.
@param spec is an optional time specification which, when specified,
will shift the Incidence times to different timezones.
@since 4.5
*/
KCAL_EXPORT_DEPRECATED QString extensiveDisplayStr( const QString &sourceName,
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 viewer widget.
@param incidence is a pointer to the Incidence to be formatted.
@param spec is an optional time specification which, when specified,
will shift the Incidence times to different timezones.
@since 4.2
@deprecated use extensiveDisplayStr( Calendar *, IncidenceBase *, KDateTime::Spec )
*/
KCAL_EXPORT_DEPRECATED QString extensiveDisplayStr( IncidenceBase *incidence,
KDateTime::Spec spec=KDateTime::Spec() );
/**
Create a RichText QString representation of an Incidence in a nice format
suitable for using in a viewer widget.
@param incidence is a pointer to the Incidence to be formatted.
@deprecated use extensiveDisplayStr( Calendar *, IncidenceBase *, KDateTime::Spec )
*/
KCAL_EXPORT_DEPRECATED QString extensiveDisplayString( IncidenceBase *incidence );
/**
Create a QString representation of an Incidence in format suitable for
including inside a mail message.
@param incidence is a pointer to the Incidence to be formatted.
@param spec is an optional time specification which, when specified,
will shift the Incidence times to different timezones.
@since 4.2
*/
KCAL_EXPORT_DEPRECATED QString mailBodyStr( IncidenceBase *incidence,
KDateTime::Spec spec=KDateTime::Spec() );
/**
Create a QString representation of an Incidence in format suitable for
including inside a mail message.
@param incidence is a pointer to the Incidence to be formatted.
@deprecated use mailBodyStr( IncidenceBase *, KDateTime::Spec )
*/
KCAL_EXPORT_DEPRECATED QString mailBodyString( IncidenceBase *incidence );
/**
Deliver an HTML formatted string displaying an invitation.
Use the time zone from mCalendar.
@param invitation a QString containing a string representation of a calendar Event
which will be intrepreted as an invitation.
@param calendar is a pointer to the Calendar that owns the invitation.
@param helper is a pointer to an InvitationFormatterHelper.
*/
KCAL_EXPORT_DEPRECATED QString formatICalInvitation( QString invitation, Calendar *calendar,
InvitationFormatterHelper *helper );
/**
Deliver an HTML formatted string displaying an invitation.
Differs from formatICalInvitation() in that invitation details (summary, location, etc)
have HTML formatting cleaned.
Use the time zone from calendar.
@param invitation a QString containing a string representation of a calendar Event
which will be intrepreted as an invitation.
@param calendar is a pointer to the Calendar that owns the invitation.
@param helper is a pointer to an InvitationFormatterHelper.
@deprecated use formatICalInvitationNoHtml(const QString &,Calendar *,
InvitationFormatterHelper *,const QString &) instead.
*/
KCAL_EXPORT_DEPRECATED QString KDE_DEPRECATED formatICalInvitationNoHtml(
QString invitation, Calendar *calendar, InvitationFormatterHelper *helper );
/**
Deliver an HTML formatted string displaying an invitation.
Differs from formatICalInvitation() in that invitation details (summary, location, etc)
have HTML formatting cleaned.
Use the time zone from calendar.
@param invitation a QString containing a string representation of a calendar Event
which will be intrepreted as an invitation.
@param calendar is a pointer to the Calendar that owns the invitation.
@param helper is a pointer to an InvitationFormatterHelper.
@param sender is a QString containing the email address of the person sending the invitation.
@since 4.5
*/
KCAL_EXPORT_DEPRECATED QString formatICalInvitationNoHtml( const QString &invitation,
Calendar *calendar,
InvitationFormatterHelper *helper,
const QString &sender );
/**
Format a TNEF attachment to an HTML mail
@since 4.1
*/
KCAL_EXPORT_DEPRECATED QString formatTNEFInvitation( const QByteArray &tnef, Calendar *mCalendar,
InvitationFormatterHelper *helper );
/**
Transform a TNEF attachment to an iCal or vCard
@since 4.1
*/
KCAL_EXPORT_DEPRECATED QString msTNEFToVPart( const QByteArray &tnef );
/**
Build a pretty QString representation of an Incidence's recurrence info.
@param incidence is a pointer to the Incidence whose recurrence info
is to be formatted.
@since 4.1
*/
KCAL_EXPORT_DEPRECATED QString recurrenceString( Incidence *incidence );
/**
Returns a reminder string computed for the specified Incidence.
Each item of the returning QStringList corresponds to a string
representation of an reminder belonging to this incidence.
@param incidence is a pointer to the Incidence.
@param shortfmt if false, a short version of each reminder is printed;
else a longer version of each reminder is printed.
@since 4.5
*/
KCAL_EXPORT_DEPRECATED QStringList reminderStringList( Incidence *incidence, bool shortfmt = true );
/**
Build a QString time representation of a KDateTime object.
@param date The date to be formatted.
@param shortfmt If true, display info in short format.
@param spec Time spec to use.
@see dateToString(), dateTimeToString().
@since 4.3
*/
KCAL_EXPORT_DEPRECATED QString timeToString( const KDateTime &date, bool shortfmt = true,
const KDateTime::Spec &spec = KDateTime::Spec() );
/**
Build a QString date representation of a KDateTime object.
@param date The date to be formatted.
@param shortfmt If true, display info in short format.
@param spec Time spec to use.
@see dateToString(), dateTimeToString().
@since 4.3
*/
KCAL_EXPORT_DEPRECATED QString dateToString( const KDateTime &date, bool shortfmt = true,
const KDateTime::Spec &spec = KDateTime::Spec() );
/**
Build a QString date/time representation of a KDateTime object.
@param date The date to be formatted.
@param dateOnly If true, don't print the time fields; print the date fields only.
@param shortfmt If true, display info in short format.
@param spec Time spec to use.
@see dateToString(), timeToString().
@since 4.3
*/
KCAL_EXPORT_DEPRECATED QString dateTimeToString( const KDateTime &date,
bool dateOnly = false,
bool shortfmt = true,
const KDateTime::Spec &spec = KDateTime::Spec() );
/**
Returns a Calendar Resource label name for the specified Incidence.
@param calendar is a pointer to the Calendar.
@param incidence is a pointer to the Incidence.
@since 4.4
*/
KCAL_EXPORT_DEPRECATED QString resourceString( Calendar *calendar, Incidence *incidence );
/**
Returns a duration string computed for the specified Incidence.
Only makes sense for Events and Todos.
@param incidence is a pointer to the Incidence.
@since 4.5
*/
KCAL_EXPORT_DEPRECATED QString durationString( Incidence *incidence );
class EventViewerVisitor;
class ScheduleMessageVisitor;
class InvitationHeaderVisitor;
class InvitationBodyVisitor;
class IncidenceCompareVisitor;
class ToolTipVisitor;
class MailBodyVisitor;
}
}
#endif
|