KisNodeProgressProxy Class Reference

#include <kis_node_progress_proxy.h>

Inheritance diagram for KisNodeProgressProxy:

Signals
void	percentageChanged (int _percentage, const KisNodeSP &_node)

Public Member Functions
bool	computePercentage ()
int	maximum () const override
int	percentage () const
	Private ()
void	setFormat (const QString &format) override
void	setRange (int minimum, int maximum) override
void	setValue (int value) override
Public Member Functions inherited from Private
	Private (KisCanvas2 *c)
Public Member Functions inherited from KoProgressProxy
virtual void	setAutoNestedName (const QString &name)
virtual	~KoProgressProxy ()

Public Attributes
int	maximum
int	minimum
KisNodeWSP	node
int	percentage
int	value
Public Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Private Member Functions
	KisNodeProgressProxy (KisNode *_node)
void	prepareDestroying ()
	~KisNodeProgressProxy () override

Private Attributes
Private *const	d

Friends
class	KisNode

Detailed Description

This class implements KoProgressProxy and allows node to report progress.

Definition at line 13 of file kis_node_progress_proxy.cpp.

Constructor & Destructor Documentation

KisNodeProgressProxy()

KisNodeProgressProxy::KisNodeProgressProxy ( KisNode * _node )

explicitprivate

Create a proxy to report progress when processing, this proxy is associated with a node, it will report progress in the node progress bar. This proxy will be deleted when _node is deleted.

Definition at line 42 of file kis_node_progress_proxy.cpp.

    : d(new Private)
{
    d->node = _node;
}

References d.

~KisNodeProgressProxy()

KisNodeProgressProxy::~KisNodeProgressProxy ( )

overrideprivate

Definition at line 48 of file kis_node_progress_proxy.cpp.

{
    delete d;
}

References d.

Member Function Documentation

computePercentage()

bool KisNodeProgressProxy::computePercentage ( )

inline

Definition at line 28 of file kis_node_progress_proxy.cpp.

                             {
        int old_percentage = percentage;
        if (value == maximum) {
            percentage = -1;
        } else if (minimum == maximum && minimum == 0) {
            percentage = 0;
        } else {
            percentage = (100 * (value - minimum)) / (maximum - minimum);
            percentage = qBound(0, percentage, 100);
        }
        return old_percentage != percentage;
    }

References value().

maximum()

int KisNodeProgressProxy::maximum ( ) const

overridevirtual

Implements KoProgressProxy.

percentage()

int KisNodeProgressProxy::percentage

(

)

const

Returns

the current percentage (return -1 if no progress)

percentageChanged

void KisNodeProgressProxy::percentageChanged ( int _percentage, const KisNodeSP & _node )

signal

Emitted when the percentage of the proxy is changed.

Parameters

_percentage	is the progress value in percent
_node	is the node that own this KisNodeProgressProxy

prepareDestroying()

void KisNodeProgressProxy::prepareDestroying ( )

private

To be called when the node is and will be no longer available and this object is going to be deleted as well.

Definition at line 53 of file kis_node_progress_proxy.cpp.

{
    d->node = 0;
}

References d.

Private()

KisNodeProgressProxy::Private ( )

inline

Definition at line 14 of file kis_node_progress_proxy.cpp.

        : minimum(0)
        , maximum(100)
        , value(100)
        , percentage(-1)
    {
    }

setFormat()

void KisNodeProgressProxy::setFormat ( const QString & format )

overridevirtual

Implements KoProgressProxy.

Definition at line 86 of file kis_node_progress_proxy.cpp.

{
    Q_UNUSED(_format);
}

setRange()

void KisNodeProgressProxy::setRange ( int minimum, int maximum )

overridevirtual

Implements KoProgressProxy.

Definition at line 77 of file kis_node_progress_proxy.cpp.

{
    d->minimum = _minimum;
    d->maximum = _maximum;
    if (d->node && d->computePercentage()) {
        emit(percentageChanged(d->percentage, d->node));
    }
}

References d, and percentageChanged().

setValue()

void KisNodeProgressProxy::setValue ( int value )

overridevirtual

Implements KoProgressProxy.

Definition at line 69 of file kis_node_progress_proxy.cpp.

{
    d->value = _value;
    if (d->node && d->computePercentage()) {
        emit(percentageChanged(d->percentage, d->node));
    }
}

References d, and percentageChanged().

Friends And Related Symbol Documentation

KisNode

friend class KisNode

friend

Definition at line 23 of file kis_node_progress_proxy.h.

Member Data Documentation

d

Private* const KisNodeProgressProxy::d

private

Definition at line 58 of file kis_node_progress_proxy.h.

maximum

int KisNodeProgressProxy::maximum

Definition at line 24 of file kis_node_progress_proxy.cpp.

minimum

int KisNodeProgressProxy::minimum

Definition at line 23 of file kis_node_progress_proxy.cpp.

node

KisNodeWSP KisNodeProgressProxy::node

Definition at line 22 of file kis_node_progress_proxy.cpp.

percentage

int KisNodeProgressProxy::percentage

Definition at line 26 of file kis_node_progress_proxy.cpp.

value

int KisNodeProgressProxy::value

Definition at line 25 of file kis_node_progress_proxy.cpp.

---

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

• libs/image/kis_node_progress_proxy.cpp
• libs/image/kis_node_progress_proxy.h