KisQmlPopupWidgetManager Class Reference

The KisQmlPopupWidgetManager class This encapsulates a KisQQuickPopupWidget.h class, so it can be used from QML. More...

#include <KisQmlPopupWidgetManager.h>

Inheritance diagram for KisQmlPopupWidgetManager:

Classes
struct	Private

Signals
void	bottomMarginChanged ()
void	itemParentChanged ()
void	leftMarginChanged ()
void	marginsChanged ()
void	rightMarginChanged ()
void	rootControlChanged ()
void	topMarginChanged ()
void	visibleChanged ()
void	xChanged ()
void	yChanged ()

Public Member Functions
qreal	bottomMargin () const
Q_INVOKABLE void	close ()
QQuickItem *	itemParent () const
	KisQmlPopupWidgetManager (QObject *parent=nullptr)
qreal	leftMargin () const
qreal	margins () const
	margins Popup qml component has margins, so we implement those in here too.
Q_INVOKABLE void	open ()
Q_INVOKABLE void	releaseKeyboard ()
void	resetBottomMargin ()
void	resetLeftMargin ()
void	resetRightMargin ()
void	resetTopMargin ()
qreal	rightMargin () const
QQuickItem *	rootControl () const
void	setBottomMargin (const qreal value)
void	setItemParent (QQuickItem *item)
void	setLeftMargin (const qreal value)
void	setMargins (const qreal value)
void	setRightMargin (const qreal value)
void	setTopMargin (const qreal value)
void	setX (const qreal value)
void	setY (const qreal value)
qreal	topMargin () const
bool	visible () const
qreal	x () const
qreal	y () const
	~KisQmlPopupWidgetManager ()

Properties
qreal	bottomMargin
qreal	leftMargin
qreal	margins
QQuickItem *	parent
qreal	rightMargin
QQuickItem *	rootControl
qreal	topMargin
bool	visible
qreal	x
qreal	y

Private Slots
void	updateMargins ()

Private Attributes
QScopedPointer< Private >	d

Detailed Description

The KisQmlPopupWidgetManager class This encapsulates a KisQQuickPopupWidget.h class, so it can be used from QML.

QQuickWidgets don't allow popups to go outside their bounds, so this class is essentially working around that by using a KisQQuickPopupWidget to wrap the content item in.

Definition at line 21 of file KisQmlPopupWidgetManager.h.

Constructor & Destructor Documentation

KisQmlPopupWidgetManager()

KisQmlPopupWidgetManager::KisQmlPopupWidgetManager ( QObject * parent = nullptr )

explicit

Definition at line 27 of file KisQmlPopupWidgetManager.cpp.

    : QObject(parent)
    , d(new Private)
{
    d->popup = new KisQQuickPopupWidget();
 
    connect(this, SIGNAL(marginsChanged()), this, SLOT(updateMargins()));
    connect(this, SIGNAL(topMarginChanged()), this, SLOT(updateMargins()));
    connect(this, SIGNAL(leftMarginChanged()), this, SLOT(updateMargins()));
    connect(this, SIGNAL(rightMarginChanged()), this, SLOT(updateMargins()));
    connect(this, SIGNAL(bottomMarginChanged()), this, SLOT(updateMargins()));
    connect(d->popup, SIGNAL(signalRootObjectReady()), this, SIGNAL(rootControlChanged()));
}

References bottomMarginChanged(), d, leftMarginChanged(), marginsChanged(), rightMarginChanged(), rootControlChanged(), topMarginChanged(), and updateMargins().

~KisQmlPopupWidgetManager()

KisQmlPopupWidgetManager::~KisQmlPopupWidgetManager

(

)

Definition at line 41 of file KisQmlPopupWidgetManager.cpp.

{
    d->popup->deleteLater();
}

References d.

Member Function Documentation

bottomMargin()

qreal KisQmlPopupWidgetManager::bottomMargin

(

)

const

Definition at line 104 of file KisQmlPopupWidgetManager.cpp.

{
    return (d->bottomMargin)? d->bottomMargin.value(): d->margins;
}

References d.

bottomMarginChanged

void KisQmlPopupWidgetManager::bottomMarginChanged ( )

signal

close()

void KisQmlPopupWidgetManager::close

(

)

Definition at line 194 of file KisQmlPopupWidgetManager.cpp.

{
    d->popup->hide();
    Q_EMIT visibleChanged();
}

References d, and visibleChanged().

itemParent()

QQuickItem * KisQmlPopupWidgetManager::itemParent

(

)

const

Definition at line 70 of file KisQmlPopupWidgetManager.cpp.

{
    return d->itemParent;
}

References d.

itemParentChanged

void KisQmlPopupWidgetManager::itemParentChanged ( )

signal

leftMargin()

qreal KisQmlPopupWidgetManager::leftMargin

(

)

const

Definition at line 109 of file KisQmlPopupWidgetManager.cpp.

{
    return (d->leftMargin)? d->leftMargin.value(): d->margins;
}

References d.

leftMarginChanged

void KisQmlPopupWidgetManager::leftMarginChanged ( )

signal

margins()

qreal KisQmlPopupWidgetManager::margins

(

)

const

margins Popup qml component has margins, so we implement those in here too.

Definition at line 87 of file KisQmlPopupWidgetManager.cpp.

{
    return d->margins;
}

References d.

marginsChanged

void KisQmlPopupWidgetManager::marginsChanged ( )

signal

open()

void KisQmlPopupWidgetManager::open

(

)

Definition at line 180 of file KisQmlPopupWidgetManager.cpp.

{
    if (!d->itemParent) {
        qWarning() << "Parent not set! PopupWidget requires parent to be explicitely set!";
        return;
    }
    d->popup->raise();
    d->popup->show();
    d->popup->move(d->itemParent->mapToGlobal(QPointF(d->x, d->y)).toPoint());
    // The following is probably causing issues with keyboard focus :(
    d->popup->activateWindow();
    Q_EMIT visibleChanged();
}

References d, and visibleChanged().

releaseKeyboard()

void KisQmlPopupWidgetManager::releaseKeyboard

(

)

Definition at line 200 of file KisQmlPopupWidgetManager.cpp.

{
    d->popup->releaseKeyboard();
}

References d.

resetBottomMargin()

void KisQmlPopupWidgetManager::resetBottomMargin

(

)

Definition at line 170 of file KisQmlPopupWidgetManager.cpp.

{
    d->bottomMargin = std::nullopt;
}

References d.

resetLeftMargin()

void KisQmlPopupWidgetManager::resetLeftMargin

(

)

Definition at line 160 of file KisQmlPopupWidgetManager.cpp.

{
    d->leftMargin = std::nullopt;
}

References d.

resetRightMargin()

void KisQmlPopupWidgetManager::resetRightMargin

(

)

Definition at line 165 of file KisQmlPopupWidgetManager.cpp.

{
    d->rightMargin = std::nullopt;
}

References d.

resetTopMargin()

void KisQmlPopupWidgetManager::resetTopMargin

(

)

Definition at line 155 of file KisQmlPopupWidgetManager.cpp.

{
    d->topMargin = std::nullopt;
}

References d.

rightMargin()

qreal KisQmlPopupWidgetManager::rightMargin

(

)

const

Definition at line 114 of file KisQmlPopupWidgetManager.cpp.

{
    return (d->rightMargin)? d->rightMargin.value(): d->margins;
}

References d.

rightMarginChanged

void KisQmlPopupWidgetManager::rightMarginChanged ( )

signal

rootControl()

QQuickItem * KisQmlPopupWidgetManager::rootControl

(

)

const

Definition at line 82 of file KisQmlPopupWidgetManager.cpp.

{
    return d->popup->rootObject();
}

References d.

rootControlChanged

void KisQmlPopupWidgetManager::rootControlChanged ( )

signal

setBottomMargin()

void KisQmlPopupWidgetManager::setBottomMargin

(

const qreal

value

)

Definition at line 146 of file KisQmlPopupWidgetManager.cpp.

{
    if (d->bottomMargin) {
        if (qFuzzyCompare(d->bottomMargin.value(), value)) return;
    }
    d->bottomMargin = std::make_optional(value);
    Q_EMIT bottomMarginChanged();
}

References bottomMarginChanged(), d, qFuzzyCompare(), and value().

setItemParent()

void KisQmlPopupWidgetManager::setItemParent

(

QQuickItem *

item

)

Definition at line 75 of file KisQmlPopupWidgetManager.cpp.

{
    if(d->itemParent == item) return;
    d->itemParent = item;
    Q_EMIT itemParentChanged();
}

References d, and itemParentChanged().

setLeftMargin()

void KisQmlPopupWidgetManager::setLeftMargin

(

const qreal

value

)

Definition at line 137 of file KisQmlPopupWidgetManager.cpp.

{
    if (d->leftMargin) {
        if (qFuzzyCompare(d->leftMargin.value(), value)) return;
    }
    d->leftMargin = std::make_optional(value);
    Q_EMIT leftMarginChanged();
}

References d, leftMarginChanged(), qFuzzyCompare(), and value().

setMargins()

void KisQmlPopupWidgetManager::setMargins

(

const qreal

value

)

Definition at line 92 of file KisQmlPopupWidgetManager.cpp.

{
    if (qFuzzyCompare(d->margins, value)) return;
    d->margins = value;
    Q_EMIT marginsChanged();
}

References d, marginsChanged(), qFuzzyCompare(), and value().

setRightMargin()

void KisQmlPopupWidgetManager::setRightMargin

(

const qreal

value

)

Definition at line 128 of file KisQmlPopupWidgetManager.cpp.

{
    if (d->rightMargin) {
        if (qFuzzyCompare(d->rightMargin.value(), value)) return;
    }
    d->rightMargin = std::make_optional(value);
    Q_EMIT rightMarginChanged();
}

References d, qFuzzyCompare(), rightMarginChanged(), and value().

setTopMargin()

void KisQmlPopupWidgetManager::setTopMargin

(

const qreal

value

)

Definition at line 119 of file KisQmlPopupWidgetManager.cpp.

{
    if (d->topMargin) {
        if (qFuzzyCompare(d->topMargin.value(), value)) return;
    }
    d->topMargin = std::make_optional(value);
    Q_EMIT topMarginChanged();
}

References d, qFuzzyCompare(), topMarginChanged(), and value().

setX()

void KisQmlPopupWidgetManager::setX

(

const qreal

value

)

Definition at line 51 of file KisQmlPopupWidgetManager.cpp.

{
    if (qFuzzyCompare(d->x, value)) return;
    d->x = value;
    Q_EMIT xChanged();
}

References d, qFuzzyCompare(), value(), and xChanged().

setY()

void KisQmlPopupWidgetManager::setY

(

const qreal

value

)

Definition at line 63 of file KisQmlPopupWidgetManager.cpp.

{
    if (qFuzzyCompare(d->y, value)) return;
    d->y = value;
    Q_EMIT yChanged();
}

References d, qFuzzyCompare(), value(), and yChanged().

topMargin()

qreal KisQmlPopupWidgetManager::topMargin

(

)

const

Definition at line 99 of file KisQmlPopupWidgetManager.cpp.

{
    return (d->topMargin)? d->topMargin.value(): d->margins;
}

References d.

topMarginChanged

void KisQmlPopupWidgetManager::topMarginChanged ( )

signal

updateMargins

void KisQmlPopupWidgetManager::updateMargins ( )

privateslot

Definition at line 205 of file KisQmlPopupWidgetManager.cpp.

{
    QMargins margins;
    margins.setTop(qRound(topMargin()));
    margins.setLeft(qRound(leftMargin()));
    margins.setRight(qRound(rightMargin()));
    margins.setBottom(qRound(bottomMargin()));
    d->popup->setLayoutMargins(margins);
}

References bottomMargin, d, leftMargin, margins, rightMargin, and topMargin.

visible()

bool KisQmlPopupWidgetManager::visible

(

)

const

Definition at line 175 of file KisQmlPopupWidgetManager.cpp.

{
    return d->popup->isVisible();
}

References d.

visibleChanged

void KisQmlPopupWidgetManager::visibleChanged ( )

signal

x()

qreal KisQmlPopupWidgetManager::x

(

)

const

Definition at line 46 of file KisQmlPopupWidgetManager.cpp.

{
    return d->x;
}

References d.

xChanged

void KisQmlPopupWidgetManager::xChanged ( )

signal

y()

qreal KisQmlPopupWidgetManager::y

(

)

const

Definition at line 58 of file KisQmlPopupWidgetManager.cpp.

{
    return d->y;
}

References d.

yChanged

void KisQmlPopupWidgetManager::yChanged ( )

signal

Member Data Documentation

d

QScopedPointer<Private> KisQmlPopupWidgetManager::d

private

Definition at line 99 of file KisQmlPopupWidgetManager.h.

Property Documentation

bottomMargin

qreal KisQmlPopupWidgetManager::bottomMargin

readwrite

Definition at line 35 of file KisQmlPopupWidgetManager.h.

leftMargin

qreal KisQmlPopupWidgetManager::leftMargin

readwrite

Definition at line 33 of file KisQmlPopupWidgetManager.h.

margins

qreal KisQmlPopupWidgetManager::margins

readwrite

Definition at line 31 of file KisQmlPopupWidgetManager.h.

parent

QQuickItem* KisQmlPopupWidgetManager::parent

readwrite

Definition at line 28 of file KisQmlPopupWidgetManager.h.

rightMargin

qreal KisQmlPopupWidgetManager::rightMargin

readwrite

Definition at line 34 of file KisQmlPopupWidgetManager.h.

rootControl

QQuickItem* KisQmlPopupWidgetManager::rootControl

read

Definition at line 29 of file KisQmlPopupWidgetManager.h.

topMargin

qreal KisQmlPopupWidgetManager::topMargin

readwrite

Definition at line 32 of file KisQmlPopupWidgetManager.h.

visible

bool KisQmlPopupWidgetManager::visible

read

Definition at line 37 of file KisQmlPopupWidgetManager.h.

x

qreal KisQmlPopupWidgetManager::x

readwrite

Definition at line 25 of file KisQmlPopupWidgetManager.h.

y

qreal KisQmlPopupWidgetManager::y

readwrite

Definition at line 26 of file KisQmlPopupWidgetManager.h.

---

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

• qmlmodules/components/KisQmlPopupWidgetManager.h
• qmlmodules/components/KisQmlPopupWidgetManager.cpp