KisIdleWatcher Class Reference

#include <kis_idle_watcher.h>

Inheritance diagram for KisIdleWatcher:

Classes
struct	Private

Signals
void	imageModified ()
void	startedIdleMode ()

Public Member Functions
void	forceImageModified ()
bool	isCounting () const
bool	isIdle () const
	KisIdleWatcher (int delay=200, QObject *parent=0)
void	restartCountdown ()
void	setTrackedImage (KisImageSP image)
void	setTrackedImages (const QVector< KisImageSP > &images)
void	triggerCountdownNoDelay ()
	~KisIdleWatcher () override

Private Slots
void	slotIdleCheckTick ()
void	slotImageModified ()
void	startIdleCheck ()
void	stopIdleCheck ()

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

Definition at line 18 of file kis_idle_watcher.h.

Constructor & Destructor Documentation

KisIdleWatcher()

KisIdleWatcher::KisIdleWatcher	(	int	delay = 200,
		QObject *	parent = 0 )

Definition at line 44 of file kis_idle_watcher.cpp.

    : QObject(parent), m_d(new Private(delay, this))
{
    connect(&m_d->imageModifiedCompressor, SIGNAL(timeout()), SLOT(startIdleCheck()));
    connect(&m_d->idleCheckTimer, SIGNAL(timeout()), SLOT(slotIdleCheckTick()));
}

References connect(), m_d, slotIdleCheckTick(), and startIdleCheck().

~KisIdleWatcher()

KisIdleWatcher::~KisIdleWatcher ( )

override

Definition at line 51 of file kis_idle_watcher.cpp.

{
}

Member Function Documentation

forceImageModified()

void KisIdleWatcher::forceImageModified ( )

inline

Definition at line 32 of file kis_idle_watcher.h.

{ slotImageModified(); }

imageModified

void KisIdleWatcher::imageModified ( )

signal

isCounting()

bool KisIdleWatcher::isCounting

(

)

const

Definition at line 71 of file kis_idle_watcher.cpp.

{
    return m_d->idleCheckTimer.isActive();
}

References m_d.

isIdle()

bool KisIdleWatcher::isIdle

(

)

const

Definition at line 55 of file kis_idle_watcher.cpp.

{
    bool idle = true;
 
    Q_FOREACH (KisImageSP image, m_d->trackedImages) {
        if (!image) continue;
 
        if (!image->isIdle()) {
            idle = false;
            break;
        }
    }
 
    return idle;
}

References KisImage::isIdle(), and m_d.

restartCountdown()

void KisIdleWatcher::restartCountdown

(

)

Definition at line 100 of file kis_idle_watcher.cpp.

{
    stopIdleCheck();
    m_d->imageModifiedCompressor.start();
}

References m_d, and stopIdleCheck().

setTrackedImage()

void KisIdleWatcher::setTrackedImage

(

KisImageSP

image

)

Definition at line 93 of file kis_idle_watcher.cpp.

{
    QVector<KisImageSP> images;
    images << image;
    setTrackedImages(images);
}

References setTrackedImages().

setTrackedImages()

void KisIdleWatcher::setTrackedImages

(

const QVector< KisImageSP > &

images

)

Definition at line 76 of file kis_idle_watcher.cpp.

{
    m_d->connectionsStore.clear();
    m_d->trackedImages.clear();
 
    Q_FOREACH (KisImageSP image, images) {
        if (image) {
            m_d->trackedImages << image;
            m_d->connectionsStore.addConnection(image, SIGNAL(sigImageModified()),
                                                this, SLOT(slotImageModified()));
 
            m_d->connectionsStore.addConnection(image, SIGNAL(sigIsolatedModeChanged()),
                                                this, SLOT(slotImageModified()));
        }
    }
}

References m_d, and slotImageModified().

slotIdleCheckTick

void KisIdleWatcher::slotIdleCheckTick ( )

privateslot

Definition at line 133 of file kis_idle_watcher.cpp.

{
    if (isIdle()) {
        if (m_d->idleCheckCounter < 0 ||
            m_d->idleCheckCounter >= Private::IDLE_CHECK_COUNT) {
 
            stopIdleCheck();
            if (!m_d->trackedImages.isEmpty()) {
                Q_EMIT startedIdleMode();
            }
        } else {
            m_d->idleCheckCounter++;
            m_d->idleCheckTimer.start();
        }
    } else {
        if (m_d->idleCheckCounter >= 0) {
            restartCountdown();
        } else {
            m_d->idleCheckTimer.start();
        }
    }
}

References KisIdleWatcher::Private::IDLE_CHECK_COUNT, isIdle(), m_d, restartCountdown(), startedIdleMode(), and stopIdleCheck().

slotImageModified

void KisIdleWatcher::slotImageModified ( )

privateslot

Definition at line 113 of file kis_idle_watcher.cpp.

{
    if (m_d->idleCheckCounter >= 0) {
        restartCountdown();
    }
    Q_EMIT imageModified();
}

References imageModified(), m_d, and restartCountdown().

startedIdleMode

void KisIdleWatcher::startedIdleMode ( )

signal

startIdleCheck

void KisIdleWatcher::startIdleCheck ( )

privateslot

Definition at line 121 of file kis_idle_watcher.cpp.

{
    m_d->idleCheckCounter = 0;
    m_d->idleCheckTimer.start();
}

References m_d.

stopIdleCheck

void KisIdleWatcher::stopIdleCheck ( )

privateslot

Definition at line 127 of file kis_idle_watcher.cpp.

{
    m_d->idleCheckTimer.stop();
    m_d->idleCheckCounter = 0;
}

References m_d.

triggerCountdownNoDelay()

void KisIdleWatcher::triggerCountdownNoDelay

(

)

Definition at line 106 of file kis_idle_watcher.cpp.

{
    stopIdleCheck();
    m_d->idleCheckCounter = -1;
    m_d->idleCheckTimer.start();
}

References m_d, and stopIdleCheck().

Member Data Documentation

m_d

const QScopedPointer<Private> KisIdleWatcher::m_d

private

Definition at line 49 of file kis_idle_watcher.h.

---

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

• libs/image/kis_idle_watcher.h
• libs/image/kis_idle_watcher.cpp