rawTherapee/rtgui/thumbimageupdater.h
2017-06-12 17:54:34 +02:00

109 lines
2.8 KiB
C++

/*
* This file is part of RawTherapee.
*
* Copyright (c) 2004-2010 Gabor Horvath <hgabor@rawtherapee.com>
*
* RawTherapee is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* RawTherapee is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with RawTherapee. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef _THUMBIMAGEUPDATER_
#define _THUMBIMAGEUPDATER_
#include <glibmm.h>
#include <glib.h>
#include "../rtengine/rtengine.h"
#include "../rtengine/noncopyable.h"
#include "thumbbrowserentrybase.h"
class ThumbImageUpdateListener
{
public:
virtual ~ThumbImageUpdateListener()
{
}
/**
* @brief Called when thumbnail image is update
*
* @param img new thumbnail image
* @param scale scale (??)
* @param cropParams how it was cropped (??)
*
* @note no locks are held when called back
*/
virtual void updateImage(rtengine::IImage8* img, double scale, rtengine::procparams::CropParams cropParams)
{
}
};
class ThumbImageUpdater :
public rtengine::NonCopyable
{
public:
/**
* @brief Singleton entry point.
*
* @return Pointer to thumbnail image updater.
*/
static ThumbImageUpdater* getInstance(void);
/**
* @brief Add an thumbnail image update request.
*
* Code will add the request to the queue and, if needed, start a pool
* thread to process it.
*
* @param t thumbnail
* @param params processing params (?)
* @param height how big
* @param priority if \c true then run as soon as possible
* @param l listener waiting on update
*/
void add(ThumbBrowserEntryBase* tbe, bool* priority, bool upgrade, ThumbImageUpdateListener* l);
/**
* @brief Remove jobs associated with listener \c l.
*
* Jobs being processed will be finished. Will not return till all jobs for
* \c l have been completed.
*
* @param listener jobs associated with this will be stopped
*/
void removeJobs(ThumbImageUpdateListener* listener);
/**
* @brief Stop processing and remove all jobs.
*
* Will not return till all running jobs have completed.
*/
void removeAllJobs(void);
private:
ThumbImageUpdater();
class Impl;
Impl* impl_;
};
/**
* @brief Singleton boiler plate.
*
* To use: \c thumbImageUpdater->start() ,
*/
#define thumbImageUpdater ThumbImageUpdater::getInstance()
#endif