• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdepim
  • Sitemap
  • Contact Us
 

kalarm

AlarmCalendar Class Reference

#include <alarmcalendar.h>

Inheritance diagram for AlarmCalendar:

Inheritance graph
[legend]

List of all members.


Detailed Description

Provides read and write access to calendar files and resources.

Either vCalendar or iCalendar files may be read, but the calendar is saved only in iCalendar format to avoid information loss.

Definition at line 41 of file alarmcalendar.h.


Signals

void calendarSaved (AlarmCalendar *)
void earliestAlarmChanged ()
void emptyStatus (bool empty)

Public Member Functions

bool addEvent (KAEvent *, QWidget *promptParent=0, bool useEventID=false, AlarmResource *=0, bool noPrompt=false, bool *cancelled=0)
KAEvent::List atLoginAlarms () const
void close ()
KCal::Event * createKCalEvent (const KAEvent *, const QString &baseID, bool original=false, bool cancelCancelledDefer=false) const
KCal::Event * createKCalEvent (const KAEvent *e, bool original=false, bool cancelCancelledDefer=false) const
bool deleteEvent (const QString &eventID, bool save=false)
KAEvent * earliestAlarm () const
void emitEmptyStatus ()
bool endUpdate ()
KAEvent * event (const QString &uniqueID)
bool eventReadOnly (const QString &uniqueID) const
KAEvent::List events (const KDateTime &from, const KDateTime &to, KCalEvent::Status)
KAEvent::List events (AlarmResource *, KCalEvent::Status=KCalEvent::EMPTY)
KAEvent::List events (KCalEvent::Status s=KCalEvent::EMPTY)
bool isEmpty () const
bool isOpen () const
KCal::Event * kcalEvent (const QString &uniqueID)
KCal::Event::List kcalEvents (AlarmResource *, KCalEvent::Status=KCalEvent::EMPTY)
KCal::Event::List kcalEvents (KCalEvent::Status s=KCalEvent::EMPTY)
int load ()
void loadResource (AlarmResource *, QWidget *parent)
bool modifyEvent (const QString &oldEventId, KAEvent *newEvent)
bool open ()
QString path () const
void purgeEvents (const KAEvent::List &)
bool reload ()
void reloadFromCache (const QString &resourceID)
AlarmResource * resourceForEvent (const QString &eventID) const
bool save ()
void setAlarmPending (KAEvent *, bool pending=true)
void startUpdate ()
KAEvent * templateEvent (const QString &templateName)
KCalEvent::Status type () const
KAEvent * updateEvent (const KAEvent *)
KAEvent * updateEvent (const KAEvent &)
QString urlString () const
bool valid () const
virtual ~AlarmCalendar ()

Static Public Member Functions

static AlarmCalendar * displayCalendar ()
static AlarmCalendar * displayCalendarOpen ()
static KAEvent * getEvent (const QString &uniqueID)
static const KCal::Event * getKCalEvent (const QString &uniqueID)
static QString icalProductId ()
static bool importAlarms (QWidget *, AlarmResource *=0)
static bool initialiseCalendars ()
static AlarmCalendar * resources ()
static void terminateCalendars ()

Constructor & Destructor Documentation

AlarmCalendar::~AlarmCalendar (  )  [virtual]

Definition at line 196 of file alarmcalendar.cpp.


Member Function Documentation

bool AlarmCalendar::addEvent ( KAEvent *  event,
QWidget *  promptParent = 0,
bool  useEventID = false,
AlarmResource *  resource = 0,
bool  noPrompt = false,
bool *  cancelled = 0 
)

Definition at line 730 of file alarmcalendar.cpp.

KAEvent::List AlarmCalendar::atLoginAlarms (  )  const

Definition at line 1260 of file alarmcalendar.cpp.

void AlarmCalendar::calendarSaved ( AlarmCalendar *   )  [signal]

void AlarmCalendar::close (  ) 

Definition at line 383 of file alarmcalendar.cpp.

Event * AlarmCalendar::createKCalEvent ( const KAEvent *  ev,
const QString &  baseID,
bool  original = false,
bool  cancelCancelledDefer = false 
) const

Definition at line 1022 of file alarmcalendar.cpp.

KCal::Event* AlarmCalendar::createKCalEvent ( const KAEvent *  e,
bool  original = false,
bool  cancelCancelledDefer = false 
) const [inline]

Definition at line 60 of file alarmcalendar.h.

bool AlarmCalendar::deleteEvent ( const QString &  eventID,
bool  save = false 
)

Definition at line 955 of file alarmcalendar.cpp.

static AlarmCalendar* AlarmCalendar::displayCalendar (  )  [inline, static]

Definition at line 89 of file alarmcalendar.h.

AlarmCalendar * AlarmCalendar::displayCalendarOpen (  )  [static]

Definition at line 112 of file alarmcalendar.cpp.

KAEvent * AlarmCalendar::earliestAlarm (  )  const

Definition at line 1316 of file alarmcalendar.cpp.

void AlarmCalendar::earliestAlarmChanged (  )  [signal]

void AlarmCalendar::emitEmptyStatus (  ) 

Definition at line 1234 of file alarmcalendar.cpp.

void AlarmCalendar::emptyStatus ( bool  empty  )  [signal]

bool AlarmCalendar::endUpdate (  ) 

Definition at line 678 of file alarmcalendar.cpp.

KAEvent * AlarmCalendar::event ( const QString &  uniqueID  ) 

Definition at line 1039 of file alarmcalendar.cpp.

bool AlarmCalendar::eventReadOnly ( const QString &  uniqueID  )  const

Definition at line 1209 of file alarmcalendar.cpp.

KAEvent::List AlarmCalendar::events ( const KDateTime &  from,
const KDateTime &  to,
KCalEvent::Status  type 
)

Definition at line 1139 of file alarmcalendar.cpp.

KAEvent::List AlarmCalendar::events ( AlarmResource *  resource,
KCalEvent::Status  type = KCalEvent::EMPTY 
)

Definition at line 1078 of file alarmcalendar.cpp.

KAEvent::List AlarmCalendar::events ( KCalEvent::Status  s = KCalEvent::EMPTY  )  [inline]

Definition at line 66 of file alarmcalendar.h.

KAEvent * AlarmCalendar::getEvent ( const QString &  uniqueID  )  [static]

Definition at line 124 of file alarmcalendar.cpp.

const KCal::Event * AlarmCalendar::getKCalEvent ( const QString &  uniqueID  )  [static]

Definition at line 138 of file alarmcalendar.cpp.

QString AlarmCalendar::icalProductId (  )  [static]

Definition at line 58 of file alarmcalendar.cpp.

bool AlarmCalendar::importAlarms ( QWidget *  parent,
AlarmResource *  resource = 0 
) [static]

Definition at line 533 of file alarmcalendar.cpp.

bool AlarmCalendar::initialiseCalendars (  )  [static]

Definition at line 80 of file alarmcalendar.cpp.

bool AlarmCalendar::isEmpty (  )  const

Definition at line 1242 of file alarmcalendar.cpp.

bool AlarmCalendar::isOpen (  )  const [inline]

Definition at line 80 of file alarmcalendar.h.

Event * AlarmCalendar::kcalEvent ( const QString &  uniqueID  ) 

Definition at line 1052 of file alarmcalendar.cpp.

Event::List AlarmCalendar::kcalEvents ( AlarmResource *  resource,
KCalEvent::Status  type = KCalEvent::EMPTY 
)

Definition at line 1117 of file alarmcalendar.cpp.

KCal::Event::List AlarmCalendar::kcalEvents ( KCalEvent::Status  s = KCalEvent::EMPTY  )  [inline]

Definition at line 69 of file alarmcalendar.h.

int AlarmCalendar::load (  ) 

Definition at line 258 of file alarmcalendar.cpp.

void AlarmCalendar::loadResource ( AlarmResource *  resource,
QWidget *  parent 
)

Definition at line 409 of file alarmcalendar.cpp.

bool AlarmCalendar::modifyEvent ( const QString &  oldEventId,
KAEvent *  newEvent 
)

Definition at line 879 of file alarmcalendar.cpp.

bool AlarmCalendar::open (  ) 

Definition at line 204 of file alarmcalendar.cpp.

QString AlarmCalendar::path (  )  const [inline]

Definition at line 82 of file alarmcalendar.h.

void AlarmCalendar::purgeEvents ( const KAEvent::List &  events  ) 

Definition at line 710 of file alarmcalendar.cpp.

bool AlarmCalendar::reload (  ) 

Definition at line 311 of file alarmcalendar.cpp.

void AlarmCalendar::reloadFromCache ( const QString &  resourceID  ) 

Definition at line 515 of file alarmcalendar.cpp.

AlarmResource * AlarmCalendar::resourceForEvent ( const QString &  eventID  )  const

Definition at line 1224 of file alarmcalendar.cpp.

static AlarmCalendar* AlarmCalendar::resources (  )  [inline, static]

Definition at line 88 of file alarmcalendar.h.

bool AlarmCalendar::save (  ) 

Definition at line 693 of file alarmcalendar.cpp.

void AlarmCalendar::setAlarmPending ( KAEvent *  event,
bool  pending = true 
)

Definition at line 1339 of file alarmcalendar.cpp.

void AlarmCalendar::startUpdate (  ) 

Definition at line 669 of file alarmcalendar.cpp.

KAEvent * AlarmCalendar::templateEvent ( const QString &  templateName  ) 

Definition at line 1061 of file alarmcalendar.cpp.

void AlarmCalendar::terminateCalendars (  )  [static]

Definition at line 103 of file alarmcalendar.cpp.

KCalEvent::Status AlarmCalendar::type (  )  const [inline]

Definition at line 47 of file alarmcalendar.h.

KAEvent * AlarmCalendar::updateEvent ( const KAEvent *  evnt  ) 

Definition at line 925 of file alarmcalendar.cpp.

KAEvent * AlarmCalendar::updateEvent ( const KAEvent &  evnt  ) 

Definition at line 921 of file alarmcalendar.cpp.

QString AlarmCalendar::urlString (  )  const [inline]

Definition at line 83 of file alarmcalendar.h.

bool AlarmCalendar::valid (  )  const [inline]

Definition at line 46 of file alarmcalendar.h.


The documentation for this class was generated from the following files:
  • alarmcalendar.h
  • alarmcalendar.cpp

kalarm

Skip menu "kalarm"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members

kdepim

Skip menu "kdepim"
  • akonadi
  •   clients
  •   kabc
  •   kcal
  •   kcm
  • akregator
  • console
  •   kabcclient
  •   konsolekalendar
  • kaddressbook
  • kalarm
  •   lib
  • kdgantt
  • kdgantt1
  • kjots
  • kleopatra
  • kmail
  • kmobiletools
  • knode
  • knotes
  • kontact
  • kontactinterfaces
  • korganizer
  •   korgac
  • kpilot
  • ktimetracker
  •   doc
  • libkdepim
  • libkholidays
  • libkleo
  • libkpgp
  • maildir
Generated for kdepim by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal