git.iko.soy/unity8
on 3643755 help sign in
unity8/plugins/Unity/scope.h
140 lines 5.5 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#include "categories.h"
33#include "filters.h"
35class Preview;
37class Scope : public QObject
39 Q_OBJECT
41 Q_PROPERTY(QString id READ id NOTIFY idChanged)
42 Q_PROPERTY(QString name READ name NOTIFY nameChanged)
43 Q_PROPERTY(QString iconHint READ iconHint NOTIFY iconHintChanged)
44 Q_PROPERTY(QString description READ description NOTIFY descriptionChanged)
45 Q_PROPERTY(QString searchHint READ searchHint NOTIFY searchHintChanged)
46 Q_PROPERTY(bool visible READ visible NOTIFY visibleChanged)
47 Q_PROPERTY(QString shortcut READ shortcut NOTIFY shortcutChanged)
48 Q_PROPERTY(bool connected READ connected NOTIFY connectedChanged)
49 Q_PROPERTY(Categories* categories READ categories NOTIFY categoriesChanged)
50 Q_PROPERTY(Filters* filters READ filters NOTIFY filtersChanged)
52 Q_PROPERTY(QString searchQuery READ searchQuery WRITE setSearchQuery NOTIFY searchQueryChanged)
53 Q_PROPERTY(QString noResultsHint READ noResultsHint WRITE setNoResultsHint NOTIFY noResultsHintChanged)
54 Q_PROPERTY(QString formFactor READ formFactor WRITE setFormFactor NOTIFY formFactorChanged)
56public:
57 explicit Scope(QObject *parent = 0);
58 ~Scope();
60 /* getters */
61 QString id() const;
62 QString name() const;
63 QString iconHint() const;
64 QString description() const;
65 QString searchHint() const;
66 bool visible() const;
67 QString shortcut() const;
68 bool connected() const;
69 Categories* categories() const;
70 Filters* filters() const;
71 QString searchQuery() const;
72 QString noResultsHint() const;
73 QString formFactor() const;
75 /* setters */
76 void setSearchQuery(const QString& search_query);
77 void setNoResultsHint(const QString& hint);
78 void setFormFactor(const QString& form_factor);
80 Q_INVOKABLE void activate(const QVariant &uri, const QVariant &icon_hint, const QVariant &category,
81 const QVariant &result_type, const QVariant &mimetype, const QVariant &title,
82 const QVariant &comment, const QVariant &dnd_uri, const QVariant &metadata);
83 Q_INVOKABLE void preview(const QVariant &uri, const QVariant &icon_hint, const QVariant &category,
84 const QVariant &result_type, const QVariant &mimetype, const QVariant &title,
85 const QVariant &comment, const QVariant &dnd_uri, const QVariant &metadata);
86 void setUnityScope(const unity::dash::Scope::Ptr& scope);
87 unity::dash::Scope::Ptr unityScope() const;
89Q_SIGNALS:
90 void idChanged(const std::string&);
91 void dbusNameChanged(const std::string&);
92 void dbusPathChanged(const std::string&);
93 void nameChanged(const std::string&);
94 void iconHintChanged(const std::string&);
95 void descriptionChanged(const std::string&);
96 void searchHintChanged(const std::string&);
97 void visibleChanged(bool);
98 void shortcutChanged(const std::string&);
99 void connectedChanged(bool);
100 void categoriesChanged();
101 void searchFinished(const std::string&, unity::glib::HintsMap const&, unity::glib::Error const&);
102 void searchQueryChanged();
103 void noResultsHintChanged();
104 void formFactorChanged();
105 void filtersChanged();
107 // signals triggered by activate(..) or preview(..) requests.
108 void previewReady(Preview *preview);
109 void showDash();
110 void hideDash();
111 void gotoUri(const QString &uri);
113 void activateApplication(const QString &desktop);
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 GCancellable* m_previewCancellable;
136};
138Q_DECLARE_METATYPE(Scope*)
140#endif // SCOPE_H