Thumbnailer Qt API
|
Holds a thumbnailer request. More...
#include <unity/thumbnailer/qt/thumbnailer-qt.h>
Signals | |
void | finished () |
This signal is emitted when the request completes. More... | |
Public Member Functions | |
~Request () | |
Destroys a request. More... | |
bool | isFinished () const |
Returns whether the request has completed. More... | |
QImage | image () const |
Returns the thumbnail. More... | |
QString | errorMessage () const |
Returns the error message for a failed request. More... | |
bool | isValid () const |
Returns whether the request completed successfully. More... | |
void | waitForFinished () |
Blocks the calling thread until the request completes. More... | |
void | cancel () |
Cancel the thumbnail request. More... | |
bool | isCancelled () const |
Returns whether the request was cancelled. More... | |
Holds a thumbnailer request.
This class stores the state of an in-progress or completed thumbnail request.
unity::thumbnailer::qt::Request::~Request | ( | ) |
Destroys a request.
If the request is still in progress, it is implicitly cancelled, and the finished() signal is not emitted.
void unity::thumbnailer::qt::Request::cancel | ( | ) |
Cancel the thumbnail request.
Cancels the request if it has not completed yet and emits the finished() signal. Calling cancel() more than once or on a request that has already completed does nothing.
QString unity::thumbnailer::qt::Request::errorMessage | ( | ) | const |
Returns the error message for a failed request.
QString
, otherwise.
|
signal |
This signal is emitted when the request completes.
QImage unity::thumbnailer::qt::Request::image | ( | ) | const |
Returns the thumbnail.
QImage
if the request was successful and an empty QImage
, otherwise. bool unity::thumbnailer::qt::Request::isCancelled | ( | ) | const |
Returns whether the request was cancelled.
true
if the request was cancelled and false
, otherwise. bool unity::thumbnailer::qt::Request::isFinished | ( | ) | const |
Returns whether the request has completed.
false
if the request is still in progress. Otherwise, the return value is true
(whether the request completed successfully or not). bool unity::thumbnailer::qt::Request::isValid | ( | ) | const |
Returns whether the request completed successfully.
true
if the request completed successfully. Otherwise, if the request is still in progress, has failed, or was cancelled, the return value is false
. void unity::thumbnailer::qt::Request::waitForFinished | ( | ) |
Blocks the calling thread until the request completes.
It is safe to call waitForFinished() on the same request more than once. If called on an already-completed (or cancelled) request, waitForFinished() returns immediately.