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 ()

Signals
void	sigPopupWidgetShown ()

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 Slots
void	slotMenuAboutToHide ()

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 106 of file KisPopupButton.cpp.

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

References showPopupWidget().

~KisPopupButton()

KisPopupButton::~KisPopupButton ( )

override

Definition at line 114 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 231 of file KisPopupButton.cpp.

{
    QScreen *currentScreen = nullptr;
    auto getCurrentScreen = [this, &currentScreen] {
        if (!currentScreen) {
            QWindow *mainWinHandle = window()->windowHandle();
            if (mainWinHandle) {
                currentScreen = mainWinHandle->screen();
            } else {
                currentScreen = QApplication::primaryScreen();
            }
        }
        return currentScreen;
    };
 
    // 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) {
        QWindow *winHandle = m_d->frame->windowHandle();
        if (winHandle) {
            winHandle->setScreen(getCurrentScreen());
        }
    }
 
    // 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, &getCurrentScreen]() {
        QWindow *winHandle = m_d->frame->windowHandle();
        if (winHandle && winHandle->screen()) {
            return winHandle->screen();
        }
        return getCurrentScreen();
    }();
    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 180 of file KisPopupButton.cpp.

{
    setPopupWidgetVisible(false);
}

References setPopupWidgetVisible().

isPopupWidgetVisible()

bool KisPopupButton::isPopupWidgetVisible

(

)

Definition at line 205 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 210 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 218 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 282 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 137 of file KisPopupButton.cpp.

{
    if (widget) {
        delete m_d->frame;
 
        // Bit wonky to assign a popup menu to a popup widget, so they need
        // extra coddling to make them work properly.
        QMenu *menu = qobject_cast<QMenu *>(widget);
        m_d->frame = new KisPopupButtonFrame(this->window(), m_d->isPopupDetached, menu);
        m_d->frame->setWindowTitle(widget->windowTitle());
 
        m_d->popupWidget = widget;
 
        m_d->frame->layout()->addWidget(m_d->popupWidget);
 
        if (menu) {
            // The menu may decide to hide itself in response to user input.
            // Compensate for that by catching the situation where we'd hide
            // the menu while the frame is still up and show it again.
            connect(menu, &QMenu::aboutToHide, this, &KisPopupButton::slotMenuAboutToHide);
            // If the menu still hides itself somehow, make it show up again.
            connect(this, &KisPopupButton::sigPopupWidgetShown, menu, &QMenu::show);
        }
    }
}

References KisPopupButton::Private::frame, KisPopupButton::Private::isPopupDetached, m_d, KisPopupButton::Private::popupWidget, sigPopupWidgetShown(), and slotMenuAboutToHide().

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 120 of file KisPopupButton.cpp.

{
    m_d->isPopupDetached = detach;
    if (m_d->frame) {
        bool wasVisible = isPopupWidgetVisible();
        m_d->frame->setDetached(detach, qobject_cast<QMenu *>(m_d->popupWidget));
        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, KisPopupButton::Private::popupWidget, and setPopupWidgetVisible().

setPopupWidgetVisible

void KisPopupButton::setPopupWidgetVisible ( bool visible )

slot

Definition at line 185 of file KisPopupButton.cpp.

{
    if (m_d->popupWidget) {
        if (visible) {
            if (m_d->isPopupDetached) {
                // 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();
            Q_EMIT sigPopupWidgetShown();
        } else {
            m_d->frame->setVisible(false);
        }
    }
}

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

setPopupWidgetWidth()

void KisPopupButton::setPopupWidgetWidth

(

int

w

)

Set the width of the popup widget.

Returns

new width of the popup widget

Definition at line 163 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 168 of file KisPopupButton.cpp.

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

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

sigPopupWidgetShown

void KisPopupButton::sigPopupWidgetShown ( )

signal

slotMenuAboutToHide

void KisPopupButton::slotMenuAboutToHide ( )

privateslot

Definition at line 291 of file KisPopupButton.cpp.

{
    // Menus will hide themselves when clicking on one of their separators,
    // which just ends up with a blank popup frame. Fight back against this by
    // showing the menu again if the frame is still up when the menu disappears.
    if (m_d->popupWidget && m_d->frame->isVisible()) {
        m_d->popupWidget->show();
    }
}

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

Member Data Documentation

m_d

Private* const KisPopupButton::m_d

private

Definition at line 82 of file KisPopupButton.h.

---

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

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