#include <kis_progress_updater.h>

Inheritance diagram for KisProgressUpdater:

Public Member Functions
	KisProgressUpdater (KisProgressInterface progressInterface, KoProgressProxy proxy, KoProgressUpdater::Mode mode=KoProgressUpdater::Threaded)

	~KisProgressUpdater () override

Public Member Functions inherited from KoProgressUpdater
bool	autoNestNames () const

void	clearState ()

bool	interrupted () const

	KoProgressUpdater (KoProgressProxy *progressProxy, Mode mode=Threaded)

	KoProgressUpdater (QPointer< KoUpdater > updater)
	a special constructor for connecting the progress updater to a self-destructible KoUpdater object.

	Private (KoProgressUpdater _q, KoProgressProxy proxy, QPointer< KoUpdater > parentUpdater, Mode _mode)

KoProgressProxy *	progressProxy ()

void	removePersistentSubtask (QPointer< KoUpdater > updater)

void	setAutoNestNames (bool value)

void	setUpdateInterval (int ms)

void	start (int range=100, const QString &text="")

QPointer< KoUpdater >	startSubtask (int weight=1, const QString &name=QString(), bool isPersistent=false)

int	updateInterval () const

void	updateParentText ()

	~KoProgressUpdater () override
	destructor

Private Attributes
KisProgressInterface *	m_interface

Additional Inherited Members
Public Types inherited from KoProgressUpdater
enum	Mode { Threaded , Unthreaded }

Public Slots inherited from KoProgressUpdater
void	cancel ()

Signals inherited from KoProgressUpdater
void	triggerUpdateAsynchronously ()

Public Attributes inherited from KoProgressUpdater
bool	autoNestNames = false

bool	canceled

int	currentProgress = 0

bool	isStarted = false

bool	isUndefinedState = false

Mode	mode

QMutex	mutex

KoProgressUpdater *	q

QList< QPointer< KoUpdaterPrivate > >	subtasks

int	taskMax = 99

QString	taskName

KisSignalCompressor *	updateCompressor

int	updateInterval = 250

Detailed Description

KisProgressUpdater is an updater that disengages itself automatically from the updater widget when done.

Definition at line 29 of file kis_progress_updater.h.

Constructor & Destructor Documentation

◆ KisProgressUpdater()

KisProgressUpdater::KisProgressUpdater	(	KisProgressInterface *	progressInterface,
		KoProgressProxy *	proxy,
		KoProgressUpdater::Mode	mode = KoProgressUpdater::Threaded )

Definition at line 10 of file kis_progress_updater.cpp.

    : KoProgressUpdater(proxy, mode)
    , m_interface(progressInterface)
{
    Q_ASSERT(progressInterface);
    Q_ASSERT(proxy);
    m_interface->attachUpdater(this);
}

References KisProgressInterface::attachUpdater(), and m_interface.

◆ ~KisProgressUpdater()

KisProgressUpdater::~KisProgressUpdater ( )

override

Definition at line 19 of file kis_progress_updater.cpp.

{
    m_interface->detachUpdater(this);
}

References KisProgressInterface::detachUpdater(), and m_interface.

Member Data Documentation

◆ m_interface

KisProgressInterface* KisProgressUpdater::m_interface

private

Definition at line 36 of file kis_progress_updater.h.

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

libs/image/kis_progress_updater.h
libs/image/kis_progress_updater.cpp

Public Member Functions