KisRootSurfaceInfoProxy Class Reference

#include <KisRootSurfaceInfoProxy.h>

Inheritance diagram for KisRootSurfaceInfoProxy:

Signals
void	sigRootSurfaceProfileChanged (const KoColorProfile *profile) const

Public Member Functions
QString	colorManagementReport () const
bool	isReady () const
	KisRootSurfaceInfoProxy (QWidget *watched, QObject *parent=nullptr)
QString	osPreferredColorSpaceReport () const
const KoColorProfile *	rootSurfaceProfile () const
	~KisRootSurfaceInfoProxy ()

Private Member Functions
bool	eventFilter (QObject *watched, QEvent *event) override
QVector< QPointer< QObject > >	getCurrentHierarchy (QWidget *wdg)
void	reconnectToHierarchy (const QVector< QPointer< QObject > > newHierarchy)
void	tryReconnectSurfaceManager ()
void	tryUpdateHierarchy ()
void	tryUpdateRootSurfaceProfile ()

Private Attributes
QPointer< QObject >	m_childChangedFilter
const KoColorProfile *	m_rootSurfaceProfile {nullptr}
QMetaObject::Connection	m_surfaceManagerConnection
QPointer< QWindow >	m_topLevelNativeWindow
QPointer< KisSRGBSurfaceColorSpaceManager >	m_topLevelSurfaceManager
QPointer< QWidget >	m_topLevelWidgetWithSurface
QWidget *	m_watched {nullptr}
QVector< QPointer< QObject > >	m_watchedHierarchy

Detailed Description

KisRootSurfaceInfoProxy is a special proxy object for the surface color management information of the widget.

When created, the proxy does the following:

1) Finds the top-level widget that watched belongs to. (is watched changed its parent in the meantime, e.g. during construction, then the proxy will handle that as well)

2) Finds the QWindow that this toplevel widget is painted on (if platform window is not created yet, subscribes to QPlatformSurfaceEvent to attach when platform window is finally created)

3) Finds KisSRGBSurfaceColorSpaceManager object attached to this window. This object is usually attached with an event filter in KisApplication to all windows not having a special property (if the manager is not yet attached, tracks its addition by filtering QChildEvent)

4) Finally, connects to the manager and forwards its sigDisplayConfigChanged() to local sigRootSurfaceProfileChanged()

Definition at line 45 of file KisRootSurfaceInfoProxy.h.

Constructor & Destructor Documentation

KisRootSurfaceInfoProxy()

KisRootSurfaceInfoProxy::KisRootSurfaceInfoProxy	(	QWidget *	watched,
		QObject *	parent = nullptr )

Definition at line 50 of file KisRootSurfaceInfoProxy.cpp.

    : QObject(parent)
    , m_watched(watched)
{
    KIS_SAFE_ASSERT_RECOVER_RETURN(KisPlatformPluginInterfaceFactory::instance()->surfaceColorManagedByOS());
    m_rootSurfaceProfile = KoColorSpaceRegistry::instance()->p709SRGBProfile();
    tryUpdateHierarchy();
}

References KoColorSpaceRegistry::instance(), KisPlatformPluginInterfaceFactory::instance(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_rootSurfaceProfile, KoColorSpaceRegistry::p709SRGBProfile(), and tryUpdateHierarchy().

~KisRootSurfaceInfoProxy()

KisRootSurfaceInfoProxy::~KisRootSurfaceInfoProxy

(

)

Definition at line 59 of file KisRootSurfaceInfoProxy.cpp.

{
}

Member Function Documentation

colorManagementReport()

QString KisRootSurfaceInfoProxy::colorManagementReport

(

)

const

Definition at line 73 of file KisRootSurfaceInfoProxy.cpp.

{
    return m_topLevelSurfaceManager ? m_topLevelSurfaceManager->colorManagementReport()
                                    : QString("Top level surface color manager is not found!\n");
}

References m_topLevelSurfaceManager.

eventFilter()

bool KisRootSurfaceInfoProxy::eventFilter ( QObject * watched, QEvent * event )

overrideprivate

Definition at line 85 of file KisRootSurfaceInfoProxy.cpp.

{
    if (event->type() == QEvent::ParentChange && m_watchedHierarchy.contains(watched)) {
        tryUpdateHierarchy();
    }
 
    if (event->type() == QEvent::PlatformSurface && watched == m_watchedHierarchy.last().data()) {
        tryReconnectSurfaceManager();
    }
 
    return false;
}

References m_watchedHierarchy, tryReconnectSurfaceManager(), and tryUpdateHierarchy().

getCurrentHierarchy()

QVector< QPointer< QObject > > KisRootSurfaceInfoProxy::getCurrentHierarchy ( QWidget * wdg )

private

Definition at line 182 of file KisRootSurfaceInfoProxy.cpp.

{
    QVector<QPointer<QObject>> result;
 
    while (wdg) {
        result.append(wdg);
        wdg = wdg->parentWidget();
    }
 
    return result;
}

isReady()

bool KisRootSurfaceInfoProxy::isReady

(

)

const

Definition at line 68 of file KisRootSurfaceInfoProxy.cpp.

{
    return m_topLevelSurfaceManager && m_topLevelSurfaceManager->isReady();
}

References m_topLevelSurfaceManager.

osPreferredColorSpaceReport()

QString KisRootSurfaceInfoProxy::osPreferredColorSpaceReport

(

)

const

Definition at line 79 of file KisRootSurfaceInfoProxy.cpp.

{
    return m_topLevelSurfaceManager ? m_topLevelSurfaceManager->osPreferredColorSpaceReport()
                                    : QString("Top level surface color manager is not found!\n");
}

References m_topLevelSurfaceManager.

reconnectToHierarchy()

void KisRootSurfaceInfoProxy::reconnectToHierarchy ( const QVector< QPointer< QObject > > newHierarchy )

private

Definition at line 194 of file KisRootSurfaceInfoProxy.cpp.

{
    Q_FOREACH (QPointer<QObject> widget, m_watchedHierarchy) {
        KIS_SAFE_ASSERT_RECOVER(widget) continue;
        widget->removeEventFilter(this);
    }
 
    m_watchedHierarchy.clear();
 
    Q_FOREACH (QPointer<QObject> widget, newHierarchy) {
        widget->installEventFilter(this);
    }
 
    m_watchedHierarchy = newHierarchy;
}

References KIS_SAFE_ASSERT_RECOVER, and m_watchedHierarchy.

rootSurfaceProfile()

const KoColorProfile * KisRootSurfaceInfoProxy::rootSurfaceProfile

(

)

const

Definition at line 63 of file KisRootSurfaceInfoProxy.cpp.

{
    return m_rootSurfaceProfile;
}

References m_rootSurfaceProfile.

sigRootSurfaceProfileChanged

void KisRootSurfaceInfoProxy::sigRootSurfaceProfileChanged ( const KoColorProfile * profile ) const

signal

tryReconnectSurfaceManager()

void KisRootSurfaceInfoProxy::tryReconnectSurfaceManager ( )

private

Definition at line 111 of file KisRootSurfaceInfoProxy.cpp.

{
    auto disconnectExistingManager = [this]() {
        m_topLevelSurfaceManager.clear();
        if (m_surfaceManagerConnection) {
            disconnect(m_surfaceManagerConnection);
        }
    };
 
    if (!m_topLevelWidgetWithSurface) {
        disconnectExistingManager();
        tryUpdateRootSurfaceProfile();
        return;
    }
 
    QWindow *nativeWindow = m_topLevelWidgetWithSurface->windowHandle();
 
    if (nativeWindow != m_topLevelNativeWindow) {
        if (m_childChangedFilter && m_topLevelNativeWindow) {
            m_topLevelNativeWindow->removeEventFilter(m_childChangedFilter);
            m_childChangedFilter->deleteLater();
            m_childChangedFilter.clear();
        }
 
        m_topLevelNativeWindow = nativeWindow;
 
        if (m_topLevelNativeWindow) {
            auto *filter = new ChildChangedEventFilter(m_topLevelNativeWindow, m_topLevelNativeWindow);
            connect(filter,
                    &ChildChangedEventFilter::sigChildrenChanged,
                    this,
                    &KisRootSurfaceInfoProxy::tryReconnectSurfaceManager);
            m_childChangedFilter = filter;
            m_topLevelNativeWindow->installEventFilter(m_childChangedFilter);
        }
    }
 
    if (nativeWindow) {
        if (auto manager = nativeWindow->findChild<KisSRGBSurfaceColorSpaceManager *>()) {
            if (manager != m_topLevelSurfaceManager) {
                disconnectExistingManager();
                m_topLevelSurfaceManager = manager;
                m_surfaceManagerConnection = connect(m_topLevelSurfaceManager,
                                                     &KisSRGBSurfaceColorSpaceManager::sigDisplayConfigChanged,
                                                     this,
                                                     &KisRootSurfaceInfoProxy::tryUpdateRootSurfaceProfile);
                tryUpdateRootSurfaceProfile();
            }
        }
    } else {
        disconnectExistingManager();
        tryUpdateRootSurfaceProfile();
    }
}

References connect(), m_childChangedFilter, m_surfaceManagerConnection, m_topLevelNativeWindow, m_topLevelSurfaceManager, m_topLevelWidgetWithSurface, KisCanvasSurfaceColorSpaceManager::sigDisplayConfigChanged(), tryReconnectSurfaceManager(), and tryUpdateRootSurfaceProfile().

tryUpdateHierarchy()

void KisRootSurfaceInfoProxy::tryUpdateHierarchy ( )

private

Definition at line 98 of file KisRootSurfaceInfoProxy.cpp.

{
    auto newHierarchy = getCurrentHierarchy(m_watched);
    if (newHierarchy != m_watchedHierarchy) {
        reconnectToHierarchy(newHierarchy);
        QWidget *topLevel = static_cast<QWidget *>(newHierarchy.last().data());
        if (topLevel != m_topLevelWidgetWithSurface) {
            m_topLevelWidgetWithSurface = topLevel;
            tryReconnectSurfaceManager();
        }
    }
}

References getCurrentHierarchy(), m_topLevelWidgetWithSurface, m_watched, m_watchedHierarchy, reconnectToHierarchy(), and tryReconnectSurfaceManager().

tryUpdateRootSurfaceProfile()

void KisRootSurfaceInfoProxy::tryUpdateRootSurfaceProfile ( )

private

Definition at line 166 of file KisRootSurfaceInfoProxy.cpp.

{
    const KoColorProfile *newProfile = KoColorSpaceRegistry::instance()->p709SRGBProfile();
 
    if (m_topLevelSurfaceManager) {
        newProfile = m_topLevelSurfaceManager->displayConfig().profile;
    }
 
    KIS_SAFE_ASSERT_RECOVER_RETURN(newProfile);
 
    if (newProfile != m_rootSurfaceProfile) {
        m_rootSurfaceProfile = newProfile;
        Q_EMIT sigRootSurfaceProfileChanged(m_rootSurfaceProfile);
    }
}

References KoColorSpaceRegistry::instance(), KIS_SAFE_ASSERT_RECOVER_RETURN, m_rootSurfaceProfile, m_topLevelSurfaceManager, KoColorSpaceRegistry::p709SRGBProfile(), and sigRootSurfaceProfileChanged().

Member Data Documentation

m_childChangedFilter

QPointer<QObject> KisRootSurfaceInfoProxy::m_childChangedFilter

private

Definition at line 79 of file KisRootSurfaceInfoProxy.h.

m_rootSurfaceProfile

const KoColorProfile* KisRootSurfaceInfoProxy::m_rootSurfaceProfile {nullptr}

private

Definition at line 84 of file KisRootSurfaceInfoProxy.h.

{nullptr};

m_surfaceManagerConnection

QMetaObject::Connection KisRootSurfaceInfoProxy::m_surfaceManagerConnection

private

Definition at line 82 of file KisRootSurfaceInfoProxy.h.

m_topLevelNativeWindow

QPointer<QWindow> KisRootSurfaceInfoProxy::m_topLevelNativeWindow

private

Definition at line 78 of file KisRootSurfaceInfoProxy.h.

m_topLevelSurfaceManager

QPointer<KisSRGBSurfaceColorSpaceManager> KisRootSurfaceInfoProxy::m_topLevelSurfaceManager

private

Definition at line 81 of file KisRootSurfaceInfoProxy.h.

m_topLevelWidgetWithSurface

QPointer<QWidget> KisRootSurfaceInfoProxy::m_topLevelWidgetWithSurface

private

Definition at line 76 of file KisRootSurfaceInfoProxy.h.

m_watched

QWidget* KisRootSurfaceInfoProxy::m_watched {nullptr}

private

Definition at line 73 of file KisRootSurfaceInfoProxy.h.

{nullptr};

m_watchedHierarchy

QVector<QPointer<QObject> > KisRootSurfaceInfoProxy::m_watchedHierarchy

private

Definition at line 74 of file KisRootSurfaceInfoProxy.h.

---

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

• libs/ui/KisRootSurfaceInfoProxy.h
• libs/ui/KisRootSurfaceInfoProxy.cpp