KisColorLabelSelectorWidget Class Reference

#include <kis_color_label_selector_widget.h>

Inheritance diagram for KisColorLabelSelectorWidget:

Classes
struct	Private

Public Types
enum	SelectionIndicationType { FillIn , Outline }

Public Slots
void	setButtonChecked (int index, bool state)
	(Un)Check the button at the given position
void	setCurrentIndex (int index)
	Set the currently selected button. It has no effect if the buttons are mutually exclusive.
void	setSelection (const QList< int > &indices)
	Set the list of checked button indices.

Signals
void	buttonToggled (int index, bool state)
void	currentIndexChanged (int index)
void	selectionChanged ()

Public Member Functions
int	buttonSize () const
	Get the size of the buttons.
bool	buttonWrapEnabled () const
	Get if the buttons should wrap in multiple lines if there is no enough space horizontally.
int	currentIndex () const
	Get the index of the currently checked button. Returns -1 if there is no checked button and -2 if the buttons are not mutually exclusive.
bool	exclusive () const
	Get if the button selection is mutually exclusive.
bool	isButtonChecked (int index) const
	Get if the button at the given position is currently checked.
	KisColorLabelSelectorWidget (QWidget *parent=nullptr)
bool	mouseDragEnabled () const
	Get if the user can drag to check/uncheck multiple buttons.
QList< int >	selection () const
	Get the list of checked button indices.
SelectionIndicationType	selectionIndicationType () const
	Get how the button is rendered.
void	setButtonSize (int size)
	Set the size of the buttons.
void	setButtonWrapEnabled (bool enabled)
	Set if the buttons should wrap in multiple lines if there is no enough space horizontally.
void	setExclusive (bool exclusive)
	Set if the button selection is mutually exclusive. This allows switching between single or multiple selection.
void	setMouseDragEnabled (bool enabled)
	Set if the user can drag to check/uncheck multiple buttons.
void	setSelectionIndicationType (SelectionIndicationType type)
	Set how the button should be rendered.
	~KisColorLabelSelectorWidget () override

Private Attributes
QScopedPointer< Private >	m_d

Detailed Description

Definition at line 16 of file kis_color_label_selector_widget.h.

Member Enumeration Documentation

SelectionIndicationType

enum KisColorLabelSelectorWidget::SelectionIndicationType

Enumerator
FillIn	The buttons show a border and their interior is filled when selected and empty when not selected.
Outline	The buttons have their interior filled and show a border if they are selected.

Definition at line 21 of file kis_color_label_selector_widget.h.

                                 {
        FillIn,
        Outline
    };

Constructor & Destructor Documentation

KisColorLabelSelectorWidget()

KisColorLabelSelectorWidget::KisColorLabelSelectorWidget

(

QWidget *

parent = nullptr

)

Definition at line 35 of file kis_color_label_selector_widget.cpp.

    : QWidget(parent)
    , m_d(new Private)
{
    KisNodeViewColorScheme scm;
    m_d->colors = scm.allColorLabels();
 
    QHBoxLayout *layout = new QHBoxLayout(this);
    layout->setAlignment(Qt::AlignLeft);
 
    layout->setContentsMargins(0,0,0,0);
    layout->setSpacing(2);
    {
        m_d->colorButtonGroup = new KisColorLabelFilterGroup(this);
        m_d->colorButtonGroup->setExclusive(true);
        m_d->colorButtonGroup->setMinimumRequiredChecked(0);
        QSet<int> viableColors;
 
        for (int id = 0; id < m_d->colors.count(); id++) {
            KisColorLabelButton* btn = new KisColorLabelButton(m_d->colors[id], m_d->buttonSize, this);
            btn->setChecked(false);
            btn->setSelectionVisType(KisColorLabelButton::Outline);
            m_d->colorButtonGroup->addButton(btn, id);
            layout->addWidget(btn);
            viableColors << id;
        }
 
        m_d->colorButtonGroup->setViableLabels(viableColors);
 
        connect(m_d->colorButtonGroup, QOverload<QAbstractButton*, bool>::of(&QButtonGroup::buttonToggled),
            [this](QAbstractButton *button, bool state)
            {
                const int index = m_d->colorButtonGroup->id(button);
                Q_EMIT buttonToggled(index, state);
                if (m_d->colorButtonGroup->exclusive()) {
                    if (!state) {
                        return;
                    }
                    Q_EMIT currentIndexChanged(index);
                } else {
                    Q_EMIT selectionChanged();
                }
            }
        );
    }
}

References KisNodeViewColorScheme::allColorLabels(), button(), connect(), m_d, KisColorLabelButton::Outline, and KisColorLabelButton::setSelectionVisType().

~KisColorLabelSelectorWidget()

KisColorLabelSelectorWidget::~KisColorLabelSelectorWidget ( )

override

Definition at line 82 of file kis_color_label_selector_widget.cpp.

{}

Member Function Documentation

buttonSize()

int KisColorLabelSelectorWidget::buttonSize

(

)

const

Get the size of the buttons.

Definition at line 232 of file kis_color_label_selector_widget.cpp.

{
    return m_d->buttonSize;
}

References m_d.

buttonToggled

void KisColorLabelSelectorWidget::buttonToggled ( int index, bool state )

signal

buttonWrapEnabled()

bool KisColorLabelSelectorWidget::buttonWrapEnabled

(

)

const

Get if the buttons should wrap in multiple lines if there is no enough space horizontally.

Definition at line 158 of file kis_color_label_selector_widget.cpp.

{
    return dynamic_cast<KisWrappableHBoxLayout*>(layout());
}

currentIndex()

int KisColorLabelSelectorWidget::currentIndex

(

)

const

Get the index of the currently checked button. Returns -1 if there is no checked button and -2 if the buttons are not mutually exclusive.

Definition at line 95 of file kis_color_label_selector_widget.cpp.

{
    if (!m_d->colorButtonGroup->exclusive()) {
        return -2;
    }
    return m_d->colorButtonGroup->checkedId();
}

References m_d.

currentIndexChanged

void KisColorLabelSelectorWidget::currentIndexChanged ( int index )

signal

exclusive()

bool KisColorLabelSelectorWidget::exclusive

(

)

const

Get if the button selection is mutually exclusive.

Definition at line 148 of file kis_color_label_selector_widget.cpp.

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

References m_d.

isButtonChecked()

bool KisColorLabelSelectorWidget::isButtonChecked

(

int

index

)

const

Get if the button at the given position is currently checked.

Definition at line 85 of file kis_color_label_selector_widget.cpp.

{
    return m_d->colorButtonGroup->button(index)->isChecked();
}

References m_d.

mouseDragEnabled()

bool KisColorLabelSelectorWidget::mouseDragEnabled

(

)

const

Get if the user can drag to check/uncheck multiple buttons.

Definition at line 186 of file kis_color_label_selector_widget.cpp.

{
    return m_d->dragFilter;
}

References m_d.

selection()

QList< int > KisColorLabelSelectorWidget::selection

(

)

const

Get the list of checked button indices.

Definition at line 125 of file kis_color_label_selector_widget.cpp.

{
    QList<int> indices;
    for (QAbstractButton *button : m_d->colorButtonGroup->buttons()) {
        if (button->isChecked()) {
            indices << m_d->colorButtonGroup->id(button);
        }
    }
    return indices;
}

References button(), and m_d.

selectionChanged

void KisColorLabelSelectorWidget::selectionChanged ( )

signal

selectionIndicationType()

KisColorLabelSelectorWidget::SelectionIndicationType KisColorLabelSelectorWidget::selectionIndicationType

(

)

const

Get how the button is rendered.

Definition at line 213 of file kis_color_label_selector_widget.cpp.

{
    return 
        static_cast<SelectionIndicationType>(
            qobject_cast<KisColorLabelButton*>(
                m_d->colorButtonGroup->button(0)
            )->selectionVisType()
        );
}

References m_d.

setButtonChecked

void KisColorLabelSelectorWidget::setButtonChecked ( int index, bool state )

slot

(Un)Check the button at the given position

Definition at line 90 of file kis_color_label_selector_widget.cpp.

{
    m_d->colorButtonGroup->button(index)->setChecked(state);
}

References m_d.

setButtonSize()

void KisColorLabelSelectorWidget::setButtonSize

(

int

size

)

Set the size of the buttons.

Definition at line 237 of file kis_color_label_selector_widget.cpp.

{
    if (size == m_d->buttonSize) {
        return;
    }
    m_d->buttonSize = size;
    for (QAbstractButton *button : m_d->colorButtonGroup->buttons()) {
        qobject_cast<KisColorLabelButton*>(button)->setSize(static_cast<uint>(size));
    }
    update();
}

References button(), and m_d.

setButtonWrapEnabled()

void KisColorLabelSelectorWidget::setButtonWrapEnabled

(

bool

enabled

)

Set if the buttons should wrap in multiple lines if there is no enough space horizontally.

Definition at line 163 of file kis_color_label_selector_widget.cpp.

{
    QLayout *newLayout;
    if (enabled) {
        if (dynamic_cast<KisWrappableHBoxLayout*>(layout())) {
            return;
        }
        newLayout = new KisWrappableHBoxLayout;
    } else {
        if (dynamic_cast<QHBoxLayout*>(layout())) {
            return;
        }
        newLayout = new QHBoxLayout;
    }
    newLayout->setContentsMargins(0,0,0,0);
    newLayout->setSpacing(2);
    for (QAbstractButton *button : m_d->colorButtonGroup->buttons()) {
        newLayout->addWidget(button);
    }
    delete layout();
    setLayout(newLayout);
}

References button(), and m_d.

setCurrentIndex

void KisColorLabelSelectorWidget::setCurrentIndex ( int index )

slot

Set the currently selected button. It has no effect if the buttons are mutually exclusive.

Definition at line 103 of file kis_color_label_selector_widget.cpp.

{
    if (!m_d->colorButtonGroup->exclusive()) {
        return;
    }
    if (index == -1) {
        QAbstractButton* btn = m_d->colorButtonGroup->checkedButton();
        if (btn) {
            btn->group()->setExclusive(false);
            btn->setChecked(false);
            btn->group()->setExclusive(true);
        }
    } else if (index != m_d->colorButtonGroup->checkedId()) {
        QAbstractButton* btn = m_d->colorButtonGroup->button(index);
        if (btn) {
            btn->setChecked(true);
        }
    }
 
    Q_EMIT currentIndexChanged(index);
}

References currentIndexChanged(), and m_d.

setExclusive()

void KisColorLabelSelectorWidget::setExclusive

(

bool

exclusive

)

Set if the button selection is mutually exclusive. This allows switching between single or multiple selection.

Definition at line 153 of file kis_color_label_selector_widget.cpp.

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

References exclusive(), and m_d.

setMouseDragEnabled()

void KisColorLabelSelectorWidget::setMouseDragEnabled

(

bool

enabled

)

Set if the user can drag to check/uncheck multiple buttons.

Definition at line 191 of file kis_color_label_selector_widget.cpp.

{
    if (enabled) {
        if (m_d->dragFilter) {
            return;
        }
        m_d->dragFilter = new KisColorLabelMouseDragFilter(this);
        for (QAbstractButton *button : m_d->colorButtonGroup->buttons()) {
            button->installEventFilter(m_d->dragFilter);
        }
    } else {
        if (!m_d->dragFilter) {
            return;
        }
        for (QAbstractButton *button : m_d->colorButtonGroup->buttons()) {
            button->removeEventFilter(m_d->dragFilter);
        }
        delete m_d->dragFilter;
        m_d->dragFilter = nullptr;
    }
}

References button(), and m_d.

setSelection

void KisColorLabelSelectorWidget::setSelection ( const QList< int > & indices )

slot

Set the list of checked button indices.

Definition at line 136 of file kis_color_label_selector_widget.cpp.

{
    KisSignalsBlocker blocker(m_d->colorButtonGroup);
    for (QAbstractButton *button : m_d->colorButtonGroup->buttons()) {
        button->setChecked(false);
    }
    for (int index : indices) {
        m_d->colorButtonGroup->button(index)->setChecked(true);
    }
    Q_EMIT selectionChanged();
}

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

setSelectionIndicationType()

void KisColorLabelSelectorWidget::setSelectionIndicationType

(

SelectionIndicationType

type

)

Set how the button should be rendered.

Definition at line 223 of file kis_color_label_selector_widget.cpp.

{
    for (QAbstractButton *button : m_d->colorButtonGroup->buttons()) {
        qobject_cast<KisColorLabelButton*>(button)->setSelectionVisType(
            static_cast<KisColorLabelButton::SelectionIndicationType>(type)
        );
    }
}

References button(), and m_d.

Member Data Documentation

m_d

QScopedPointer<Private> KisColorLabelSelectorWidget::m_d

private

Definition at line 122 of file kis_color_label_selector_widget.h.

---

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

• libs/ui/widgets/kis_color_label_selector_widget.h
• libs/ui/widgets/kis_color_label_selector_widget.cpp