unity.scopes.qt.QPreviewReply

Allows the results of a preview to be sent to the preview requester. More...

#include <unity/scopes/qt/QPreviewReply.h>

Inheritance diagram for unity::scopes::qt::QPreviewReply: src="https://assets.ubuntu.com/v1/fee74989-classunity_1_1scopes_1_1qt_1_1_q_preview_reply__inherit__graph.png" border="0" alt="Inheritance graph"/>

Public Member Functions

bool register_layout (QColumnLayoutList const &layouts)
 Registers a list of column layouts for the current preview. More...
 
bool push (QPreviewWidgetList const &widget_list)
 Sends widget definitions to the sender of the preview query. More...
 
bool push (QString const &key, QVariant const &value)
 Sends data for a preview widget attribute. More...
 

Detailed Description

Allows the results of a preview to be sent to the preview requester.

Member Function Documentation

bool unity::scopes::qt::QPreviewReply::push ( QPreviewWidgetList const &  widget_list)

Sends widget definitions to the sender of the preview query.

This method can be called mutiple times to send widgets in stages.

Returns
True if the query is still alive, false if the query failed or was cancelled.
bool unity::scopes::qt::QPreviewReply::push ( QString const &  key,
QVariant const &  value 
)

Sends data for a preview widget attribute.

Returns
True if the query is still alive, false if the query failed or was cancelled.
bool unity::scopes::qt::QPreviewReply::register_layout ( QColumnLayoutList const &  layouts)

Registers a list of column layouts for the current preview.

Layouts must be registered before pushing a unity::scopes::PreviewWidgetList, and must be registered only once.

Returns
True if the query is still alive, false if the query failed or was cancelled.
Exceptions
unity::LogicExceptionregister_layout() is called more than once.