KisOptionButtonStrip Class Reference

Provides a list of consecutive tool buttons. More...

#include <KisOptionButtonStrip.h>

Inheritance diagram for KisOptionButtonStrip:

Classes
class	Private

Signals
void	buttonToggled (int index, bool checked)
void	buttonToggled (KoGroupButton *button, bool checked)

Public Member Functions
KoGroupButton *	addButton ()
KoGroupButton *	addButton (const QIcon &icon, const QString &text=QString())
KoGroupButton *	addButton (const QString &text)
KoGroupButton *	button (int index) const
QList< KoGroupButton * >	buttons () const
KoGroupButton *	checkedButton () const
int	checkedButtonIndex () const
bool	exclusive () const
	KisOptionButtonStrip (QWidget *parent=nullptr)
void	setExclusive (bool exclusive)
	~KisOptionButtonStrip () override

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

Provides a list of consecutive tool buttons.

Definition at line 21 of file KisOptionButtonStrip.h.

Constructor & Destructor Documentation

KisOptionButtonStrip()

KisOptionButtonStrip::KisOptionButtonStrip ( QWidget * parent = nullptr )

explicit

Definition at line 22 of file KisOptionButtonStrip.cpp.

    : QWidget(parent)
    , m_d(new Private)
{
    setSizePolicy(QSizePolicy::Minimum, QSizePolicy::Preferred);
 
    QHBoxLayout *mainLayout = new QHBoxLayout;
    mainLayout->setSpacing(0);
    mainLayout->setContentsMargins(0, 0, 0, 0);
    mainLayout->addStretch();
    setLayout(mainLayout);
 
    m_d->buttonGroup = new QButtonGroup(this);
    m_d->buttonGroup->setExclusive(true);
 
    connect(
        m_d->buttonGroup,
        QOverload<QAbstractButton *, bool>::of(&QButtonGroup::buttonToggled),
        [this](QAbstractButton *button, bool checked) {
            Q_EMIT buttonToggled(dynamic_cast<KoGroupButton *>(button), checked);
            Q_EMIT buttonToggled(m_d->buttonGroup->id(button), checked);
        });
}

References button(), connect(), and m_d.

~KisOptionButtonStrip()

KisOptionButtonStrip::~KisOptionButtonStrip ( )

override

Definition at line 46 of file KisOptionButtonStrip.cpp.

{
}

Member Function Documentation

addButton() [1/3]

KoGroupButton * KisOptionButtonStrip::addButton

(

)

Definition at line 84 of file KisOptionButtonStrip.cpp.

{
    return addButton(QIcon(), QString());
}

References addButton().

addButton() [2/3]

KoGroupButton * KisOptionButtonStrip::addButton	(	const QIcon &	icon,
		const QString &	text = QString() )

Definition at line 50 of file KisOptionButtonStrip.cpp.

{
    KoGroupButton *newButton = new KoGroupButton(this);
    newButton->setCheckable(true);
    newButton->setIcon(icon);
    newButton->setText(text);
    newButton->setMinimumSize(28, 28);
 
    if (m_d->numberOfButtons > 0) {
        KoGroupButton *prevButton = dynamic_cast<KoGroupButton *>(
            m_d->buttonGroup->button(m_d->numberOfButtons - 1));
        prevButton->setGroupPosition(m_d->numberOfButtons == 1
                                         ? KoGroupButton::GroupLeft
                                         : KoGroupButton::GroupCenter);
        newButton->setGroupPosition(KoGroupButton::GroupRight);
    }
 
    m_d->buttonGroup->addButton(newButton, m_d->numberOfButtons);
 
    QHBoxLayout *mainLayout = dynamic_cast<QHBoxLayout *>(layout());
    KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE(mainLayout, newButton);
    mainLayout->insertWidget(m_d->numberOfButtons, newButton);
 
    ++m_d->numberOfButtons;
 
    return newButton;
}

References KoGroupButton::GroupCenter, KoGroupButton::GroupLeft, KoGroupButton::GroupRight, KIS_SAFE_ASSERT_RECOVER_RETURN_VALUE, m_d, and KoGroupButton::setGroupPosition().

addButton() [3/3]

KoGroupButton * KisOptionButtonStrip::addButton

(

const QString &

text

)

Definition at line 79 of file KisOptionButtonStrip.cpp.

{
    return addButton(QIcon(), text);
}

References addButton().

button()

KoGroupButton * KisOptionButtonStrip::button

(

int

index

)

const

Definition at line 89 of file KisOptionButtonStrip.cpp.

{
    return dynamic_cast<KoGroupButton *>(m_d->buttonGroup->button(index));
}

References m_d.

buttons()

QList< KoGroupButton * > KisOptionButtonStrip::buttons

(

)

const

Definition at line 94 of file KisOptionButtonStrip.cpp.

{
    QList<KoGroupButton *> list;
    for (QAbstractButton *b : m_d->buttonGroup->buttons()) {
        list.append(dynamic_cast<KoGroupButton *>(b));
    }
    return list;
}

References m_d.

buttonToggled [1/2]

void KisOptionButtonStrip::buttonToggled ( int index, bool checked )

signal

buttonToggled [2/2]

void KisOptionButtonStrip::buttonToggled ( KoGroupButton * button, bool checked )

signal

checkedButton()

KoGroupButton * KisOptionButtonStrip::checkedButton

(

)

const

Definition at line 113 of file KisOptionButtonStrip.cpp.

{
    return dynamic_cast<KoGroupButton *>(m_d->buttonGroup->checkedButton());
}

References m_d.

checkedButtonIndex()

int KisOptionButtonStrip::checkedButtonIndex

(

)

const

Definition at line 118 of file KisOptionButtonStrip.cpp.

{
    return m_d->buttonGroup->checkedId();
}

References m_d.

exclusive()

bool KisOptionButtonStrip::exclusive

(

)

const

Definition at line 103 of file KisOptionButtonStrip.cpp.

{
    return m_d->buttonGroup->exclusive();
}

References m_d.

setExclusive()

void KisOptionButtonStrip::setExclusive

(

bool

exclusive

)

Definition at line 108 of file KisOptionButtonStrip.cpp.

{
    m_d->buttonGroup->setExclusive(exclusive);
}

References exclusive(), and m_d.

Member Data Documentation

m_d

QScopedPointer<Private> KisOptionButtonStrip::m_d

private

Definition at line 49 of file KisOptionButtonStrip.h.

---

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

• libs/widgetutils/KisOptionButtonStrip.h
• libs/widgetutils/KisOptionButtonStrip.cpp