libkcal

KCal::CustomProperties

KCal::CustomProperties Class Reference

This class represents custom calendar properties. More...

#include <customproperties.h>

Inheritance diagram for KCal::CustomProperties:

Inheritance graph
[legend]

List of all members.


Public Member Functions

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

Protected Member Functions

virtual void customPropertyUpdated ()

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 42 of file customproperties.h.

Constructor & Destructor Documentation

CustomProperties::CustomProperties (  ) 

Construct a new empty custom properties instance.

Definition at line 28 of file customproperties.cpp.

CustomProperties::CustomProperties ( const CustomProperties &  cp  ) 

Definition at line 32 of file customproperties.cpp.

CustomProperties::~CustomProperties (  ) 

Definition at line 37 of file customproperties.cpp.

Member Function Documentation

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

Return all custom calendar property key/value pairs.

Definition at line 119 of file customproperties.cpp.

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

virtual void KCal::CustomProperties::customPropertyUpdated (  )  [inline, protected, virtual]

Called when a custom property has been changed.

The default implementation does nothing: override in derived classes to perform change processing.

Reimplemented in KCal::Alarm, KCal::Calendar, and KCal::IncidenceBase.

Definition at line 120 of file customproperties.h.

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 97 of file customproperties.cpp.

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

Definition at line 41 of file customproperties.cpp.

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 70 of file customproperties.cpp.

void CustomProperties::removeNonKDECustomProperty ( const QCString &  name  ) 

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

Parameters:
name Full property name

Definition at line 88 of file customproperties.cpp.

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

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

Definition at line 105 of file customproperties.cpp.

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 58 of file customproperties.cpp.

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 80 of file customproperties.cpp.

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