Unity Scopes API
QResult.h
1 /*
2  * Copyright (C) 2015 Canonical Ltd
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License version 3 as
6  * published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Lesser General Public License for more details.
12  *
13  * You should have received a copy of the GNU Lesser General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  *
16  * Authored by: Xavi Garcia <xavi.garcia.mena@canonical.com>
17  */
18 
19 #pragma once
20 
21 #include <unity/util/DefinesPtrs.h>
22 
23 #include <unity/scopes/ScopeProxyFwd.h>
24 
25 #include <QtCore/QString>
26 #include <QtCore/QVariant>
27 
28 namespace unity
29 {
30 
31 namespace scopes
32 {
33 
34 class Variant;
35 class Result;
36 
37 namespace qt
38 {
39 
40 class QCategorisedResult;
41 
42 namespace internal
43 {
44 class QResultImpl;
45 class QPreviewQueryBaseImpl;
46 }
47 
56 class QResult
57 {
58 public:
60  UNITY_DEFINES_PTRS(QResult);
62 
63  QResult();
67  //{@
68  QResult(QResult const& other);
69  QResult(QResult&&);
70 
71  QResult& operator=(QResult const& other);
72  QResult& operator=(QResult&&);
74 
78  virtual ~QResult();
79 
92  void store(QResult const& other, bool intercept_activation = false);
93 
98  bool has_stored_result() const;
99 
105  QResult retrieve() const;
106 
110  void set_uri(QString const& uri);
111 
117  void set_title(QString const& title);
123  void set_art(QString const& image);
124 
130  void set_dnd_uri(QString const& dnd_uri);
131 
145 
151  bool direct_activation() const;
152 
162 
173  QVariant& operator[](QString const& key);
174 
184  QVariant const& operator[](QString const& key) const;
185 
193  QString uri() const noexcept;
194 
202  QString title() const noexcept;
203 
211  QString art() const noexcept;
212 
220  QString dnd_uri() const noexcept;
221 
227  bool contains(QString const& key) const;
228 
236  QVariant const& value(QString const& key) const;
237 
242  QVariantMap serialize() const;
243 
244 protected:
246  explicit QResult(const QVariantMap& variant_map);
247  explicit QResult(internal::QResultImpl* impl);
248  explicit QResult(unity::scopes::Result const& result);
249 
250 private:
251  std::unique_ptr<internal::QResultImpl> p;
252 
253  friend class internal::QResultImpl;
254  friend class QCategorisedResult;
255  friend class internal::QPreviewQueryBaseImpl;
256  friend class QPreviewQueryBaseAPI;
258 };
259 
260 } // namespace qt
261 
262 } // namespace scopes
263 
264 } // namespace unity
A result, including the category it belongs to.
Definition: QCategorisedResult.h:43
std::shared_ptr< Scope > ScopeProxy
Convenience type definition.
Definition: ScopeProxyFwd.h:34
bool direct_activation() const
Check if this result should be activated directly by the shell because the scope doesn't handle activ...
void set_title(QString const &title)
Set the "title" attribute of this result.
Definition: HttpAsyncReader.h:45
void set_art(QString const &image)
Set the "art" attribute of this result.
bool contains(QString const &key) const
Check if this Result has an attribute.
ScopeProxy target_scope_proxy() const
Get the proxy of a scope that handles activation and preview of this result.
The attributes of a result returned by a Scope.
Definition: Result.h:50
void set_uri(QString const &uri)
Set the "uri" attribute of this result.
QString dnd_uri() const noexcept
Get the "dnd_uri" property of this Result.
QVariant & operator[](QString const &key)
Returns reference of a Result attribute.
QVariant const & value(QString const &key) const
Get the value of an attribute.
QString art() const noexcept
Get the "art" property of this Result.
bool has_stored_result() const
Check if this Result instance has a stored result.
Top-level namespace for all things Unity-related.
Definition: Version.h:49
QResult retrieve() const
Get a stored result.
QString title() const noexcept
Get the "title" property of this Result.
void set_intercept_activation()
Indicates to the receiver that this scope should intercept activation requests for this result...
The attributes of a result returned by a Scope.
Definition: QResult.h:56
Definition: ActionMetadata.h:31
void set_dnd_uri(QString const &dnd_uri)
Set the "dnd_uri" attribute of this result.
void store(QResult const &other, bool intercept_activation=false)
Stores a Result inside this Result instance.
Abstract base class to represent a particular preview.
Definition: QPreviewQueryBaseAPI.h:63
QString uri() const noexcept
Get the "uri" property of this Result.
QVariantMap serialize() const
Returns a dictionary of all attributes of this Result instance.