libkcal Library API Documentation

KCal::CustomProperties Class Reference

This class represents custom calendar properties. More...

#include <customproperties.h>

Inheritance diagram for KCal::CustomProperties:

KCal::Alarm KCal::Calendar KCal::IncidenceBase KCal::CalendarLocal KCal::CalendarNull KCal::CalendarResources KCal::FreeBusy KCal::Incidence KCal::Event KCal::Journal KCal::Todo List of all members.

Public Methods

 CustomProperties ()
 CustomProperties (const CustomProperties &)
 ~CustomProperties ()
void setCustomProperty (const QCString &app, const QCString &key, const QString &value)
void removeCustomProperty (const QCString &app, const QCString &key)
QString customProperty (const QCString &app, const QCString &key) const
void setNonKDECustomProperty (const QCString &name, const QString &value)
void removeNonKDECustomProperty (const QCString &name)
QString nonKDECustomProperty (const QCString &name) const
void setCustomProperties (const QMap< QCString, QString > &properties)
QMap< QCString, QStringcustomProperties () const

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 '-'.

Definition at line 39 of file customproperties.h.


Constructor & Destructor Documentation

CustomProperties::CustomProperties  
 

Construct a new empty custom properties instance.

Definition at line 25 of file customproperties.cpp.


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.

Definition at line 38 of file customproperties.cpp.

References QCString::isEmpty(), and QString::isNull().

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.

Definition at line 49 of file customproperties.cpp.

References removeNonKDECustomProperty().

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.

Definition at line 54 of file customproperties.cpp.

References nonKDECustomProperty().

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.

Definition at line 59 of file customproperties.cpp.

References QString::isNull().

void CustomProperties::removeNonKDECustomProperty const QCString   name
 

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

Parameters:
name  Full property name

Definition at line 66 of file customproperties.cpp.

References QMap< QCString, QString >::end(), QMap< QCString, QString >::find(), and QMap< QCString, QString >::remove().

Referenced by removeCustomProperty().

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.

Definition at line 73 of file customproperties.cpp.

References QMap< QCString, QString >::end(), and QMap< QCString, QString >::find().

Referenced by customProperty().

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

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

Definition at line 81 of file customproperties.cpp.

References QMap::begin(), and QMap::end().

QMap< QCString, QString > CustomProperties::customProperties   const
 

Return all custom calendar property key/value pairs.

Definition at line 91 of file customproperties.cpp.


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for libkcal Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat May 1 11:36:24 2004 by doxygen 1.2.15 written by Dimitri van Heesch, © 1997-2003