KCalendarCore::CustomProperties Class
class KCalendarCore::CustomPropertiesA class to manage custom calendar properties. More...
| Header: | #include <KCalendarCore/CustomProperties> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS CalendarCore)target_link_libraries(mytarget PRIVATE KF6::CalendarCore) |
| Inherited By: | KCalendarCore::Alarm, KCalendarCore::Calendar, and KCalendarCore::IncidenceBase |
Public Functions
| CustomProperties() | |
| CustomProperties(const KCalendarCore::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 |
| 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()) |
| KCalendarCore::CustomProperties & | operator=(const KCalendarCore::CustomProperties &other) |
| bool | operator==(const KCalendarCore::CustomProperties &properties) const |
Static Public Members
| QByteArray | customPropertyName(const QByteArray &app, const QByteArray &key) |
Protected Functions
| virtual void | customPropertyUpdate() |
| 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 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 '-'.
Member Function Documentation
CustomProperties::CustomProperties()
Constructs an empty custom properties instance.
See also setCustomProperties().
CustomProperties::CustomProperties(const KCalendarCore::CustomProperties &other)
Copy constructor.
other is the one to copy.
[virtual noexcept] CustomProperties::~CustomProperties()
Destructor.
QMap<QByteArray, QString> CustomProperties::customProperties() const
Returns all custom calendar property key/value pairs.
See also setCustomProperties().
QString CustomProperties::customProperty(const QByteArray &app, const QByteArray &key) const
Return the value of a custom calendar property.
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.
See also setCustomProperty().
[static] QByteArray CustomProperties::customPropertyName(const QByteArray &app, const QByteArray &key)
Validate and return the full name of a custom calendar property.
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
[virtual protected] void CustomProperties::customPropertyUpdate()
Called before a custom property will be changed. The default implementation does nothing: override in derived classes to perform change processing.
[virtual protected] void CustomProperties::customPropertyUpdated()
Called when a custom property has been changed. The default implementation does nothing: override in derived classes to perform change processing.
QString CustomProperties::nonKDECustomProperty(const QByteArray &name) const
Return the value of a non-KDE or non-standard custom calendar property.
name Full property name
Returns Property value, or QString() if (and only if) the property does not exist.
See also setNonKDECustomProperty().
QString CustomProperties::nonKDECustomPropertyParameters(const QByteArray &name) const
Return the parameters of a non-KDE or non-standard custom calendar property.
name Full property name
Returns The parameters for the given property. Empty string is returned if none are set.
void CustomProperties::removeCustomProperty(const QByteArray &app, const QByteArray &key)
Delete a custom calendar property.
app Application name as it appears in the custom property name.
key Property identifier specific to the application.
See also setCustomProperty().
void CustomProperties::removeNonKDECustomProperty(const QByteArray &name)
Delete a non-KDE or non-standard custom calendar property.
name Full property name
See also setNonKDECustomProperty().
void CustomProperties::setCustomProperties(const QMap<QByteArray, QString> &properties)
Initialise the alarm's custom calendar properties to the specified key/value pairs.
properties is a QMap of property key/value pairs.
See also customProperties().
void CustomProperties::setCustomProperty(const QByteArray &app, const QByteArray &key, const QString &value)
Create or modify a custom calendar property.
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 customProperty() and removeCustomProperty().
void CustomProperties::setNonKDECustomProperty(const QByteArray &name, const QString &value, const QString ¶meters = QString())
Create or modify a non-KDE or non-standard custom calendar property.
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 nonKDECustomProperty() and removeNonKDECustomProperty().
KCalendarCore::CustomProperties &CustomProperties::operator=(const KCalendarCore::CustomProperties &other)
Assignment operator.
Warning: The assignment is not polymorphic.
other is the CustomProperty to assign.
bool CustomProperties::operator==(const KCalendarCore::CustomProperties &properties) const
Compare this with properties for equality.
properties is the one to compare.
Warning: The comparison is not polymorphic.
Returns true if properties is equal to this object, or false if not