Unity Scopes API
|
Top-level namespace for public functionality of the Unity scopes API. More...
Classes | |
class | ActionMetadata |
Metadata passed to scopes for preview and activation. More... | |
class | ActivationListenerBase |
Base class to receive a response to a result activation request. More... | |
class | ActivationQueryBase |
Base class for an activation request that is executed inside a scope. More... | |
class | ActivationResponse |
Response to a result activation. More... | |
class | Annotation |
Query link(s) that result in a new search query when clicked by the user. More... | |
class | CannedQuery |
Parameters of a search query. More... | |
class | CategorisedResult |
A result, including the category it belongs to. More... | |
class | Category |
A set of related results returned by a scope and displayed within a single pane in the Unity dash. More... | |
class | CategoryRenderer |
A category renderer template in JSON format. More... | |
class | ColumnLayout |
Defines a layout for preview widgets with given column setup. More... | |
class | Department |
A department with optional sub-departments. More... | |
class | FilterBase |
Base class for all implementations of filters. More... | |
class | FilterOption |
Holds definition of filter option for OptionSelectorFilter. More... | |
class | FilterState |
Captures state of multiple filters. More... | |
class | Link |
A hyperlink (label and canned query). More... | |
class | ListenerBase |
Abstract base class to be notified of query completion. More... | |
class | Object |
The root base class for all proxies. More... | |
class | OptionSelectorFilter |
A selection filter that displays a list of choices and allows one or more of them to be selected. More... | |
class | PreviewListenerBase |
Abstract base class for a scope to respond to preview requests. More... | |
class | PreviewQueryBase |
Abstract base class to represent a particular preview. More... | |
class | PreviewReply |
Allows the results of a preview to be sent to the preview requester. More... | |
class | PreviewWidget |
A widget for a preview. More... | |
class | QueryBase |
Abstract server-side base interface for a query that is executed inside a scope. More... | |
class | QueryCtrl |
QueryCtrl allows a query to be cancelled. More... | |
class | Registry |
White pages service for available scopes. More... | |
class | Reply |
Allows query termination to be sent to the source of a query. More... | |
class | Result |
The attributes of a result returned by a Scope. More... | |
class | Runtime |
The main object for query originators to access the scopes run time. More... | |
class | Scope |
Allows queries, preview requests, and activation requests to be sent to a scope. More... | |
class | ScopeBase |
Base class for a scope implementation. More... | |
class | MiddlewareException |
Exception to indicate that something went wrong with the middleware layer. More... | |
class | ObjectNotExistException |
Exception to indicate that a (twoway) request was sent to an object with an unknown identity. More... | |
class | TimeoutException |
Exception to indicate that a twoway request timed out. More... | |
class | ConfigException |
Exception to indicate that something went wrong with the contents of configuration files. More... | |
class | NotFoundException |
Exception to indicate that an object wasn't found by a lookup function. More... | |
class | ScopeMetadata |
Holds scope attributes such as name, description, icon etc. More... | |
class | SearchListenerBase |
Abstract base interface that a scope specializes to receive the results of a query. More... | |
class | SearchMetadata |
Metadata passed with search requests. More... | |
class | SearchQueryBase |
Abstract base class to represent a particular query. More... | |
class | SearchReply |
Allows the results of a search query to be sent to the query source. More... | |
class | Variant |
Simple variant class that can hold an integer, boolean, string, double, dictionary, array or null value. More... | |
class | VariantBuilder |
Helper class for creating and populating Variant containers. More... | |
Typedefs | |
typedef std::list< ColumnLayout > | ColumnLayoutList |
List of column layouts (see unity::scopes::ColumnLayout) | |
typedef std::list< Department > | DepartmentList |
List of departments (see unity::scopes::Department) | |
typedef std::list < FilterBase::SCPtr > | Filters |
List of filters. | |
typedef std::shared_ptr< Object > | ObjectProxy |
Convenience type definition for the proxy inheritance root. | |
typedef std::shared_ptr < PreviewReply > | PreviewReplyProxy |
Convenience type definition. | |
typedef std::list< PreviewWidget > | PreviewWidgetList |
List of preview widgets (see unity::scopes::PreviewWidget) | |
typedef std::shared_ptr < QueryCtrl > | QueryCtrlProxy |
Convenience type definition. | |
typedef std::map< std::string, ScopeMetadata > | MetadataMap |
Map for scope ID and metadata pairs. | |
typedef std::shared_ptr< Registry > | RegistryProxy |
Convenience type definition. | |
typedef std::shared_ptr< Reply > | ReplyProxy |
Convenience type definition. | |
typedef std::shared_ptr< Scope > | ScopeProxy |
Convenience type definition. | |
typedef std::shared_ptr < SearchReply > | SearchReplyProxy |
Convenience type definition. | |
typedef std::map< std::string, Variant > | VariantMap |
A dictionary of (string, Variant) pairs. | |
typedef std::vector< Variant > | VariantArray |
An array of variants. | |
Functions | |
char const * | to_string (ListenerBase::Reason reason) |
Convenience function to convert a ListenerBase::Reason enumerator to a string. More... | |
void | swap (Variant &, Variant &) noexcept |
Swaps the contents of two Variants. | |
Version information | |
Version information is represented as < Releases that differ in the major version number are binary incompatible. Releases of the library that differ in the minor or micro version number are binary compatible with older releases, so client code does not need to be recompiled to use the newer library version. Changes in the micro version number indicate bug fixes. Changes in the minor version number indicate feature additions that are binary compatible. | |
int | major_version () |
Returns the major version number of the Unity scopes library. More... | |
int | minor_version () |
Returns the minor version number of the Unity scopes library. More... | |
int | micro_version () |
Returns the micro version number of the Unity scopes library. More... | |
const char * | version_string () |
Returns the Unity scopes version as a string in the format <major >.<minor >.<micro >. More... | |
Variables | |
constexpr const char * | DEFAULT_RENDERER |
A default template for generic use. More... | |
constexpr const char * | MUSIC_GRID_RENDERER |
A template suitable for displaying music results. More... | |
decltype(&UNITY_SCOPE_CREATE_FUNCTION) typedef | CreateFunction |
Convenience typedef for the create function pointer. | |
decltype(&UNITY_SCOPE_DESTROY_FUNCTION) typedef | DestroyFunction |
Convenience typedef for the destroy function pointer. | |
Top-level namespace for public functionality of the Unity scopes API.
int unity::scopes::major_version | ( | ) |
Returns the major version number of the Unity scopes library.
The major version number is also available as the macro UNITY_SCOPES_VERSION_MAJOR
.
int unity::scopes::micro_version | ( | ) |
Returns the micro version number of the Unity scopes library.
The micro version number is also available as the macro UNITY_SCOPES_VERSION_MICRO
.
int unity::scopes::minor_version | ( | ) |
Returns the minor version number of the Unity scopes library.
The minor version number is also available as the macro UNITY_SCOPES_VERSION_MINOR
.
char const* unity::scopes::to_string | ( | ListenerBase::Reason | reason | ) |
Convenience function to convert a ListenerBase::Reason enumerator to a string.
char const * unity::scopes::version_string | ( | ) |
Returns the Unity scopes version as a string in the format <major
>.<minor
>.<micro
>.
The version string is also available as the macro UNITY_SCOPES_VERSION_STRING
.
constexpr const char* unity::scopes::DEFAULT_RENDERER |
A default template for generic use.
constexpr const char* unity::scopes::MUSIC_GRID_RENDERER |
A template suitable for displaying music results.