KisPopupButton Class Reference

#include <KisPopupButton.h>

Inheritance diagram for KisPopupButton:

Classes
struct	Private

Public Slots
void	hidePopupWidget ()
void	setPopupWidgetDetached (bool detach)
void	setPopupWidgetVisible (bool visible)
void	showPopupWidget ()

Public Member Functions
void	adjustPosition ()
	adjustPosition adjusts the position of the popup widget based on the position of this button and the size of the widget
bool	isPopupWidgetVisible ()
	KisPopupButton (QWidget *parent)
void	setArrowVisible (bool v)
void	setPopupWidget (QWidget *widget)
void	setPopupWidgetWidth (int w)
	~KisPopupButton () override

Protected Member Functions
void	paintEvent (QPaintEvent *event) override
void	paintPopupArrow ()

Private Attributes
Private *const	m_d

Detailed Description

This class is a convenience class for a button that when clicked displays a popup widget.

Definition at line 18 of file KisPopupButton.h.

Constructor & Destructor Documentation

KisPopupButton()

KisPopupButton::KisPopupButton

(

QWidget *

parent

)

Definition at line 100 of file KisPopupButton.cpp.

        : QToolButton(parent)
        , m_d(new Private)
{
    setObjectName("KisPopupButton");
    connect(this, SIGNAL(released()), SLOT(showPopupWidget()));
}

References connect(), and showPopupWidget().

~KisPopupButton()

KisPopupButton::~KisPopupButton ( )

override

Definition at line 108 of file KisPopupButton.cpp.

{
    delete m_d->frame;
    delete m_d;
}

References KisPopupButton::Private::frame, and m_d.

Member Function Documentation

adjustPosition()

void KisPopupButton::adjustPosition

(

)

adjustPosition adjusts the position of the popup widget based on the position of this button and the size of the widget

Definition at line 206 of file KisPopupButton.cpp.

{
    // If popup is not detached, or if its detached geometry hasn't been set,
    // we first move the popup to the "current" screen.
    if (!m_d->isPopupDetached || !m_d->isDetachedGeometrySet) {
        QScreen *currentScreen = [this]() {
            QWindow *mainWinHandle = this->window()->windowHandle();
            if (mainWinHandle) {
                return mainWinHandle->screen();
            }
            return QApplication::primaryScreen();
        }();
        QWindow *winHandle = m_d->frame->windowHandle();
        if (winHandle) {
            winHandle->setScreen(currentScreen);
        }
    }
 
    // Attach to the button if it's visible, else attach to the cursor.
    QPoint pos = this->isVisible() ? this->mapToGlobal(QPoint(0, this->size().height())) : QCursor().pos();
    QSize popSize = m_d->popupWidget->size();
    QRect popupRect(pos, popSize);
 
    // Get the available geometry of the screen which contains the popup.
    QScreen *screen = [this]() {
        QWindow *winHandle = m_d->frame->windowHandle();
        if (winHandle && winHandle->screen()) {
            return winHandle->screen();
        }
        return QApplication::primaryScreen();
    }();
    QRect screenRect = screen->availableGeometry();
    if (m_d->isPopupDetached) {
        if (m_d->isDetachedGeometrySet) {
            popupRect.moveTo(m_d->frame->geometry().topLeft());
        } else {
            popupRect.moveTo(this->window()->geometry().center() - QRect(QPoint(0, 0), popSize).center());
            m_d->isDetachedGeometrySet = true;
        }
    }
    popupRect = kisEnsureInRect(popupRect, screenRect);
 
    m_d->frame->setGeometry(popupRect);
}

References KisPopupButton::Private::frame, KisPopupButton::Private::isDetachedGeometrySet, KisPopupButton::Private::isPopupDetached, kisEnsureInRect(), m_d, and KisPopupButton::Private::popupWidget.

hidePopupWidget

void KisPopupButton::hidePopupWidget ( )

slot

Definition at line 158 of file KisPopupButton.cpp.

{
    setPopupWidgetVisible(false);
}

References setPopupWidgetVisible().

isPopupWidgetVisible()

bool KisPopupButton::isPopupWidgetVisible

(

)

Definition at line 180 of file KisPopupButton.cpp.

{
    return m_d->popupWidget && m_d->frame->isVisible();
}

References KisPopupButton::Private::frame, m_d, and KisPopupButton::Private::popupWidget.

paintEvent()

void KisPopupButton::paintEvent ( QPaintEvent * event )

overrideprotected

Definition at line 185 of file KisPopupButton.cpp.

{
    QToolButton::paintEvent(event);
    if (m_d->arrowVisible) {
        paintPopupArrow();
    }
}

References KisPopupButton::Private::arrowVisible, m_d, and paintPopupArrow().

paintPopupArrow()

void KisPopupButton::paintPopupArrow ( )

protected

Definition at line 193 of file KisPopupButton.cpp.

{
    QStylePainter p(this);
    QStyleOption option;
    option.rect = QRect(rect().right() - 15, rect().bottom() - 15, 14, 14);
    option.palette = palette();
    option.palette.setBrush(QPalette::ButtonText, Qt::black); // Force color to black
    option.state = QStyle::State_Enabled;
    p.setBrush(Qt::black); // work around some theme that don't use QPalette::ButtonText like they  should, but instead the QPainter brushes and pen
    p.setPen(Qt::black);
    p.drawPrimitive(QStyle::PE_IndicatorArrowDown, option);
}

References p, and palette.

setArrowVisible()

void KisPopupButton::setArrowVisible

(

bool

v

)

This function allows to show or hide the arrow.

Parameters

v	set to true to draw the arrow, else set to false

Definition at line 251 of file KisPopupButton.cpp.

{
    if (v) {
        m_d->arrowVisible = true;
    } else {
        m_d->arrowVisible = false;
    }
}

References KisPopupButton::Private::arrowVisible, m_d, and v.

setPopupWidget()

void KisPopupButton::setPopupWidget

(

QWidget *

widget

)

Set the popup widget, the KisPopupButton becomes the owner and parent of the widget.

Definition at line 131 of file KisPopupButton.cpp.

{
    if (widget) {
        delete m_d->frame;
        m_d->frame = new KisPopupButtonFrame(this->window(), m_d->isPopupDetached);
        m_d->frame->setWindowTitle(widget->windowTitle());
 
        m_d->popupWidget = widget;
 
        m_d->frame->layout()->addWidget(m_d->popupWidget);
    }
}

References KisPopupButton::Private::frame, KisPopupButton::Private::isPopupDetached, m_d, and KisPopupButton::Private::popupWidget.

setPopupWidgetDetached

void KisPopupButton::setPopupWidgetDetached ( bool detach )

slot

Set whether the popup is detached as a dialog.

Parameters

v	set to true to cause the popup to be detached

Definition at line 114 of file KisPopupButton.cpp.

{
    m_d->isPopupDetached = detach;
    if (m_d->frame) {
        bool wasVisible = isPopupWidgetVisible();
        m_d->frame->setDetached(detach);
        if (wasVisible) {
            // Setting the window flags closes the widget, so make it visible again.
            setPopupWidgetVisible(true);
            if (detach) {
                m_d->isDetachedGeometrySet = true;
            }
            adjustPosition();
        }
    }
}

References adjustPosition(), KisPopupButton::Private::frame, KisPopupButton::Private::isDetachedGeometrySet, KisPopupButton::Private::isPopupDetached, isPopupWidgetVisible(), m_d, and setPopupWidgetVisible().

setPopupWidgetVisible

void KisPopupButton::setPopupWidgetVisible ( bool visible )

slot

Definition at line 163 of file KisPopupButton.cpp.

{
    if (m_d->popupWidget) {
        if (visible) {
            // Force layout sizing before positioning
            m_d->popupWidget->adjustSize();
            m_d->frame->adjustSize();
            adjustPosition();
            m_d->frame->raise();
            m_d->frame->show();
            m_d->frame->activateWindow();
        } else {
            m_d->frame->setVisible(false);
        }
    }
}

References adjustPosition(), KisPopupButton::Private::frame, m_d, and KisPopupButton::Private::popupWidget.

setPopupWidgetWidth()

void KisPopupButton::setPopupWidgetWidth

(

int

w

)

Set the width of the popup widget.

Returns

new width of the popup widget

Definition at line 144 of file KisPopupButton.cpp.

{
    m_d->frame->resize(w, m_d->frame->height());
}

References KisPopupButton::Private::frame, and m_d.

showPopupWidget

void KisPopupButton::showPopupWidget ( )

slot

Definition at line 149 of file KisPopupButton.cpp.

{
    if (m_d->popupWidget && !m_d->frame->isVisible()) {
        setPopupWidgetVisible(true);
    } else {
        hidePopupWidget();
    }
}

References KisPopupButton::Private::frame, hidePopupWidget(), m_d, KisPopupButton::Private::popupWidget, and setPopupWidgetVisible().

Member Data Documentation

m_d

Private* const KisPopupButton::m_d

private

Definition at line 75 of file KisPopupButton.h.

---

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

• libs/widgetutils/KisPopupButton.h
• libs/widgetutils/KisPopupButton.cpp