KAlarm Library
#include <collectionattribute.h>

Public Member Functions | |
CollectionAttribute (const CollectionAttribute &other) | |
QColor | backgroundColor () const |
virtual CollectionAttribute * | clone () const |
virtual void | deserialize (const QByteArray &data) |
CalEvent::Types | enabled () const |
bool | isEnabled (CalEvent::Type type) const |
bool | isStandard (CalEvent::Type type) const |
bool | keepFormat () const |
CollectionAttribute & | operator= (const CollectionAttribute &other) |
virtual QByteArray | serialized () const |
void | setBackgroundColor (const QColor &c) |
void | setEnabled (CalEvent::Type type, bool enabled) |
void | setEnabled (CalEvent::Types types) |
void | setKeepFormat (bool keep) |
void | setStandard (CalEvent::Type, bool standard) |
void | setStandard (CalEvent::Types types) |
CalEvent::Types | standard () const |
virtual QByteArray | type () const |
Static Public Member Functions | |
static QByteArray | name () |
Detailed Description
An Attribute for a KAlarm Collection containing various status information.
This class represents an Akonadi attribute of a KAlarm Collection. It contains information on the enabled status, the alarm types allowed in the resource, which alarm types the resource is the standard Collection for, etc.
The attribute is maintained by client applications.
- See Also
- CompatibilityAttribute
Definition at line 51 of file collectionattribute.h.
Constructor & Destructor Documentation
KAlarmCal::CollectionAttribute::CollectionAttribute | ( | const CollectionAttribute & | other | ) |
Copy constructor.
Definition at line 49 of file collectionattribute.cpp.
Member Function Documentation
QColor KAlarmCal::CollectionAttribute::backgroundColor | ( | ) | const |
Return the background color to display this collection and its alarms, or invalid color if none is set.
Definition at line 151 of file collectionattribute.cpp.
|
virtual |
Reimplemented from Attribute.
Implements Akonadi::Attribute.
Definition at line 70 of file collectionattribute.cpp.
|
virtual |
Reimplemented from Attribute.
Implements Akonadi::Attribute.
Definition at line 197 of file collectionattribute.cpp.
CalEvent::Types KAlarmCal::CollectionAttribute::enabled | ( | ) | const |
Return which alarm types (active, archived or template) the collection is enabled for.
Definition at line 80 of file collectionattribute.cpp.
bool KAlarmCal::CollectionAttribute::isEnabled | ( | CalEvent::Type | type | ) | const |
Return whether the collection is enabled for a specified alarm type (active, archived, template or displaying).
- Parameters
-
type alarm type to check for.
Definition at line 75 of file collectionattribute.cpp.
bool KAlarmCal::CollectionAttribute::isStandard | ( | CalEvent::Type | type | ) | const |
Return whether the collection is the standard collection for a specified alarm type (active, archived or template).
- Parameters
-
type alarm type
Definition at line 111 of file collectionattribute.cpp.
bool KAlarmCal::CollectionAttribute::keepFormat | ( | ) | const |
Return whether the user has chosen to keep the old calendar storage format, i.e.
not update to current KAlarm format.
Definition at line 161 of file collectionattribute.cpp.
|
static |
Return the attribute name.
Definition at line 176 of file collectionattribute.cpp.
CollectionAttribute & KAlarmCal::CollectionAttribute::operator= | ( | const CollectionAttribute & | other | ) |
Assignment operator.
Definition at line 60 of file collectionattribute.cpp.
|
virtual |
Reimplemented from Attribute.
Implements Akonadi::Attribute.
Definition at line 181 of file collectionattribute.cpp.
void KAlarmCal::CollectionAttribute::setBackgroundColor | ( | const QColor & | c | ) |
Set the background color for this collection and its alarms.
- Parameters
-
c background color
Definition at line 156 of file collectionattribute.cpp.
void KAlarmCal::CollectionAttribute::setEnabled | ( | CalEvent::Type | type, |
bool | enabled | ||
) |
Set the enabled/disabled state of the collection and its alarms, for a specified alarm type (active, archived or template).
The enabled/disabled state for other alarm types is not affected. The alarms of that type in a disabled collection are ignored, and not displayed in the alarm list. The standard status for that type for a disabled collection is automatically cleared.
- Parameters
-
type alarm type enabled true to set enabled, false to set disabled.
Definition at line 85 of file collectionattribute.cpp.
void KAlarmCal::CollectionAttribute::setEnabled | ( | CalEvent::Types | types | ) |
Set which alarm types (active, archived or template) the collection is enabled for.
- Parameters
-
types alarm types
Definition at line 105 of file collectionattribute.cpp.
void KAlarmCal::CollectionAttribute::setKeepFormat | ( | bool | keep | ) |
Set whether to keep the old calendar storage format unchanged.
- Parameters
-
keep true to keep format unchanged, false to allow changes.
Definition at line 166 of file collectionattribute.cpp.
void KAlarmCal::CollectionAttribute::setStandard | ( | CalEvent::Type | type, |
bool | standard | ||
) |
Set or clear the collection as the standard collection for a specified alarm type (active, archived or template).
- Parameters
-
type alarm type standard true to set as standard, false to clear standard status.
Definition at line 129 of file collectionattribute.cpp.
void KAlarmCal::CollectionAttribute::setStandard | ( | CalEvent::Types | types | ) |
Set which alarm types (active, archived or template) the collection is the standard collection for.
- Parameters
-
types alarm types.
Definition at line 146 of file collectionattribute.cpp.
CalEvent::Types KAlarmCal::CollectionAttribute::standard | ( | ) | const |
Return which alarm types (active, archived or template) the collection is standard for.
- Returns
- alarm types.
Definition at line 124 of file collectionattribute.cpp.
|
virtual |
Reimplemented from Attribute.
Implements Akonadi::Attribute.
Definition at line 171 of file collectionattribute.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2013 The KDE developers.
Generated on Tue Nov 26 2013 09:04:31 by doxygen 1.8.5 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.