Digikam::AlbumThumbnailLoader Class Reference

#include <albumthumbnailloader.h>

Inheritance diagram for Digikam::AlbumThumbnailLoader:

[legend]

List of all members.

Public Types
enum	RelativeSize { NormalSize, SmallerSize }
Signals
void	signalDispatchThumbnailInternal (int albumID, const QPixmap &thumbnail)
void	signalFailed (Album *album)
void	signalReloadThumbnails ()
void	signalThumbnail (Album *album, const QPixmap &)
Public Member Functions
QPixmap	blendIcons (QPixmap dstIcon, const QPixmap &tagIcon)
void	cleanUp ()
bool	getAlbumThumbnail (PAlbum *album)
QPixmap	getAlbumThumbnailDirectly (PAlbum *album)
QPixmap	getStandardAlbumIcon (PAlbum *album, RelativeSize size=NormalSize)
QPixmap	getStandardAlbumIcon (RelativeSize size=NormalSize)
QPixmap	getStandardAlbumRootIcon (RelativeSize size=NormalSize)
QPixmap	getStandardTagIcon (TAlbum *album, RelativeSize size=NormalSize)
QPixmap	getStandardTagIcon (RelativeSize size=NormalSize)
QPixmap	getStandardTagRootIcon (RelativeSize size=NormalSize)
bool	getTagThumbnail (TAlbum *album, QPixmap &icon)
QPixmap	getTagThumbnailDirectly (TAlbum *album, bool blendIcons=true)
void	setThumbnailSize (int size)
int	thumbnailSize () const
Static Public Member Functions
static AlbumThumbnailLoader *	instance ()
Protected Slots
void	slotDispatchThumbnailInternal (int albumID, const QPixmap &thumbnail)
void	slotGotThumbnailFromIcon (const LoadingDescription &loadingDescription, const QPixmap &pixmap)
void	slotIconChanged (Album *album)

---

Detailed Description

Definition at line 47 of file albumthumbnailloader.h.

---

Member Enumeration Documentation

enum Digikam::AlbumThumbnailLoader::RelativeSize

Album thumbnail size is configurable via the settings menu.

Some widgets use smaller icons than other widgets. These widgets do not need to know the currently set icon size from the setup and calculate a smaller size, but can simply request a relatively smaller icon. Depending on the user-chosen icon size, this size may in fact not be smaller than the normal size.

Enumerator:

NormalSize
SmallerSize

Definition at line 77 of file albumthumbnailloader.h.

---

Member Function Documentation

QPixmap Digikam::AlbumThumbnailLoader::blendIcons	(	QPixmap	dstIcon,
		const QPixmap &	tagIcon
	)

Blend tagIcon centered on dstIcon, where dstIcon is a standard icon of variable size and tagIcon is 12 pixels smaller.

If height(dstIcon) < minBlendSize we return tagIcon verbatim.

Definition at line 489 of file albumthumbnailloader.cpp.

void Digikam::AlbumThumbnailLoader::cleanUp

(

)

Definition at line 110 of file albumthumbnailloader.cpp.

bool Digikam::AlbumThumbnailLoader::getAlbumThumbnail

(

PAlbum *

album

)

Request thumbnail for given album.

The thumbnail will be loaded and returned asynchronously by the signals. If no thumbnail is associated with given album, no action will be taken, and false is returned.

Definition at line 245 of file albumthumbnailloader.cpp.

QPixmap Digikam::AlbumThumbnailLoader::getAlbumThumbnailDirectly

(

PAlbum *

album

)

Request thumbnail for given album, with slightly different behavior than the above method: If the thumbnail is already available in the cache, it is returned.

If the icon is not yet loaded, it will be returned asynchronously by the signals, and a default icon is returned here. If no icon is associated, the default icon is returned.

Definition at line 259 of file albumthumbnailloader.cpp.

QPixmap Digikam::AlbumThumbnailLoader::getStandardAlbumIcon	(	PAlbum *	album,
		RelativeSize	size = NormalSize
	)

Definition at line 146 of file albumthumbnailloader.cpp.

QPixmap Digikam::AlbumThumbnailLoader::getStandardAlbumIcon

(

RelativeSize

size = NormalSize

)

Definition at line 136 of file albumthumbnailloader.cpp.

QPixmap Digikam::AlbumThumbnailLoader::getStandardAlbumRootIcon

(

RelativeSize

size = NormalSize

)

Definition at line 141 of file albumthumbnailloader.cpp.

QPixmap Digikam::AlbumThumbnailLoader::getStandardTagIcon	(	TAlbum *	album,
		RelativeSize	size = NormalSize
	)

Definition at line 128 of file albumthumbnailloader.cpp.

QPixmap Digikam::AlbumThumbnailLoader::getStandardTagIcon

(

RelativeSize

size = NormalSize

)

Return standard tag and album icons.

The third methods check if album is the root, and returns the standard icon or the root standard icon.

Definition at line 118 of file albumthumbnailloader.cpp.

QPixmap Digikam::AlbumThumbnailLoader::getStandardTagRootIcon

(

RelativeSize

size = NormalSize

)

Definition at line 123 of file albumthumbnailloader.cpp.

bool Digikam::AlbumThumbnailLoader::getTagThumbnail	(	TAlbum *	album,
		QPixmap &	icon
	)

Behaves similar to the above method.

Tag thumbnails will be processed as appropriate. Tags may have associated an icon that is loaded synchronously by the system icon loader. In this case, icon is set to this icon, and false is returned. If no icon is associated with the tag, icon is set to null, and false is returned. If a custom icon is associated with the tag, it is loaded asynchronously, icon is set to null, and true is returned. Tag thumbnails are always smaller than album thumbnails - as small as an album thumbnail with SmallerSize. They are supposed to be blended into the standard tag icon obtained below, or used as is when SmallerSize is requested anyway.

Returns:

Returns true if icon is loaded asynchronously.

Definition at line 180 of file albumthumbnailloader.cpp.

QPixmap Digikam::AlbumThumbnailLoader::getTagThumbnailDirectly	(	TAlbum *	album,
		bool	blendIcons = true
	)

Loads tag thumbnail, with slightly different behavior than the above method: If the thumbnail is already available in the cache, it is returned, already blended with the standard icon, if requested.

If the icon is not yet loaded, it will be returned asynchronously by the signals, and a default icon is returned here. If no icon is associated, the default icon is returned.

Definition at line 214 of file albumthumbnailloader.cpp.

AlbumThumbnailLoader * Digikam::AlbumThumbnailLoader::instance

(

)

[static]

Definition at line 84 of file albumthumbnailloader.cpp.

void Digikam::AlbumThumbnailLoader::setThumbnailSize

(

int

size

)

Change the size of the thumbnails.

If the size differs from the current size, signalReloadThumbnails will be emitted.

Definition at line 351 of file albumthumbnailloader.cpp.

void Digikam::AlbumThumbnailLoader::signalDispatchThumbnailInternal	(	int	albumID,
		const QPixmap &	thumbnail
	)			[signal]

void Digikam::AlbumThumbnailLoader::signalFailed

(

Album *

album

)

[signal]

This signal is emitted if thumbnail generation for given album failed.

Same considerations as above.

void Digikam::AlbumThumbnailLoader::signalReloadThumbnails

(

)

[signal]

Indicates that all album and tag thumbnails need to be reloaded.

This is usually because the icon size has changed in the setup.

void Digikam::AlbumThumbnailLoader::signalThumbnail	(	Album *	album,
		const QPixmap &
	)			[signal]

This signal is emitted as soon as a thumbnail has become available for given album.

This class is a singleton, so any object connected to this signal might not actually have requested a thumbnail for given url

void Digikam::AlbumThumbnailLoader::slotDispatchThumbnailInternal	(	int	albumID,
		const QPixmap &	thumbnail
	)			[protected, slot]

Definition at line 439 of file albumthumbnailloader.cpp.

void Digikam::AlbumThumbnailLoader::slotGotThumbnailFromIcon	(	const LoadingDescription &	loadingDescription,
		const QPixmap &	pixmap
	)			[protected, slot]

Definition at line 382 of file albumthumbnailloader.cpp.

void Digikam::AlbumThumbnailLoader::slotIconChanged

(

Album *

album

)

[protected, slot]

Definition at line 454 of file albumthumbnailloader.cpp.

int Digikam::AlbumThumbnailLoader::thumbnailSize

(

)

const

Get the current default icon size.

Definition at line 377 of file albumthumbnailloader.cpp.

---

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

• albumthumbnailloader.h
• albumthumbnailloader.cpp