KAlarmCal

eventattribute.h
1 /*
2  * eventattribute.h - per-user attributes for individual events
3  * This file is part of kalarmcal library, which provides access to KAlarm
4  * calendar data.
5  * SPDX-FileCopyrightText: 2010-2011 David Jarvie <[email protected]>
6  *
7  * SPDX-License-Identifier: LGPL-2.0-or-later
8  */
9 
10 #ifndef KALARM_EVENT_ATTRIBUTE_H
11 #define KALARM_EVENT_ATTRIBUTE_H
12 
13 #include "kalarmcal_export.h"
14 
15 #include "kaevent.h"
16 
17 #include <attribute.h>
18 
19 namespace KAlarmCal
20 {
21 
22 /**
23  * @short An Attribute containing status information for a KAlarm item.
24  *
25  * This class represents an Akonadi attribute of a KAlarm Item. It contains
26  * information on the command execution error status of the event
27  * represented by the Item.
28  *
29  * The attribute is maintained by client applications.
30  *
31  * @author David Jarvie <[email protected]>
32  */
33 
34 class KALARMCAL_EXPORT EventAttribute : public Akonadi::Attribute
35 {
36 public:
38 
39  /** Copy constructor. */
40  EventAttribute(const EventAttribute &other);
41 
42  /** Assignment operator. */
43  EventAttribute &operator=(const EventAttribute &other);
44 
45  ~EventAttribute() override;
46 
47  /** Return the last command execution error for the item. */
48  KAEvent::CmdErrType commandError() const;
49 
50  /** Set the last command execution error for the item. */
51  void setCommandError(KAEvent::CmdErrType err);
52 
53  // Reimplemented from Attribute
54  QByteArray type() const override;
55  // Reimplemented from Attribute
56  EventAttribute *clone() const override;
57  // Reimplemented from Attribute
58  QByteArray serialized() const override;
59  // Reimplemented from Attribute
60  void deserialize(const QByteArray &data) override;
61 
62 private:
63  //@cond PRIVATE
64  class Private;
65  Private *const d;
66  //@endcond
67 };
68 
69 } // namespace KAlarmCal
70 
71 #endif // KALARM_EVENT_ATTRIBUTE_H
72 
73 // vim: et sw=4:
CmdErrType
Command execution error type for last time the alarm was triggered.
Definition: kaevent.h:299
An Attribute containing status information for a KAlarm item.
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Mar 2 2021 02:55:25 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.