#include <customproperties.h>
Public Member Functions | |
CustomProperties () | |
CustomProperties (const CustomProperties &) | |
bool | operator== (const CustomProperties &) const |
void | setCustomProperty (const TQCString &app, const TQCString &key, const TQString &value) |
void | removeCustomProperty (const TQCString &app, const TQCString &key) |
TQString | customProperty (const TQCString &app, const TQCString &key) const |
void | setNonKDECustomProperty (const TQCString &name, const TQString &value) |
void | removeNonKDECustomProperty (const TQCString &name) |
TQString | nonKDECustomProperty (const TQCString &name) const |
void | setCustomProperties (const TQMap< TQCString, TQString > &properties) |
TQMap< TQCString, TQString > | customProperties () const |
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-TDE-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::CustomProperties | ( | ) |
Construct a new empty custom properties instance.
Definition at line 28 of file customproperties.cpp.
Member Function Documentation
◆ customProperties()
TQMap< TQCString, TQString > CustomProperties::customProperties | ( | ) | const |
Return all custom calendar property key/value pairs.
Definition at line 119 of file customproperties.cpp.
◆ customProperty()
TQString CustomProperties::customProperty | ( | const TQCString & | app, |
const TQCString & | 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 TQString() if (and only if) the property does not exist.
Definition at line 75 of file customproperties.cpp.
◆ customPropertyUpdated()
|
inlineprotectedvirtual |
Called when a custom property has been changed.
The default implementation does nothing: override in derived classes to perform change processing.
Reimplemented in KCal::IncidenceBase, KCal::Calendar, and KCal::Alarm.
Definition at line 120 of file customproperties.h.
◆ nonKDECustomProperty()
TQString CustomProperties::nonKDECustomProperty | ( | const TQCString & | name | ) | const |
Return the value of a non-KDE or non-standard custom calendar property.
- Parameters
-
name Full property name
- Returns
- Property value, or TQString() if (and only if) the property does not exist.
Definition at line 97 of file customproperties.cpp.
◆ removeCustomProperty()
void CustomProperties::removeCustomProperty | ( | const TQCString & | app, |
const TQCString & | 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.
◆ removeNonKDECustomProperty()
void CustomProperties::removeNonKDECustomProperty | ( | const TQCString & | name | ) |
Delete a non-KDE or non-standard custom calendar property.
- Parameters
-
name Full property name
Definition at line 88 of file customproperties.cpp.
◆ setCustomProperties()
void CustomProperties::setCustomProperties | ( | const TQMap< TQCString, TQString > & | properties | ) |
Initialise the alarm's custom calendar properties to the specified key/value pairs.
Definition at line 105 of file customproperties.cpp.
◆ setCustomProperty()
void CustomProperties::setCustomProperty | ( | const TQCString & | app, |
const TQCString & | key, | ||
const TQString & | 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 TQString() will be ignored.
Definition at line 58 of file customproperties.cpp.
◆ setNonKDECustomProperty()
void CustomProperties::setNonKDECustomProperty | ( | const TQCString & | name, |
const TQString & | 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 TQString() will be ignored.
Definition at line 80 of file customproperties.cpp.
The documentation for this class was generated from the following files: