Skip to main content :: ::

KDE PIM API Reference

:: Skip to Link Menu

/ API Reference / libkcal

libkcal incidence.h Go to the documentation of this file. /* 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 INCIDENCE_H #define INCIDENCE_H #include <qdatetime.h> #include <qstringlist.h> #include <qvaluelist.h> #include "recurrence.h" #include "alarm.h" #include "attachment.h" #include "libkcal_export.h" #include "incidencebase.h" #include <kdepimmacros.h> namespace KCal { class LIBKCAL_EXPORT Incidence : public IncidenceBase, public Recurrence::Observer { public: template<class T> class AddVisitor : public IncidenceBase::Visitor { public: AddVisitor( T *r ) : mResource( r ) {} bool visit( Event *e ) { return mResource->addEvent( e ); } bool visit( Todo *t ) { return mResource->addTodo( t ); } bool visit( Journal *j ) { return mResource->addJournal( j ); } private: T *mResource; }; template<class T> class DeleteVisitor : public IncidenceBase::Visitor { public: DeleteVisitor( T *r ) : mResource( r ) {} bool visit( Event *e ) { mResource->deleteEvent( e ); return true; } bool visit( Todo *t ) { mResource->deleteTodo( t ); return true; } bool visit( Journal *j ) { mResource->deleteJournal( j ); return true; } private: T *mResource; }; enum Status { StatusNone, StatusTentative, StatusConfirmed, StatusCompleted, StatusNeedsAction, StatusCanceled, StatusInProcess, StatusDraft, StatusFinal, StatusX // indicates a non-standard status string }; enum { SecrecyPublic = 0, SecrecyPrivate = 1, SecrecyConfidential = 2 }; typedef ListBase<Incidence> List; Incidence(); Incidence( const Incidence & ); ~Incidence(); Incidence& operator=( const Incidence &i ); bool operator==( const Incidence & ) const; virtual Incidence *clone() = 0; void setReadOnly( bool readonly ); void setFloats( bool f ); void recreate(); void setCreated( const QDateTime & ); QDateTime created() const; void setRevision( int rev ); int revision() const; virtual void setDtStart( const QDateTime &dtStart ); virtual QDateTime dtEnd() const { return QDateTime(); } void setDescription( const QString &description ); QString description() const; void setSummary( const QString &summary ); QString summary() const; void setCategories( const QStringList &categories ); void setCategories(const QString &catStr); QStringList categories() const; QString categoriesStr() const; void setRelatedToUid(const QString &); QString relatedToUid() const; void setRelatedTo(Incidence *relatedTo); Incidence *relatedTo() const; Incidence::List relations() const; void addRelation(Incidence *); void removeRelation(Incidence *); // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% // %%%%% Recurrence-related methods // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% Recurrence *recurrence() const; void clearRecurrence(); bool doesRecur() const; uint recurrenceType() const; virtual bool recursOn( const QDate &qd ) const; bool recursAt( const QDateTime &qdt ) const; virtual QValueList<QDateTime> startDateTimesForDate( const QDate &date ) const; virtual QValueList<QDateTime> startDateTimesForDateTime( const QDateTime &datetime ) const; virtual QDateTime endDateForStart( const QDateTime &startDt ) const; // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% // %%%%% Attachment-related methods // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% void addAttachment( Attachment *attachment ); void deleteAttachment( Attachment *attachment ); void deleteAttachments( const QString &mime ); Attachment::List attachments() const; Attachment::List attachments( const QString &mime ) const; void clearAttachments(); // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% // %%%%% Secrecy and Status methods // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% void setSecrecy( int ); int secrecy() const; QString secrecyStr() const; static QStringList secrecyList(); static QString secrecyName( int ); void setStatus( Status status ); void setCustomStatus( const QString &status ); Status status() const; QString statusStr() const; static QString statusName( Status ); // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% // %%%%% Other methods // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% void setResources( const QStringList &resources ); QStringList resources() const; void setPriority( int priority ); int priority() const; // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% // %%%%% Alarm-related methods // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% const Alarm::List &alarms() const; Alarm *newAlarm(); void addAlarm( Alarm * ); void removeAlarm( Alarm * ); void clearAlarms(); bool isAlarmEnabled() const; // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% // %%%%% Other methods // %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% void setLocation(const QString &location); QString location() const; void setSchedulingID( const QString& sid ); QString schedulingID() const; virtual void recurrenceUpdated( Recurrence * ); protected: virtual QDateTime endDateRecurrenceBase() const { return dtStart(); } private: int mRevision; // base components of jounal, event and todo QDateTime mCreated; QString mDescription; QString mSummary; QStringList mCategories; Incidence *mRelatedTo; QString mRelatedToUid; Incidence::List mRelations; Attachment::List mAttachments; QStringList mResources; QString mStatusString; Status mStatus; int mSecrecy; int mPriority; // 1 = highest, 2 = less, etc. Alarm::List mAlarms; Recurrence *mRecurrence; QString mLocation; // Scheduling ID - used only to identify between scheduling mails QString mSchedulingID; class Private; Private *d; }; } #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