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

KCalCore Library

  • kcalcore
calformat.h
Go to the documentation of this file.
1/*
2 This file is part of the kcalcore library.
3
4 Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
5
6 This library is free software; you can redistribute it and/or
7 modify it under the terms of the GNU Library General Public
8 License as published by the Free Software Foundation; either
9 version 2 of the License, or (at your option) any later version.
10
11 This library is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 Library General Public License for more details.
15
16 You should have received a copy of the GNU Library General Public License
17 along with this library; see the file COPYING.LIB. If not, write to
18 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA.
20*/
28
29#ifndef KCALCORE_CALFORMAT_H
30#define KCALCORE_CALFORMAT_H
31
32#include "kcalcore_export.h"
33#include "calendar.h"
34
35#include <QtCore/QString>
36
37namespace KCalCore {
38
39class Exception;
40
48class KCALCORE_EXPORT CalFormat
49{
50public:
54 CalFormat();
55
59 virtual ~CalFormat();
60
69 virtual bool load(const Calendar::Ptr &calendar, const QString &fileName) = 0;
70
79 virtual bool save(const Calendar::Ptr &calendar, const QString &fileName) = 0;
80
92 virtual bool fromString(const Calendar::Ptr &calendar, const QString &string,
93 bool deleted = false, const QString &notebook = QString()) = 0;
94
109 virtual bool fromRawString(const Calendar::Ptr &calendar, const QByteArray &string,
110 bool deleted = false, const QString &notebook = QString()) = 0;
111
122 virtual QString toString(const Calendar::Ptr &calendar,
123 const QString &notebook = QString(), bool deleted = false) = 0;
124
128 void clearException();
129
134 Exception *exception() const;
135
143 static void setApplication(const QString &application,
144 const QString &productID);
145
149 static const QString &application(); //krazy:exclude=constref
150
154 static const QString &productId(); //krazy:exclude=constref
155
160 QString loadedProductId();
161
165 static QString createUniqueId();
166
173 void setException(Exception *error);
174
175protected:
181 void setLoadedProductId(const QString &id);
182
187 virtual void virtual_hook(int id, void *data);
188
189private:
190 //@cond PRIVATE
191 Q_DISABLE_COPY(CalFormat)
192 class Private;
193 Private *const d;
194 //@endcond
195};
196
197}
198
199#endif
calendar.h
This file is part of the API for handling calendar data and defines the Calendar class.
KCalCore::CalFormat::createUniqueId
static QString createUniqueId()
Creates a unique id string.
Definition calformat.cpp:123
KCalCore::CalFormat::fromRawString
virtual bool fromRawString(const Calendar::Ptr &calendar, const QByteArray &string, bool deleted=false, const QString &notebook=QString())=0
Parses a utf8 encoded string, returning the first iCal component encountered in that string.
KCalCore::CalFormat::setLoadedProductId
void setLoadedProductId(const QString &id)
Sets the PRODID string loaded from calendar file.
Definition calformat.cpp:118
KCalCore::CalFormat::clearException
void clearException()
Clears the exception status.
Definition calformat.cpp:79
KCalCore::CalFormat::toString
virtual QString toString(const Calendar::Ptr &calendar, const QString &notebook=QString(), bool deleted=false)=0
Returns the calendar as a string.
KCalCore::CalFormat::loadedProductId
QString loadedProductId()
Returns the PRODID string loaded from calendar file.
Definition calformat.cpp:113
KCalCore::CalFormat::virtual_hook
virtual void virtual_hook(int id, void *data)
Definition calformat.cpp:144
KCalCore::CalFormat::CalFormat
CalFormat()
Constructs a new Calendar Format object.
Definition calformat.cpp:68
KCalCore::CalFormat::setApplication
static void setApplication(const QString &application, const QString &productID)
Sets the application name for use in unique IDs and error messages, and product ID for incidence PROD...
Definition calformat.cpp:96
KCalCore::CalFormat::application
static const QString & application()
Returns the application name used in unique IDs and error messages.
Definition calformat.cpp:103
KCalCore::CalFormat::exception
Exception * exception() const
Returns an exception, if there is any, containing information about the last error that occurred.
Definition calformat.cpp:91
KCalCore::CalFormat::productId
static const QString & productId()
Returns the our library's PRODID string to write into calendar files.
Definition calformat.cpp:108
KCalCore::CalFormat::load
virtual bool load(const Calendar::Ptr &calendar, const QString &fileName)=0
Loads a calendar on disk into the calendar associated with this format.
KCalCore::CalFormat::setException
void setException(Exception *error)
Sets an exception that is to be used by the functions of this class to report errors.
Definition calformat.cpp:85
KCalCore::CalFormat::save
virtual bool save(const Calendar::Ptr &calendar, const QString &fileName)=0
Writes the calendar to disk.
KCalCore::CalFormat::fromString
virtual bool fromString(const Calendar::Ptr &calendar, const QString &string, bool deleted=false, const QString &notebook=QString())=0
Loads a calendar from a string.
KCalCore::Calendar::Ptr
QSharedPointer< Calendar > Ptr
A shared pointer to a Calendar.
Definition calendar.h:138
KCalCore::Exception
Exception base class, currently used as a fancy kind of error code and not as an C++ exception.
Definition exceptions.h:51
KCalCore
TODO: KDE5:
Definition alarm.h:47
This file is part of the KDE documentation.
Documentation copyright © 1996-2025 The KDE developers.
Generated on Fri Jan 17 2025 00:00:00 by doxygen 1.13.2 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCalCore Library

Skip menu "KCalCore 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