Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / libkcal

libkcal resourcecalendar.h Go to the documentation of this file. /* This file is part of libkcal. Copyright (c) 1998 Preston Brown <pbrown@kde.org> Copyright (c) 2001,2003 Cornelius Schumacher <schumacher@kde.org> Copyright (c) 2002 Jan-Pascal van Best <janpascal@vanbest.org> Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com> 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_RESOURCECALENDAR_H #define KCAL_RESOURCECALENDAR_H #include <qstring.h> #include <qdatetime.h> #include <qptrlist.h> #include <kconfig.h> #include "alarm.h" #include "todo.h" #include "event.h" #include "journal.h" #include "calendar.h" #include <kresources/resource.h> #include <kresources/manager.h> #include <kabc/lock.h> #include <kdepimmacros.h> namespace KCal { class CalFormat; class LIBKCAL_EXPORT ResourceCalendar : public KRES::Resource { Q_OBJECT public: ResourceCalendar( const KConfig * ); virtual ~ResourceCalendar(); void setResolveConflict( bool b); virtual void writeConfig( KConfig* config ); virtual QString infoText() const; bool load(); bool save( Incidence *incidence = 0 ); virtual bool isSaving() { return false; } virtual KABC::Lock *lock() = 0; virtual bool addIncidence( Incidence * ); virtual bool deleteIncidence( Incidence * ); Incidence *incidence( const QString &uid ); virtual bool addEvent( Event *event ) = 0; virtual bool deleteEvent( Event * ) = 0; virtual Event *event( const QString &uid ) = 0; virtual Event::List rawEvents( EventSortField sortField = EventSortUnsorted, SortDirection sortDirection = SortDirectionAscending ) = 0; virtual Event::List rawEventsForDate( const QDate &date, EventSortField sortField = EventSortUnsorted, SortDirection sortDirection = SortDirectionAscending ) = 0; virtual Event::List rawEventsForDate( const QDateTime &qdt ) = 0; virtual Event::List rawEvents( const QDate &start, const QDate &end, bool inclusive = false ) = 0; virtual bool setValue( const QString &key, const QString &value ); signals: void resourceChanged( ResourceCalendar * ); void resourceLoaded( ResourceCalendar * ); void resourceSaved( ResourceCalendar * ); void resourceLoadError( ResourceCalendar *, const QString &error ); void resourceSaveError( ResourceCalendar *, const QString &error ); void signalSubresourceAdded( ResourceCalendar *, const QString& type, const QString& subresource, const QString& label ); void signalSubresourceRemoved( ResourceCalendar *, const QString &, const QString & ); public: virtual bool addTodo( Todo *todo ) = 0; virtual bool deleteTodo( Todo * ) = 0; virtual Todo *todo( const QString &uid ) = 0; virtual Todo::List rawTodos( TodoSortField sortField = TodoSortUnsorted, SortDirection sortDirection = SortDirectionAscending ) = 0; virtual Todo::List rawTodosForDate( const QDate &date ) = 0; virtual bool addJournal( Journal * ) = 0; virtual bool deleteJournal( Journal * ) = 0; virtual Journal *journal( const QString &uid ) = 0; virtual Journal::List rawJournals( JournalSortField sortField = JournalSortUnsorted, SortDirection sortDirection = SortDirectionAscending ) = 0; virtual Journal::List rawJournalsForDate( const QDate &date ) = 0; virtual Alarm::List alarms( const QDateTime &from, const QDateTime &to ) = 0; virtual Alarm::List alarmsTo( const QDateTime &to ) = 0; Incidence::List rawIncidences(); virtual void setTimeZoneId( const QString &timeZoneId ) = 0; virtual QStringList subresources() const { return QStringList(); } virtual bool canHaveSubresources() const { return false; } virtual bool subresourceActive( const QString& ) const { return true; } virtual const QString labelForSubresource( const QString& resource ) const { // the resource identifier is a sane fallback return resource; }; virtual QString subresourceIdentifier( Incidence *incidence ) { Q_UNUSED( incidence ); return QString(); } virtual bool removeSubresource( const QString& resource ); virtual bool addSubresource( const QString& resource, const QString& parent ); virtual QString subresourceType( const QString &resource ); public slots: virtual void setSubresourceActive( const QString &, bool active ); protected: bool mResolveConflict; virtual bool doLoad() = 0; virtual bool doSave() = 0; virtual bool doSave( Incidence * ); virtual void addInfoText( QString & ) const {}; void loadError( const QString &errorMessage = QString::null ); void saveError( const QString &errorMessage = QString::null ); private: bool mReceivedLoadError; bool mReceivedSaveError; class Private; Private *d; }; typedef KRES::Manager<ResourceCalendar> CalendarResourceManager; } #endif libkcal Skip menu "libkcal" Main Page Namespace List Class Hierarchy Alphabetical List Class List File List Namespace Members Class Members API Reference Skip menu "API Reference"   doc kioslaves kmail konsolekalendar kpilot libemailfunctions libkcal Generated for API Reference by doxygen 1.5.9 This website is maintained by Adriaan de Groot and Allen Winter. KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal