• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdepimlibs API Reference
  • KDE Home
  • Contact Us
 

KCalCore Library

  • KCalCore
  • Journal
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
KCalCore::Journal Class Reference

#include <journal.h>

Inheritance diagram for KCalCore::Journal:
Inheritance graph
[legend]

Public Types

typedef QVector< Ptr > List
 
typedef QSharedPointer< Journal > Ptr
 
- Public Types inherited from KCalCore::Incidence
typedef QVector< Ptr > List
 
typedef QSharedPointer< Incidence > Ptr
 
enum  RelType { RelTypeParent, RelTypeChild, RelTypeSibling }
 
enum  Secrecy { SecrecyPublic, SecrecyPrivate, SecrecyConfidential }
 
enum  Status {
  StatusNone, StatusTentative, StatusConfirmed, StatusCompleted,
  StatusNeedsAction, StatusCanceled, StatusInProcess, StatusDraft,
  StatusFinal, StatusX
}
 
- Public Types inherited from KCalCore::IncidenceBase
enum  DateTimeRole {
  RoleAlarmStartOffset = 0, RoleAlarmEndOffset, RoleSort, RoleCalendarHashing,
  RoleStartTimeZone, RoleEndTimeZone, RoleEndRecurrenceBase, RoleEnd,
  RoleDisplayEnd, RoleAlarm, RoleRecurrenceStart, RoleDisplayStart,
  RoleDnD
}
 
enum  Field {
  FieldDtStart, FieldDtEnd, FieldLastModified, FieldDescription,
  FieldSummary, FieldLocation, FieldCompleted, FieldPercentComplete,
  FieldDtDue, FieldCategories, FieldRelatedTo, FieldRecurrence,
  FieldAttachment, FieldSecrecy, FieldStatus, FieldTransparency,
  FieldResources, FieldPriority, FieldGeoLatitude, FieldGeoLongitude,
  FieldRecurrenceId, FieldAlarms, FieldSchedulingId, FieldAttendees,
  FieldOrganizer, FieldCreated, FieldRevision, FieldDuration,
  FieldContact, FieldComment, FieldUid, FieldUnknown,
  FieldUrl
}
 
enum  IncidenceType {
  TypeEvent = 0, TypeTodo, TypeJournal, TypeFreeBusy,
  TypeUnknown
}
 
typedef QSharedPointer
< IncidenceBase > 
Ptr
 

Public Member Functions

 Journal ()
 
 ~Journal ()
 
Journal * clone () const
 
KDateTime dateTime (DateTimeRole role) const
 
QLatin1String iconName (const KDateTime &recurrenceId=KDateTime()) const
 
QLatin1String mimeType () const
 
void setDateTime (const KDateTime &dateTime, DateTimeRole role)
 
IncidenceType type () const
 
QByteArray typeStr () const
 
- Public Member Functions inherited from KCalCore::Incidence
 Incidence ()
 
virtual ~Incidence ()
 
void addAlarm (const Alarm::Ptr &alarm)
 
void addAttachment (const Attachment::Ptr &attachment)
 
Alarm::List alarms () const
 
QString altDescription () const
 
Attachment::List attachments () const
 
Attachment::List attachments (const QString &mime) const
 
QStringList categories () const
 
QString categoriesStr () const
 
void clearAlarms ()
 
void clearAttachments ()
 
void clearRecurrence ()
 
void clearTempFiles ()
 
KDateTime created () const
 
QString customStatus () const
 
void deleteAttachment (const Attachment::Ptr &attachment)
 
void deleteAttachments (const QString &mime)
 
QString description () const
 
bool descriptionIsRich () const
 
virtual KDateTime endDateForStart (const KDateTime &startDt) const
 
float geoLatitude () const
 
float geoLongitude () const
 
bool hasAltDescription () const
 
bool hasEnabledAlarms () const
 
bool hasGeo () const
 
bool hasRecurrenceId () const
 
QString instanceIdentifier () const
 
bool localOnly () const
 
QString location () const
 
bool locationIsRich () const
 
Alarm::Ptr newAlarm ()
 
int priority () const
 
void recreate ()
 
Recurrence * recurrence () const
 
KDateTime recurrenceId () const
 
ushort recurrenceType () const
 
virtual void recurrenceUpdated (Recurrence *recurrence)
 
bool recurs () const
 
bool recursAt (const KDateTime &dt) const
 
virtual bool recursOn (const QDate &date, const KDateTime::Spec &timeSpec) const
 
QString relatedTo (RelType relType=RelTypeParent) const
 
void removeAlarm (const Alarm::Ptr &alarm)
 
QStringList resources () const
 
int revision () const
 
QString richDescription () const
 
QString richLocation () const
 
QString richSummary () const
 
QString schedulingID () const
 
Secrecy secrecy () const
 
void setAllDay (bool allDay)
 
void setAltDescription (const QString &altdescription)
 
void setCategories (const QStringList &categories)
 
void setCategories (const QString &catStr)
 
void setCreated (const KDateTime &dt)
 
void setCustomStatus (const QString &status)
 
void setDescription (const QString &description, bool isRich)
 
void setDescription (const QString &description)
 
virtual void setDtStart (const KDateTime &dt)
 
void setGeoLatitude (float geolatitude)
 
void setGeoLongitude (float geolongitude)
 
void setHasGeo (bool hasGeo)
 
void setLastModified (const KDateTime &lm)
 
void setLocalOnly (bool localonly)
 
void setLocation (const QString &location, bool isRich)
 
void setLocation (const QString &location)
 
void setPriority (int priority)
 
void setReadOnly (bool readonly)
 
void setRecurrenceId (const KDateTime &recurrenceId)
 
void setRelatedTo (const QString &uid, RelType relType=RelTypeParent)
 
void setResources (const QStringList &resources)
 
void setRevision (int rev)
 
void setSchedulingID (const QString &sid, const QString &uid=QString())
 
void setSecrecy (Secrecy secrecy)
 
void setStatus (Status status)
 
void setSummary (const QString &summary, bool isRich)
 
void setSummary (const QString &summary)
 
void setThisAndFuture (bool thisAndFuture)
 
virtual void shiftTimes (const KDateTime::Spec &oldSpec, const KDateTime::Spec &newSpec)
 
virtual QList< KDateTime > startDateTimesForDate (const QDate &date, const KDateTime::Spec &timeSpec=KDateTime::LocalZone) const
 
virtual QList< KDateTime > startDateTimesForDateTime (const KDateTime &datetime) const
 
Status status () const
 
QString summary () const
 
bool summaryIsRich () const
 
bool supportsGroupwareCommunication () const
 
bool thisAndFuture () const
 
QString writeAttachmentToTempFile (const Attachment::Ptr &attachment) const
 
- Public Member Functions inherited from KCalCore::IncidenceBase
 IncidenceBase ()
 
virtual ~IncidenceBase ()
 
void addAttendee (const Attendee::Ptr &attendee, bool doUpdate=true)
 
void addComment (const QString &comment)
 
void addContact (const QString &contact)
 
bool allDay () const
 
Attendee::Ptr attendeeByMail (const QString &email) const
 
Attendee::Ptr attendeeByMails (const QStringList &emails, const QString &email=QString()) const
 
Attendee::Ptr attendeeByUid (const QString &uid) const
 
int attendeeCount () const
 
Attendee::List attendees () const
 
void clearAttendees ()
 
void clearComments ()
 
void clearContacts ()
 
QStringList comments () const
 
QStringList contacts () const
 
void deleteAttendee (const Attendee::Ptr &attendee, bool doUpdate=true)
 
QSet< IncidenceBase::Field > dirtyFields () const
 
virtual KDateTime dtStart () const
 
Duration duration () const
 
void endUpdates ()
 
bool hasDuration () const
 
bool isReadOnly () const
 
KDateTime lastModified () const
 
bool operator!= (const IncidenceBase &ib) const
 
IncidenceBase & operator= (const IncidenceBase &other)
 
bool operator== (const IncidenceBase &ib) const
 
Person::Ptr organizer () const
 
void registerObserver (IncidenceObserver *observer)
 
bool removeComment (const QString &comment)
 
bool removeContact (const QString &contact)
 
void resetDirtyFields ()
 
void setAllDay (bool allDay)
 
void setDirtyFields (const QSet< IncidenceBase::Field > &)
 
virtual void setDuration (const Duration &duration)
 
void setHasDuration (bool hasDuration)
 
void setOrganizer (const Person::Ptr &organizer)
 
void setOrganizer (const QString &organizer)
 
void setUid (const QString &uid)
 
void setUrl (const QUrl &url)
 
void startUpdates ()
 
QString uid () const
 
void unRegisterObserver (IncidenceObserver *observer)
 
void update ()
 
void updated ()
 
KUrl uri () const
 
QUrl url () const
 
- Public Member Functions inherited from KCalCore::CustomProperties
 CustomProperties ()
 
 CustomProperties (const CustomProperties &other)
 
virtual ~CustomProperties ()
 
QMap< QByteArray, QString > customProperties () const
 
QString customProperty (const QByteArray &app, const QByteArray &key) const
 
QString nonKDECustomProperty (const QByteArray &name) const
 
QString nonKDECustomPropertyParameters (const QByteArray &name) const
 
CustomProperties & operator= (const CustomProperties &other)
 
bool operator== (const CustomProperties &properties) const
 
void removeCustomProperty (const QByteArray &app, const QByteArray &key)
 
void removeNonKDECustomProperty (const QByteArray &name)
 
void setCustomProperties (const QMap< QByteArray, QString > &properties)
 
void setCustomProperty (const QByteArray &app, const QByteArray &key, const QString &value)
 
void setNonKDECustomProperty (const QByteArray &name, const QString &value, const QString &parameters=QString())
 

Static Public Member Functions

static QLatin1String journalMimeType ()
 
- Static Public Member Functions inherited from KCalCore::Incidence
static QStringList mimeTypes ()
 
- Static Public Member Functions inherited from KCalCore::IncidenceBase
static quint32 magicSerializationIdentifier ()
 
- Static Public Member Functions inherited from KCalCore::CustomProperties
static QByteArray customPropertyName (const QByteArray &app, const QByteArray &key)
 

Protected Member Functions

virtual IncidenceBase & assign (const IncidenceBase &other)
 
bool equals (const IncidenceBase &journal) const
 
virtual void virtual_hook (int id, void *data)
 
- Protected Member Functions inherited from KCalCore::Incidence
 Incidence (const Incidence &other)
 
void deserialize (QDataStream &in)
 
void serialize (QDataStream &out)
 
- Protected Member Functions inherited from KCalCore::IncidenceBase
 IncidenceBase (const IncidenceBase &ib)
 
virtual void customPropertyUpdate ()
 
virtual void customPropertyUpdated ()
 
void setFieldDirty (IncidenceBase::Field field)
 

Additional Inherited Members

- Protected Types inherited from KCalCore::IncidenceBase
enum  VirtualHook { SerializerHook, DeserializerHook }
 
- Protected Attributes inherited from KCalCore::IncidenceBase
bool mReadOnly
 

Detailed Description

Provides a Journal in the sense of RFC2445.

Definition at line 43 of file journal.h.

Member Typedef Documentation

typedef QVector<Ptr> KCalCore::Journal::List

List of journals.

Definition at line 54 of file journal.h.

typedef QSharedPointer<Journal> KCalCore::Journal::Ptr

A shared pointer to a Journal object.

Definition at line 49 of file journal.h.

Constructor & Destructor Documentation

Journal::Journal ( )

Constructs an empty journal.

Definition at line 39 of file journal.cpp.

Journal::~Journal ( )

Destroys a journal.

Definition at line 43 of file journal.cpp.

Member Function Documentation

IncidenceBase & Journal::assign ( const IncidenceBase &  other)
protectedvirtual

IncidenceBase::assign()

Reimplemented from KCalCore::Incidence.

Definition at line 62 of file journal.cpp.

Journal * Journal::clone ( ) const
virtual

Returns an exact copy of this journal.

The returned object is owned by the caller.

Implements KCalCore::Incidence.

Definition at line 57 of file journal.cpp.

KDateTime Journal::dateTime ( DateTimeRole  role) const
virtual

IncidenceBase::dateTime(DateTimeRole)const

Implements KCalCore::IncidenceBase.

Definition at line 78 of file journal.cpp.

bool Journal::equals ( const IncidenceBase &  journal) const
protectedvirtual

Compare this with journal for equality.

Parameters
journalis the journal to compare.

Reimplemented from KCalCore::Incidence.

Definition at line 68 of file journal.cpp.

QLatin1String Journal::iconName ( const KDateTime &  recurrenceId = KDateTime()) const
virtual

Incidence::iconName()

Implements KCalCore::Incidence.

Definition at line 130 of file journal.cpp.

QLatin1String Journal::journalMimeType ( )
static

Returns the Akonadi specific sub MIME type of a KCalCore::Journal.

Definition at line 125 of file journal.cpp.

QLatin1String Journal::mimeType ( ) const
virtual

IncidenceBase::mimeType()

Implements KCalCore::IncidenceBase.

Definition at line 119 of file journal.cpp.

void Journal::setDateTime ( const KDateTime &  dateTime,
DateTimeRole  role 
)
virtual

IncidenceBase::setDateTime(const KDateTime &, DateTimeRole )

Implements KCalCore::IncidenceBase.

Definition at line 92 of file journal.cpp.

Incidence::IncidenceType Journal::type ( ) const
virtual

IncidenceBase::type()

Implements KCalCore::IncidenceBase.

Definition at line 47 of file journal.cpp.

QByteArray Journal::typeStr ( ) const
virtual

IncidenceBase::typeStr()

Implements KCalCore::IncidenceBase.

Definition at line 52 of file journal.cpp.

void Journal::virtual_hook ( int  id,
void *  data 
)
protectedvirtual

IncidenceBase::virtual_hook()

Implements KCalCore::IncidenceBase.

Definition at line 105 of file journal.cpp.


The documentation for this class was generated from the following files:
  • journal.h
  • journal.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:59:58 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KCalCore Library

Skip menu "KCalCore Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Related Pages

kdepimlibs API Reference

Skip menu "kdepimlibs API Reference"
  • akonadi
  •   contact
  •   kmime
  •   socialutils
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kldap
  • kmbox
  • kmime
  • kpimidentities
  • kpimtextedit
  • kresources
  • ktnef
  • kxmlrpcclient
  • microblog

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal