KCalendarCore::Journal

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

#include <journal.h>

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

Public Types

typedef QVector< Ptr > List
 
typedef QSharedPointer< Journal > Ptr
 
- Public Types inherited from KCalendarCore::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 KCalendarCore::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 (const Journal &)
 
 ~Journal () override
 
Journal * clone () const override
 
QDateTime dateTime (DateTimeRole role) const override
 
QLatin1String iconName (const QDateTime &recurrenceId={}) const override
 
QLatin1String mimeType () const override
 
void setDateTime (const QDateTime &dateTime, DateTimeRole role) override
 
bool supportsGroupwareCommunication () const override
 
IncidenceType type () const override
 
QByteArray typeStr () const override
 
- Public Member Functions inherited from KCalendarCore::Incidence
 Incidence ()
 
 ~Incidence () override
 
void addAlarm (const Alarm::Ptr &alarm)
 
void addAttachment (const Attachment &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 ()
 
QDateTime created () const
 
QString customStatus () const
 
void deleteAttachments (const QString &mime)
 
QString description () const
 
bool descriptionIsRich () const
 
virtual QDateTime endDateForStart (const QDateTime &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
 
QDateTime recurrenceId () const override
 
ushort recurrenceType () const
 
void recurrenceUpdated (Recurrence *recurrence) override
 
bool recurs () const
 
bool recursAt (const QDateTime &dt) const
 
virtual bool recursOn (const QDate &date, const QTimeZone &timeZone) 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) override
 
void setAltDescription (const QString &altdescription)
 
void setCategories (const QStringList &categories)
 
void setCategories (const QString &catStr)
 
void setCreated (const QDateTime &dt)
 
void setCustomStatus (const QString &status)
 
void setDescription (const QString &description, bool isRich)
 
void setDescription (const QString &description)
 
void setDtStart (const QDateTime &dt) override
 
void setGeoLatitude (float geolatitude)
 
void setGeoLongitude (float geolongitude)
 
void setHasGeo (bool hasGeo)
 
void setLastModified (const QDateTime &lm) override
 
void setLocalOnly (bool localonly)
 
void setLocation (const QString &location, bool isRich)
 
void setLocation (const QString &location)
 
void setPriority (int priority)
 
void setReadOnly (bool readonly) override
 
void setRecurrenceId (const QDateTime &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)
 
void shiftTimes (const QTimeZone &oldZone, const QTimeZone &newZone) override
 
virtual QList< QDateTime > startDateTimesForDate (const QDate &date, const QTimeZone &timeZone) const
 
virtual QList< QDateTime > startDateTimesForDateTime (const QDateTime &datetime) const
 
Status status () const
 
QString summary () const
 
bool summaryIsRich () const
 
bool thisAndFuture () const
 
- Public Member Functions inherited from KCalendarCore::IncidenceBase
 IncidenceBase ()
 
 ~IncidenceBase () override
 
void addAttendee (const Attendee &attendee, bool doUpdate=true)
 
void addComment (const QString &comment)
 
void addContact (const QString &contact)
 
bool allDay () const
 
Attendee attendeeByMail (const QString &email) const
 
Attendee attendeeByMails (const QStringList &emails, const QString &email=QString()) const
 
Attendee attendeeByUid (const QString &uid) const
 
int attendeeCount () const
 
Attendee::List attendees () const
 
void clearAttendees ()
 
void clearComments ()
 
void clearContacts ()
 
QStringList comments () const
 
QStringList contacts () const
 
QSet< IncidenceBase::Field > dirtyFields () const
 
virtual QDateTime dtStart () const
 
Duration duration () const
 
void endUpdates ()
 
bool hasDuration () const
 
bool isReadOnly () const
 
QDateTime lastModified () const
 
bool operator!= (const IncidenceBase &ib) const
 
IncidenceBase & operator= (const IncidenceBase &other)
 
bool operator== (const IncidenceBase &ib) const
 
Person organizer () const
 
void registerObserver (IncidenceObserver *observer)
 
bool removeComment (const QString &comment)
 
bool removeContact (const QString &contact)
 
void resetDirtyFields ()
 
void setAttendees (const Attendee::List &attendees, bool doUpdate=true)
 
void setDirtyFields (const QSet< IncidenceBase::Field > &)
 
virtual void setDuration (const Duration &duration)
 
void setHasDuration (bool hasDuration)
 
void setOrganizer (const Person &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 ()
 
QUrl uri () const
 
QUrl url () const
 
- Public Member Functions inherited from KCalendarCore::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 KCalendarCore::Incidence
static QStringList mimeTypes ()
 
- Static Public Member Functions inherited from KCalendarCore::IncidenceBase
static quint32 magicSerializationIdentifier ()
 
- Static Public Member Functions inherited from KCalendarCore::CustomProperties
static QByteArray customPropertyName (const QByteArray &app, const QByteArray &key)
 

Protected Member Functions

IncidenceBase & assign (const IncidenceBase &other) override
 
bool equals (const IncidenceBase &journal) const override
 
void virtual_hook (VirtualHook id, void *data) override
 
- Protected Member Functions inherited from KCalendarCore::Incidence
 Incidence (const Incidence &other)
 
- Protected Member Functions inherited from KCalendarCore::IncidenceBase
 IncidenceBase (const IncidenceBase &ib)
 
void customPropertyUpdate () override
 
void customPropertyUpdated () override
 
void setFieldDirty (IncidenceBase::Field field)
 

Additional Inherited Members

- Properties inherited from KCalendarCore::Incidence
QVariantList attachments
 
QStringList categories
 
QDateTime created
 
QString description
 
float geoLatitude
 
float geoLongitude
 
bool hasGeo
 
QString location
 
int priority
 
KCalendarCore::Incidence::Secrecy secrecy
 
KCalendarCore::Incidence::Status status
 
QString summary
 
- Properties inherited from KCalendarCore::IncidenceBase
bool allDay
 
QVariantList attendees
 
QDateTime dtStart
 
QDateTime lastModified
 
KCalendarCore::Person organizer
 
QString uid
 
- Protected Types inherited from KCalendarCore::IncidenceBase
enum  VirtualHook
 
- Protected Attributes inherited from KCalendarCore::IncidenceBase
bool mReadOnly
 

Detailed Description

Provides a Journal in the sense of RFC2445.

Definition at line 30 of file journal.h.

Member Typedef Documentation

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

List of journals.

Definition at line 41 of file journal.h.

typedef QSharedPointer<Journal> KCalendarCore::Journal::Ptr

A shared pointer to a Journal object.

Definition at line 36 of file journal.h.

Constructor & Destructor Documentation

Journal::Journal ( )

Constructs an empty journal.

Definition at line 26 of file journal.cpp.

Journal::Journal ( const Journal &  )
default

Copy a journey object.

Journal::~Journal ( )
overridedefault

Destroys a journal.

Member Function Documentation

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

IncidenceBase::assign()

Reimplemented from KCalendarCore::Incidence.

Definition at line 48 of file journal.cpp.

Journal * Journal::clone ( ) const
overridevirtual

Returns an exact copy of this journal.

The returned object is owned by the caller.

Implements KCalendarCore::Incidence.

Definition at line 43 of file journal.cpp.

QDateTime Journal::dateTime ( DateTimeRole  role) const
overridevirtual

IncidenceBase::dateTime(DateTimeRole)const

Implements KCalendarCore::IncidenceBase.

Definition at line 64 of file journal.cpp.

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

Compare this with journal for equality.

Parameters
journalis the journal to compare.

Reimplemented from KCalendarCore::Incidence.

Definition at line 54 of file journal.cpp.

QLatin1String Journal::iconName ( const QDateTime &  recurrenceId = {}) const
overridevirtual

Incidence::iconName()

Implements KCalendarCore::Incidence.

Definition at line 107 of file journal.cpp.

QLatin1String Journal::journalMimeType ( )
static

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

Definition at line 102 of file journal.cpp.

QLatin1String Journal::mimeType ( ) const
overridevirtual

IncidenceBase::mimeType()

Implements KCalendarCore::IncidenceBase.

Definition at line 96 of file journal.cpp.

void Journal::setDateTime ( const QDateTime &  dateTime,
DateTimeRole  role 
)
overridevirtual

IncidenceBase::setDateTime(const QDateTime &, DateTimeRole )

Implements KCalendarCore::IncidenceBase.

Definition at line 78 of file journal.cpp.

bool Journal::supportsGroupwareCommunication ( ) const
overridevirtual

Incidence::supportsGroupwareCommunication()

Implements KCalendarCore::Incidence.

Definition at line 122 of file journal.cpp.

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

IncidenceBase::type()

Implements KCalendarCore::IncidenceBase.

Definition at line 33 of file journal.cpp.

QByteArray Journal::typeStr ( ) const
overridevirtual

IncidenceBase::typeStr()

Implements KCalendarCore::IncidenceBase.

Definition at line 38 of file journal.cpp.

void Journal::virtual_hook ( VirtualHook  id,
void *  data 
)
overrideprotectedvirtual

IncidenceBase::virtual_hook()

Implements KCalendarCore::IncidenceBase.

Definition at line 90 of file journal.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Thu Sep 24 2020 22:51:33 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.