KCalendarCore::CustomProperties
#include <customproperties.h>
Public Member Functions | |
CustomProperties () | |
CustomProperties (const CustomProperties &other) | |
virtual | ~CustomProperties () |
QMap< QByteArray, QString > | customProperties () const |
QString | customProperty (const QByteArray &app, const QByteArray &key) const |
QString | nonKDECustomProperty (const QByteArray &name) const |
QString | nonKDECustomPropertyParameters (const QByteArray &name) const |
CustomProperties & | operator= (const CustomProperties &other) |
bool | operator== (const CustomProperties &properties) const |
void | removeCustomProperty (const QByteArray &app, const QByteArray &key) |
void | removeNonKDECustomProperty (const QByteArray &name) |
void | setCustomProperties (const QMap< QByteArray, QString > &properties) |
void | setCustomProperty (const QByteArray &app, const QByteArray &key, const QString &value) |
void | setNonKDECustomProperty (const QByteArray &name, const QString &value, const QString ¶meters=QString()) |
Static Public Member Functions | |
static QByteArray | customPropertyName (const QByteArray &app, const QByteArray &key) |
Protected Member Functions | |
virtual void | customPropertyUpdate () |
virtual void | customPropertyUpdated () |
Detailed Description
A class to manage custom calendar properties.
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 the kcalcore library 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 38 of file customproperties.h.
Constructor & Destructor Documentation
◆ CustomProperties() [1/2]
CustomProperties::CustomProperties | ( | ) |
Constructs an empty custom properties instance.
Definition at line 68 of file customproperties.cpp.
◆ CustomProperties() [2/2]
CustomProperties::CustomProperties | ( | const CustomProperties & | other | ) |
Copy constructor.
- Parameters
-
other is the one to copy.
Definition at line 73 of file customproperties.cpp.
◆ ~CustomProperties()
|
virtual |
Destructor.
Definition at line 89 of file customproperties.cpp.
Member Function Documentation
◆ customProperties()
QMap< QByteArray, QString > CustomProperties::customProperties | ( | ) | const |
Returns all custom calendar property key/value pairs.
- See also
- setCustomProperties().
Definition at line 198 of file customproperties.cpp.
◆ customProperty()
QString CustomProperties::customProperty | ( | const QByteArray & | app, |
const QByteArray & | 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() if (and only if) the property does not exist.
Definition at line 124 of file customproperties.cpp.
◆ customPropertyName()
|
static |
Validate and return the full name 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
- Full property name, or empty string if it would contain invalid characters
Definition at line 129 of file customproperties.cpp.
◆ customPropertyUpdate()
|
protectedvirtual |
Called before a custom property will be changed.
The default implementation does nothing: override in derived classes to perform change processing.
Reimplemented in KCalendarCore::IncidenceBase.
Definition at line 208 of file customproperties.cpp.
◆ customPropertyUpdated()
|
protectedvirtual |
Called when a custom property has been changed.
The default implementation does nothing: override in derived classes to perform change processing.
Reimplemented in KCalendarCore::Alarm, KCalendarCore::Calendar, and KCalendarCore::IncidenceBase.
Definition at line 212 of file customproperties.cpp.
◆ nonKDECustomProperty()
QString CustomProperties::nonKDECustomProperty | ( | const QByteArray & | 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() if (and only if) the property does not exist.
Definition at line 166 of file customproperties.cpp.
◆ nonKDECustomPropertyParameters()
QString CustomProperties::nonKDECustomPropertyParameters | ( | const QByteArray & | name | ) | const |
Return the parameters of a non-KDE or non-standard custom calendar property.
- Parameters
-
name Full property name
- Returns
- The parameters for the given property. Empty string is returned if none are set.
Definition at line 171 of file customproperties.cpp.
◆ operator=()
CustomProperties & CustomProperties::operator= | ( | const CustomProperties & | other | ) |
Assignment operator.
- Warning
- The assignment is not polymorphic.
- Parameters
-
other is the CustomProperty to assign.
Definition at line 78 of file customproperties.cpp.
◆ operator==()
bool CustomProperties::operator== | ( | const CustomProperties & | properties | ) | const |
Compare this with properties
for equality.
- Parameters
-
properties is the one to compare.
- Warning
- The comparison is not polymorphic.
Definition at line 94 of file customproperties.cpp.
◆ removeCustomProperty()
void CustomProperties::removeCustomProperty | ( | const QByteArray & | app, |
const QByteArray & | 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.
- See also
- setCustomProperty().
Definition at line 119 of file customproperties.cpp.
◆ removeNonKDECustomProperty()
void CustomProperties::removeNonKDECustomProperty | ( | const QByteArray & | name | ) |
Delete a non-KDE or non-standard custom calendar property.
- Parameters
-
name Full property name
- See also
- setNonKDECustomProperty().
Definition at line 152 of file customproperties.cpp.
◆ setCustomProperties()
void CustomProperties::setCustomProperties | ( | const QMap< QByteArray, QString > & | properties | ) |
Initialise the alarm's custom calendar properties to the specified key/value pairs.
- Parameters
-
properties is a QMap of property key/value pairs.
- See also
- customProperties().
Definition at line 176 of file customproperties.cpp.
◆ setCustomProperty()
void CustomProperties::setCustomProperty | ( | const QByteArray & | app, |
const QByteArray & | 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() will be ignored.
- See also
- removeCustomProperty().
Definition at line 99 of file customproperties.cpp.
◆ setNonKDECustomProperty()
void CustomProperties::setNonKDECustomProperty | ( | const QByteArray & | name, |
const QString & | value, | ||
const QString & | parameters = QString() ) |
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() will be ignored. parameters The formatted list of parameters for the property. They should be formatted as RFC specifies, that is, KEY=VALUE;KEY2=VALUE2. We're mostly concerned about passing them through as-is albeit they can be of course parsed if need be.
- See also
- removeNonKDECustomProperty().
Definition at line 138 of file customproperties.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Nov 29 2024 11:54:10 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.