CalendarSupport::IncidenceViewer Class Reference

#include <incidenceviewer.h>

Inheritance diagram for CalendarSupport::IncidenceViewer:

Public Slots
void	setIncidence (const Akonadi::Item &incidence, const QDate &activeDate=QDate())

Public Member Functions
	IncidenceViewer (Akonadi::ETMCalendar *calendar, QWidget *parent=0)
	IncidenceViewer (QWidget *parent=0)
	~IncidenceViewer ()
QDate	activeDate () const
QAbstractItemModel *	attachmentModel () const
Akonadi::Item	incidence () const
void	setCalendar (Akonadi::ETMCalendar *calendar)
void	setDefaultMessage (const QString &message)
void	setDelayedClear (bool delayed)
void	setHeaderText (const QString &text)

Protected Member Functions
void	init ()

Detailed Description

A viewer component for incidences in Akonadi.

This widgets provides a way to show an incidence from the Akonadi storage.

Example:

using namespace CalendarSupport;

const Item item = ...

IncidenceViewer *viewer = new IncidenceViewer( this );
viewer->setIncidence( item );

Author

Tobias Koenig tokoe.nosp@m.@kde.nosp@m..org

Since

4.5

Definition at line 62 of file incidenceviewer.h.

Constructor & Destructor Documentation

IncidenceViewer::IncidenceViewer ( Akonadi::ETMCalendar *  calendar, QWidget *  parent = 0  )

explicit

Creates a new incidence viewer.

*param

Parameters

calendar	is a pointer to a Calendar instance.
parent	it the parent widget.

Definition at line 140 of file incidenceviewer.cpp.

IncidenceViewer::IncidenceViewer ( QWidget *  parent = 0 )

explicit

Creates a new incidence viewer.

*param

Parameters

parent

it the parent widget.

Definition at line 147 of file incidenceviewer.cpp.

IncidenceViewer::~IncidenceViewer

(

)

Destroys the incidence viewer.

Definition at line 171 of file incidenceviewer.cpp.

Member Function Documentation

QDate IncidenceViewer::activeDate

(

)

const

Returns the active date used for the currently displayed incidence.

Definition at line 186 of file incidenceviewer.cpp.

QAbstractItemModel * IncidenceViewer::attachmentModel

(

)

const

Returns the attachment model for the currently displayed incidence.

Definition at line 191 of file incidenceviewer.cpp.

Akonadi::Item IncidenceViewer::incidence

(

)

const

Returns the incidence that is currently displayed.

Definition at line 181 of file incidenceviewer.cpp.

void IncidenceViewer::init ( )

protected

Initialize the widget settings.

Definition at line 154 of file incidenceviewer.cpp.

void IncidenceViewer::setCalendar

(

Akonadi::ETMCalendar *

calendar

)

Sets the Calendar for this viewer.

Parameters

calendar

is a pointer to a Calendar instance.

Definition at line 176 of file incidenceviewer.cpp.

void IncidenceViewer::setDefaultMessage

(

const QString &

message

)

Sets the default message that shall be shown if no incidence is set.

Definition at line 205 of file incidenceviewer.cpp.

void IncidenceViewer::setDelayedClear

(

bool

delayed

)

Sets whether the view shall be cleared as soon as an empty incidence is set (default) or delayed when the next valid incidence is set.

Definition at line 200 of file incidenceviewer.cpp.

void IncidenceViewer::setHeaderText

(

const QString &

text

)

Sets an additional text that is shown above the incidence.

Definition at line 210 of file incidenceviewer.cpp.

void IncidenceViewer::setIncidence ( const Akonadi::Item &  incidence, const QDate &  activeDate = QDate()  )

slot

Sets the incidence that shall be displayed in the viewer.

Parameters

activeDate

The active date is used to calculate the actual date of the selected incidence in case of recurring incidences.

Definition at line 215 of file incidenceviewer.cpp.

---

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

• incidenceviewer.h
• incidenceviewer.cpp