incidencebase.h

/*
    This file is part of libkcal.
 
    Copyright (c) 2001-2003 Cornelius Schumacher <schumacher@kde.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_INCIDENCEBASE_H
#define KCAL_INCIDENCEBASE_H
 
#include <tqdatetime.h>
#include <tqstringlist.h>
#include <tqvaluelist.h>
#include <tqptrlist.h>
 
#include "customproperties.h"
#include "attendee.h"
 
namespace KCal {
 
typedef TQValueList<TQDate> DateList;
typedef TQValueList<TQDateTime> DateTimeList;
class Event;
class Todo;
class Journal;
class FreeBusy;

class LIBKCAL_EXPORT IncidenceBase : public CustomProperties
{
  public:
    class Visitor
    {
      public:
        virtual ~Visitor() {}

        virtual bool visit(Event *) { return false; }
        virtual bool visit(Todo *) { return false; }
        virtual bool visit(Journal *) { return false; }
        virtual bool visit(FreeBusy *) { return false; }
 
      protected:
        Visitor() {}
    };
 
    class Observer {
      public:
        virtual ~Observer() {}
        virtual void incidenceUpdated( IncidenceBase * ) = 0;
        virtual void incidenceUpdatedSilent( IncidenceBase * ) {};
    };
 
    IncidenceBase();
    IncidenceBase( const IncidenceBase & );
    virtual ~IncidenceBase();
 
    IncidenceBase& operator=( const IncidenceBase &i );
    bool operator==( const IncidenceBase & ) const;

    virtual bool accept(Visitor &) { return false; }
 
    virtual TQCString type() const = 0;

    void setUid( const TQString & );
    TQString uid() const;

    void setLastModified( const TQDateTime &lm );
    TQDateTime lastModified() const;

    void setOrganizer( const Person &o );
    void setOrganizer( const TQString &o );
    Person organizer() const;

    virtual void setReadOnly( bool );
    bool isReadOnly() const { return mReadOnly; }

    virtual void setDtStart( const TQDateTime &dtStart );
 
    virtual TQDateTime dtStart() const;

    virtual TDE_DEPRECATED TQString dtStartTimeStr() const;

    virtual TDE_DEPRECATED TQString dtStartDateStr( bool shortfmt = true ) const;
    virtual TDE_DEPRECATED TQString dtStartStr() const;
 
    virtual void setDuration( int seconds );
    int duration() const;
    void setHasDuration( bool );
    bool hasDuration() const;

    bool doesFloat() const;
    void setFloats( bool f );
 
    //
    // Comments
    //

    void addComment(const TQString& comment);

    bool removeComment( const TQString& comment );

    void clearComments();

    TQStringList comments() const;

    void addAttendee( Attendee *attendee, bool doUpdate = true );
    void clearAttendees();
    const Attendee::List &attendees() const { return mAttendees; };
    int attendeeCount() const { return mAttendees.count(); };
    Attendee *attendeeByMail( const TQString & ) const;
    Attendee *attendeeByMails( const TQStringList &,
                               const TQString &email = TQString() ) const;
    Attendee *attendeeByUid( const TQString &uid ) const;

    enum { SYNCNONE = 0, SYNCMOD = 1, SYNCDEL = 3 };
    void setSyncStatus( int status );
    void setSyncStatusSilent( int status );
    int syncStatus() const;

    void setPilotId( unsigned long id );
    unsigned long pilotId() const;

    void registerObserver( Observer * );
    void unRegisterObserver( Observer * );
    void updated();
    void updatedSilent();
 
  protected:
    virtual void customPropertyUpdated();
 
    bool mReadOnly;
 
  private:
    // base components
    TQDateTime mDtStart;
    Person mOrganizer;
    TQString mUid;
    TQDateTime mLastModified;
    Attendee::List mAttendees;
    TQStringList mComments;
 
    bool mFloats;
 
    int mDuration;
    bool mHasDuration;
 
    // PILOT SYNCHRONIZATION STUFF
    unsigned long mPilotId;                         // unique id for pilot sync
    int mSyncStatus;                      // status (for sync)
 
    TQPtrList<Observer> mObservers;
 
    class Private;
    Private *d;
};
 
}
 
#endif