/usr/include/kactivities/consumer.h is in libkactivities-dev 4:4.8.2-0ubuntu2.
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 | /*
* Copyright (c) 2010 Ivan Cukic <ivan.cukic(at)kde.org>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License version 2 as published by the Free Software Foundation.
*
* 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public License
* along with this library; see the file COPYING.LIB. If not, write to
* the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
* Boston, MA 02110-1301, USA.
*/
#ifndef ACTIVITIES_CONSUMER_H_
#define ACTIVITIES_CONSUMER_H_
#include <QObject>
#include <QWidget>
#include <QString>
#include <QStringList>
#include "info.h"
#include <kurl.h>
#include "kactivities_export.h"
namespace KActivities {
class ConsumerPrivate;
/**
* Contextual information can be, from the user's point of view, divided
* into three aspects - "who am I?", "where am I?" (what are my surroundings?)
* and "what am I doing?".
*
* Activities deal with the last one - "what am I doing?". The current activity
* refers to what the user is doing at the moment, while the other activities represent
* things that he/she was doing before, and probably will be doing again.
*
* Activity is an abstract concept whose meaning can differ from one user to another.
* Typical examples of activities are "developing a KDE project", "studying the
* 19th century art", "composing music", "lazing on a Sunday afternoon" etc.
*
* Every activity can have applications, documents, or other types of resources
* assigned to it.
*
* Consumer provides an entry-level API for supporting activities in an
* application - to react to the changes to the current activity as well as
* registering the resources with its windows.
*
* Resource can be anything that is identifiable by an URI (for example,
* a local file or a web page)
*
* @since 4.5
*/
class KACTIVITIES_EXPORT Consumer: public QObject {
Q_OBJECT
Q_PROPERTY(QString currentActivity READ currentActivity)
Q_PROPERTY(QStringList activities READ listActivities)
public:
/**
* Different states of the activities service
*/
enum ServiceStatus {
NotRunning, ///< Service is not running
BareFunctionality, ///< Service is running without a sane backend
FullFunctionality ///< Service is running, and a backend is available
};
explicit Consumer(QObject * parent = 0);
~Consumer();
/**
* @returns the id of the current activity
*/
QString currentActivity() const;
/**
* @returns the list of activities filtered by state
* @param state state of the activity
*/
QStringList listActivities(Info::State state) const;
/**
* @returns the list of all existing activities
*/
QStringList listActivities() const;
/**
* @returns status of the activities service
*/
static ServiceStatus serviceStatus();
/**
* Links a resource to the activity
* @param uri URI of the resource
* @activityId id of the activity to link to. If empty, the
* resource is linked to the current activity.
*/
void linkResourceToActivity(const QUrl & uri, const QString & activityId = QString());
Q_SIGNALS:
/**
* This signal is emitted when the global
* activity is changed
* @param id id of the new current activity
*/
void currentActivityChanged(const QString & id);
/**
* This signal is emitted when the activity service
* goes online or offline
* @param status new status of the service
*/
void serviceStatusChanged(KActivities::Consumer::ServiceStatus status);
/**
* This signal is emitted when a new activity is added
* @param id id of the new activity
*/
void activityAdded(const QString & id);
/**
* This signal is emitted when the activity
* is removed
* @param id id of the removed activity
*/
void activityRemoved(const QString & id);
private:
ConsumerPrivate * const d;
};
} // namespace KActivities
#endif // ACTIVITIES_CONSUMER_H_
|