git.iko.soy/unity8
on 9db4f20 help sign in
unity8/plugins/Unity/scope.h
139 lines 5.4 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>
32// dee-qt
33#include "deelistmodel.h"
35#include "categories.h"
36#include "filters.h"
38class Preview;
40class Scope : public QObject
42 Q_OBJECT
44 Q_PROPERTY(QString id READ id NOTIFY idChanged)
45 Q_PROPERTY(QString name READ name NOTIFY nameChanged)
46 Q_PROPERTY(QString iconHint READ iconHint NOTIFY iconHintChanged)
47 Q_PROPERTY(QString description READ description NOTIFY descriptionChanged)
48 Q_PROPERTY(QString searchHint READ searchHint NOTIFY searchHintChanged)
49 Q_PROPERTY(bool visible READ visible NOTIFY visibleChanged)
50 Q_PROPERTY(QString shortcut READ shortcut NOTIFY shortcutChanged)
51 Q_PROPERTY(bool connected READ connected NOTIFY connectedChanged)
52 Q_PROPERTY(Categories* categories READ categories NOTIFY categoriesChanged)
53 Q_PROPERTY(Filters* filters READ filters NOTIFY filtersChanged)
55 Q_PROPERTY(QString searchQuery READ searchQuery WRITE setSearchQuery NOTIFY searchQueryChanged)
56 Q_PROPERTY(QString noResultsHint READ noResultsHint WRITE setNoResultsHint NOTIFY noResultsHintChanged)
57 Q_PROPERTY(QString formFactor READ formFactor WRITE setFormFactor NOTIFY formFactorChanged)
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 Categories* categories() const;
72 Filters* filters() const;
73 QString searchQuery() const;
74 QString noResultsHint() const;
75 QString formFactor() const;
77 /* setters */
78 void setSearchQuery(const QString& search_query);
79 void setNoResultsHint(const QString& hint);
80 void setFormFactor(const QString& form_factor);
82 Q_INVOKABLE void activate(const QVariant &uri, const QVariant &icon_hint, const QVariant &category,
83 const QVariant &result_type, const QVariant &mimetype, const QVariant &title,
84 const QVariant &comment, const QVariant &dnd_uri, const QVariant &metadata);
85 Q_INVOKABLE void preview(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 void setUnityScope(const unity::dash::Scope::Ptr& scope);
89 unity::dash::Scope::Ptr unityScope() const;
91Q_SIGNALS:
92 void idChanged(const std::string&);
93 void dbusNameChanged(const std::string&);
94 void dbusPathChanged(const std::string&);
95 void nameChanged(const std::string&);
96 void iconHintChanged(const std::string&);
97 void descriptionChanged(const std::string&);
98 void searchHintChanged(const std::string&);
99 void visibleChanged(bool);
100 void shortcutChanged(const std::string&);
101 void connectedChanged(bool);
102 void categoriesChanged();
103 void searchFinished(const std::string&, unity::glib::HintsMap const&, unity::glib::Error const&);
104 void searchQueryChanged();
105 void noResultsHintChanged();
106 void formFactorChanged();
107 void filtersChanged();
109 // signals triggered by activate(..) or preview(..) requests.
110 void previewReady(Preview *preview);
111 void showDash();
112 void hideDash();
113 void gotoUri(const QString &uri);
115private Q_SLOTS:
116 void synchronizeStates();
117 void onSearchFinished(const std::string &, unity::glib::HintsMap const &);
119private:
120 unity::dash::LocalResult createLocalResult(const QVariant &uri, const QVariant &icon_hint,
121 const QVariant &category, const QVariant &result_type,
122 const QVariant &mimetype, const QVariant &title,
123 const QVariant &comment, const QVariant &dnd_uri,
124 const QVariant &metadata);
125 void onActivated(unity::dash::LocalResult const& result, unity::dash::ScopeHandledType type, unity::glib::HintsMap const& hints);
126 void onPreviewReady(unity::dash::LocalResult const& result, unity::dash::Preview::Ptr const& preview);
127 void fallbackActivate(const QString& uri);
129 unity::dash::Scope::Ptr m_unityScope;
130 std::unique_ptr<Categories> m_categories;
131 std::unique_ptr<Filters> m_filters;
132 QString m_searchQuery;
133 QString m_noResultsHint;
134 QString m_formFactor;
135};
137Q_DECLARE_METATYPE(Scope*)
139#endif // SCOPE_H