kacalendar.h

/*
 *  kacalendar.h  -  KAlarm kcal library calendar and event categorisation
 *  This file is part of kalarmcal library, which provides access to KAlarm
 *  calendar data.
 *  Copyright © 2005-2012 by David Jarvie <djarvie@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 KALARM_KACALENDAR_H
#define KALARM_KACALENDAR_H

#include "kalarmcal_export.h"
#ifndef KALARMCAL_USE_KRESOURCES
#include <kcalcore/filestorage.h>
#include <kcalcore/calendar.h>
#include <kcalcore/event.h>
#include <akonadi/collection.h>
#endif
#include <QtCore/QByteArray>
#include <QtCore/QStringList>

#ifndef KALARMCAL_USE_KRESOURCES
namespace KCalCore {
  class Alarm;
}
#else
namespace KCal {
  class Event;
  class Alarm;
  class CalendarLocal;
}
#endif

namespace KAlarmCal
{

#ifndef KALARMCAL_USE_KRESOURCES
extern const QLatin1String KALARMCAL_EXPORT MIME_BASE;      
extern const QLatin1String KALARMCAL_EXPORT MIME_ACTIVE;    
extern const QLatin1String KALARMCAL_EXPORT MIME_ARCHIVED;  
extern const QLatin1String KALARMCAL_EXPORT MIME_TEMPLATE;  
#endif

namespace KACalendar
{
#ifndef KALARMCAL_USE_KRESOURCES

    enum Compatibility
    {
        Unknown      = 0,               
        Current      = 0x02,            
        Converted    = Current | 0x01,  
        Convertible  = 0x04,            
        Incompatible = 0x08             
    };
    Q_DECLARE_FLAGS(Compat, Compatibility)
#else

    enum Compat
    {
        Current,       
        Converted,     
        Convertible,   
        Incompatible,  
        ByEvent        
    };
#endif

    enum
    {
        CurrentFormat      = 0,    
#ifndef KALARMCAL_USE_KRESOURCES
        MixedFormat        = -2,   
#endif
        IncompatibleFormat = -1    
    };

#ifndef KALARMCAL_USE_KRESOURCES
    KALARMCAL_EXPORT int updateVersion(const KCalCore::FileStorage::Ptr&, QString& versionString);
#else
    KALARMCAL_EXPORT int updateVersion(KCal::CalendarLocal& calendar, const QString& localFile, QString& versionString);
#endif

#ifndef KALARMCAL_USE_KRESOURCES

    KALARMCAL_EXPORT void setKAlarmVersion(const KCalCore::Calendar::Ptr&);
#else
    KALARMCAL_EXPORT void setKAlarmVersion(KCal::CalendarLocal&);
#endif

    KALARMCAL_EXPORT void setProductId(const QByteArray& progName, const QByteArray& progVersion);

    KALARMCAL_EXPORT QByteArray  icalProductId();

    extern const QByteArray APPNAME;    
} // namespace KACalendar

//

namespace CalEvent
{
    enum Type
    {
        EMPTY      = 0,       
        ACTIVE     = 0x01,    
        ARCHIVED   = 0x02,    
        TEMPLATE   = 0x04,    
        DISPLAYING = 0x08     
    };
    Q_DECLARE_FLAGS(Types, Type)

    KALARMCAL_EXPORT QString uid(const QString& id, Type);
#ifndef KALARMCAL_USE_KRESOURCES
    KALARMCAL_EXPORT Type    status(const KCalCore::Event::Ptr&, QString* param = 0);
    KALARMCAL_EXPORT void    setStatus(const KCalCore::Event::Ptr&, Type, const QString& param = QString());

    KALARMCAL_EXPORT Type    type(const QString& mimeType);
    KALARMCAL_EXPORT Types   types(const QStringList& mimeTypes);
    KALARMCAL_EXPORT QString mimeType(Type);
    KALARMCAL_EXPORT QStringList mimeTypes(Types);
#else
    KALARMCAL_EXPORT Type    status(const KCal::Event*, QString* param = 0);
    KALARMCAL_EXPORT void    setStatus(KCal::Event*, Type, const QString& param = QString());
#endif
} // namespace CalEvent

Q_DECLARE_OPERATORS_FOR_FLAGS(CalEvent::Types)

} // namespace KAlarmCal

#endif // KALARM_KACALENDAR_H

// vim: et sw=4: