/usr/include/QtZeitgeist/DataModel/event.h is in libqzeitgeist-dev 0.7.0-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 | /*
* This file is part of QtZeitgeist.
*
* Copyright (C) 2010 Collabora Ltd. <http://www.collabora.co.uk/>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
#ifndef QTZEITGEIST_EVENT_H_
#define QTZEITGEIST_EVENT_H_
#include <QList>
#include <QDateTime>
#include <QMetaType>
#include <QDBusArgument>
#include "QtZeitgeist/DataModel/Subject"
namespace QtZeitgeist
{
namespace DataModel
{
class EventPrivate;
/**
* @class Event event.h event.h
* @brief The Event objects abstract events returned from Zeitgeist queries.
*
* The Event class is one of the primary elements for communicating with the
* Zeitgeist daemon. The Event serve two purposes:
* Unsurprisingly they represent events that have happened, but they also
* can act as templates.
*
* @see Subject.
*
* @author Abner Silva <abner@collabora.co.uk>
*/
class Q_DECL_EXPORT Event : public QObject
{
Q_OBJECT
Q_PROPERTY(quint32 id READ id)
Q_PROPERTY(QDateTime timestamp READ timestamp WRITE setTimestamp)
Q_PROPERTY(QString interpretation READ interpretation WRITE setInterpretation)
Q_PROPERTY(QString manifestation READ manifestation WRITE setManifestation)
Q_PROPERTY(QString actor READ actor WRITE setActor)
Q_PROPERTY(SubjectList subjects READ subjects WRITE setSubjects)
Q_PROPERTY(QByteArray payload READ payload WRITE setPayload)
public:
/**
* Default constructor.
*/
explicit Event(QObject *parent = 0);
/**
* Copy constructor.
*/
Event(const Event &source, QObject *parent = 0);
/**
* Destructor.
*/
virtual ~Event();
/**
* Get the event id as assigned by the Zeitgeist engine.
*
* @return The event id or 0 if it's unset. An event retrieved from the
* Zeitgeist engine will always have an event id.
*/
quint32 id() const;
/**
* Get the event timestamp.
*
* The timestamp is in milliseconds since the Unix epoch.
*
* @return The event timestamp. Note that 0 is ambiguous as it denotes both
* an unset timestamp and the time of the Unix Epoch.
*/
QDateTime timestamp() const;
/**
* Set the event timestamp.
*
* The timestamp is in milliseconds since the Unix epoch.
*
* @param timestamp the timestamp to set the event for.
*
* Note that the if you insert events into the Zeitgeist log without a
* timestamp set the Zeiteist daemon will automatically assign the
* timestamp of the logging time to the event.
*/
void setTimestamp(const QDateTime ×tamp);
/**
* The event interpretation represents what happened.
*
* It is encoded as URI defined by the Zeitgeist Event Ontology.
* Examples could be "something was opened" or "something was modified".
*
* @return The event interpretation as a URI or empty if unset.
*/
QString interpretation() const;
/**
* Set the event interpretation.
*
* @param interpretation the URI designating the interpretation type of
* the event.
*/
void setInterpretation(const QString &interpretation);
/**
* The event manifestation represents how did it happen.
*
* It is encoded as URI defined by the Zeitgeist Event Ontology. Examples
* could be "the user did it" or "the system send a notification".
*
* @return The event interpretation as a URI or empty if unset.
*/
QString manifestation() const;
/**
* Set the event manifestation.
*
* @param manifestation the URI designating the manifestation type of
* the event.
*/
void setManifestation(const QString &manifestation);
/**
* Get the event actor.
*
* The actor represents the party responsible for triggering the event.
* When the actor is an application (which it almost always is) the actor
* is encoded in the app:// URI scheme with the base name of the .desktop
* file for the application appended. Eg.app://firefox.desktop
*
* @return A URI designating the actor of the event.
*/
QString actor() const;
/**
* Set the event actor.
*
* @param The URI designating the actor triggering the event.
*/
void setActor(const QString &actor);
/**
* Get the subject list of this event.
*
* @return A list containing all event's subjects.
*/
SubjectList subjects() const;
/**
* Set the event's subject list.
*
* @param subjects the list of subjects to set.
*/
void setSubjects(const SubjectList &subjects);
/**
* Get the event's payload.
*
* Look up the free form binary payload of @Event.
*
* @return The event payload or NULL (empty) if unset.
*/
QByteArray payload() const;
/**
* Set the event's payload.
*
* Attach a a free form binary payload to @Event. Payloads are application
* specific and can not be assumed to have any particular format unless
* you have other contextual information about the event.
*
* @param payload the payload to add to @Event.
*/
void setPayload(const QByteArray &payload);
/**
* Append a @Subject to the list of subjects for @Event.
*
* @param subject the subject to be added to the event.
*/
void addSubject(const Subject &subject);
Event & operator = (const Event &source);
private:
// D Pointer.
class EventPrivate * const d;
// Marshalers operators.
friend QDBusArgument & operator << (QDBusArgument &argument,
const Event &event);
friend const QDBusArgument & operator >> (const QDBusArgument &argument,
Event &event);
};
Q_DECL_EXPORT QDBusArgument & operator << (QDBusArgument &argument,
const Event &event);
Q_DECL_EXPORT const QDBusArgument & operator >> (const QDBusArgument &argument,
Event &event);
// Create additional types.
typedef QList<Event> EventList;
typedef QList<quint32> EventIdList;
};
};
// Declare types as Qt Meta Type.
Q_DECLARE_METATYPE(QtZeitgeist::DataModel::Event)
Q_DECLARE_METATYPE(QtZeitgeist::DataModel::EventList)
Q_DECLARE_METATYPE(QtZeitgeist::DataModel::EventIdList)
#endif // QTZEITGEIST_EVENT_H_
|