Akonadi::BlockAlarmsAttribute

Search for usage in LXR

Akonadi::BlockAlarmsAttribute Class Reference

#include <blockalarmsattribute.h>

Inheritance diagram for Akonadi::BlockAlarmsAttribute:

Public Member Functions

 BlockAlarmsAttribute ()
 
 ~BlockAlarmsAttribute () override
 
void blockAlarmType (KCalendarCore::Alarm::Type type, bool block=true)
 
void blockEverything (bool block=true)
 
BlockAlarmsAttributeclone () const override
 
void deserialize (const QByteArray &data) override
 
bool isAlarmTypeBlocked (KCalendarCore::Alarm::Type type) const
 
bool isEverythingBlocked () const
 
QByteArray serialized () const override
 
QByteArray type () const override
 
- Public Member Functions inherited from Akonadi::Attribute

Additional Inherited Members

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

Detailed Description

An Attribute that marks that alarms from a calendar collection are blocked.

A calendar collection which has this attribute set won't be evaluated by korgac and therefore it's alarms won't be used, unless explicitly unblocked in blockAlarmType().

Author
Tobias Koenig tokoe.nosp@m.@kda.nosp@m.b.com
See also
Akonadi::Attribute
Since
4.11

Definition at line 31 of file blockalarmsattribute.h.

Constructor & Destructor Documentation

◆ BlockAlarmsAttribute()

BlockAlarmsAttribute::BlockAlarmsAttribute ( )

Creates a new block alarms attribute.

Definition at line 28 of file blockalarmsattribute.cpp.

◆ ~BlockAlarmsAttribute()

BlockAlarmsAttribute::~BlockAlarmsAttribute ( )
overridedefault

Destroys the block alarms attribute.

Member Function Documentation

◆ blockAlarmType()

void BlockAlarmsAttribute::blockAlarmType ( KCalendarCore::Alarm::Type type,
bool block = true )

Blocks or unblocks given alarm type.

By default, all alarm types are blocked.

Since
4.11

Definition at line 35 of file blockalarmsattribute.cpp.

◆ blockEverything()

void BlockAlarmsAttribute::blockEverything ( bool block = true)

Blocks or unblocks every alarm type.

By default, all alarm types are blocked.

Since
5.0

Definition at line 55 of file blockalarmsattribute.cpp.

◆ clone()

BlockAlarmsAttribute * BlockAlarmsAttribute::clone ( ) const
overridevirtual

Implements Akonadi::Attribute.

Definition at line 91 of file blockalarmsattribute.cpp.

◆ deserialize()

void BlockAlarmsAttribute::deserialize ( const QByteArray & data)
overridevirtual

Implements Akonadi::Attribute.

Definition at line 114 of file blockalarmsattribute.cpp.

◆ isAlarmTypeBlocked()

bool BlockAlarmsAttribute::isAlarmTypeBlocked ( KCalendarCore::Alarm::Type type) const
nodiscard

Returns whether given alarm type is blocked or not.

Since
4.11

Definition at line 63 of file blockalarmsattribute.cpp.

◆ isEverythingBlocked()

bool BlockAlarmsAttribute::isEverythingBlocked ( ) const
nodiscard

Returns whether all alarms are blocked or not.

Since
5.0

Definition at line 79 of file blockalarmsattribute.cpp.

◆ serialized()

QByteArray BlockAlarmsAttribute::serialized ( ) const
nodiscardoverridevirtual

Implements Akonadi::Attribute.

Definition at line 102 of file blockalarmsattribute.cpp.

◆ type()

QByteArray BlockAlarmsAttribute::type ( ) const
nodiscardoverridevirtual

Implements Akonadi::Attribute.

Definition at line 85 of file blockalarmsattribute.cpp.


The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Mon Nov 4 2024 16:37:41 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.