KGAPI2::Event

#include <event.h>

Inheritance diagram for KGAPI2::Event:

[legend]

Public Types
enum class	EventType { Default , FocusTime , OutOfOffice , WorkingLocation }

Public Types inherited from KCalendarCore::Event
typedef QList< Ptr >	List

typedef QSharedPointer< Event >	Ptr

enum	Transparency

Public Types inherited from KCalendarCore::Incidence
typedef QList< Ptr >	List

typedef QSharedPointer< Incidence >	Ptr

enum	RelType

enum	Secrecy

enum	Status

Public Types inherited from KCalendarCore::IncidenceBase
enum	DateTimeRole

enum	Field

enum	IncidenceType

typedef QSharedPointer< IncidenceBase >	Ptr

Public Member Functions
	Event ()

	Event (const Event &other)

	Event (const KCalendarCore::Event &event)

	~Event () override

bool	deleted () const

EventType	eventType () const

QString	hangoutLink () const

QString	id () const

bool	operator== (const Event &other) const

	Q_ENUM (EventType)

void	setDeleted (bool deleted)

void	setEventType (EventType eventType)

void	setHangoutLink (const QString &id)

void	setId (const QString &id)

void	setUseDefaultReminders (bool useDefault)

bool	useDefaultReminders () const

Public Member Functions inherited from KGAPI2::Object
	Object ()

	Object (const Object &other)

virtual	~Object ()

QString	etag () const

bool	operator== (const Object &other) const

void	setEtag (const QString &etag)

Public Member Functions inherited from KCalendarCore::Event
	Event (const Event &other)

	Event (const Incidence &other)

Event *	clone () const override

QDate	dateEnd () const

QDateTime	dateTime (DateTimeRole role) const override

virtual QDateTime	dtEnd () const

bool	hasEndDate () const

QLatin1String	iconName (const QDateTime &recurrenceId={}) const override

bool	isMultiDay (const QTimeZone &zone={}) const

QLatin1String	mimeType () const override

void	setAllDay (bool allDay) override

void	setDateTime (const QDateTime &dateTime, DateTimeRole role) override

void	setDtEnd (const QDateTime &dtEnd)

void	setDtStart (const QDateTime &dt) override

void	setDuration (const Duration &duration) override

void	setTransparency (Transparency transparency)

void	shiftTimes (const QTimeZone &oldZone, const QTimeZone &newZone) override

bool	supportsGroupwareCommunication () const override

Transparency	transparency () const

IncidenceType	type () const override

QByteArray	typeStr () const override

Public Member Functions inherited from KCalendarCore::Incidence
	Incidence (IncidencePrivate *p)

void	addAlarm (const Alarm::Ptr &alarm)

void	addAttachment (const Attachment &attachment)

void	addConference (const Conference &conference)

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	clearConferences ()

void	clearRecurrence ()

QString	color () const

Conference::List	conferences () const

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 QString &catStr)

void	setCategories (const QStringList &categories)

void	setColor (const QString &colorName)

void	setConferences (const Conference::List &conferences)

void	setCreated (const QDateTime &dt)

void	setCustomStatus (const QString &status)

void	setDescription (const QString &description)

void	setDescription (const QString &description, bool isRich)

void	setDtStart (const QDateTime &dt) override

void	setGeoLatitude (float geolatitude)

void	setGeoLongitude (float geolongitude)

void	setLastModified (const QDateTime &lm) override

void	setLocalOnly (bool localonly)

void	setLocation (const QString &location)

void	setLocation (const QString &location, bool isRich)

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)

void	setSummary (const QString &summary, bool isRich)

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
KCALENDARCORE_NO_EXPORT	IncidenceBase (IncidenceBasePrivate *p)

virtual bool	accept (Visitor &v, const IncidenceBase::Ptr &incidence)

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 > &)

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 (const CustomProperties &other)

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())

Additional Inherited Members
Static Public Member Functions inherited from KCalendarCore::Event
static QLatin1String	eventMimeType ()

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)

Public Attributes inherited from KCalendarCore::Event
	Opaque

	Transparent

Public Attributes inherited from KCalendarCore::Incidence
	RelTypeChild

	RelTypeParent

	RelTypeSibling

	SecrecyConfidential

	SecrecyPrivate

	SecrecyPublic

	StatusCanceled

	StatusCompleted

	StatusConfirmed

	StatusDraft

	StatusFinal

	StatusInProcess

	StatusNeedsAction

	StatusNone

	StatusTentative

	StatusX

Public Attributes inherited from KCalendarCore::IncidenceBase
	FieldAlarms

	FieldAttachment

	FieldAttendees

	FieldCategories

	FieldColor

	FieldComment

	FieldCompleted

	FieldConferences

	FieldContact

	FieldCreated

	FieldDescription

	FieldDtDue

	FieldDtEnd

	FieldDtStart

	FieldDuration

	FieldGeoLatitude

	FieldGeoLongitude

	FieldLastModified

	FieldLocation

	FieldOrganizer

	FieldPercentComplete

	FieldPriority

	FieldRecurrence

	FieldRecurrenceId

	FieldRelatedTo

	FieldResources

	FieldRevision

	FieldSchedulingId

	FieldSecrecy

	FieldStatus

	FieldSummary

	FieldTransparency

	FieldUid

	FieldUnknown

	FieldUrl

	RoleAlarm

	RoleAlarmEndOffset

	RoleAlarmStartOffset

	RoleCalendarHashing

	RoleDisplayEnd

	RoleDisplayStart

	RoleDnD

	RoleEnd

	RoleEndTimeZone

	RoleRecurrenceStart

	RoleSort

	RoleStartTimeZone

	TypeEvent

	TypeFreeBusy

	TypeJournal

	TypeTodo

	TypeUnknown

Protected Member Functions inherited from KCalendarCore::Event
IncidenceBase &	assign (const IncidenceBase &other) override

bool	equals (const IncidenceBase &event) const override

void	virtual_hook (VirtualHook id, void *data) override

Protected Member Functions inherited from KCalendarCore::Incidence
	Incidence (const Incidence &other, IncidencePrivate *p)

IncidenceBase &	assign (const IncidenceBase &other) override

void	deserialize (QDataStream &in) override

bool	equals (const IncidenceBase &incidence) const override

void	serialize (QDataStream &out) const override

Protected Member Functions inherited from KCalendarCore::IncidenceBase
KCALENDARCORE_NO_EXPORT	IncidenceBase (const IncidenceBase &ib, IncidenceBasePrivate *p)

void	customPropertyUpdate () override

void	customPropertyUpdated () override

void	setFieldDirty (IncidenceBase::Field field)

Protected Attributes inherited from KCalendarCore::IncidenceBase
bool	mReadOnly

Detailed Description

Represents a single event from Google Calendar.

Author: Daniel Vrátil dvrat.nosp@m.il@r.nosp@m.edhat.nosp@m..com

Since: 0.1

Definition at line 28 of file calendar/event.h.

Member Enumeration Documentation

◆ EventType

enum class KGAPI2::Event::EventType

strong

Definition at line 31 of file calendar/event.h.

Constructor & Destructor Documentation

◆ Event() [1/3]

Event::Event ( )

Constructor.

Definition at line 29 of file calendar/event.cpp.

◆ Event() [2/3]

Event::Event ( const Event & other )

Copy constructor.

Definition at line 36 of file calendar/event.cpp.

◆ Event() [3/3]

Event::Event ( const KCalendarCore::Event & event )

explicit

Copy constructor.

Definition at line 43 of file calendar/event.cpp.

◆ ~Event()

Event::~Event ( )

overridedefault

Destructor.

Member Function Documentation

◆ deleted()

bool Event::deleted ( ) const

Returns whether the event was removed.

Definition at line 72 of file calendar/event.cpp.

◆ eventType()

Event::EventType Event::eventType ( ) const

Returns the type of the event.

Definition at line 118 of file calendar/event.cpp.

◆ hangoutLink()

QString Event::hangoutLink ( ) const

Returns the hangout link for Google Meet.

Definition at line 108 of file calendar/event.cpp.

◆ id()

QString Event::id ( ) const

Returns ID used by Google to identify the event in calendar.

This is not the same as UID.

Definition at line 92 of file calendar/event.cpp.

◆ operator==()

bool Event::operator== ( const Event & other ) const

Definition at line 52 of file calendar/event.cpp.

◆ setDeleted()

void Event::setDeleted ( bool deleted )

Marks the event as deleted.

Parameters

deleted

Definition at line 82 of file calendar/event.cpp.

◆ setEventType()

void Event::setEventType ( EventType eventType )

Sets the type of the event.

Definition at line 123 of file calendar/event.cpp.

◆ setHangoutLink()

void Event::setHangoutLink ( const QString & id )

Sets the hangout link for Google Meet.

Definition at line 113 of file calendar/event.cpp.

◆ setId()

void Event::setId ( const QString & id )

Sets event ID used by Google to identify the event in calendar.

Definition at line 103 of file calendar/event.cpp.

◆ setUseDefaultReminders()

void Event::setUseDefaultReminders ( bool useDefault )

Sets whether the event should use calendar's default reminders.

Parameters

useDefault

Definition at line 87 of file calendar/event.cpp.

◆ useDefaultReminders()

bool Event::useDefaultReminders ( ) const

Returns whether the event should use calendar's default reminders.

Definition at line 77 of file calendar/event.cpp.

The documentation for this class was generated from the following files:

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About Kgapi