KisSynchronizedConnectionBase Class Reference

A base class for KisSynchronizedConnection. More...

#include <KisSynchronizedConnection.h>

Inheritance diagram for KisSynchronizedConnectionBase:

Static Public Member Functions
static int	eventType ()
static void	forceDeliverAllSynchronizedEvents ()
static bool	isAutoModeForUnittestsEnabled ()
static void	registerSynchronizedEventBarrier (std::function< void()> callback)
static void	setAutoModeForUnittestsEnabled (bool value)

Protected Member Functions
virtual void	deliverEventToReceiver ()=0
bool	event (QEvent *event) override
void	postEvent ()

Detailed Description

A base class for KisSynchronizedConnection.

This class implements QEvent logic for KisSynchronizedConnection. Since KisSynchronizedConnection is templated, it should be implemented fully inline, but we don't want to expose our interactions with KisApplication. Therefore we implement this logic in a separate non-templated class that will be hidden in kritaglobal.

Definition at line 48 of file KisSynchronizedConnection.h.

Member Function Documentation

deliverEventToReceiver()

virtual void KisSynchronizedConnectionBase::deliverEventToReceiver ( )

protectedpure virtual

Implemented in KisSynchronizedConnection< Args >, KisSynchronizedConnection< KisSharedPtr >, KisSynchronizedConnection< KisSharedPtr, KisNodeAdditionFlags >, KisSynchronizedConnection< KisSharedPtr, KisSharedPtr, KisSharedPtr >, and KisSynchronizedConnection< KisSharedPtr, QList >.

event()

bool KisSynchronizedConnectionBase::event ( QEvent * event )

overrideprotected

Definition at line 94 of file KisSynchronizedConnection.cpp.

{
    if (event->type() == s_instance->eventType) {
        KisSynchronizedConnectionEvent *typedEvent =
                static_cast<KisSynchronizedConnectionEvent*>(event);
 
        KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(typedEvent->destination == this, false);
        deliverEventToReceiver();
        return true;
    }
 
    return QObject::event(event);
}

References deliverEventToReceiver(), KisSynchronizedConnectionEvent::destination, event(), and KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE.

eventType()

int KisSynchronizedConnectionBase::eventType ( )

static

Definition at line 60 of file KisSynchronizedConnection.cpp.

{
    return s_instance->eventType;
}

forceDeliverAllSynchronizedEvents()

void KisSynchronizedConnectionBase::forceDeliverAllSynchronizedEvents ( )

static

We need to first make sure that all the events are delivered to the applications object and then make sure they are processed whatever the state of the recursion is (this call is called from python filters only)

Definition at line 81 of file KisSynchronizedConnection.cpp.

{
    qApp->processEvents(QEventLoop::ExcludeUserInputEvents);
    KIS_SAFE_ASSERT_RECOVER_RETURN(s_barrier->callback);
    s_barrier->callback();
}

References KIS_SAFE_ASSERT_RECOVER_RETURN.

isAutoModeForUnittestsEnabled()

bool KisSynchronizedConnectionBase::isAutoModeForUnittestsEnabled ( )

static

Definition at line 76 of file KisSynchronizedConnection.cpp.

{
    return s_instance->enableAutoModeForUnittests;
}

postEvent()

void KisSynchronizedConnectionBase::postEvent ( )

protected

TODO: check if we need s_barrier at all now!

TODO: This assert triggers in unittests that don't have a fully-featured KisApplication object. Perhaps we should add a fake callback to KISTEST_MAIN KIS_SAFE_ASSERT_RECOVER_NOOP(s_barrier->callback);

Definition at line 108 of file KisSynchronizedConnection.cpp.

{
    if (s_instance->enableAutoModeForUnittests && QThread::currentThread() == this->thread()) {
 
 
        if (s_barrier->callback) {
            s_barrier->callback();
        }
 
        deliverEventToReceiver();
    } else {
        qApp->postEvent(this, new KisSynchronizedConnectionEvent(this));
    }
}

References deliverEventToReceiver().

registerSynchronizedEventBarrier()

void KisSynchronizedConnectionBase::registerSynchronizedEventBarrier ( std::function< void()> callback )

static

Definition at line 65 of file KisSynchronizedConnection.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_NOOP(!s_barrier->callback);
    s_barrier->callback = callback;
}

References KIS_SAFE_ASSERT_RECOVER_NOOP.

setAutoModeForUnittestsEnabled()

void KisSynchronizedConnectionBase::setAutoModeForUnittestsEnabled ( bool value )

static

In unittests the connection should work in 'Auto' mode, because most of the actions are executed in the GUI thread, and (usually) don't have an event loop at all

Default value: false

Definition at line 71 of file KisSynchronizedConnection.cpp.

{
    s_instance->enableAutoModeForUnittests = value;
}

References value().

---

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

• libs/global/KisSynchronizedConnection.h
• libs/global/KisSynchronizedConnection.cpp