A pushbutton to display or allow user selection of a color. More...

#include <kis_color_button.h>

Inheritance diagram for KisColorButton:

Classes
class	KisColorButtonPrivate

Public Slots
void	setColor (const KoColor &c)

Signals
void	changed (const KoColor &newColor)

Public Member Functions
KoColor	color () const

KoColor	defaultColor () const

bool	isAlphaChannelEnabled () const

	KisColorButton (const KoColor &c, const KoColor &defaultColor, QWidget *parent=0)

	KisColorButton (const KoColor &c, QWidget *parent=0)

	KisColorButton (QWidget *parent=0)

QSize	minimumSizeHint () const override

bool	paletteViewEnabled () const
	paletteViewEnabled

void	setAlphaChannelEnabled (bool alpha)

void	setDefaultColor (const KoColor &c)

void	setPaletteViewEnabled (bool enable)

QSize	sizeHint () const override

	~KisColorButton () override

Protected Member Functions
void	dragEnterEvent (QDragEnterEvent *) override

void	dropEvent (QDropEvent *) override

void	keyPressEvent (QKeyEvent *e) override

void	mouseMoveEvent (QMouseEvent *e) override

void	mousePressEvent (QMouseEvent *e) override

void	paintEvent (QPaintEvent *pe) override

Properties
bool	alphaChannelEnabled

KoColor	color

KoColor	defaultColor

Private Attributes
KisColorButtonPrivate *const	d

Detailed Description

A pushbutton to display or allow user selection of a color.

This widget can be used to display or allow user selection of a color.

See also: QColorDialog

KDE Color Button

Definition at line 26 of file kis_color_button.h.

Constructor & Destructor Documentation

◆ KisColorButton() [1/3]

KisColorButton::KisColorButton ( QWidget * parent = 0 )

explicit

Creates a color button.

Definition at line 115 of file kis_color_button.cpp.

    : QPushButton(parent)
    , d(new KisColorButtonPrivate(this))
{
}

◆ KisColorButton() [2/3]

KisColorButton::KisColorButton	(	const KoColor &	c,
		QWidget *	parent = 0 )

explicit

Creates a color button with an initial color c.

Definition at line 121 of file kis_color_button.cpp.

    : QPushButton(parent)
    , d(new KisColorButtonPrivate(this))
{
    d->col = c;
}

References KisColorButton::KisColorButtonPrivate::col, and d.

◆ KisColorButton() [3/3]

KisColorButton::KisColorButton	(	const KoColor &	c,
		const KoColor &	defaultColor,
		QWidget *	parent = 0 )

Creates a color button with an initial color c and default color defaultColor.

Definition at line 128 of file kis_color_button.cpp.

    : QPushButton(parent)
    , d(new KisColorButtonPrivate(this))
{
    d->col = c;
    setDefaultColor(defaultColor);
}

References KisColorButton::KisColorButtonPrivate::col, d, defaultColor, and setDefaultColor().

◆ ~KisColorButton()

KisColorButton::~KisColorButton ( )

override

Definition at line 136 of file kis_color_button.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ changed

void KisColorButton::changed ( const KoColor & newColor )

signal

Emitted when the color of the widget is changed, either with setColor() or via user selection.

◆ color()

KoColor KisColorButton::color ( ) const

Returns the currently chosen color.

Definition at line 141 of file kis_color_button.cpp.

{
    return d->col;
}

References KisColorButton::KisColorButtonPrivate::col, and d.

◆ defaultColor()

KoColor KisColorButton::defaultColor ( ) const

Returns the default color or an invalid color if no default color is set.

Definition at line 173 of file kis_color_button.cpp.

{
    return d->m_defaultColor;
}

References d, and KisColorButton::KisColorButtonPrivate::m_defaultColor.

◆ dragEnterEvent()

void KisColorButton::dragEnterEvent ( QDragEnterEvent * event )

overrideprotected

Definition at line 261 of file kis_color_button.cpp.

{
    event->setAccepted(_k_canDecode(event->mimeData()) && isEnabled());
}

References _k_canDecode().

◆ dropEvent()

void KisColorButton::dropEvent ( QDropEvent * event )

overrideprotected

Definition at line 266 of file kis_color_button.cpp.

{
    QColor c = _k_fromMimeData(event->mimeData());
    if (c.isValid()) {
        KoColor col;
        col.fromQColor(c);
        setColor(col);
    }
}

References _k_fromMimeData(), KoColor::fromQColor(), and setColor().

◆ isAlphaChannelEnabled()

bool KisColorButton::isAlphaChannelEnabled ( ) const

Returns true if the user is allowed to change the alpha component.

Definition at line 158 of file kis_color_button.cpp.

{
    return d->m_alphaChannel;
}

References d, and KisColorButton::KisColorButtonPrivate::m_alphaChannel.

◆ keyPressEvent()

void KisColorButton::keyPressEvent ( QKeyEvent * e )

overrideprotected

Definition at line 276 of file kis_color_button.cpp.

{
    int key = e->key() | e->modifiers();
 
    if (QKeySequence::keyBindings(QKeySequence::Copy).contains(key)) {
        QMimeData *mime = new QMimeData;
        _k_populateMimeData(mime, color());
        QApplication::clipboard()->setMimeData(mime, QClipboard::Clipboard);
    } else if (QKeySequence::keyBindings(QKeySequence::Paste).contains(key)) {
        QColor color = _k_fromMimeData(QApplication::clipboard()->mimeData(QClipboard::Clipboard));
        KoColor col;
        col.fromQColor(color);
        setColor(col);
    } else {
        QPushButton::keyPressEvent(e);
    }
}

References _k_fromMimeData(), _k_populateMimeData(), color, KoColor::fromQColor(), and setColor().

◆ minimumSizeHint()

QSize KisColorButton::minimumSizeHint ( ) const

override

Definition at line 254 of file kis_color_button.cpp.

{
    QStyleOptionButton opt;
    d->initStyleOption(&opt);
    return style()->sizeFromContents(QStyle::CT_PushButton, &opt, QSize(3, 3), this);
}

References d, and KisColorButton::KisColorButtonPrivate::initStyleOption().

◆ mouseMoveEvent()

void KisColorButton::mouseMoveEvent ( QMouseEvent * e )

overrideprotected

Definition at line 300 of file kis_color_button.cpp.

{
    if ((e->buttons() & Qt::LeftButton) &&
            (e->pos() - d->mPos).manhattanLength() > QApplication::startDragDistance()) {
        _k_createDrag(color(), this)->exec();
        setDown(false);
    }
}

References _k_createDrag(), color, d, and KisColorButton::KisColorButtonPrivate::mPos.

◆ mousePressEvent()

void KisColorButton::mousePressEvent ( QMouseEvent * e )

overrideprotected

Definition at line 294 of file kis_color_button.cpp.

{
    d->mPos = e->pos();
    QPushButton::mousePressEvent(e);
}

References d, and KisColorButton::KisColorButtonPrivate::mPos.

◆ paintEvent()

void KisColorButton::paintEvent ( QPaintEvent * pe )

overrideprotected

Definition at line 196 of file kis_color_button.cpp.

{
    QPainter painter(this);
    QStyle *style = QWidget::style();
 
    //First, we need to draw the bevel.
    QStyleOptionButton butOpt;
    d->initStyleOption(&butOpt);
    style->drawControl(QStyle::CE_PushButtonBevel, &butOpt, &painter, this);
 
    //OK, now we can muck around with drawing out pretty little color box
    //First, sort out where it goes
    QRect labelRect = style->subElementRect(QStyle::SE_PushButtonContents,
                                            &butOpt, this);
    int shift = style->pixelMetric(QStyle::PM_ButtonMargin, &butOpt, this) / 2;
    labelRect.adjust(shift, shift, -shift, -shift);
    int x, y, w, h;
    labelRect.getRect(&x, &y, &w, &h);
 
    if (isChecked() || isDown()) {
        x += style->pixelMetric(QStyle::PM_ButtonShiftHorizontal, &butOpt, this);
        y += style->pixelMetric(QStyle::PM_ButtonShiftVertical, &butOpt, this);
    }
 
    QColor fillCol = isEnabled() ? d->col.toQColor() : palette().color(backgroundRole());
    qDrawShadePanel(&painter, x, y, w, h, palette(), true, 1, NULL);
    if (fillCol.isValid()) {
        const QRect rect(x + 1, y + 1, w - 2, h - 2);
        if (fillCol.alpha() < 255) {
            QPixmap chessboardPattern(16, 16);
            QPainter patternPainter(&chessboardPattern);
            patternPainter.fillRect(0, 0, 8, 8, Qt::black);
            patternPainter.fillRect(8, 8, 8, 8, Qt::black);
            patternPainter.fillRect(0, 8, 8, 8, Qt::white);
            patternPainter.fillRect(8, 0, 8, 8, Qt::white);
            patternPainter.end();
            painter.fillRect(rect, QBrush(chessboardPattern));
        }
        painter.fillRect(rect, fillCol);
    }
 
    if (hasFocus()) {
        QRect focusRect = style->subElementRect(QStyle::SE_PushButtonFocusRect, &butOpt, this);
        QStyleOptionFocusRect focusOpt;
        focusOpt.initFrom(this);
        focusOpt.rect            = focusRect;
        focusOpt.backgroundColor = palette().window().color();
        style->drawPrimitive(QStyle::PE_FrameFocusRect, &focusOpt, &painter, this);
    }
}

References KisColorButton::KisColorButtonPrivate::col, d, KisColorButton::KisColorButtonPrivate::initStyleOption(), palette, and KoColor::toQColor().

◆ paletteViewEnabled()

bool KisColorButton::paletteViewEnabled ( ) const

paletteViewEnabled

Returns: whether the palette is enabled.

Definition at line 168 of file kis_color_button.cpp.

{
    return d->m_palette;
}

References d, and KisColorButton::KisColorButtonPrivate::m_palette.

◆ setAlphaChannelEnabled()

void KisColorButton::setAlphaChannelEnabled ( bool alpha )

When set to true, allow the user to change the alpha component of the color. The default value is false.

Definition at line 153 of file kis_color_button.cpp.

{
    d->m_alphaChannel = alpha;
}

References d, and KisColorButton::KisColorButtonPrivate::m_alphaChannel.

◆ setColor

void KisColorButton::setColor ( const KoColor & c )

slot

Sets the current color to c.

Definition at line 146 of file kis_color_button.cpp.

{
    d->col = c;
    update();
    Q_EMIT changed(d->col);
}

References changed(), KisColorButton::KisColorButtonPrivate::col, and d.

◆ setDefaultColor()

void KisColorButton::setDefaultColor ( const KoColor & c )

Sets the default color to c.

Definition at line 178 of file kis_color_button.cpp.

{
    d->m_bdefaultColor = true;
    d->m_defaultColor = c;
}

References d, KisColorButton::KisColorButtonPrivate::m_bdefaultColor, and KisColorButton::KisColorButtonPrivate::m_defaultColor.

◆ setPaletteViewEnabled()

void KisColorButton::setPaletteViewEnabled ( bool enable )

Allow having a palette.

Definition at line 163 of file kis_color_button.cpp.

{
    d->m_palette = enable;
}

References d, and KisColorButton::KisColorButtonPrivate::m_palette.

◆ sizeHint()

QSize KisColorButton::sizeHint ( ) const

override

Definition at line 247 of file kis_color_button.cpp.

{
    QStyleOptionButton opt;
    d->initStyleOption(&opt);
    return style()->sizeFromContents(QStyle::CT_PushButton, &opt, QSize(40, 15), this);
}

References d, and KisColorButton::KisColorButtonPrivate::initStyleOption().

Member Data Documentation

◆ d

KisColorButtonPrivate* const KisColorButton::d

private

Definition at line 118 of file kis_color_button.h.

Property Documentation

◆ alphaChannelEnabled

bool KisColorButton::alphaChannelEnabled

readwrite

Definition at line 36 of file kis_color_button.h.

◆ color

KoColor KisColorButton::color

readwrite

QtCreator treats KoColor as a QColor in incorrect way, so just disable using them in QtCreator https://bugs.kde.org/show_bug.cgi?id=368483

Definition at line 34 of file kis_color_button.h.

◆ defaultColor

KoColor KisColorButton::defaultColor

readwrite

Definition at line 35 of file kis_color_button.h.

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

libs/widgets/kis_color_button.h
libs/widgets/kis_color_button.cpp

Classes

Public Slots

Signals

Public Member Functions

Protected Member Functions

Properties

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisColorButton() [1/3]

◆ KisColorButton() [2/3]

◆ KisColorButton() [3/3]

◆ ~KisColorButton()

Member Function Documentation

◆ changed

◆ color()

◆ defaultColor()

◆ dragEnterEvent()

◆ dropEvent()

◆ isAlphaChannelEnabled()

◆ keyPressEvent()

◆ minimumSizeHint()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ paintEvent()

◆ paletteViewEnabled()

◆ setAlphaChannelEnabled()

◆ setColor

◆ setDefaultColor()

◆ setPaletteViewEnabled()

◆ sizeHint()

Member Data Documentation

◆ d

Property Documentation

◆ alphaChannelEnabled

◆ color

◆ defaultColor