KisGradientColorEditor Class Reference

#include <KisGradientColorEditor.h>

Inheritance diagram for KisGradientColorEditor:

Public Slots
void	setColor (KoColor color)
void	setColorType (KisGradientWidgetsUtils::ColorType type)
void	setOpacity (qreal opacity)
void	setPosition (qreal position)
void	setPositionSliderEnabled (bool enabled)
void	setTransparent (bool checked)
void	setUsePositionSlider (bool use)
void	setUseTransParentCheckBox (bool use)

Signals
void	colorChanged (KoColor color)
void	colorTypeChanged (KisGradientWidgetsUtils::ColorType type)
void	opacityChanged (qreal opacity)
void	positionChanged (qreal position)
void	transparentToggled (bool checked)

Public Member Functions
KoColor	color () const
KisGradientWidgetsUtils::ColorType	colorType () const
	KisGradientColorEditor (const KisGradientColorEditor &other)
	KisGradientColorEditor (QWidget *parent=nullptr)
QSize	minimumSizeHint () const override
qreal	opacity () const
qreal	position () const
QSize	sizeHint () const override
bool	transparent () const
	~KisGradientColorEditor ()

Public Attributes
KisColorButton *	colorButton {nullptr}
QToolButton *	colorTypeBackgroundButton {nullptr}
QToolButton *	colorTypeCustomButton {nullptr}
QToolButton *	colorTypeForegroundButton {nullptr}
KisDoubleSliderSpinBox *	opacitySlider {nullptr}
KisDoubleSliderSpinBox *	positionSlider {nullptr}
QCheckBox *	transparentCheckBox {nullptr}

Private Attributes
QScopedPointer< Private >	m_d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

Definition at line 18 of file KisGradientColorEditor.cpp.

Constructor & Destructor Documentation

KisGradientColorEditor() [1/2]

KisGradientColorEditor::KisGradientColorEditor

(

QWidget *

parent = nullptr

)

Definition at line 30 of file KisGradientColorEditor.cpp.

    : QWidget(parent)
    , m_d(new Private)
{
    m_d->colorTypeForegroundButton = new QToolButton;
    m_d->colorTypeForegroundButton->setCheckable(true);
    m_d->colorTypeForegroundButton->setChecked(true);
    m_d->colorTypeForegroundButton->setAutoExclusive(true);
    m_d->colorTypeForegroundButton->setAutoRaise(true);
    m_d->colorTypeForegroundButton->setIcon(KisIconUtils::loadIcon("object-order-lower-calligra"));
    m_d->colorTypeForegroundButton->setToolTip(i18nc("Button to change the gradient stop type to foreground", "Foreground color"));
    connect(m_d->colorTypeForegroundButton, &QToolButton::toggled,
        [this](bool toggled)
        {
            if (toggled) {
                setColorType(KisGradientWidgetsUtils::Foreground);
            }
            Q_EMIT colorTypeChanged(KisGradientWidgetsUtils::Foreground);
        });
 
    m_d->colorTypeBackgroundButton = new QToolButton;
    m_d->colorTypeBackgroundButton->setCheckable(true);
    m_d->colorTypeBackgroundButton->setAutoExclusive(true);
    m_d->colorTypeBackgroundButton->setAutoRaise(true);
    m_d->colorTypeBackgroundButton->setIcon(KisIconUtils::loadIcon("object-order-raise-calligra"));
    m_d->colorTypeBackgroundButton->setToolTip(i18nc("Button to change the gradient stop type to background", "Background color"));
    connect(m_d->colorTypeBackgroundButton, &QToolButton::toggled,
        [this](bool toggled)
        {
            if (toggled) {
                setColorType(KisGradientWidgetsUtils::Background);
            }
            Q_EMIT colorTypeChanged(KisGradientWidgetsUtils::Background);
        });
 
    m_d->colorTypeCustomButton = new QToolButton;
    m_d->colorTypeCustomButton->setCheckable(true);
    m_d->colorTypeCustomButton->setAutoExclusive(true);
    m_d->colorTypeCustomButton->setAutoRaise(true);
    m_d->colorTypeCustomButton->setIcon(KisIconUtils::loadIcon("wheel-sectors"));
    m_d->colorTypeCustomButton->setToolTip(i18nc("Button to change the gradient stop type to custom color", "Custom color"));
    connect(m_d->colorTypeCustomButton, &QToolButton::toggled,
        [this](bool toggled)
        {
            if (toggled) {
                setColorType(KisGradientWidgetsUtils::Custom);
            }
            Q_EMIT colorTypeChanged(KisGradientWidgetsUtils::Custom);
        });
 
    QWidget *colorTypeButtonsContainer = new QWidget;
 
    m_d->transparentCheckBox = new QCheckBox;
    m_d->transparentCheckBox->setText(i18n("Transparent"));
    m_d->transparentCheckBox->setProperty("isBeingUsed", true);
    connect(m_d->transparentCheckBox, SIGNAL(toggled(bool)), this, SIGNAL(transparentToggled(bool)));
 
    m_d->colorButton = new KisColorButton;
    m_d->colorButton->setVisible(false);
    connect(m_d->colorButton, SIGNAL(changed(KoColor)), this, SIGNAL(colorChanged(KoColor)));
 
    m_d->opacitySlider = new KisDoubleSliderSpinBox;
    m_d->opacitySlider->setRange(0, 100, 2);
    KisSpinBoxI18nHelper::setText(m_d->opacitySlider,
                                  i18nc("{n} is the number value, % is the percent sign", "Opacity: {n}%"));
    m_d->opacitySlider->setVisible(false);
    connect(m_d->opacitySlider, SIGNAL(valueChanged(double)), this, SIGNAL(opacityChanged(qreal)));
 
    m_d->positionSlider = new KisDoubleSliderSpinBox;
    m_d->positionSlider->setRange(0, 100, 2);
    KisSpinBoxI18nHelper::setText(m_d->positionSlider,
                                  i18nc("{n} is the number value, % is the percent sign", "Position: {n}%"));
    connect(m_d->positionSlider, SIGNAL(valueChanged(double)), this, SIGNAL(positionChanged(qreal)));
 
    QHBoxLayout *colorTypeButtonsLayout = new QHBoxLayout;
    colorTypeButtonsLayout->setContentsMargins(0, 0, 0, 0);
    colorTypeButtonsLayout->setSpacing(0);
    colorTypeButtonsLayout->addWidget(m_d->colorTypeForegroundButton);
    colorTypeButtonsLayout->addWidget(m_d->colorTypeBackgroundButton);
    colorTypeButtonsLayout->addWidget(m_d->colorTypeCustomButton);
    colorTypeButtonsContainer->setLayout(colorTypeButtonsLayout);
 
    QHBoxLayout *mainLayout = new QHBoxLayout;
    mainLayout->setContentsMargins(0, 0, 0, 0);
    mainLayout->setSpacing(5);
    mainLayout->addWidget(colorTypeButtonsContainer);
    mainLayout->addWidget(m_d->transparentCheckBox);
    mainLayout->addWidget(m_d->colorButton);
    mainLayout->addWidget(m_d->opacitySlider);
    mainLayout->addStretch();
    mainLayout->addWidget(m_d->positionSlider);
    setLayout(mainLayout);
 
    setSizePolicy(QSizePolicy::MinimumExpanding, QSizePolicy::Fixed);
}

References colorTypeChanged(), connect(), KisGradientWidgetsUtils::Foreground, KisIconUtils::loadIcon(), and m_d.

KisGradientColorEditor() [2/2]

KisGradientColorEditor::KisGradientColorEditor

(

const KisGradientColorEditor &

other

)

Definition at line 126 of file KisGradientColorEditor.cpp.

    : QWidget()
{
    setPosition(other.position());
    setColorType(other.colorType());
    setTransparent(other.transparent());
    setColor(other.color());
    setOpacity(other.opacity());
}

References color(), colorType(), opacity(), position(), setColor(), setColorType(), setOpacity(), setPosition(), setTransparent(), and transparent().

~KisGradientColorEditor()

KisGradientColorEditor::~KisGradientColorEditor

(

)

Definition at line 136 of file KisGradientColorEditor.cpp.

{}

Member Function Documentation

color()

KoColor KisGradientColorEditor::color

(

)

const

Definition at line 155 of file KisGradientColorEditor.cpp.

{
    return m_d->colorButton->color();
}

References m_d.

colorChanged

void KisGradientColorEditor::colorChanged ( KoColor color )

signal

colorType()

KisGradientWidgetsUtils::ColorType KisGradientColorEditor::colorType

(

)

const

Definition at line 144 of file KisGradientColorEditor.cpp.

{
    if (m_d->colorTypeForegroundButton->isChecked()) {
        return KisGradientWidgetsUtils::Foreground;
    } else if (m_d->colorTypeBackgroundButton->isChecked()) {
        return KisGradientWidgetsUtils::Background;
    } else {
        return KisGradientWidgetsUtils::Custom;
    }
}

References KisGradientWidgetsUtils::Background, KisGradientWidgetsUtils::Custom, KisGradientWidgetsUtils::Foreground, and m_d.

colorTypeChanged

void KisGradientColorEditor::colorTypeChanged ( KisGradientWidgetsUtils::ColorType type )

signal

minimumSizeHint()

QSize KisGradientColorEditor::minimumSizeHint ( ) const

override

Definition at line 265 of file KisGradientColorEditor.cpp.

{
    return QSize(
        m_d->colorTypeForegroundButton->minimumSizeHint().width() +
        m_d->colorTypeBackgroundButton->minimumSizeHint().width() +
        m_d->colorTypeCustomButton->minimumSizeHint().width() +
        qMax(
            m_d->transparentCheckBox->minimumSizeHint().width(),
            m_d->colorButton->minimumSizeHint().width() +
            m_d->opacitySlider->minimumSizeHint().width()
        ) +
        (m_d->positionSlider->isVisible() ? m_d->positionSlider->minimumSizeHint().width() : 0) +
        15, // spacing
 
        qMax(
            m_d->colorTypeForegroundButton->minimumSizeHint().height(),
            qMax(
                m_d->transparentCheckBox->minimumSizeHint().height(),
                qMax(
                    m_d->colorButton->minimumSizeHint().height(),
                    m_d->opacitySlider->minimumSizeHint().height()
                )
            )
        )
    );
}

References m_d.

opacity()

qreal KisGradientColorEditor::opacity

(

)

const

Definition at line 165 of file KisGradientColorEditor.cpp.

{
    return m_d->opacitySlider->value();
}

References m_d.

opacityChanged

void KisGradientColorEditor::opacityChanged ( qreal opacity )

signal

position()

qreal KisGradientColorEditor::position

(

)

const

Definition at line 139 of file KisGradientColorEditor.cpp.

{
    return m_d->positionSlider->value();
}

References m_d.

positionChanged

void KisGradientColorEditor::positionChanged ( qreal position )

signal

setColor

void KisGradientColorEditor::setColor ( KoColor color )

slot

Definition at line 206 of file KisGradientColorEditor.cpp.

{
    color.setOpacity(1.0);
    if (color == m_d->colorButton->color()) {
        return;
    }
    m_d->colorButton->setColor(color);
}

References color(), m_d, and KoColor::setOpacity().

setColorType

void KisGradientColorEditor::setColorType ( KisGradientWidgetsUtils::ColorType type )

slot

Definition at line 175 of file KisGradientColorEditor.cpp.

{
    if (type == KisGradientWidgetsUtils::Foreground) {
        m_d->colorTypeForegroundButton->setChecked(true);
    } else if (type == KisGradientWidgetsUtils::Background) {
        m_d->colorTypeBackgroundButton->setChecked(true);
    } else {
        m_d->colorTypeCustomButton->setChecked(true);
    }
 
    // "if" to avoid flickering. setUpdatesEnabled doesn't seems to work here?
    if (type == KisGradientWidgetsUtils::Custom) {
        m_d->transparentCheckBox->setVisible(false);
        m_d->colorButton->setVisible(true);
        m_d->opacitySlider->setVisible(true);
    } else {
        m_d->colorButton->setVisible(false);
        m_d->opacitySlider->setVisible(false);
        m_d->transparentCheckBox->setVisible(m_d->transparentCheckBox->property("isBeingUsed").toBool());
    }
 
    if (type != colorType()) {
        Q_EMIT colorTypeChanged(type);
    }
}

References KisGradientWidgetsUtils::Background, colorType(), colorTypeChanged(), KisGradientWidgetsUtils::Custom, KisGradientWidgetsUtils::Foreground, and m_d.

setOpacity

void KisGradientColorEditor::setOpacity ( qreal opacity )

slot

Definition at line 215 of file KisGradientColorEditor.cpp.

{
    m_d->opacitySlider->setValue(opacity);
}

References m_d, and opacity().

setPosition

void KisGradientColorEditor::setPosition ( qreal position )

slot

Definition at line 170 of file KisGradientColorEditor.cpp.

{
    m_d->positionSlider->setValue(position);
}

References m_d, and position().

setPositionSliderEnabled

void KisGradientColorEditor::setPositionSliderEnabled ( bool enabled )

slot

Definition at line 233 of file KisGradientColorEditor.cpp.

{
    m_d->positionSlider->setEnabled(enabled);
}

References m_d.

setTransparent

void KisGradientColorEditor::setTransparent ( bool checked )

slot

Definition at line 201 of file KisGradientColorEditor.cpp.

{
    m_d->transparentCheckBox->setChecked(checked);
}

References m_d.

setUsePositionSlider

void KisGradientColorEditor::setUsePositionSlider ( bool use )

slot

Definition at line 228 of file KisGradientColorEditor.cpp.

{
    m_d->positionSlider->setVisible(use);
}

References m_d.

setUseTransParentCheckBox

void KisGradientColorEditor::setUseTransParentCheckBox ( bool use )

slot

Definition at line 220 of file KisGradientColorEditor.cpp.

{
    m_d->transparentCheckBox->setProperty("isBeingUsed", use);
    if (colorType() != KisGradientWidgetsUtils::Custom) {
        m_d->transparentCheckBox->setVisible(use);
    }
}

References colorType(), KisGradientWidgetsUtils::Custom, and m_d.

sizeHint()

QSize KisGradientColorEditor::sizeHint ( ) const

override

Definition at line 238 of file KisGradientColorEditor.cpp.

{
    return QSize(
        m_d->colorTypeForegroundButton->sizeHint().width() +
        m_d->colorTypeBackgroundButton->sizeHint().width() +
        m_d->colorTypeCustomButton->sizeHint().width() +
        qMax(
            m_d->transparentCheckBox->sizeHint().width(),
            m_d->colorButton->sizeHint().width() +
            m_d->opacitySlider->sizeHint().width()
        ) +
        (m_d->positionSlider->isVisible() ? m_d->positionSlider->sizeHint().width() : 0) +
        15, // spacing
 
        qMax(
            m_d->colorTypeForegroundButton->sizeHint().height(),
            qMax(
                m_d->transparentCheckBox->sizeHint().height(),
                qMax(
                    m_d->colorButton->sizeHint().height(),
                    m_d->opacitySlider->sizeHint().height()
                )
            )
        )
    );
}

References m_d.

transparent()

bool KisGradientColorEditor::transparent

(

)

const

Definition at line 160 of file KisGradientColorEditor.cpp.

{
    return m_d->transparentCheckBox->isChecked();
}

References m_d.

transparentToggled

void KisGradientColorEditor::transparentToggled ( bool checked )

signal

Member Data Documentation

colorButton

KisColorButton* KisGradientColorEditor::colorButton {nullptr}

Definition at line 26 of file KisGradientColorEditor.cpp.

{nullptr};

colorTypeBackgroundButton

QToolButton* KisGradientColorEditor::colorTypeBackgroundButton {nullptr}

Definition at line 23 of file KisGradientColorEditor.cpp.

{nullptr};

colorTypeCustomButton

QToolButton* KisGradientColorEditor::colorTypeCustomButton {nullptr}

Definition at line 24 of file KisGradientColorEditor.cpp.

{nullptr};

colorTypeForegroundButton

QToolButton* KisGradientColorEditor::colorTypeForegroundButton {nullptr}

Definition at line 22 of file KisGradientColorEditor.cpp.

{nullptr};

m_d

QScopedPointer<Private> KisGradientColorEditor::m_d

private

Definition at line 57 of file KisGradientColorEditor.h.

opacitySlider

KisDoubleSliderSpinBox* KisGradientColorEditor::opacitySlider {nullptr}

Definition at line 27 of file KisGradientColorEditor.cpp.

{nullptr};

positionSlider

KisDoubleSliderSpinBox* KisGradientColorEditor::positionSlider {nullptr}

Definition at line 21 of file KisGradientColorEditor.cpp.

{nullptr};

transparentCheckBox

QCheckBox* KisGradientColorEditor::transparentCheckBox {nullptr}

Definition at line 25 of file KisGradientColorEditor.cpp.

{nullptr};

---

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

• libs/ui/widgets/gradient/KisGradientColorEditor.cpp
• libs/ui/widgets/gradient/KisGradientColorEditor.h