KCalCore::Journal Class Reference

Provides a Journal in the sense of RFC2445. More...

#include <journal.h>

Inheritance diagram for KCalCore::Journal:

List of all members.

Public Types
typedef QVector< Ptr >	List
typedef QSharedPointer< Journal >	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
Static Public Member Functions
static QLatin1String	journalMimeType ()
Protected Member Functions
virtual IncidenceBase &	assign (const IncidenceBase &other)
bool	equals (const IncidenceBase &journal) const
virtual void	virtual_hook (int id, void *data)

---

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.

Reimplemented from KCalCore::Incidence.

Definition at line 54 of file journal.h.

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

A shared pointer to a Journal object.

Reimplemented from KCalCore::Incidence.

Definition at line 49 of file journal.h.

---

Constructor & Destructor Documentation

Journal::Journal

(

)

Constructs an empty journal.

Definition at line 37 of file journal.cpp.

Journal::~Journal

(

)

Destroys a journal.

Definition at line 41 of file journal.cpp.

---

Member Function Documentation

IncidenceBase & Journal::assign

(

const IncidenceBase &

other

)

[protected, virtual]

Provides polymorfic assignment.

Parameters:

other

is the IncidenceBase to assign.

Reimplemented from KCalCore::Incidence.

Definition at line 60 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 55 of file journal.cpp.

KDateTime Journal::dateTime

(

DateTimeRole

role

)

const [virtual]

Returns a date/time corresponding to the specified DateTimeRole.

Parameters:

role	is a DateTimeRole.

Implements KCalCore::IncidenceBase.

Definition at line 76 of file journal.cpp.

bool Journal::equals

(

const IncidenceBase &

journal

)

const [protected, virtual]

Compare this with journal for equality.

Parameters:

journal

is the journal to compare.

Reimplemented from KCalCore::Incidence.

Definition at line 66 of file journal.cpp.

QLatin1String Journal::iconName

(

const KDateTime &

recurrenceId = KDateTime()

)

const [virtual]

Implements KCalCore::Incidence.

Definition at line 113 of file journal.cpp.

QLatin1String Journal::journalMimeType

(

)

[static]

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

Definition at line 108 of file journal.cpp.

QLatin1String Journal::mimeType

(

)

const [virtual]

Returns the Akonadi specific sub MIME type of a KCalCore::IncidenceBase item, e.g.

getting "application/x-vnd.akonadi.calendar.event" for a KCalCore::Event.

Implements KCalCore::IncidenceBase.

Definition at line 102 of file journal.cpp.

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

Sets the date/time corresponding to the specified DateTimeRole.

Parameters:

dateTime	is KDateTime value to set.
role	is a DateTimeRole.

Implements KCalCore::IncidenceBase.

Definition at line 89 of file journal.cpp.

Incidence::IncidenceType Journal::type

(

)

const [virtual]

Returns the incidence type.

Implements KCalCore::IncidenceBase.

Definition at line 45 of file journal.cpp.

QByteArray Journal::typeStr

(

)

const [virtual]

Prints the type of incidence as a string.

Implements KCalCore::IncidenceBase.

Definition at line 50 of file journal.cpp.

void Journal::virtual_hook	(	int	id,
		void *	data
	)		[protected, virtual]

Standard trick to add virtuals later.

Parameters:

id	is any integer unique to this class which we will use to identify the method to be called.
data	is a pointer to some glob of data, typically a struct.

Implements KCalCore::IncidenceBase.

Definition at line 95 of file journal.cpp.

---

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

• journal.h
• journal.cpp