You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdepim/libkcal/exceptions.h

108 lines
2.8 KiB

/*
This file is part of libkcal.
Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.org>
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.
*/
#ifndef KCAL_EXCEPTIONS_H
#define KCAL_EXCEPTIONS_H
//
// Exception classes of libkcal.
//
// We don't use actual C++ exceptions right now. These classes are currently
// returned by an error function, but we can build upon them, if we start
// to use C++ exceptions.
#include <tqstring.h>
namespace KCal {
/**
KOrganizer exceptions base class. This is currently used as a fancy kind of
error code not as an C++ exception.
*/
class Exception
{
public:
/**
Construct exception with descriptive message \a message.
*/
Exception( const TQString &message = TQString() );
virtual ~Exception();
/**
Return descriptive message of exception.
*/
virtual TQString message();
protected:
TQString mMessage;
private:
class Private;
Private *d;
};
/**
Calendar format related error class.
*/
class ErrorFormat : public Exception
{
public:
/**
The different types of Calendar format errors.
*/
enum ErrorCodeFormat {
LoadError, /**< Load error */
SaveError, /**< Save error */
ParseErrorIcal, /**< Parse error in libical */
ParseErrorKcal, /**< Parse error in libkcal */
NoCalendar, /**< No calendar component found */
CalVersion1, /**< vCalendar v1.0 detected */
CalVersion2, /**< iCalendar v2.0 detected */
CalVersionUnknown, /**< Unknown calendar format detected */
Restriction, /**< Restriction violation */
NoWritableFound, /**< No writable resource is available */
UserCancel /**< User canceled the operation */
};
/**
Create format error exception.
*/
ErrorFormat( ErrorCodeFormat code, const TQString &message = TQString() );
/**
Return format error message.
*/
TQString message();
/**
Return format error code.
*/
ErrorCodeFormat errorCode();
private:
ErrorCodeFormat mCode;
class Private;
Private *d;
};
}
#endif