home *** CD-ROM | disk | FTP | other *** search
/ Personal Computer World 2009 February / PCWFEB09.iso / Software / Linux / SLAX 6.0.8 / slax-6.0.8.iso / slax / base / 006-devel.lzm / usr / include / libkcal / resourcecalendar.h < prev    next >
Encoding:
C/C++ Source or Header  |  2008-02-13  |  12.6 KB  |  414 lines
  1. /*
  2.     This file is part of libkcal.
  3.  
  4.     Copyright (c) 1998 Preston Brown <pbrown@kde.org>
  5.     Copyright (c) 2001,2003 Cornelius Schumacher <schumacher@kde.org>
  6.     Copyright (c) 2002 Jan-Pascal van Best <janpascal@vanbest.org>
  7.     Copyright (C) 2003-2004 Reinhold Kainhofer <reinhold@kainhofer.com>
  8.  
  9.     This library is free software; you can redistribute it and/or
  10.     modify it under the terms of the GNU Library General Public
  11.     License as published by the Free Software Foundation; either
  12.     version 2 of the License, or (at your option) any later version.
  13.  
  14.     This library is distributed in the hope that it will be useful,
  15.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  16.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17.     Library General Public License for more details.
  18.  
  19.     You should have received a copy of the GNU Library General Public License
  20.     along with this library; see the file COPYING.LIB.  If not, write to
  21.     the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  22.     Boston, MA 02110-1301, USA.
  23. */
  24.  
  25. #ifndef KCAL_RESOURCECALENDAR_H
  26. #define KCAL_RESOURCECALENDAR_H
  27.  
  28. #include <qstring.h>
  29. #include <qdatetime.h>
  30. #include <qptrlist.h>
  31.  
  32. #include <kconfig.h>
  33.  
  34. #include "alarm.h"
  35. #include "todo.h"
  36. #include "event.h"
  37. #include "journal.h"
  38. #include "calendar.h"
  39.  
  40. #include <kresources/resource.h>
  41. #include <kresources/manager.h>
  42. #include <kabc/lock.h>
  43. #include <kdepimmacros.h>
  44.  
  45. namespace KCal {
  46.  
  47. class CalFormat;
  48.  
  49. /**
  50.   This class provides the interfaces for a calendar resource. It makes use of
  51.   the kresources framework.
  52.  
  53.   \warning This code is still under heavy development. Don't expect source or
  54.   binary compatibility in future versions.
  55. */
  56. class LIBKCAL_EXPORT ResourceCalendar : public KRES::Resource
  57. {
  58.     Q_OBJECT
  59.   public:
  60.     ResourceCalendar( const KConfig * );
  61.     virtual ~ResourceCalendar();
  62.  
  63.     void setResolveConflict( bool b);
  64.  
  65.     virtual void writeConfig( KConfig* config );
  66.  
  67.     /**
  68.       Return rich text with info about the resource. Adds standard info and
  69.       then calls addInfoText() to add info about concrete resources.
  70.     */
  71.     virtual QString infoText() const;
  72.  
  73.     /**
  74.       Load resource data. After calling this function all data is accessible by
  75.       calling the incidence/event/todo/etc. accessor functions.
  76.  
  77.       Whether data is actually loaded within this function or the loading is delayed
  78.       until it is accessed by another function depends on the implementation of
  79.       the resource.
  80.  
  81.       If loading the data takes significant time, the resource should return
  82.       cached values if available, and return the results via the resourceChanged
  83.       signal. When the resource has finished loading, the resourceLoaded() signal
  84.       is emitted.
  85.  
  86.       Calling this function multiple times should have the same effect as
  87.       calling it once, given that the data isn't changed between calls.
  88.  
  89.       This function calls doLoad() which has to be reimplented by the resource
  90.       to do the actual loading.
  91.     */
  92.     bool load();
  93.  
  94.     /**
  95.       Save resource data. After calling this function it is safe to close the
  96.       resource without losing data.
  97.  
  98.       Whether data is actually saved within this function or saving is delayed
  99.       depends on the implementation of the resource.
  100.  
  101.       If saving the data takes significant time, the resource should return from
  102.       the function, do the saving in the background and notify the end of the
  103.       save by emitting the signal resourceSaved().
  104.  
  105.       This function calls doSave() which has to be reimplented by the resource
  106.       to do the actual saving.
  107.  
  108.       @param incidence if given as 0, doSave() is called to save all incidences,
  109.              else doSave(incidence) is called to save only the given one
  110.     */
  111.     bool save( Incidence *incidence = 0 );
  112.  
  113.     /**
  114.       Return true if a save operation is still in progress, otherwise return
  115.       false.
  116.     */
  117.     virtual bool isSaving() { return false; }
  118.  
  119.     /**
  120.       Return object for locking the resource.
  121.     */
  122.     virtual KABC::Lock *lock() = 0;
  123.  
  124.     /**
  125.       Add incidence to resource.
  126.     */
  127.     virtual bool addIncidence( Incidence * );
  128.  
  129.     /**
  130.       Delete incidence from resource.
  131.     */
  132.     virtual bool deleteIncidence( Incidence * );
  133.  
  134.     /**
  135.       Return incidence with given unique id. If there is no incidence with that
  136.       uid, return 0.
  137.     */
  138.     Incidence *incidence( const QString &uid );
  139.  
  140.     /**
  141.       Add event to resource.
  142.     */
  143.     virtual bool addEvent( Event *event ) = 0;
  144.  
  145.     /**
  146.       Delete event from this resource.
  147.     */
  148.     virtual bool deleteEvent( Event * ) = 0;
  149.  
  150.     /**
  151.       Retrieves an event on the basis of the unique string ID.
  152.     */
  153.     virtual Event *event( const QString &uid ) = 0;
  154.  
  155.     /**
  156.       Return unfiltered list of all events in calendar. Use with care,
  157.       this can be a bad idea for server-based calendars.
  158.     */
  159.     virtual Event::List rawEvents( EventSortField sortField = EventSortUnsorted, SortDirection sortDirection = SortDirectionAscending ) = 0;
  160.  
  161.     /**
  162.       Builds and then returns a list of all events that match the
  163.       date specified. Useful for dayView, etc. etc.
  164.     */
  165.     virtual Event::List rawEventsForDate( const QDate &date, EventSortField sortField = EventSortUnsorted, SortDirection sortDirection = SortDirectionAscending ) = 0;
  166.  
  167.     /**
  168.       Get unfiltered events for date \a qdt.
  169.     */
  170.     virtual Event::List rawEventsForDate( const QDateTime &qdt ) = 0;
  171.  
  172.     /**
  173.       Get unfiltered events in a range of dates. If inclusive is set to true,
  174.       only events which are completely included in the range are returned.
  175.     */
  176.     virtual Event::List rawEvents( const QDate &start, const QDate &end,
  177.                                    bool inclusive = false ) = 0;
  178.  
  179.     /**
  180.       Sets a particular value of the resource's configuration. The possible
  181.       keys are resource specific.
  182.  
  183.       This method is provided to make it possible
  184.       to set resource-type specific settings without actually linking to
  185.       the resource's library. Its use is discouraged, but in
  186.       some situations the only possibility to avoid unwanted compiling and
  187.       linking dependencies. E.g. if you don't want to link to the remote
  188.       resource, but need to create a remote resource at the URL given in
  189.       yourURL, you can use code like the following:
  190.         KCal::ResourceCalendar *res = manager->createResource( "remote" );
  191.         if ( res ) {
  192.           res->setTimeZoneId( timezone );
  193.           res->setResourceName( i18n("Test resource") );
  194.           res->setValue( "DownloadURL", yourURL );
  195.           manager->add( res );
  196.         }
  197.     */
  198.     virtual bool setValue( const QString &key, const QString &value );
  199.  
  200.   signals:
  201.     /**
  202.       This signal is emitted when the data in the resource has changed. The
  203.       resource has to make sure that this signal is emitted whenever any
  204.       pointers to incidences which the resource has previously given to the
  205.       calling code, become invalid.
  206.     */
  207.     void resourceChanged( ResourceCalendar * );
  208.  
  209.     /**
  210.       This signal is emitted when loading data into the resource has been
  211.       finished.
  212.     */
  213.     void resourceLoaded( ResourceCalendar * );
  214.     /**
  215.       This signal is emitted when saving the data of the resource has been
  216.       finished.
  217.     */
  218.     void resourceSaved( ResourceCalendar * );
  219.  
  220.     /**
  221.       This signal is emitted when an error occurs during loading.
  222.     */
  223.     void resourceLoadError( ResourceCalendar *, const QString &error );
  224.     /**
  225.       This signal is emitted when an error occurs during saving.
  226.     */
  227.     void resourceSaveError( ResourceCalendar *, const QString &error );
  228.  
  229.     /**
  230.      This signal is emitted when a subresource is added.
  231.     */
  232.     void signalSubresourceAdded( ResourceCalendar *, const QString& type,
  233.                                  const QString& subresource, const QString& label );
  234.  
  235.     /**
  236.      This signal is emitted when a subresource is removed.
  237.     */
  238.     void signalSubresourceRemoved( ResourceCalendar *, const QString &,
  239.                                    const QString & );
  240.  
  241.   public:
  242.     /**
  243.       Add a todo to the todolist.
  244.     */
  245.     virtual bool addTodo( Todo *todo ) = 0;
  246.     /**
  247.       Remove a todo from the todolist.
  248.     */
  249.     virtual bool deleteTodo( Todo * ) = 0;
  250.     /**
  251.       Searches todolist for an event with this unique id.
  252.  
  253.       @return pointer to todo or 0 if todo wasn't found
  254.     */
  255.     virtual Todo *todo( const QString &uid ) = 0;
  256.     /**
  257.       Return list of all todos.
  258.     */
  259.     virtual Todo::List rawTodos( TodoSortField sortField = TodoSortUnsorted, SortDirection sortDirection = SortDirectionAscending ) = 0;
  260.     /**
  261.       Returns list of todos due on the specified date.
  262.     */
  263.     virtual Todo::List rawTodosForDate( const QDate &date ) = 0;
  264.  
  265.  
  266.     /**
  267.       Add a Journal entry to the resource.
  268.     */
  269.     virtual bool addJournal( Journal * ) = 0;
  270.  
  271.     /**
  272.       Remove a Journal entry from calendar.
  273.     */
  274.     virtual bool deleteJournal( Journal * ) = 0;
  275.  
  276.     /**
  277.       Return Journal with given unique id.
  278.     */
  279.     virtual Journal *journal( const QString &uid ) = 0;
  280.     /**
  281.       Return list of all journals.
  282.     */
  283.     virtual Journal::List rawJournals( JournalSortField sortField = JournalSortUnsorted, SortDirection sortDirection = SortDirectionAscending ) = 0;
  284.     /**
  285.       Returns list of journals for the given date.
  286.     */
  287.     virtual Journal::List rawJournalsForDate( const QDate &date ) = 0;
  288.  
  289.     /**
  290.       Return all alarms which occur in the given time interval.
  291.     */
  292.     virtual Alarm::List alarms( const QDateTime &from,
  293.                                 const QDateTime &to ) = 0;
  294.  
  295.     /**
  296.       Return all alarms which occur before given date.
  297.     */
  298.     virtual Alarm::List alarmsTo( const QDateTime &to ) = 0;
  299.  
  300.  
  301.     /** Returns a list of all incideces */
  302.     Incidence::List rawIncidences();
  303.  
  304.     /**
  305.       Set time zone id used by this resource, e.g. "Europe/Berlin".
  306.     */
  307.     virtual void setTimeZoneId( const QString &timeZoneId ) = 0;
  308.  
  309.     /**
  310.       If this resource has subresources, return a QStringList of them.
  311.       In most cases, resources do not have subresources, so this is
  312.       by default just empty.
  313.     */
  314.     virtual QStringList subresources() const { return QStringList(); }
  315.  
  316.     /**
  317.       Is this subresource capable of having subresources or not?
  318.     */
  319.     virtual bool canHaveSubresources() const { return false; }
  320.  
  321.     /**
  322.       Is this subresource active or not?
  323.     */
  324.     virtual bool subresourceActive( const QString& ) const { return true; }
  325.  
  326.     /**
  327.       What is the label for this subresource?
  328.      */
  329.     virtual const QString labelForSubresource( const QString& resource ) const
  330.     {
  331.        // the resource identifier is a sane fallback
  332.        return resource;
  333.     };
  334.  
  335.     /**
  336.       Get the identifier of the subresource associated with a specified
  337.       incidence.
  338.  
  339.       @return the identifier of the subresource or an empty string.
  340.     */
  341.     virtual QString subresourceIdentifier( Incidence *incidence )
  342.     { Q_UNUSED( incidence ); return QString(); }
  343.  
  344.  
  345.  
  346.     /**
  347.      * Remove a subresource with the id @param resource
  348.      */
  349.     virtual bool removeSubresource( const QString& resource );
  350.  
  351.     /**
  352.      * Add a subresource with the name @param resource and the parent
  353.      * id @param parent.
  354.      */
  355.     virtual bool addSubresource( const QString& resource, const QString& parent );
  356.  
  357.     /**
  358.      * Returns the type of the subresource: "event", "todo" or "journal",
  359.      * QString() if unknown/mixed.
  360.      */
  361.     virtual QString subresourceType( const QString &resource );
  362.  
  363.   public slots:
  364.     /**
  365.       (De-)activate a subresource.
  366.     */
  367.     virtual void setSubresourceActive( const QString &, bool active );
  368.  
  369.   protected:
  370.  
  371.     bool mResolveConflict;
  372.     /**
  373.       Do the actual loading of the resource data. Called by load().
  374.     */
  375.     virtual bool doLoad() = 0;
  376.     /**
  377.       Do the actual saving of the resource data. Called by save().
  378.     */
  379.     virtual bool doSave() = 0;
  380.  
  381.     /**
  382.       Do the actual saving of the resource data. Called by save().
  383.       Save one Incidence. The default implementation calls doSave() to save everything
  384.     */
  385.     virtual bool doSave( Incidence * );
  386.  
  387.     /**
  388.       Add info text for concrete resources. Called by infoText().
  389.     */
  390.     virtual void addInfoText( QString & ) const {};
  391.  
  392.     /**
  393.       A resource should call this function if a load error happens.
  394.     */
  395.     void loadError( const QString &errorMessage = QString::null );
  396.     /**
  397.       A resource should call this function if a save error happens.
  398.     */
  399.     void saveError( const QString &errorMessage = QString::null );
  400.  
  401.   private:
  402.     bool mReceivedLoadError;
  403.     bool mReceivedSaveError;
  404.  
  405.     class Private;
  406.     Private *d;
  407. };
  408.  
  409. typedef KRES::Manager<ResourceCalendar> CalendarResourceManager;
  410.  
  411. }
  412.  
  413. #endif
  414.