KGAPI2::Reminder

Search for usage in LXR

KGAPI2::Reminder Class Reference

#include <reminder.h>

Public Member Functions

 Reminder ()
 
 Reminder (const Reminder &other)
 
 Reminder (KCalendarCore::Alarm::Type type, const KCalendarCore::Duration &startOffset=KCalendarCore::Duration(0))
 
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.nosp@m.il@r.nosp@m.edhat.nosp@m..com
Since
0.4

Definition at line 29 of file reminder.h.

Constructor & Destructor Documentation

◆ Reminder() [1/3]

Reminder::Reminder ( )
explicit

Constructor.

Definition at line 22 of file reminder.cpp.

◆ Reminder() [2/3]

Reminder::Reminder ( 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 27 of file reminder.cpp.

◆ Reminder() [3/3]

Reminder::Reminder ( const Reminder & other)

Copy constructor.

Definition at line 34 of file reminder.cpp.

◆ ~Reminder()

Reminder::~Reminder ( )
virtualdefault

Destructor.

Member Function Documentation

◆ operator==()

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

Definition at line 41 of file reminder.cpp.

◆ setStartOffset()

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

Sets how long before the event should reminder be shown.

Definition at line 64 of file reminder.cpp.

◆ setType()

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

Sets type of the reminder.

Parameters
type

Definition at line 54 of file reminder.cpp.

◆ startOffset()

Duration Reminder::startOffset ( ) const

Returns how long before the event should reminder be shown.

Definition at line 69 of file reminder.cpp.

◆ toAlarm()

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 75 of file reminder.cpp.

◆ type()

Alarm::Type Reminder::type ( ) const

Returns type of the reminder.

Definition at line 59 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-2024 The KDE developers.
Generated on Fri Jun 7 2024 12:02:03 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.