• Skip to content
  • Skip to link menu
KDE 4.8 API Reference
  • KDE API Reference
  • KDE-PIM Libraries
  • KDE Home
  • Contact Us
 

KAlarm Library

  • KAlarmCal
  • KACalendar
Enumerations | Functions | Variables
KAlarmCal::KACalendar Namespace Reference

Enumerations

enum  { CurrentFormat = 0, MixedFormat = -2, IncompatibleFormat = -1 }
enum  Compatibility {
  Unknown = 0, Current = 0x02, Converted = Current | 0x01, Convertible = 0x04,
  Incompatible = 0x08
}

Functions

const QByteArray APPNAME ("KALARM")
QByteArray icalProductId ()
void setKAlarmVersion (const KCalCore::Calendar::Ptr &)
void setProductId (const QByteArray &progName, const QByteArray &progVersion)
int updateVersion (const KCalCore::FileStorage::Ptr &, QString &versionString)

Variables

const QByteArray APPNAME

Detailed Description

Class representing attributes of a KAlarm calendar.

KACalendar provides methods to check and convert the KAlarm calendar format version, and to get and set the iCalendar product ID (which contains the identity of the application which wrote the calendar).

Author:
David Jarvie <djarvie@kde.org>

Enumeration Type Documentation

anonymous enum

Special calendar storage format version codes.

Positive version values are actual KAlarm format version numbers.

Enumerator:
CurrentFormat 

current KAlarm format

MixedFormat 

calendar may contain more than one version

IncompatibleFormat 

not written by KAlarm, or a newer KAlarm version

Definition at line 95 of file kacalendar.h.

enum KAlarmCal::KACalendar::Compatibility

Compatibility of resource backend calendar format.

Enumerator:
Unknown 

format not determined

Current 

in current KAlarm format

Converted 

in current KAlarm format, but not yet saved

Convertible 

in an older KAlarm format

Incompatible 

not written by KAlarm, or in a newer KAlarm version

Definition at line 71 of file kacalendar.h.


Function Documentation

KALARMCAL_EXPORT QByteArray KAlarmCal::KACalendar::icalProductId ( )

Return the product ID string for use in calendars.

setProductId() must have been called previously.

Definition at line 101 of file kacalendar.cpp.

KALARMCAL_EXPORT void KAlarmCal::KACalendar::setKAlarmVersion ( const KCalCore::Calendar::Ptr &  )

Set the KAlarm version custom property for a calendar.

Definition at line 110 of file kacalendar.cpp.

KALARMCAL_EXPORT void KAlarmCal::KACalendar::setProductId ( const QByteArray &  progName,
const QByteArray &  progVersion 
)

Set the program name and version for use in calendars.

Definition at line 96 of file kacalendar.cpp.

KALARMCAL_EXPORT int KAlarmCal::KACalendar::updateVersion ( const KCalCore::FileStorage::Ptr &  ,
QString &  versionString 
)

Check the version of KAlarm which wrote a calendar file, and convert it in memory to the current KAlarm format if possible.

The storage file is not updated. The compatibility of the calendar format is indicated by the return value.

Parameters:
calendarcalendar stored in localFile
localFilefull path of the calendar's file storage
versionStringreceives calendar's KAlarm version as a string
Returns:
CurrentFormat if the calendar is in the current KAlarm format; IncompatibleFormat calendar is not a KAlarm format or is an unknown KAlarm format; >0 the older KAlarm version which wrote the calendar

Definition at line 128 of file kacalendar.cpp.


Variable Documentation

const QByteArray KAlarmCal::KACalendar::APPNAME

The application name ("KALARM") used in calendar properties.

KAlarm Library

Skip menu "KAlarm Library"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • Related Pages

KDE-PIM Libraries

Skip menu "KDE-PIM Libraries"
  • akonadi
  •   contact
  •   kmime
  • kabc
  • kalarmcal
  • kblog
  • kcal
  • kcalcore
  • kcalutils
  • kholidays
  • kimap
  • kioslave
  •   imap4
  •   mbox
  •   nntp
  • kldap
  • kmbox
  • kmime
  • kontactinterface
  • kpimidentities
  • kpimtextedit
  •   richtextbuilders
  • kpimutils
  • kresources
  • ktnef
  • kxmlrpcclient
  • mailtransport
  • microblog
  • qgpgme
  • syndication
  •   atom
  •   rdf
  •   rss2
Generated for KDE-PIM Libraries by doxygen 1.7.6.1
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