KisRootSurfaceTrackerBase Class Reference

#include <KisRootSurfaceTrackerBase.h>

Inheritance diagram for KisRootSurfaceTrackerBase:

Public Member Functions
	KisRootSurfaceTrackerBase (QWidget *watched, QObject *parent=nullptr)
QWidget *	trackedWidget () const
	~KisRootSurfaceTrackerBase ()

Protected Member Functions
virtual void	connectToNativeWindow (QWindow *nativeWindow)=0
virtual void	disconnectFromNativeWindow ()=0
void	initialize ()

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

Private Attributes
QPointer< QObject >	m_childChangedFilter
QPointer< QWindow >	m_topLevelNativeWindow
QPointer< QWidget >	m_topLevelWidgetWithSurface
QWidget *	m_watched {nullptr}
QVector< QPointer< QObject > >	m_watchedHierarchy

Detailed Description

KisRootSurfaceProxyBase is a special proxy object for toplevel native window attached to the current QWidget

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) When found, calls implementation of connectToNativeWindow() that would connect to the actual native window

Definition at line 37 of file KisRootSurfaceTrackerBase.h.

Constructor & Destructor Documentation

KisRootSurfaceTrackerBase()

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

Definition at line 50 of file KisRootSurfaceTrackerBase.cpp.

    : QObject(parent)
    , m_watched(watched)
{
}

~KisRootSurfaceTrackerBase()

KisRootSurfaceTrackerBase::~KisRootSurfaceTrackerBase

(

)

Definition at line 56 of file KisRootSurfaceTrackerBase.cpp.

{
}

Member Function Documentation

connectToNativeWindow()

virtual void KisRootSurfaceTrackerBase::connectToNativeWindow ( QWindow * nativeWindow )

protectedpure virtual

Implemented in KisRootSurfaceInfoProxy, and KisScreenMigrationTracker.

disconnectFromNativeWindow()

virtual void KisRootSurfaceTrackerBase::disconnectFromNativeWindow ( )

protectedpure virtual

Implemented in KisRootSurfaceInfoProxy, and KisScreenMigrationTracker.

eventFilter()

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

overrideprivate

Definition at line 70 of file KisRootSurfaceTrackerBase.cpp.

{
    if (event->type() == QEvent::ParentChange && m_watchedHierarchy.contains(watched)) {
        tryUpdateHierarchy();
    }
 
    if (event->type() == QEvent::PlatformSurface) {
        if (watched == m_watchedHierarchy.last().data()) {
            tryReconnectToNativeWindow();
        } else {
            // some widget in the middle of the hierarchy just received
            // a native window. Let's promote that to toplevel now!
            tryUpdateHierarchy();
        }
    }
 
    return false;
}

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

getCurrentHierarchy()

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

private

Definition at line 138 of file KisRootSurfaceTrackerBase.cpp.

{
    QVector<QPointer<QObject>> result;
 
    while (wdg) {
        result.append(wdg);
 
        // break on the first native window
        if (wdg->windowHandle()) {
            break;
        } else {
            wdg = wdg->parentWidget();
        }
    }
 
    return result;
}

initialize()

void KisRootSurfaceTrackerBase::initialize ( )

protected

Definition at line 65 of file KisRootSurfaceTrackerBase.cpp.

{
    tryUpdateHierarchy();
}

References tryUpdateHierarchy().

reconnectToHierarchy()

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

private

Definition at line 156 of file KisRootSurfaceTrackerBase.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.

trackedWidget()

QWidget * KisRootSurfaceTrackerBase::trackedWidget

(

)

const

Definition at line 60 of file KisRootSurfaceTrackerBase.cpp.

{
    return m_watched;
}

References m_watched.

tryReconnectToNativeWindow()

void KisRootSurfaceTrackerBase::tryReconnectToNativeWindow ( )

private

Definition at line 102 of file KisRootSurfaceTrackerBase.cpp.

{
    if (!m_topLevelWidgetWithSurface) {
        disconnectFromNativeWindow();
        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,
                    &KisRootSurfaceTrackerBase::tryReconnectToNativeWindow);
            m_childChangedFilter = filter;
            m_topLevelNativeWindow->installEventFilter(m_childChangedFilter);
        }
    }
 
    if (nativeWindow) {
        connectToNativeWindow(nativeWindow);
    } else {
        disconnectFromNativeWindow();
    }
}

References connectToNativeWindow(), disconnectFromNativeWindow(), m_childChangedFilter, m_topLevelNativeWindow, m_topLevelWidgetWithSurface, and tryReconnectToNativeWindow().

tryUpdateHierarchy()

void KisRootSurfaceTrackerBase::tryUpdateHierarchy ( )

private

Definition at line 89 of file KisRootSurfaceTrackerBase.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;
            tryReconnectToNativeWindow();
        }
    }
}

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

Member Data Documentation

m_childChangedFilter

QPointer<QObject> KisRootSurfaceTrackerBase::m_childChangedFilter

private

Definition at line 69 of file KisRootSurfaceTrackerBase.h.

m_topLevelNativeWindow

QPointer<QWindow> KisRootSurfaceTrackerBase::m_topLevelNativeWindow

private

Definition at line 68 of file KisRootSurfaceTrackerBase.h.

m_topLevelWidgetWithSurface

QPointer<QWidget> KisRootSurfaceTrackerBase::m_topLevelWidgetWithSurface

private

Definition at line 66 of file KisRootSurfaceTrackerBase.h.

m_watched

QWidget* KisRootSurfaceTrackerBase::m_watched {nullptr}

private

Definition at line 63 of file KisRootSurfaceTrackerBase.h.

{nullptr};

m_watchedHierarchy

QVector<QPointer<QObject> > KisRootSurfaceTrackerBase::m_watchedHierarchy

private

Definition at line 64 of file KisRootSurfaceTrackerBase.h.

---

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

• libs/widgetutils/KisRootSurfaceTrackerBase.h
• libs/widgetutils/KisRootSurfaceTrackerBase.cpp