17 #ifndef UNITY_SHELL_SCOPES_SCOPEINTERFACE_H
18 #define UNITY_SHELL_SCOPES_SCOPEINTERFACE_H
20 #include <unity/SymbolExport.h>
23 #include <QVariantMap>
32 class CategoriesInterface;
33 class PreviewStackInterface;
34 class NavigationInterface;
35 class SettingsModelInterface;
49 Q_PROPERTY(QString
id READ
id NOTIFY idChanged)
54 Q_PROPERTY(QString name READ name NOTIFY nameChanged)
59 Q_PROPERTY(QString iconHint READ iconHint NOTIFY iconHintChanged)
64 Q_PROPERTY(QString description READ description NOTIFY descriptionChanged)
69 Q_PROPERTY(QString searchHint READ searchHint NOTIFY searchHintChanged)
74 Q_PROPERTY(
bool searchInProgress READ searchInProgress NOTIFY searchInProgressChanged)
79 Q_PROPERTY(
bool favorite READ favorite WRITE setFavorite NOTIFY favoriteChanged)
83 Q_PROPERTY(QString shortcut READ shortcut NOTIFY shortcutChanged)
100 Q_PROPERTY(QString searchQuery READ searchQuery WRITE setSearchQuery NOTIFY searchQueryChanged)
105 Q_PROPERTY(QString noResultsHint READ noResultsHint WRITE setNoResultsHint NOTIFY noResultsHintChanged)
114 Q_PROPERTY(QString formFactor READ formFactor WRITE setFormFactor NOTIFY formFactorChanged)
119 Q_PROPERTY(
bool isActive READ isActive WRITE setActive NOTIFY isActiveChanged)
124 Q_PROPERTY(QString currentNavigationId READ currentNavigationId NOTIFY currentNavigationIdChanged)
129 Q_PROPERTY(
bool hasNavigation READ hasNavigation NOTIFY hasNavigationChanged)
134 Q_PROPERTY(QString currentAltNavigationId READ currentAltNavigationId NOTIFY currentAltNavigationIdChanged)
139 Q_PROPERTY(
bool hasAltNavigation READ hasAltNavigation NOTIFY hasAltNavigationChanged)
144 Q_PROPERTY(QVariantMap customizations READ customizations NOTIFY customizationsChanged)
153 explicit
ScopeInterface(QObject* parent = 0) : QObject(parent) { }
169 virtual QString id()
const = 0;
170 virtual QString name()
const = 0;
171 virtual QString iconHint()
const = 0;
172 virtual QString description()
const = 0;
173 virtual QString searchHint()
const = 0;
174 virtual QString shortcut()
const = 0;
175 virtual bool searchInProgress()
const = 0;
176 virtual bool favorite()
const = 0;
179 virtual QString searchQuery()
const = 0;
180 virtual QString noResultsHint()
const = 0;
181 virtual QString formFactor()
const = 0;
182 virtual bool isActive()
const = 0;
183 virtual QString currentNavigationId()
const = 0;
184 virtual bool hasNavigation()
const = 0;
185 virtual QString currentAltNavigationId()
const = 0;
186 virtual bool hasAltNavigation()
const = 0;
187 virtual Status status()
const = 0;
188 virtual QVariantMap customizations()
const = 0;
191 virtual void setSearchQuery(
const QString& search_query) = 0;
192 virtual void setNoResultsHint(
const QString& hint) = 0;
193 virtual void setFormFactor(
const QString& form_factor) = 0;
194 virtual void setActive(
const bool) = 0;
195 virtual void setFavorite(
const bool) = 0;
201 Q_INVOKABLE
virtual void activate(QVariant
const& result, QString
const& categoryId) = 0;
214 Q_INVOKABLE
virtual void cancelActivation() = 0;
234 Q_INVOKABLE
virtual void setNavigationState(QString
const& navId,
bool altNavigation) = 0;
239 Q_INVOKABLE
virtual void performQuery(QString
const& cannedQuery) = 0;
244 Q_INVOKABLE
virtual void refresh() = 0;
250 void iconHintChanged();
251 void descriptionChanged();
252 void searchHintChanged();
253 void searchInProgressChanged();
254 void favoriteChanged();
255 void shortcutChanged();
256 void categoriesChanged();
257 void settingsChanged();
258 void searchQueryChanged();
259 void noResultsHintChanged();
260 void formFactorChanged();
261 void isActiveChanged();
262 void hasNavigationChanged();
263 void currentNavigationIdChanged();
264 void hasAltNavigationChanged();
265 void currentAltNavigationIdChanged();
266 void customizationsChanged();
267 void statusChanged();
268 void detailsChanged();
291 void gotoUri(QString
const& uri);
298 void previewRequested(QVariant
const& result);
303 void gotoScope(QString
const& scopeId);
Definition: SettingsModelInterface.h:31
Top-level namespace for all things Unity-related.
Definition: Version.h:37
Object representing scope instance, which exposes model(s) with results.
Definition: ScopeInterface.h:40
A master model for previews.
Definition: PreviewStackInterface.h:40
Object representing department instance, which exposes model(s) with results.
Definition: NavigationInterface.h:34
Status
Status info code following the last operation.
Definition: ScopeInterface.h:160
A list of categories for a particular search.
Definition: CategoriesInterface.h:37