Abstract base class to represent a particular preview.
More...
#include <unity/scopes/PreviewQueryBase.h>
Abstract base class to represent a particular preview.
A scope must return an instance of this class from its implementation of ScopeBase::preview().
- Note
- The constructor of the instance must complete in a timely manner. Do not perform anything in the constructor that might block.
unity::scopes::PreviewQueryBase::PreviewQueryBase |
( |
Result const & |
result, |
|
|
ActionMetadata const & |
metadata |
|
) |
| |
|
protected |
Instantiates a PreviewQueryBase.
- Parameters
-
result | The result to be previewed. |
metadata | Additional data for the preview. |
ActionMetadata unity::scopes::PreviewQueryBase::action_metadata |
( |
| ) |
const |
Get metadata for this preview request.
- Returns
- search metadata
- Exceptions
-
unity::LogicException | if preview metadata was not initialized (the default ctor was used). |
Result unity::scopes::PreviewQueryBase::result |
( |
| ) |
const |
Get result for this preview request.
- Exceptions
-
unity::LogicException | if result was not initialized (the default ctor was used). |
- Returns
- result
Called by scopes run time to start the preview.
Your implementation of run() can use the reply proxy to push results for the preview. You can push results from within run(), in which case the preview implicitly completes when run() returns. Alternatively, run() can store the reply proxy and return immediately. In this case, you can use the stored proxy to push results from another thread. It is safe to call push()
from multiple threads without synchronization.
The preview completes either when run() returns, or when the last stored reply proxy goes out of scope (whichever happens last).
- Parameters
-
reply | The proxy on which to push results for the preview. |
Implemented in unity::scopes::qt::QPreviewQueryBaseAPI.
The documentation for this class was generated from the following files: