KGAPI2::Reminder

KGAPI2::Reminder Class Reference

#include <reminder.h>

Public Member Functions

 Reminder ()
 
 Reminder (const KCalendarCore::Alarm::Type &type, const KCalendarCore::Duration &startOffset=KCalendarCore::Duration(0))
 
 Reminder (const Reminder &other)
 
virtual ~Reminder ()
 
bool operator== (const Reminder &other) const
 
void setStartOffset (const KCalendarCore::Duration &startOffset)
 
void setType (KCalendarCore::Alarm::Type type)
 
KCalendarCore::Duration startOffset () const
 
KCalendarCore::AlarmtoAlarm (KCalendarCore::Incidence *incidence) const
 
KCalendarCore::Alarm::Type type () const
 

Detailed Description

Represents a default calendar reminder.

Author
Daniel Vrátil dvrat[email protected][email protected][email protected]edhat[email protected].com
Since
0.4

Definition at line 30 of file reminder.h.

Constructor & Destructor Documentation

Reminder::Reminder ( )
explicit

Constructor.

Definition at line 23 of file reminder.cpp.

Reminder::Reminder ( const KCalendarCore::Alarm::Type type,
const KCalendarCore::Duration startOffset = KCalendarCore::Duration(0) 
)
explicit

Constructor.

Parameters
typeType of the reminder (email, notification, etc.)
startOffsetHow long before the event should the reminder be shown

Definition at line 28 of file reminder.cpp.

Reminder::Reminder ( const Reminder other)

Copy constructor.

Definition at line 35 of file reminder.cpp.

Reminder::~Reminder ( )
virtualdefault

Destructor.

Member Function Documentation

void Reminder::setStartOffset ( const KCalendarCore::Duration startOffset)

Sets how long before the event should reminder be shown.

Definition at line 65 of file reminder.cpp.

void Reminder::setType ( KCalendarCore::Alarm::Type  type)

Sets type of the reminder.

Parameters
type

Definition at line 55 of file reminder.cpp.

Duration Reminder::startOffset ( ) const

Returns how long before the event should reminder be shown.

Definition at line 70 of file reminder.cpp.

Alarm * Reminder::toAlarm ( KCalendarCore::Incidence incidence) const

Converts the reminder to a KCalendarCore::Alarm.

Parameters
incidenceAn incidence on which the reminder should be applied
Returns
Returns a new KCalendarCore::Alarm

Definition at line 76 of file reminder.cpp.

Alarm::Type Reminder::type ( ) const

Returns type of the reminder.

Definition at line 60 of file reminder.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 Fri Nov 27 2020 23:12:45 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.