KAlarmCal::CollectionAttribute

KAlarmCal::CollectionAttribute Class Reference

#include <collectionattribute.h>

Inheritance diagram for KAlarmCal::CollectionAttribute:

Public Member Functions

 CollectionAttribute (const CollectionAttribute &other)
 
QColor backgroundColor () const
 
CollectionAttributeclone () const override
 
void deserialize (const QByteArray &data) override
 
CalEvent::Types enabled () const
 
bool isEnabled (CalEvent::Type type) const
 
bool isStandard (CalEvent::Type type) const
 
bool keepFormat () const
 
bool operator!= (const CollectionAttribute &other) const
 
CollectionAttributeoperator= (const CollectionAttribute &other)
 
bool operator== (const CollectionAttribute &other) const
 
QByteArray serialized () const override
 
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
 
QByteArray type () const override
 

Static Public Member Functions

static QByteArray name ()
 

Additional Inherited Members

- Public Types inherited from Akonadi::Attribute
typedef QList< Attribute * > List
 

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
Author
David Jarvie djarv[email protected][email protected][email protected]de.or[email protected]g

Definition at line 38 of file collectionattribute.h.

Constructor & Destructor Documentation

KAlarmCal::CollectionAttribute::CollectionAttribute ( const CollectionAttribute other)

Copy constructor.

Definition at line 40 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 143 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 75 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
typealarm type to check for.

Definition at line 70 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
typealarm type

Definition at line 104 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 153 of file collectionattribute.cpp.

QByteArray KAlarmCal::CollectionAttribute::name ( )
static

Return the attribute name.

Definition at line 168 of file collectionattribute.cpp.

CollectionAttribute & KAlarmCal::CollectionAttribute::operator= ( const CollectionAttribute other)

Assignment operator.

Definition at line 51 of file collectionattribute.cpp.

bool KAlarmCal::CollectionAttribute::operator== ( const CollectionAttribute other) const

Comparison operator.

Definition at line 60 of file collectionattribute.cpp.

void KAlarmCal::CollectionAttribute::setBackgroundColor ( const QColor c)

Set the background color for this collection and its alarms.

Parameters
cbackground color

Definition at line 148 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
typealarm type
enabledtrue to set enabled, false to set disabled.

Definition at line 80 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
typesalarm types

Definition at line 98 of file collectionattribute.cpp.

void KAlarmCal::CollectionAttribute::setKeepFormat ( bool  keep)

Set whether to keep the old calendar storage format unchanged.

Parameters
keeptrue to keep format unchanged, false to allow changes.

Definition at line 158 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
typealarm type
standardtrue to set as standard, false to clear standard status.

Definition at line 121 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
typesalarm types.

Definition at line 138 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 116 of file collectionattribute.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jul 6 2020 23:08:57 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.