KDE PIM / Developers / API Docs / libkcal

KCal::CustomProperties Class Reference

This class represents custom calendar properties. More...

#include <customproperties.h>

Inherited by KCal::Alarm, KCal::Calendar, and KCal::IncidenceBase.

List of all members.

Public Member Functions


Detailed Description

This class represents custom calendar properties.

It is used as a base class for classes which represent calendar components. A custom property name written by libkcal has the form X-KDE-APP-KEY where APP represents the application name, and KEY distinguishes individual properties for the application. In keeping with RFC2445, property names must be composed only of the characters A-Z, a-z, 0-9 and '-'.


Constructor & Destructor Documentation

CustomProperties::CustomProperties  ) 
 

Construct a new empty custom properties instance.


Member Function Documentation

void CustomProperties::setCustomProperty const QCString &  app,
const QCString &  key,
const QString &  value
 

Create or modify a custom calendar property.

Parameters:
app Application name as it appears in the custom property name.
key Property identifier specific to the application.
value The property's value. A call with a value of QString::null will be ignored.

void CustomProperties::removeCustomProperty const QCString &  app,
const QCString &  key
 

Delete a custom calendar property.

Parameters:
app Application name as it appears in the custom property name.
key Property identifier specific to the application.

QString CustomProperties::customProperty const QCString &  app,
const QCString &  key
const
 

Return the value of a custom calendar property.

Parameters:
app Application name as it appears in the custom property name.
key Property identifier specific to the application.
Returns:
Property value, or QString::null if (and only if) the property does not exist.

void CustomProperties::setNonKDECustomProperty const QCString &  name,
const QString &  value
 

Create or modify a non-KDE or non-standard custom calendar property.

Parameters:
name Full property name
value The property's value. A call with a value of QString::null will be ignored.

void CustomProperties::removeNonKDECustomProperty const QCString &  name  ) 
 

Delete a non-KDE or non-standard custom calendar property.

Parameters:
name Full property name

QString CustomProperties::nonKDECustomProperty const QCString &  name  )  const
 

Return the value of a non-KDE or non-standard custom calendar property.

Parameters:
name Full property name
Returns:
Property value, or QString::null if (and only if) the property does not exist.

void CustomProperties::setCustomProperties const QMap< QCString, QString > &  properties  ) 
 

Initialise the alarm's custom calendar properties to the specified key/value pairs.

QMap< QCString, QString > CustomProperties::customProperties  )  const
 

Return all custom calendar property key/value pairs.


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