Holds a thumbnailer request. More...

Signals
void	finished ()
	This signal is emitted when the request completes. More...

Public Member Functions
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...

Detailed Description

Holds a thumbnailer request.

This class stores the state of an in-progress or completed thumbnail request.

Member Function Documentation

void unity::thumbnailer::qt::Request::cancel ( )

Cancel the thumbnail request.

The finished signal will be emitted and the request will be considered to be in an invalid state with an error message set.

QString unity::thumbnailer::qt::Request::errorMessage ( ) const

Returns the error message for a failed request.

Returns: The error message in case of a failure and an empty QString, otherwise.

void unity::thumbnailer::qt::Request::finished ( )

signal

This signal is emitted when the request completes.

QImage unity::thumbnailer::qt::Request::image ( ) const

Returns the thumbnail.

Returns: A valid QImage if the request was successful and an empty QImage, otherwise.

bool unity::thumbnailer::qt::Request::isFinished ( ) const

Returns whether the request has completed.

Returns: 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.

Returns: true if the request completed successfully. Otherwise, if the request is still in progress or has failed, the return value is false.

void unity::thumbnailer::qt::Request::waitForFinished ( )

Blocks the calling thread until the request completes.

Warning: Calling this function from the main (GUI) thread might cause your user interface to freeze.

The documentation for this class was generated from the following file:

/build/thumbnailer-exuLgm/thumbnailer-2.3+15.10.20150915.1/include/unity/thumbnailer/qt/thumbnailer-qt.h