Digikam::PreviewLoadThread Class Reference

Inheritance diagram for Digikam::PreviewLoadThread:

Public Types
enum	AccessMode { AccessModeRead , AccessModeReadWrite }
enum	LoadingMode { LoadingModeNormal , LoadingModeShared }
enum	LoadingPolicy {   LoadingPolicyFirstRemovePrevious , LoadingPolicyPrepend , LoadingPolicySimplePrepend , LoadingPolicyAppend ,   LoadingPolicySimpleAppend , LoadingPolicyPreload }
enum	LoadingTaskFilter { LoadingTaskFilterAll , LoadingTaskFilterPreloading }
enum	NotificationPolicy { NotificationPolicyDirect , NotificationPolicyTimeLimited }
enum	State { Inactive , Scheduled , Running , Deactivating }
enum	TerminationPolicy { TerminationPolicyTerminateLoading , TerminationPolicyTerminatePreloading , TerminationPolicyWait , TerminationPolicyTerminateAll }

Public Slots
void	start ()
void	stop ()
void	wait ()

Signals
void	finished ()
void	signalImageLoaded (const LoadingDescription &loadingDescription, const DImg &img)
void	signalImageSaved (const QString &filePath, bool success)
void	signalImageStartedLoading (const LoadingDescription &loadingDescription)
void	signalImageStartedSaving (const QString &filePath)
void	signalLoadingProgress (const LoadingDescription &loadingDescription, float progress)
void	signalMoreCompleteLoadingAvailable (const LoadingDescription &oldLoadingDescription, const LoadingDescription &newLoadingDescription)
void	signalSavingProgress (const QString &filePath, float progress)
void	signalThumbnailLoaded (const LoadingDescription &loadingDescription, const QImage &img)
void	starting ()

Public Member Functions
void	imageLoaded (const LoadingDescription &loadingDescription, const DImg &img) override
void	imageSaved (const QString &filePath, bool success) override
void	imageStartedLoading (const LoadingDescription &loadingDescription) override
void	imageStartedSaving (const QString &filePath) override
bool	isFinished () const
bool	isRunning () const
void	load (const LoadingDescription &description)
void	load (const LoadingDescription &description, LoadingPolicy policy)
void	load (const QString &filePath, const PreviewSettings &settings, int size=0)
void	loadFast (const QString &filePath, int size)
void	loadFastButLarge (const QString &filePath, int minimumSize)
void	loadHighQuality (const QString &filePath, PreviewSettings::RawLoading rawLoadingMode=PreviewSettings::RawPreviewAutomatic)
LoadingPolicy	loadingPolicy () const
void	loadingProgress (const LoadingDescription &loadingDescription, float progress) override
void	moreCompleteLoadingAvailable (const LoadingDescription &oldLoadingDescription, const LoadingDescription &newLoadingDescription) override
	PreviewLoadThread (QObject *const parent=nullptr)
QThread::Priority	priority () const
virtual bool	querySendNotifyEvent () const
void	save (const DImg &image, const QString &filePath, const QString &format)
void	save (DImg &image, const QString &filePath, const QString &format)
void	savingProgress (const QString &filePath, float progress) override
void	setDisplayingWidget (QWidget *const widget)
void	setEmitSignals (bool emitThem)
void	setLoadingPolicy (LoadingPolicy policy)
void	setNotificationPolicy (NotificationPolicy notificationPolicy)
void	setPriority (QThread::Priority priority)
void	setTerminationPolicy (TerminationPolicy terminationPolicy)
State	state () const
void	stopAllTasks ()
void	stopLoading (const LoadingDescription &desc, LoadingTaskFilter filter=LoadingTaskFilterAll)
void	stopLoading (const QString &filePath=QString(), LoadingTaskFilter filter=LoadingTaskFilterAll)
void	stopSaving (const QString &filePath=QString())
virtual void	taskHasFinished ()
TerminationPolicy	terminationPolicy () const
void	thumbnailLoaded (const LoadingDescription &loadingDescription, const QImage &img) override
	~PreviewLoadThread () override

Static Public Member Functions
static int	exifOrientation (const QString &filePath, const DMetadata &metadata, bool isRaw, bool fromRawEmbeddedPreview)
static LoadSaveFileInfoProvider *	infoProvider ()
static DImg	loadFastButLargeSynchronously (const QString &filePath, int minimumSize, const IccProfile &profile=IccProfile())
static DImg	loadFastSynchronously (const QString &filePath, int size, const IccProfile &profile=IccProfile())
static DImg	loadHighQualitySynchronously (const QString &filePath, PreviewSettings::RawLoading rawLoadingMode=PreviewSettings::RawPreviewAutomatic, const IccProfile &profile=IccProfile())
static DImg	loadSynchronously (const LoadingDescription &description)
static DImg	loadSynchronously (const QString &filePath, const PreviewSettings &previewSettings, int size, const IccProfile &profile=IccProfile())
static void	setInfoProvider (LoadSaveFileInfoProvider *const infoProvider)

Protected Member Functions
LoadingDescription	createLoadingDescription (const QString &filePath, const PreviewSettings &settings, int size)
void	load (const LoadingDescription &description, LoadingMode loadingMode, AccessMode mode=AccessModeReadWrite)
void	load (const LoadingDescription &description, LoadingMode loadingMode, LoadingPolicy policy, AccessMode mode=AccessModeReadWrite)
void	loadPreview (const LoadingDescription &description, LoadingPolicy policy)
void	loadThumbnail (const LoadingDescription &description)
void	notificationReceived ()
void	preloadThumbnail (const LoadingDescription &description)
void	preloadThumbnailGroup (const QList< LoadingDescription > &descriptions)
void	prependThumbnailGroup (const QList< LoadingDescription > &descriptions)
void	run () override
bool	runningFlag () const volatile
void	shutDown ()
void	start (QMutexLocker &locker)
void	stop (QMutexLocker &locker)
QMutex *	threadMutex () const
void	wait (QMutexLocker &locker)

Static Protected Member Functions
static LoadingDescription	createLoadingDescription (const QString &filePath, const PreviewSettings &settings, int size, const IccProfile &profile)

Protected Attributes
LoadSaveTask *	m_currentTask
QWidget *	m_displayingWidget
LoadingPolicy	m_loadingPolicy
QMutex	m_mutex
NotificationPolicy	m_notificationPolicy
TerminationPolicy	m_terminationPolicy
QList< LoadSaveTask * >	m_todo

Member Enumeration Documentation

AccessMode

enum Digikam::LoadSaveThread::AccessMode

inherited

used by SharedLoadSaveThread only

Enumerator
AccessModeRead	image will only be used for reading
AccessModeReadWrite	image data will possibly be changed

LoadingMode

enum Digikam::ManagedLoadSaveThread::LoadingMode

inherited

used by SharedLoadSaveThread only

Enumerator
LoadingModeNormal	no sharing of loading process, no caching of image
LoadingModeShared	loading process is shared, image is cached

LoadingPolicy

enum Digikam::ManagedLoadSaveThread::LoadingPolicy

inherited

Enumerator
LoadingPolicyFirstRemovePrevious	Load image immediately, remove and stop all previous loading tasks.
LoadingPolicyPrepend	Prepend loading in front of all other tasks, but wait for the current task to finish. No other tasks will be removed, preloading tasks will be stopped and postponed.
LoadingPolicySimplePrepend	Prepend in front of all other tasks (not touching the current task). Do not check for duplicate tasks, do not check for preloading tasks.
LoadingPolicyAppend	Append loading task to the end of the list, but in front of all preloading tasks. No other tasks will be removed, preloading tasks will be stopped and postponed. This is similar to the simple load() operation from LoadSaveThread, except for the special care taken for preloading.
LoadingPolicySimpleAppend	Append to the lists of tasks. Do not check for duplicate tasks, do not check for preloading tasks.
LoadingPolicyPreload	Preload image, i.e. load it with low priority when no other tasks are scheduled. All other tasks will take precedence, and preloading tasks will be stopped and postponed when another task is added. No progress info will be sent for preloaded images

LoadingTaskFilter

enum Digikam::ManagedLoadSaveThread::LoadingTaskFilter

inherited

Enumerator
LoadingTaskFilterAll	filter all loading tasks
LoadingTaskFilterPreloading	filter only tasks with preloading policy

NotificationPolicy

enum Digikam::LoadSaveThread::NotificationPolicy

inherited

Enumerator
NotificationPolicyDirect	Always send notification, unless the last event is still in the event queue
NotificationPolicyTimeLimited	Always wait for a certain amount of time after the last event sent. In particular, the first event will be sent only after waiting for this time span. (Or no event will be sent, when the loading has finished before) This is the default.

State

enum Digikam::DynamicThread::State

inherited

Enumerator
Inactive
Scheduled
Running
Deactivating

TerminationPolicy

enum Digikam::ManagedLoadSaveThread::TerminationPolicy

inherited

Enumerator
TerminationPolicyTerminateLoading	Wait for saving tasks, stop and remove loading tasks This is the default.
TerminationPolicyTerminatePreloading	Wait for loading and saving tasks, stop and remove preloading tasks
TerminationPolicyWait	Wait for all pending tasks
TerminationPolicyTerminateAll	Stop all pending tasks

Constructor & Destructor Documentation

PreviewLoadThread()

Digikam::PreviewLoadThread::PreviewLoadThread ( QObject *const  parent = nullptr )

explicit

Creates a preview load thread. Provides three flavors of preview loading. The default loading policy, for the typical usage in a preview widget, always stops any previous tasks and loads the new task as soon as possible.

References Digikam::ManagedLoadSaveThread::LoadingPolicyFirstRemovePrevious, and Digikam::ManagedLoadSaveThread::m_loadingPolicy.

~PreviewLoadThread()

Digikam::PreviewLoadThread::~PreviewLoadThread ( )

override

Member Function Documentation

createLoadingDescription() [1/2]

LoadingDescription Digikam::PreviewLoadThread::createLoadingDescription ( const QString &  filePath, const PreviewSettings &  settings, int  size  )

protected

References createLoadingDescription(), Digikam::IccManager::displayProfile(), and m_displayingWidget.

createLoadingDescription() [2/2]

LoadingDescription Digikam::PreviewLoadThread::createLoadingDescription ( const QString &  filePath, const PreviewSettings &  settings, int  size, const IccProfile &  profile  )

staticprotected

References Digikam::LoadingDescription::PostProcessingParameters::colorManagement, Digikam::LoadingDescription::ConvertForDisplay, Digikam::ICCSettingsContainer::enableCM, Digikam::DImg::fileFormat(), Digikam::DRawDecoderSettings::halfSizeColorImage, Digikam::IccSettings::instance(), Digikam::IccProfile::isNull(), Digikam::DRawDecoding::optimizeTimeLoading(), Digikam::LoadingDescription::postProcessingParameters, Digikam::DImg::RAW, Digikam::LoadingDescription::rawDecodingHint, Digikam::LoadingDescription::rawDecodingSettings, Digikam::LoadingDescription::RawDecodingTimeOptimized, Digikam::DRawDecoding::rawPrm, Digikam::LoadingDescription::PostProcessingParameters::setProfile(), Digikam::IccSettings::settings(), Digikam::DRawDecoderSettings::sixteenBitsImage, Digikam::IccProfile::sRGB(), and Digikam::ICCSettingsContainer::useManagedPreviews.

Referenced by createLoadingDescription(), load(), loadFast(), loadFastButLarge(), loadFastButLargeSynchronously(), loadFastSynchronously(), loadHighQuality(), loadHighQualitySynchronously(), and loadSynchronously().

exifOrientation()

int Digikam::LoadSaveThread::exifOrientation ( const QString &  filePath, const DMetadata &  metadata, bool  isRaw, bool  fromRawEmbeddedPreview  )

staticinherited

Retrieves the Exif orientation, either from the info provider if available, or from the metadata

References Digikam::MetaEngineRotation::exifOrientation(), Digikam::MetaEngine::getItemOrientation(), Digikam::LoadSaveThread::infoProvider(), Digikam::MetaEngine::ORIENTATION_NORMAL, Digikam::MetaEngine::ORIENTATION_UNSPECIFIED, Digikam::LoadSaveFileInfoProvider::orientationHint(), and Digikam::MetaEngineRotation::toTransform().

Referenced by Digikam::DImg::exifOrientation().

finished

void Digikam::DynamicThread::finished ( )

signalinherited

Referenced by Digikam::ThumbnailImageCatcher::Private::harvest(), Digikam::DImgThreadedFilter::startFilter(), and Digikam::DImgThreadedFilter::startFilterDirectly().

imageLoaded()

void Digikam::LoadSaveThread::imageLoaded ( const LoadingDescription &  loadingDescription, const DImg &  img  )

overridevirtualinherited

Implements Digikam::LoadSaveNotifier.

References Digikam::LoadSaveThread::notificationReceived(), and Digikam::LoadSaveThread::signalImageLoaded().

Referenced by Digikam::LoadingTask::execute(), Digikam::SharedLoadingTask::execute(), and Digikam::PreviewLoadingTask::execute().

imageSaved()

void Digikam::LoadSaveThread::imageSaved ( const QString &  filePath, bool  success  )

overridevirtualinherited

Implements Digikam::LoadSaveNotifier.

References Digikam::LoadSaveThread::notificationReceived(), and Digikam::LoadSaveThread::signalImageSaved().

Referenced by Digikam::SavingTask::execute().

imageStartedLoading()

void Digikam::LoadSaveThread::imageStartedLoading ( const LoadingDescription &  loadingDescription )

overridevirtualinherited

Implements Digikam::LoadSaveNotifier.

References Digikam::LoadSaveThread::notificationReceived(), and Digikam::LoadSaveThread::signalImageStartedLoading().

Referenced by Digikam::SharedLoadingTask::execute().

imageStartedSaving()

void Digikam::LoadSaveThread::imageStartedSaving ( const QString &  filePath )

overridevirtualinherited

Implements Digikam::LoadSaveNotifier.

References Digikam::LoadSaveThread::notificationReceived(), and Digikam::LoadSaveThread::signalImageStartedSaving().

Referenced by Digikam::SavingTask::execute().

infoProvider()

LoadSaveFileInfoProvider * Digikam::LoadSaveThread::infoProvider ( )

staticinherited

Referenced by Digikam::LoadSaveThread::exifOrientation(), and Digikam::LoadSaveThread::setInfoProvider().

isFinished()

bool Digikam::DynamicThread::isFinished ( ) const

inherited

References Digikam::DynamicThread::Inactive.

isRunning()

bool Digikam::DynamicThread::isRunning ( ) const

inherited

References Digikam::DynamicThread::Deactivating, Digikam::DynamicThread::Running, and Digikam::DynamicThread::Scheduled.

Referenced by Digikam::DImgThreadedFilter::cancelFilter(), and Digikam::ImageHistogram::isCalculating().

load() [1/5]

void Digikam::PreviewLoadThread::load

(

const LoadingDescription &

description

)

Load a preview. Loading description will not be touched.

References Digikam::ManagedLoadSaveThread::loadPreview(), and Digikam::ManagedLoadSaveThread::m_loadingPolicy.

load() [2/5]

void Digikam::ManagedLoadSaveThread::load ( const LoadingDescription &  description, LoadingMode  loadingMode, AccessMode  mode = AccessModeReadWrite  )

protectedinherited

References Digikam::ManagedLoadSaveThread::load(), and Digikam::ManagedLoadSaveThread::m_loadingPolicy.

load() [3/5]

void Digikam::ManagedLoadSaveThread::load ( const LoadingDescription &  description, LoadingMode  loadingMode, LoadingPolicy  policy, AccessMode  mode = AccessModeReadWrite  )

protectedinherited

References Digikam::ManagedLoadSaveThread::load(), Digikam::LoadingTask::loadingDescription(), Digikam::ManagedLoadSaveThread::LoadingPolicyAppend, Digikam::ManagedLoadSaveThread::LoadingPolicyFirstRemovePrevious, Digikam::ManagedLoadSaveThread::LoadingPolicyPreload, Digikam::ManagedLoadSaveThread::LoadingPolicyPrepend, Digikam::ManagedLoadSaveThread::LoadingPolicySimpleAppend, Digikam::ManagedLoadSaveThread::LoadingPolicySimplePrepend, Digikam::ManagedLoadSaveThread::LoadingTaskFilterAll, Digikam::ManagedLoadSaveThread::LoadingTaskFilterPreloading, Digikam::LoadingTask::LoadingTaskStatusLoading, Digikam::LoadingTask::LoadingTaskStatusStopping, Digikam::LoadSaveThread::m_currentTask, Digikam::LoadSaveThread::m_todo, Digikam::LoadingTask::setStatus(), Digikam::DynamicThread::start(), and Digikam::DynamicThread::threadMutex().

load() [4/5]

void Digikam::ManagedLoadSaveThread::load ( const LoadingDescription &  description, LoadingPolicy  policy  )

inherited

References Digikam::ManagedLoadSaveThread::load(), and Digikam::ManagedLoadSaveThread::LoadingModeNormal.

load() [5/5]

void Digikam::PreviewLoadThread::load	(	const QString &	filePath,
		const PreviewSettings &	settings,
		int	size = 0
	)

Load a preview. Settings determine the loading mode. For fast loading, size is preview area size. For fast-but-large loading, it serves as a minimum size. For high quality loading, it is ignored

References createLoadingDescription().

Referenced by loadFast(), loadFastButLarge(), and loadHighQuality().

loadFast()

void Digikam::PreviewLoadThread::loadFast	(	const QString &	filePath,
		int	size
	)

Load a preview that is optimized for fast loading. Raw decoding and color management settings will be adjusted.

References createLoadingDescription(), Digikam::PreviewSettings::FastPreview, and load().

loadFastButLarge()

void Digikam::PreviewLoadThread::loadFastButLarge	(	const QString &	filePath,
		int	minimumSize
	)

Load a preview that is as large as possible without sacrificing speed for performance. Especially, raw previews are taken if larger than the given size. Raw decoding and color management settings will be adjusted.

References createLoadingDescription(), Digikam::PreviewSettings::FastButLargePreview, and load().

loadFastButLargeSynchronously()

DImg Digikam::PreviewLoadThread::loadFastButLargeSynchronously ( const QString &  filePath, int  minimumSize, const IccProfile &  profile = IccProfile()  )

static

References createLoadingDescription(), Digikam::PreviewSettings::FastButLargePreview, and loadSynchronously().

loadFastSynchronously()

DImg Digikam::PreviewLoadThread::loadFastSynchronously ( const QString &  filePath, int  size, const IccProfile &  profile = IccProfile()  )

static

Synchronous versions of the above methods. These are safe to call from the non-UI thread, as the IccProfile either passed or deduced independent from a displaying widget

References createLoadingDescription(), Digikam::PreviewSettings::FastPreview, and loadSynchronously().

Referenced by Digikam::FingerprintsTask::run(), and Digikam::ImageQualityTask::run().

loadHighQuality()

void Digikam::PreviewLoadThread::loadHighQuality	(	const QString &	filePath,
		PreviewSettings::RawLoading	rawLoadingMode = PreviewSettings::RawPreviewAutomatic
	)

Load a preview with higher resolution, trading more quality for less speed. Raw decoding and color management settings will be adjusted.

References createLoadingDescription(), Digikam::PreviewSettings::HighQualityPreview, and load().

Referenced by Digikam::FacePreviewLoader::process().

loadHighQualitySynchronously()

DImg Digikam::PreviewLoadThread::loadHighQualitySynchronously ( const QString &  filePath, PreviewSettings::RawLoading  rawLoadingMode = PreviewSettings::RawPreviewAutomatic, const IccProfile &  profile = IccProfile()  )

static

References createLoadingDescription(), Digikam::PreviewSettings::HighQualityPreview, and loadSynchronously().

Referenced by Digikam::DPreviewImage::load().

loadingPolicy()

ManagedLoadSaveThread::LoadingPolicy Digikam::ManagedLoadSaveThread::loadingPolicy ( ) const

inherited

References Digikam::ManagedLoadSaveThread::m_loadingPolicy.

loadingProgress()

void Digikam::LoadSaveThread::loadingProgress ( const LoadingDescription &  loadingDescription, float  progress  )

overridevirtualinherited

Implements Digikam::LoadSaveNotifier.

References Digikam::LoadSaveThread::notificationReceived(), and Digikam::LoadSaveThread::signalLoadingProgress().

Referenced by Digikam::LoadingTask::progressInfo().

loadPreview()

void Digikam::ManagedLoadSaveThread::loadPreview ( const LoadingDescription &  description, LoadingPolicy  policy  )

protectedinherited

References Digikam::ManagedLoadSaveThread::load(), and Digikam::ManagedLoadSaveThread::LoadingModeShared.

Referenced by load().

loadSynchronously() [1/2]

DImg Digikam::PreviewLoadThread::loadSynchronously ( const LoadingDescription &  description )

static

References Digikam::PreviewLoadingTask::execute(), and Digikam::SharedLoadingTask::img().

loadSynchronously() [2/2]

DImg Digikam::PreviewLoadThread::loadSynchronously ( const QString &  filePath, const PreviewSettings &  previewSettings, int  size, const IccProfile &  profile = IccProfile()  )

static

References createLoadingDescription().

Referenced by loadFastButLargeSynchronously(), loadFastSynchronously(), and loadHighQualitySynchronously().

loadThumbnail()

void Digikam::ManagedLoadSaveThread::loadThumbnail ( const LoadingDescription &  description )

protectedinherited

References Digikam::LoadingTask::LoadingTaskStatusLoading, Digikam::LoadSaveThread::m_todo, Digikam::LoadingTask::setStatus(), Digikam::DynamicThread::start(), and Digikam::DynamicThread::threadMutex().

moreCompleteLoadingAvailable()

void Digikam::LoadSaveThread::moreCompleteLoadingAvailable ( const LoadingDescription &  oldLoadingDescription, const LoadingDescription &  newLoadingDescription  )

overridevirtualinherited

Implements Digikam::LoadSaveNotifier.

References Digikam::LoadSaveThread::notificationReceived(), and Digikam::LoadSaveThread::signalMoreCompleteLoadingAvailable().

notificationReceived()

void Digikam::LoadSaveThread::notificationReceived ( )

protectedinherited

References Digikam::LoadSaveThread::m_notificationPolicy, Digikam::LoadSaveThread::NotificationPolicyDirect, and Digikam::LoadSaveThread::NotificationPolicyTimeLimited.

Referenced by Digikam::LoadSaveThread::imageLoaded(), Digikam::LoadSaveThread::imageSaved(), Digikam::LoadSaveThread::imageStartedLoading(), Digikam::LoadSaveThread::imageStartedSaving(), Digikam::LoadSaveThread::loadingProgress(), Digikam::LoadSaveThread::moreCompleteLoadingAvailable(), Digikam::LoadSaveThread::savingProgress(), and Digikam::LoadSaveThread::thumbnailLoaded().

preloadThumbnail()

void Digikam::ManagedLoadSaveThread::preloadThumbnail ( const LoadingDescription &  description )

protectedinherited

References Digikam::LoadingTask::LoadingTaskStatusPreloading, Digikam::LoadSaveThread::m_todo, Digikam::LoadingTask::setStatus(), Digikam::DynamicThread::start(), and Digikam::DynamicThread::threadMutex().

preloadThumbnailGroup()

void Digikam::ManagedLoadSaveThread::preloadThumbnailGroup ( const QList< LoadingDescription > &  descriptions )

protectedinherited

References Digikam::LoadingTask::LoadingTaskStatusPreloading, Digikam::LoadSaveThread::m_todo, Digikam::LoadingTask::setStatus(), Digikam::DynamicThread::start(), and Digikam::DynamicThread::threadMutex().

Referenced by Digikam::ThumbnailLoadThread::pregenerateGroup(), and Digikam::ThumbnailLoadThread::preloadGroup().

prependThumbnailGroup()

void Digikam::ManagedLoadSaveThread::prependThumbnailGroup ( const QList< LoadingDescription > &  descriptions )

protectedinherited

References Digikam::LoadSaveThread::m_currentTask, Digikam::LoadSaveThread::m_todo, Digikam::DynamicThread::start(), and Digikam::DynamicThread::threadMutex().

Referenced by Digikam::ThumbnailLoadThread::findGroup().

priority()

QThread::Priority Digikam::DynamicThread::priority ( ) const

inherited

Referenced by Digikam::DynamicThread::setPriority().

querySendNotifyEvent()

bool Digikam::LoadSaveThread::querySendNotifyEvent ( ) const

virtualinherited

References Digikam::LoadSaveThread::m_notificationPolicy, Digikam::LoadSaveThread::NotificationPolicyDirect, and Digikam::LoadSaveThread::NotificationPolicyTimeLimited.

Referenced by Digikam::LoadingTask::progressInfo(), Digikam::SavingTask::progressInfo(), and Digikam::SharedLoadingTask::querySendNotifyEvent().

run()

void Digikam::LoadSaveThread::run ( )

overrideprotectedvirtualinherited

Implement this pure virtual function in your subclass.

Implements Digikam::DynamicThread.

References Digikam::LoadSaveTask::execute(), Digikam::LoadSaveThread::m_currentTask, Digikam::LoadSaveThread::m_notificationPolicy, Digikam::LoadSaveThread::m_todo, Digikam::LoadSaveThread::NotificationPolicyTimeLimited, Digikam::DynamicThread::runningFlag(), Digikam::DynamicThread::stop(), and Digikam::DynamicThread::threadMutex().

runningFlag()

bool Digikam::DynamicThread::runningFlag ( ) const volatile

protectedinherited

In you run() method, you shall regularly check for runningFlag() and cleanup and return if false.

Referenced by Digikam::ImageHistogram::calculate(), Digikam::RawProcessingFilter::continueQuery(), Digikam::LoadSaveThread::run(), Digikam::ScanStateFilter::run(), and Digikam::NREstimate::startAnalyse().

save() [1/2]

void Digikam::LoadSaveThread::save ( const DImg &  image, const QString &  filePath, const QString &  format  )

inherited

Append a task to save the image to the task list

References Digikam::LoadSaveThread::m_todo, Digikam::DynamicThread::start(), and Digikam::DynamicThread::threadMutex().

save() [2/2]

void Digikam::ManagedLoadSaveThread::save ( DImg &  image, const QString &  filePath, const QString &  format  )

inherited

Append a task to save the image to the task list

References Digikam::ManagedLoadSaveThread::load(), Digikam::LoadingTask::loadingDescription(), Digikam::ManagedLoadSaveThread::LoadingPolicyPreload, Digikam::ManagedLoadSaveThread::LoadingTaskFilterPreloading, Digikam::LoadingTask::LoadingTaskStatusStopping, Digikam::LoadSaveThread::m_currentTask, Digikam::LoadSaveThread::m_todo, Digikam::LoadingTask::setStatus(), Digikam::DynamicThread::start(), and Digikam::DynamicThread::threadMutex().

savingProgress()

void Digikam::LoadSaveThread::savingProgress ( const QString &  filePath, float  progress  )

overridevirtualinherited

Implements Digikam::LoadSaveNotifier.

References Digikam::LoadSaveThread::notificationReceived(), and Digikam::LoadSaveThread::signalSavingProgress().

Referenced by Digikam::SavingTask::progressInfo().

setDisplayingWidget()

void Digikam::PreviewLoadThread::setDisplayingWidget

(

QWidget *const

widget

)

Optionally, set the displaying widget for color management

References m_displayingWidget.

setEmitSignals()

void Digikam::DynamicThread::setEmitSignals ( bool  emitThem )

inherited

setInfoProvider()

void Digikam::LoadSaveThread::setInfoProvider ( LoadSaveFileInfoProvider *const  infoProvider )

staticinherited

References Digikam::LoadSaveThread::infoProvider().

Referenced by Digikam::DigikamApp::DigikamApp().

setLoadingPolicy()

void Digikam::ManagedLoadSaveThread::setLoadingPolicy ( LoadingPolicy  policy )

inherited

Set the loading policy. Default is LoadingPolicyAppend. You can override the default value for each operation.

References Digikam::ManagedLoadSaveThread::m_loadingPolicy.

Referenced by Digikam::FacePreviewLoader::FacePreviewLoader().

setNotificationPolicy()

void Digikam::LoadSaveThread::setNotificationPolicy ( NotificationPolicy  notificationPolicy )

inherited

References Digikam::LoadSaveThread::m_notificationPolicy.

setPriority()

void Digikam::DynamicThread::setPriority ( QThread::Priority  priority )

inherited

Sets the priority for this dynamic thread. Can be set anytime. If the thread is currently not running, the priority will be set when it is run next time. When you set QThread::InheritPriority (default), the priority is not changed but inherited from the thread pool.

References Digikam::DynamicThread::priority().

Referenced by Digikam::FacePipeline::Private::applyPriority(), and Digikam::FacePipeline::Private::createThumbnailLoadThread().

setTerminationPolicy()

void Digikam::ManagedLoadSaveThread::setTerminationPolicy ( TerminationPolicy  terminationPolicy )

inherited

References Digikam::ManagedLoadSaveThread::m_terminationPolicy, and Digikam::ManagedLoadSaveThread::terminationPolicy().

shutDown()

void Digikam::ManagedLoadSaveThread::shutDown ( )

protectedinherited

References Digikam::ManagedLoadSaveThread::LoadingTaskFilterAll, Digikam::ManagedLoadSaveThread::LoadingTaskFilterPreloading, Digikam::LoadingTask::LoadingTaskStatusStopping, Digikam::LoadSaveThread::m_currentTask, Digikam::ManagedLoadSaveThread::m_terminationPolicy, Digikam::LoadingTask::setStatus(), Digikam::DynamicThread::shutDown(), Digikam::ManagedLoadSaveThread::stopAllTasks(), Digikam::ManagedLoadSaveThread::TerminationPolicyTerminateAll, Digikam::ManagedLoadSaveThread::TerminationPolicyTerminateLoading, Digikam::ManagedLoadSaveThread::TerminationPolicyTerminatePreloading, Digikam::ManagedLoadSaveThread::TerminationPolicyWait, and Digikam::DynamicThread::threadMutex().

Referenced by Digikam::ManagedLoadSaveThread::~ManagedLoadSaveThread(), and Digikam::ThumbnailLoadThread::~ThumbnailLoadThread().

signalImageLoaded

void Digikam::LoadSaveThread::signalImageLoaded ( const LoadingDescription &  loadingDescription, const DImg &  img  )

signalinherited

This signal is emitted when the loading process has finished. If the process failed, img is null.

Referenced by Digikam::FacePreviewLoader::FacePreviewLoader(), and Digikam::LoadSaveThread::imageLoaded().

signalImageSaved

void Digikam::LoadSaveThread::signalImageSaved ( const QString &  filePath, bool  success  )

signalinherited

Referenced by Digikam::LoadSaveThread::imageSaved().

signalImageStartedLoading

void Digikam::LoadSaveThread::signalImageStartedLoading ( const LoadingDescription &  loadingDescription )

signalinherited

All signals are delivered to the thread from where the LoadSaveThread object has been created. This thread must use its event loop to get the signals. You must connect to these signals with Qt::AutoConnection (default) or Qt::QueuedConnection. This signal is emitted when the loading process begins.

Referenced by Digikam::LoadSaveThread::imageStartedLoading().

signalImageStartedSaving

void Digikam::LoadSaveThread::signalImageStartedSaving ( const QString &  filePath )

signalinherited

Referenced by Digikam::LoadSaveThread::imageStartedSaving().

signalLoadingProgress

void Digikam::LoadSaveThread::signalLoadingProgress ( const LoadingDescription &  loadingDescription, float  progress  )

signalinherited

This signal is emitted whenever new progress info is available and the notification policy allows emitting the signal. No progress info will be sent for preloaded images (ManagedLoadSaveThread).

Referenced by Digikam::LoadSaveThread::loadingProgress().

signalMoreCompleteLoadingAvailable

void Digikam::LoadSaveThread::signalMoreCompleteLoadingAvailable ( const LoadingDescription &  oldLoadingDescription, const LoadingDescription &  newLoadingDescription  )

signalinherited

This signal is emitted if

• you are doing shared loading (SharedLoadSaveThread)
• you started a loading operation with a LoadingDescription for a reduced version of the image
• another thread started a loading operation for a more complete version You may want to cancel the current operation and start with the given loadingDescription

Referenced by Digikam::LoadSaveThread::moreCompleteLoadingAvailable().

signalSavingProgress

void Digikam::LoadSaveThread::signalSavingProgress ( const QString &  filePath, float  progress  )

signalinherited

Referenced by Digikam::LoadSaveThread::savingProgress().

signalThumbnailLoaded

void Digikam::LoadSaveThread::signalThumbnailLoaded ( const LoadingDescription &  loadingDescription, const QImage &  img  )

signalinherited

Referenced by Digikam::LoadSaveThread::thumbnailLoaded().

start [1/2]

void Digikam::DynamicThread::start ( )

slotinherited

Referenced by Digikam::ImageHistogram::calculateInThread(), Digikam::FacePreviewLoader::checkRestart(), Digikam::ImageHistogram::getCount(), Digikam::ImageHistogram::getMaximum(), Digikam::ImageHistogram::getMean(), Digikam::ImageHistogram::getMedian(), Digikam::ImageHistogram::getStdDev(), Digikam::LoadSaveThread::load(), Digikam::ManagedLoadSaveThread::load(), Digikam::ManagedLoadSaveThread::loadThumbnail(), Digikam::DImgThreadedFilter::multithreadedSteps(), Digikam::ManagedLoadSaveThread::preloadThumbnail(), Digikam::ManagedLoadSaveThread::preloadThumbnailGroup(), Digikam::ManagedLoadSaveThread::prependThumbnailGroup(), Digikam::ScanStateFilter::process(), Digikam::LoadSaveThread::save(), Digikam::ManagedLoadSaveThread::save(), and Digikam::DImgThreadedFilter::startFilter().

start() [2/2]

void Digikam::DynamicThread::start ( QMutexLocker &  locker )

protectedinherited

Doing the same as start(), stop() and wait above, provide it with a locked QMutexLocker on mutex(). Note the start() will unlock and relock for scheduling once, after state change.

References Digikam::ThreadManager::instance(), and Digikam::ThreadManager::schedule().

starting

void Digikam::DynamicThread::starting ( )

signalinherited

Emitted if emitSignals is enabled

state()

DynamicThread::State Digikam::DynamicThread::state ( ) const

inherited

Referenced by Digikam::ThumbnailImageCatcher::Private::harvest(), and Digikam::ThumbnailImageCatcher::Private::reset().

stop [1/2]

void Digikam::DynamicThread::stop ( )

slotinherited

Stop computation, sets the running flag to false.

Referenced by Digikam::WBFilter::autoExposureAdjustement(), Digikam::DImgThreadedFilter::cancelFilter(), Digikam::DImgThreadedFilter::multithreadedSteps(), Digikam::LoadSaveThread::run(), Digikam::ScanStateFilter::run(), Digikam::DynamicThread::shutDown(), Digikam::FacePreviewLoader::slotImageLoaded(), Digikam::FacePipeline::Private::stop(), and Digikam::ImageHistogram::stopCalculation().

stop() [2/2]

void Digikam::DynamicThread::stop ( QMutexLocker &  locker )

protectedinherited

stopAllTasks()

void Digikam::ManagedLoadSaveThread::stopAllTasks ( )

inherited

References Digikam::LoadingTask::LoadingTaskStatusStopping, Digikam::LoadSaveThread::m_currentTask, Digikam::LoadSaveThread::m_todo, Digikam::SavingTask::SavingTaskStatusStopping, Digikam::LoadingTask::setStatus(), Digikam::SavingTask::setStatus(), Digikam::LoadSaveTask::TaskTypeLoading, Digikam::LoadSaveTask::TaskTypeSaving, Digikam::DynamicThread::threadMutex(), and Digikam::LoadSaveTask::type().

Referenced by Digikam::FacePreviewLoader::cancel(), Digikam::ThumbnailLoadThread::cleanUp(), Digikam::ManagedLoadSaveThread::shutDown(), and Digikam::FacePipeline::Private::stop().

stopLoading() [1/2]

void Digikam::ManagedLoadSaveThread::stopLoading ( const LoadingDescription &  desc, LoadingTaskFilter  filter = LoadingTaskFilterAll  )

inherited

Same than previous method, but Stop and remove tasks filtered by LoadingDescription.

References Digikam::DynamicThread::threadMutex().

stopLoading() [2/2]

void Digikam::ManagedLoadSaveThread::stopLoading ( const QString &  filePath = QString(), LoadingTaskFilter  filter = LoadingTaskFilterAll  )

inherited

Stop and remove tasks filtered by filePath and policy. If filePath isNull, applies to all file paths.

References Digikam::DynamicThread::threadMutex().

Referenced by Digikam::EditorCore::load().

stopSaving()

void Digikam::ManagedLoadSaveThread::stopSaving ( const QString &  filePath = QString() )

inherited

Stop and remove saving tasks filtered by filePath. If filePath isNull, applies to all file paths.

References Digikam::SavingTask::filePath(), Digikam::LoadSaveThread::m_currentTask, Digikam::LoadSaveThread::m_todo, Digikam::SavingTask::SavingTaskStatusStopping, Digikam::SavingTask::setStatus(), Digikam::LoadSaveTask::TaskTypeSaving, Digikam::DynamicThread::threadMutex(), and Digikam::LoadSaveTask::type().

Referenced by Digikam::EditorCore::abortSaving().

taskHasFinished()

void Digikam::LoadSaveThread::taskHasFinished ( )

virtualinherited

References Digikam::LoadSaveThread::m_currentTask, and Digikam::DynamicThread::threadMutex().

Referenced by Digikam::LoadingTask::execute(), Digikam::SharedLoadingTask::execute(), Digikam::SavingTask::execute(), Digikam::PreviewLoadingTask::execute(), and Digikam::ThumbnailLoadingTask::execute().

terminationPolicy()

ManagedLoadSaveThread::TerminationPolicy Digikam::ManagedLoadSaveThread::terminationPolicy ( ) const

inherited

References Digikam::ManagedLoadSaveThread::m_terminationPolicy.

Referenced by Digikam::ManagedLoadSaveThread::setTerminationPolicy().

threadMutex()

QMutex * Digikam::DynamicThread::threadMutex ( ) const

protectedinherited

This is the non-recursive mutex used to protect state variables and waiting in this class. You can use it if you want to protect your memory in the same scope as calling start, stop or wait, then using the QMutexLocker variants below. Note that when you have locked this mutex, you must use these variants, as the mutex is non-recursive.

Referenced by Digikam::ScanStateFilter::dispatch(), Digikam::LoadSaveThread::load(), Digikam::ManagedLoadSaveThread::load(), Digikam::ManagedLoadSaveThread::loadThumbnail(), Digikam::ManagedLoadSaveThread::preloadThumbnail(), Digikam::ManagedLoadSaveThread::preloadThumbnailGroup(), Digikam::ManagedLoadSaveThread::prependThumbnailGroup(), Digikam::ScanStateFilter::process(), Digikam::LoadSaveThread::run(), Digikam::ScanStateFilter::run(), Digikam::LoadSaveThread::save(), Digikam::ManagedLoadSaveThread::save(), Digikam::ManagedLoadSaveThread::shutDown(), Digikam::ManagedLoadSaveThread::stopAllTasks(), Digikam::ManagedLoadSaveThread::stopLoading(), Digikam::ManagedLoadSaveThread::stopSaving(), and Digikam::LoadSaveThread::taskHasFinished().

thumbnailLoaded()

void Digikam::LoadSaveThread::thumbnailLoaded ( const LoadingDescription &  loadingDescription, const QImage &  img  )

overridevirtualinherited

Implements Digikam::LoadSaveNotifier.

Reimplemented in Digikam::ThumbnailLoadThread.

References Digikam::LoadSaveThread::notificationReceived(), and Digikam::LoadSaveThread::signalThumbnailLoaded().

Referenced by Digikam::ThumbnailLoadingTask::execute(), and Digikam::ThumbnailLoadThread::thumbnailLoaded().

wait [1/2]

void Digikam::DynamicThread::wait ( )

slotinherited

Waits until the thread finishes. Typically, call stop() before.

Referenced by Digikam::DImgThreadedFilter::cancelFilter(), Digikam::ThumbnailLoadThread::cleanUp(), Digikam::DynamicThread::shutDown(), Digikam::FacePreviewLoader::slotImageLoaded(), Digikam::ImageHistogram::stopCalculation(), and Digikam::FacePipeline::Private::wait().

wait() [2/2]

void Digikam::DynamicThread::wait ( QMutexLocker &  locker )

protectedinherited

Member Data Documentation

m_currentTask

LoadSaveTask* Digikam::LoadSaveThread::m_currentTask

protectedinherited

Referenced by Digikam::ManagedLoadSaveThread::load(), Digikam::ManagedLoadSaveThread::prependThumbnailGroup(), Digikam::LoadSaveThread::run(), Digikam::ManagedLoadSaveThread::save(), Digikam::ManagedLoadSaveThread::shutDown(), Digikam::ManagedLoadSaveThread::stopAllTasks(), Digikam::ManagedLoadSaveThread::stopSaving(), and Digikam::LoadSaveThread::taskHasFinished().

m_displayingWidget

QWidget* Digikam::PreviewLoadThread::m_displayingWidget

protected

Referenced by createLoadingDescription(), and setDisplayingWidget().

m_loadingPolicy

LoadingPolicy Digikam::ManagedLoadSaveThread::m_loadingPolicy

protectedinherited

Referenced by Digikam::ManagedLoadSaveThread::load(), load(), Digikam::ManagedLoadSaveThread::loadingPolicy(), PreviewLoadThread(), and Digikam::ManagedLoadSaveThread::setLoadingPolicy().

m_mutex

QMutex Digikam::LoadSaveThread::m_mutex

protectedinherited

m_notificationPolicy

NotificationPolicy Digikam::LoadSaveThread::m_notificationPolicy

protectedinherited

Referenced by Digikam::LoadSaveThread::notificationReceived(), Digikam::LoadSaveThread::querySendNotifyEvent(), Digikam::LoadSaveThread::run(), and Digikam::LoadSaveThread::setNotificationPolicy().

m_terminationPolicy

TerminationPolicy Digikam::ManagedLoadSaveThread::m_terminationPolicy

protectedinherited

Referenced by Digikam::ManagedLoadSaveThread::setTerminationPolicy(), Digikam::ManagedLoadSaveThread::shutDown(), and Digikam::ManagedLoadSaveThread::terminationPolicy().

m_todo

QList<LoadSaveTask*> Digikam::LoadSaveThread::m_todo

protectedinherited

Referenced by Digikam::LoadSaveThread::load(), Digikam::ManagedLoadSaveThread::load(), Digikam::ManagedLoadSaveThread::loadThumbnail(), Digikam::ManagedLoadSaveThread::preloadThumbnail(), Digikam::ManagedLoadSaveThread::preloadThumbnailGroup(), Digikam::ManagedLoadSaveThread::prependThumbnailGroup(), Digikam::LoadSaveThread::run(), Digikam::LoadSaveThread::save(), Digikam::ManagedLoadSaveThread::save(), Digikam::ManagedLoadSaveThread::stopAllTasks(), and Digikam::ManagedLoadSaveThread::stopSaving().

---

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

• core/libs/threadimageio/preview/previewloadthread.h
• core/libs/threadimageio/preview/previewloadthread.cpp