git.iko.soy/unity8
on 6db14c8 help sign in
unity8/plugins/Unity/scope.h
150 lines 5.9 kB history raw
1/*
2 * Copyright (C) 2011 Canonical, Ltd.
3 *
4 * Authors:
5 * Florian Boucault <florian.boucault@canonical.com>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; version 3.
10 *
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
15 *
16 * You should have received a copy of the GNU General Public License
17 * along with this program. If not, see <http://www.gnu.org/licenses/>.
18 */
20#ifndef SCOPE_H
21#define SCOPE_H
23// Qt
24#include <QObject>
25#include <QString>
26#include <QMetaType>
28// libunity-core
29#include <UnityCore/Scope.h>
30#include <UnityCore/Results.h>
31#include <UnityCore/GLibWrapper.h>
33#include "categories.h"
34#include "filters.h"
36class Preview;
38class Scope : public QObject
40 Q_OBJECT
42 Q_PROPERTY(QString id READ id NOTIFY idChanged)
43 Q_PROPERTY(QString name READ name NOTIFY nameChanged)
44 Q_PROPERTY(QString iconHint READ iconHint NOTIFY iconHintChanged)
45 Q_PROPERTY(QString description READ description NOTIFY descriptionChanged)
46 Q_PROPERTY(QString searchHint READ searchHint NOTIFY searchHintChanged)
47 Q_PROPERTY(bool searchInProgress READ searchInProgress NOTIFY searchInProgressChanged)
48 Q_PROPERTY(bool visible READ visible NOTIFY visibleChanged)
49 Q_PROPERTY(QString shortcut READ shortcut NOTIFY shortcutChanged)
50 Q_PROPERTY(bool connected READ connected NOTIFY connectedChanged)
51 Q_PROPERTY(Categories* categories READ categories NOTIFY categoriesChanged)
52 Q_PROPERTY(Filters* filters READ filters NOTIFY filtersChanged)
54 Q_PROPERTY(QString searchQuery READ searchQuery WRITE setSearchQuery NOTIFY searchQueryChanged)
55 Q_PROPERTY(QString noResultsHint READ noResultsHint WRITE setNoResultsHint NOTIFY noResultsHintChanged)
56 Q_PROPERTY(QString formFactor READ formFactor WRITE setFormFactor NOTIFY formFactorChanged)
57 Q_PROPERTY(bool isActive READ isActive WRITE setActive NOTIFY isActiveChanged)
59public:
60 explicit Scope(QObject *parent = 0);
62 /* getters */
63 QString id() const;
64 QString name() const;
65 QString iconHint() const;
66 QString description() const;
67 QString searchHint() const;
68 bool visible() const;
69 QString shortcut() const;
70 bool connected() const;
71 bool searchInProgress() const;
72 Categories* categories() const;
73 Filters* filters() const;
74 QString searchQuery() const;
75 QString noResultsHint() const;
76 QString formFactor() const;
77 bool isActive() const;
79 /* setters */
80 void setSearchQuery(const QString& search_query);
81 void setNoResultsHint(const QString& hint);
82 void setFormFactor(const QString& form_factor);
83 void setActive(const bool);
85 Q_INVOKABLE void activate(const QVariant &uri, const QVariant &icon_hint, const QVariant &category,
86 const QVariant &result_type, const QVariant &mimetype, const QVariant &title,
87 const QVariant &comment, const QVariant &dnd_uri, const QVariant &metadata);
88 Q_INVOKABLE void preview(const QVariant &uri, const QVariant &icon_hint, const QVariant &category,
89 const QVariant &result_type, const QVariant &mimetype, const QVariant &title,
90 const QVariant &comment, const QVariant &dnd_uri, const QVariant &metadata);
91 void setUnityScope(const unity::dash::Scope::Ptr& scope);
92 unity::dash::Scope::Ptr unityScope() const;
94Q_SIGNALS:
95 void idChanged(const std::string&);
96 void dbusNameChanged(const std::string&);
97 void dbusPathChanged(const std::string&);
98 void nameChanged(const std::string&);
99 void iconHintChanged(const std::string&);
100 void descriptionChanged(const std::string&);
101 void searchHintChanged(const std::string&);
102 void searchInProgressChanged();
103 void visibleChanged(bool);
104 void shortcutChanged(const std::string&);
105 void connectedChanged(bool);
106 void categoriesChanged();
107 void searchQueryChanged();
108 void noResultsHintChanged();
109 void formFactorChanged();
110 void isActiveChanged(bool);
111 void filtersChanged();
113 // signals triggered by activate(..) or preview(..) requests.
114 void previewReady(Preview *preview);
115 void showDash();
116 void hideDash();
117 void gotoUri(const QString &uri);
119 void activateApplication(const QString &desktop);
121private Q_SLOTS:
122 void synchronizeStates();
123 void scopeIsActiveChanged();
124 void onSearchFinished(std::string const &, unity::glib::HintsMap const &, unity::glib::Error const&);
126private:
127 unity::dash::LocalResult createLocalResult(const QVariant &uri, const QVariant &icon_hint,
128 const QVariant &category, const QVariant &result_type,
129 const QVariant &mimetype, const QVariant &title,
130 const QVariant &comment, const QVariant &dnd_uri,
131 const QVariant &metadata);
132 void onActivated(unity::dash::LocalResult const& result, unity::dash::ScopeHandledType type, unity::glib::HintsMap const& hints);
133 void onPreviewReady(unity::dash::LocalResult const& result, unity::dash::Preview::Ptr const& preview);
134 void fallbackActivate(const QString& uri);
135 void resultsDirtyToggled(bool);
137 unity::dash::Scope::Ptr m_unityScope;
138 std::unique_ptr<Categories> m_categories;
139 std::unique_ptr<Filters> m_filters;
140 QString m_searchQuery;
141 QString m_noResultsHint;
142 QString m_formFactor;
143 bool m_isActive;
144 bool m_searchInProgress;
145 unity::glib::Cancellable m_cancellable;
146};
148Q_DECLARE_METATYPE(Scope*)
150#endif // SCOPE_H