LeechCraft  0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
IImgSource Class Referenceabstract

Interface for remote image storage plugins. More...

#include "iimgsource.h"

Public Member Functions

virtual ~IImgSource ()
 
virtual LC::ImageServiceInfos_t GetServices () const =0
 Returns the list of supported services. More...
 
virtual IPendingImgSourceRequestRequestImages (const QByteArray &serviceId)=0
 Requests the images for the given service. More...
 
virtual IPendingImgSourceRequestStartDefaultChooser ()=0
 Requests the default image chooser to be opened. More...
 

Detailed Description

Interface for remote image storage plugins.

This interface should be implemented by plugins that provide a read-only interface to images hosted on a remote service, like Picasa or Flickr.

Definition at line 146 of file iimgsource.h.

Constructor & Destructor Documentation

◆ ~IImgSource()

virtual IImgSource::~IImgSource ( )
inlinevirtual

Definition at line 149 of file iimgsource.h.

Member Function Documentation

◆ GetServices()

virtual LC::ImageServiceInfos_t IImgSource::GetServices ( ) const
pure virtual

Returns the list of supported services.

Returns
The list of supported image services.
See also
LC::ImageServiceInfo

◆ RequestImages()

virtual IPendingImgSourceRequest* IImgSource::RequestImages ( const QByteArray &  serviceId)
pure virtual

Requests the images for the given service.

The implementation may either return all the images for the given serviceId or start the IImgSource-implementing plugin's default image chooser dialog, focused on the given service.

A pending request proxy object is returned. When the user selects the desired images and accepts the dialog, the proxy object emits the IPendingImgSourceRequest::ready() signal, and the images are available via IPendingImgSourceRequest::GetInfos(). If the user rejects the dialog, the signal is still emitted, but the IPendingImgSourceRequest::GetInfos() method returns an empty list.

Parameters
[in]serviceIdThe ID of a service returned from GetServices().
Returns
The pending request proxy object.

◆ StartDefaultChooser()

virtual IPendingImgSourceRequest* IImgSource::StartDefaultChooser ( )
pure virtual

Requests the default image chooser to be opened.

This function opens the IImgSource-implementing plugin's default image chooser dialog, where the user can select arbitrary images from arbitrary services.

The semantics of the returned pending proxy object is the same as in the RequestImages() method.

Returns
The pending request proxy object.

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