Kgapi

event.h
1 /*
2  * This file is part of LibKGAPI library
3  *
4  * SPDX-FileCopyrightText: 2013 Daniel Vrátil <[email protected]>
5  *
6  * SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
7  */
8 
9 #ifndef LIBKGAPI2_EVENT_H
10 #define LIBKGAPI2_EVENT_H
11 
12 #include "object.h"
13 #include "types.h"
14 #include "kgapicalendar_export.h"
15 
16 #include <KCalendarCore/Event>
17 
18 #include <QScopedPointer>
19 
20 namespace KGAPI2
21 {
22 
23 /**
24  * @brief Represents a single event from Google Calendar
25  *
26  * @author Daniel Vrátil <[email protected]>
27  * @since 0.1
28  */
29 class KGAPICALENDAR_EXPORT Event: public KGAPI2::Object,
31 {
32  public:
33  /**
34  * @brief Constructor
35  */
36  Event();
37 
38  /**
39  * @brief Copy constructor
40  */
41  Event(const Event& other);
42 
43  /**
44  * @brief Copy constructor
45  */
46  explicit Event(const KCalendarCore::Event &event);
47 
48  /**
49  * @brief Destructor
50  */
51  ~Event();
52 
53  bool operator==(const Event &other) const;
54 
55  /**
56  * @brief Marks the event as deleted
57  *
58  * @param deleted
59  */
60  void setDeleted(bool deleted);
61 
62  /**
63  * @brief Returns whether the event was removed
64  */
65  bool deleted() const;
66 
67  /**
68  * @brief Sets whether the event should use calendar's default reminders.
69  *
70  * @param useDefault
71  */
72  void setUseDefaultReminders(bool useDefault);
73 
74  /**
75  * @brief Returns whether the event should use calendar's default reminders.
76  */
77  bool useDefaultReminders() const;
78 
79  /**
80  * @brief Returns ID used by Google to identify the event in calendar.
81  *
82  * This is not the same as UID.
83  */
84  QString id() const;
85 
86  /**
87  * @brief Sets event ID used by Google to identify the event in calendar.
88  */
89  void setId(const QString &id);
90 
91  private:
92  class Private;
94 
95 };
96 
97 } // namespace KGAPI
98 
99 #endif // LIBKGAPI2_EVENT_H
Base class for all objects.
Definition: object.h:31
A job to fetch a single map tile described by a StaticMapUrl.
Definition: blog.h:16
Represents a single event from Google Calendar.
Definition: event.h:29
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Wed Mar 3 2021 00:10:03 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.