calendarsupport/blockalarmsattribute.h

   1 /*
   2   Copyright (c) 2010 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
   3     Author: Tobias Koenig <tokoe@kdab.com>
   4
   5   This library is free software; you can redistribute it and/or modify it
   6   under the terms of the GNU Library General Public License as published by
   7   the Free Software Foundation; either version 2 of the License, or (at your
   8   option) any later version.
   9
  10   This library is distributed in the hope that it will be useful, but WITHOUT
  11   ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  12   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Library General Public
  13   License for more details.
  14
  15   You should have received a copy of the GNU Library General Public License
  16   along with this library; see the file COPYING.LIB.  If not, write to the
  17   Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  18   02110-1301, USA.
  19 */
  20
  21 #ifndef CALENDARSUPPORT_BLOCKALARMSATTRIBUTE_H
  22 #define CALENDARSUPPORT_BLOCKALARMSATTRIBUTE_H
  23
  24 #include "calendarsupport_export.h"
  25
  26 #include <Akonadi/Attribute>
  27
  28 namespace CalendarSupport {
  29
  30 /**
  31  * @short An Attribute that marks that alarms from an calendar collection are blocked.
  32  *
  33  * A calendar collection which has this attribute set won't be evaluated by korgac and
  34  * therefor its alarms won't be used.
  35  *
  36  * @author Tobias Koenig <tokoe@kdab.com>
  37  * @see Akonadi::Attribute
  38  */
  39 class CALENDARSUPPORT_EXPORT BlockAlarmsAttribute : public Akonadi::Attribute
  40 {
  41   public:
  42     /**
  43      * Creates a new block alarms attribute.
  44      */
  45     BlockAlarmsAttribute();
  46
  47     /**
  48      * Destroys the block alarms attribute.
  49      */
  50     ~BlockAlarmsAttribute();
  51
  52     /**
  53      * Reimplemented from Attribute
  54      */
  55     QByteArray type() const;
  56
  57     /**
  58      * Reimplemented from Attribute
  59      */
  60     BlockAlarmsAttribute *clone() const;
  61
  62     /**
  63      * Reimplemented from Attribute
  64      */
  65     QByteArray serialized() const;
  66
  67     /**
  68      * Reimplemented from Attribute
  69      */
  70     void deserialize( const QByteArray &data );
  71 };
  72
  73 }
  74
  75 #endif