A widget for selecting two related colors. More...

#include <KoDualColorButton.h>

Inheritance diagram for KoDualColorButton:

Public Types
enum	Selection { Foreground , Background }

Public Slots
QColor	getColorFromDisplayRenderer (KoColor c)
	getColorFromDisplayRenderer convenience function to get the right qcolor from the display renderer, including checking whether the display renderer actually exists.

void	openBackgroundDialog ()

void	openForegroundDialog ()

void	setBackgroundColor (const KoColor &color)

void	setColorSpace (const KoColorSpace *cs)
	setColorSpace set ColorSpace so we can lock the selector. Right now this'll be changed per view-change.

void	setDisplayRenderer (const KoColorDisplayRendererInterface *displayRenderer=KoDumbColorDisplayRenderer::instance())

void	setForegroundColor (const KoColor &color)

void	setPopDialog (bool popDialog)

void	slotSetForeGroundColorFromDialog (const KoColor color)

Signals
void	backgroundColorChanged (const KoColor &color)

void	foregroundColorChanged (const KoColor &color)

Public Member Functions
KoColor	backgroundColor () const

KoColor	foregroundColor () const

void	init (KoDualColorButton *q)

	KoDualColorButton (const KoColor &foregroundColor, const KoColor &backgroundColor, const KoColorDisplayRendererInterface displayRenderer, QWidget parent=0, QWidget *dialogParent=0)

	KoDualColorButton (const KoColor &foregroundColor, const KoColor &backgroundColor, QWidget parent=0, QWidget dialogParent=0)

bool	popDialog () const

	Private (const KoColor &fgColor, const KoColor &bgColor, QWidget _dialogParent, const KoColorDisplayRendererInterface _displayRenderer)

QSize	sizeHint () const override

void	updateArrows ()

	~KoDualColorButton () override

Public Attributes
QPixmap	arrowBitmap

KoColor	backgroundColor

KisDlgInternalColorSelector *	colorSelectorDialog

QWidget *	dialogParent

QPointer< const KoColorDisplayRendererInterface >	displayRenderer

bool	dragFlag

QPoint	dragPosition

KoColor	foregroundColor

bool	miniCtlFlag

bool	popDialog

QPixmap	resetPixmap

Selection	tmpSelection

Protected Member Functions
void	changeEvent (QEvent *event) override

void	dragEnterEvent (QDragEnterEvent *event) override

void	dropEvent (QDropEvent *event) override

bool	event (QEvent *event) override

virtual void	metrics (QRect &foregroundRect, QRect &backgroundRect)

void	mouseMoveEvent (QMouseEvent *event) override

void	mousePressEvent (QMouseEvent *event) override

void	mouseReleaseEvent (QMouseEvent *event) override

void	paintEvent (QPaintEvent *event) override

Private Attributes
Private *const	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

A widget for selecting two related colors.

KoDualColorButton allows the user to select two cascaded colors (usually a foreground and background color). Other features include drag and drop from other KDE color widgets, a reset to black and white control, and a swap colors control.

When the user clicks on the foreground or background rectangle the rectangle is first sunken and the selectionChanged() signal is emitted. Further clicks will present a color dialog and Q_EMIT either the foregroundColorChanged() or backgroundColorChanged() if a new color is selected.

Note: With drag and drop when dropping a color the current selected color will be set, while when dragging a color it will use whatever color rectangle the mouse was pressed inside.

Author: Daniel M. Duley mosfe.nosp@m.t@kd.nosp@m.e.org

Definition at line 30 of file KoDualColorButton.cpp.

Member Enumeration Documentation

◆ Selection

enum KoDualColorButton::Selection

Enumerator
Foreground
Background

Definition at line 47 of file KoDualColorButton.h.

                   {
      Foreground,
      Background
    };

Constructor & Destructor Documentation

◆ KoDualColorButton() [1/2]

KoDualColorButton::KoDualColorButton	(	const KoColor &	foregroundColor,
		const KoColor &	backgroundColor,
		QWidget *	parent = 0,
		QWidget *	dialogParent = 0 )

Constructs a new KoDualColorButton with the supplied foreground and background colors.

Parameters

parent	The parent widget of the KoDualColorButton.
dialogParent	The parent widget of the color selection dialog.

Definition at line 100 of file KoDualColorButton.cpp.

    : QWidget( parent ),
      d( new Private(foregroundColor, backgroundColor,
                     dialogParent,
                     KoDumbColorDisplayRenderer::instance()) )
{
    d->init(this);
}

References d.

◆ KoDualColorButton() [2/2]

KoDualColorButton::KoDualColorButton	(	const KoColor &	foregroundColor,
		const KoColor &	backgroundColor,
		const KoColorDisplayRendererInterface *	displayRenderer,
		QWidget *	parent = 0,
		QWidget *	dialogParent = 0 )

Definition at line 109 of file KoDualColorButton.cpp.

    : QWidget( parent ),
      d( new Private(foregroundColor, backgroundColor,
                     dialogParent,
                     displayRenderer) )
{
    d->init(this);
}

References d.

◆ ~KoDualColorButton()

KoDualColorButton::~KoDualColorButton ( )

override

Destroys the KoDualColorButton.

Definition at line 120 of file KoDualColorButton.cpp.

{
    delete d;
}

References d.

Member Function Documentation

◆ backgroundColor()

KoColor KoDualColorButton::backgroundColor ( ) const

Returns the current background color.

◆ backgroundColorChanged

void KoDualColorButton::backgroundColorChanged ( const KoColor & color )

signal

Emitted when the background color is changed.

◆ changeEvent()

void KoDualColorButton::changeEvent ( QEvent * event )

overrideprotected

Definition at line 404 of file KoDualColorButton.cpp.

{
    QWidget::changeEvent(event);
 
    switch (event->type()) {
    case QEvent::StyleChange:
    case QEvent::PaletteChange:
        d->updateArrows();
    default:
        break;
    }
}

References d, and event().

◆ dragEnterEvent()

void KoDualColorButton::dragEnterEvent ( QDragEnterEvent * event )

overrideprotected

Definition at line 233 of file KoDualColorButton.cpp.

{
    event->setAccepted( isEnabled() && KColorMimeData::canDecode( event->mimeData() ) );
}

References event().

◆ dropEvent()

void KoDualColorButton::dropEvent ( QDropEvent * event )

overrideprotected

Definition at line 238 of file KoDualColorButton.cpp.

{
    Q_UNUSED(event);
    /*  QColor color = KColorMimeData::fromMimeData( event->mimeData() );
 
  if ( color.isValid() ) {
    if ( d->selection == Foreground ) {
      d->foregroundColor = color;
      Q_EMIT foregroundColorChanged( color );
    } else {
      d->backgroundColor = color;
      Q_EMIT backgroundColorChanged( color );
    }
 
    update();
  }
*/
}

References event().

◆ event()

bool KoDualColorButton::event ( QEvent * event )

overrideprotected

Definition at line 417 of file KoDualColorButton.cpp.

{
    if (event->type() == QEvent::ToolTip) {
        QRect foregroundRect;
        QRect backgroundRect;
        metrics( foregroundRect, backgroundRect );
 
        if (this->mapFromGlobal(QCursor::pos()).x() < backgroundRect.x() ) {
            if (this->mapFromGlobal(QCursor::pos()).y() < backgroundRect.y()){
                this->setToolTip(i18n("Foreground color selector"));
            }
            else{
                this->setToolTip(i18n("Set foreground and background colors to black and white"));
            }
        }
        else {
            if (this->mapFromGlobal(QCursor::pos()).y() < backgroundRect.y() ) {
                this->setToolTip(i18n("Swap foreground and background colors"));
            }
            else{
                this->setToolTip(i18n("Background color selector"));
            }
        }
    }
    return QWidget::event(event);
 
}

References event(), and metrics().

◆ foregroundColor()

KoColor KoDualColorButton::foregroundColor ( ) const

Returns the current foreground color.

◆ foregroundColorChanged

void KoDualColorButton::foregroundColorChanged ( const KoColor & color )

signal

Emitted when the foreground color is changed.

◆ getColorFromDisplayRenderer

QColor KoDualColorButton::getColorFromDisplayRenderer ( KoColor c )

slot

getColorFromDisplayRenderer convenience function to get the right qcolor from the display renderer, including checking whether the display renderer actually exists.

Parameters

c	the kocolor to convert.

Returns: the qcolor to use for display.

Definition at line 185 of file KoDualColorButton.cpp.

{
    QColor col;
    if (d->displayRenderer) {
        c.convertTo(d->displayRenderer->getPaintingColorSpace());
        col = d->displayRenderer->toQColor(c);
    } else {
        col = c.toQColor();
    }
    return col;
}

References KoColor::convertTo(), d, and KoColor::toQColor().

◆ init()

void KoDualColorButton::init ( KoDualColorButton * q )

◆ metrics()

void KoDualColorButton::metrics	(	QRect &	foregroundRect,
		QRect &	backgroundRect )

protectedvirtual

Sets the supplied rectangles to the proper size and position for the current widget size. You can reimplement this to change the layout of the widget. Restrictions are that the swap control will always be at the top right, the reset control will always be at the bottom left, and you must leave at least a 14x14 space in those corners.

Definition at line 202 of file KoDualColorButton.cpp.

{
    foregroundRect = QRect( 0, 0, width() - 14, height() - 14 );
    backgroundRect = QRect( 14, 14, width() - 14, height() - 14 );
}

◆ mouseMoveEvent()

void KoDualColorButton::mouseMoveEvent ( QMouseEvent * event )

overrideprotected

Definition at line 323 of file KoDualColorButton.cpp.

{
    if ( !d->miniCtlFlag ) {
        int delay = QApplication::startDragDistance();
 
        if ( event->x() >= d->dragPosition.x() + delay || event->x() <= d->dragPosition.x() - delay ||
             event->y() >= d->dragPosition.y() + delay || event->y() <= d->dragPosition.y() - delay ) {
            KColorMimeData::createDrag( d->tmpSelection == Foreground ?
                                            getColorFromDisplayRenderer(d->foregroundColor) :
                                            getColorFromDisplayRenderer(d->backgroundColor),
                                        this )->exec();
            d->dragFlag = true;
        }
    }
}

References d, event(), Foreground, and getColorFromDisplayRenderer().

◆ mousePressEvent()

void KoDualColorButton::mousePressEvent ( QMouseEvent * event )

overrideprotected

Definition at line 278 of file KoDualColorButton.cpp.

{
    QRect foregroundRect;
    QRect backgroundRect;
 
    metrics( foregroundRect, backgroundRect );
 
    d->dragPosition = event->pos();
 
    d->dragFlag = false;
 
    if ( foregroundRect.contains( d->dragPosition ) ) {
        d->tmpSelection = Foreground;
        d->miniCtlFlag = false;
    }
    else if( backgroundRect.contains( d->dragPosition ) ) {
        d->tmpSelection = Background;
        d->miniCtlFlag = false;
    }
    else if ( event->pos().x() > foregroundRect.width() ) {
        // We handle the swap and reset controls as soon as the mouse is
        // is pressed and ignore further events on this click (mosfet).
 
        KoColor tmp = d->foregroundColor;
        d->foregroundColor = d->backgroundColor;
        d->backgroundColor = tmp;
 
        Q_EMIT backgroundColorChanged( d->backgroundColor );
        Q_EMIT foregroundColorChanged( d->foregroundColor );
 
        d->miniCtlFlag = true;
    }
    else if ( event->pos().x() < backgroundRect.x() ) {
        d->foregroundColor = d->displayRenderer->approximateFromRenderedQColor(Qt::black);
        d->backgroundColor = d->displayRenderer->approximateFromRenderedQColor(Qt::white);
 
        Q_EMIT backgroundColorChanged( d->backgroundColor );
        Q_EMIT foregroundColorChanged( d->foregroundColor );
 
        d->miniCtlFlag = true;
    }
    update();
}

References Background, backgroundColorChanged(), d, event(), Foreground, foregroundColorChanged(), and metrics().

◆ mouseReleaseEvent()

void KoDualColorButton::mouseReleaseEvent ( QMouseEvent * event )

overrideprotected

Definition at line 339 of file KoDualColorButton.cpp.

{
    d->dragFlag = false;
 
    if ( d->miniCtlFlag )
        return;
 
    d->miniCtlFlag = false;
 
    QRect foregroundRect;
    QRect backgroundRect;
    metrics( foregroundRect, backgroundRect );
 
    KConfigGroup cfg =  KSharedConfig::openConfig()->group("colorselector");
    bool usePlatformDialog = cfg.readEntry("UsePlatformColorDialog", false);
 
    if (foregroundRect.contains( event->pos())) {
        if (d->tmpSelection == Foreground) {
            if (d->popDialog) {
                if (usePlatformDialog) {
                    QColor c = d->foregroundColor.toQColor();
                    c = QColorDialog::getColor(c, this);
                    if (c.isValid()) {
                        d->foregroundColor = d->displayRenderer->approximateFromRenderedQColor(c);
                        Q_EMIT foregroundColorChanged(d->foregroundColor);
                    }
                }
                else {
                    d->colorSelectorDialog->setPreviousColor(d->foregroundColor);
                    d->colorSelectorDialog->show();
                }
            }
        }
        else {
            d->foregroundColor = d->backgroundColor;
            Q_EMIT foregroundColorChanged( d->foregroundColor );
        }
    }
    else if (backgroundRect.contains( event->pos())) {
        if(d->tmpSelection == Background ) {
            if( d->popDialog) {
                if (usePlatformDialog) {
                    QColor c = d->backgroundColor.toQColor();
                    c = QColorDialog::getColor(c, this);
                    if (c.isValid()) {
                        d->backgroundColor = d->displayRenderer->approximateFromRenderedQColor(c);
                        Q_EMIT backgroundColorChanged(d->backgroundColor);
                    }
                }
                else {
                    KoColor c = d->backgroundColor;
                    c = KisDlgInternalColorSelector::getModalColorDialog(c, this, d->colorSelectorDialog->windowTitle());
                    d->backgroundColor = c;
                    Q_EMIT backgroundColorChanged(d->backgroundColor);
                }
            }
        } else {
            d->backgroundColor = d->foregroundColor;
            Q_EMIT backgroundColorChanged( d->backgroundColor );
        }
    }
 
    update();
}

References Background, backgroundColorChanged(), d, event(), Foreground, foregroundColorChanged(), KisDlgInternalColorSelector::getModalColorDialog(), and metrics().

◆ openBackgroundDialog

void KoDualColorButton::openBackgroundDialog ( )

slot

Definition at line 271 of file KoDualColorButton.cpp.

                                            {
    KoColor c = d->backgroundColor;
    c = KisDlgInternalColorSelector::getModalColorDialog(c, this, d->colorSelectorDialog->windowTitle());
    d->backgroundColor = c;
    Q_EMIT backgroundColorChanged(d->backgroundColor);
}

References backgroundColorChanged(), d, and KisDlgInternalColorSelector::getModalColorDialog().

◆ openForegroundDialog

void KoDualColorButton::openForegroundDialog ( )

slot

Definition at line 265 of file KoDualColorButton.cpp.

                                            {
    d->colorSelectorDialog->setPreviousColor(d->foregroundColor);
    d->colorSelectorDialog->show();
    update();
}

References d.

◆ paintEvent()

void KoDualColorButton::paintEvent ( QPaintEvent * event )

overrideprotected

Definition at line 208 of file KoDualColorButton.cpp.

{
    QRect foregroundRect;
    QRect backgroundRect;
 
    QPainter painter( this );
 
    metrics( foregroundRect, backgroundRect );
 
    QBrush defBrush = palette().brush( QPalette::Button );
    QBrush foregroundBrush( getColorFromDisplayRenderer(d->foregroundColor), Qt::SolidPattern );
    QBrush backgroundBrush( getColorFromDisplayRenderer(d->backgroundColor), Qt::SolidPattern );
 
    qDrawShadeRect( &painter, backgroundRect, palette(), false, 1, 0,
                    isEnabled() ? &backgroundBrush : &defBrush );
 
    qDrawShadeRect( &painter, foregroundRect, palette(), false, 1, 0,
                    isEnabled() ? &foregroundBrush : &defBrush );
 
    painter.setPen( palette().color( QPalette::Shadow ) );
 
    painter.drawPixmap( foregroundRect.right() + 2, 1, d->arrowBitmap );
    painter.drawPixmap( 1, foregroundRect.bottom() + 2, d->resetPixmap );
}

References d, getColorFromDisplayRenderer(), metrics(), and palette.

◆ popDialog()

bool KoDualColorButton::popDialog ( ) const

Returns if a dialog with a color chooser will be popped up when clicking If false then you could/should connect to the pleasePopDialog signal and pop your own dialog. Just set the current color afterwards.

◆ Private()

KoDualColorButton::Private	(	const KoColor &	fgColor,
		const KoColor &	bgColor,
		QWidget *	_dialogParent,
		const KoColorDisplayRendererInterface *	_displayRenderer )

inline

Definition at line 33 of file KoDualColorButton.cpp.

        : dialogParent(_dialogParent)
        , dragFlag( false )
        , miniCtlFlag( false )
        , foregroundColor(fgColor)
        , backgroundColor(bgColor)
 
        , displayRenderer(_displayRenderer)
    {
        updateArrows();
        resetPixmap = QPixmap( (const char **)dcolorreset_xpm );
 
        popDialog = true;
    }

◆ setBackgroundColor

void KoDualColorButton::setBackgroundColor ( const KoColor & color )

slot

Sets the background color.

Definition at line 159 of file KoDualColorButton.cpp.

{
    d->backgroundColor = color;
    update();
}

References d.

◆ setColorSpace

void KoDualColorButton::setColorSpace ( const KoColorSpace * cs )

slot

setColorSpace set ColorSpace so we can lock the selector. Right now this'll be changed per view-change.

Parameters

cs

Definition at line 180 of file KoDualColorButton.cpp.

{
    d->colorSelectorDialog->lockUsedColorSpace(cs);
}

References d.

◆ setDisplayRenderer

void KoDualColorButton::setDisplayRenderer ( const KoColorDisplayRendererInterface * displayRenderer = KoDumbColorDisplayRenderer::instance() )

slot

Definition at line 165 of file KoDualColorButton.cpp.

{
    if (d->displayRenderer && d->displayRenderer != KoDumbColorDisplayRenderer::instance()) {
        d->displayRenderer->disconnect(this);
    }
    if (displayRenderer) {
        d->displayRenderer = displayRenderer;
        d->colorSelectorDialog->setDisplayRenderer(displayRenderer);
        connect(d->displayRenderer, SIGNAL(destroyed()), this, SLOT(setDisplayRenderer()), Qt::UniqueConnection);
        connect(d->displayRenderer, SIGNAL(displayConfigurationChanged()), this, SLOT(update()));
    } else {
        d->displayRenderer = KoDumbColorDisplayRenderer::instance();
    }
}

References connect(), d, displayRenderer, KoDumbColorDisplayRenderer::instance(), and setDisplayRenderer().

◆ setForegroundColor

void KoDualColorButton::setForegroundColor ( const KoColor & color )

slot

Sets the foreground color.

The internal color selector might Q_EMIT the color of a different profile, so we should break this cycling dependency somehow.

Definition at line 145 of file KoDualColorButton.cpp.

{
    d->foregroundColor = color;
    {
        KisSignalsBlocker b(d->colorSelectorDialog);
        d->colorSelectorDialog->slotColorUpdated(color);
    }
    update();
}

References d.

◆ setPopDialog

void KoDualColorButton::setPopDialog ( bool popDialog )

slot

Sets if a dialog with a color chooser should be popped up when clicking If you set this to false then you could connect to the pleasePopDialog signal and pop your own dialog. Just set the current color afterwards.

Definition at line 197 of file KoDualColorButton.cpp.

{
    d->popDialog = popDialog;
}

References d, and popDialog.

◆ sizeHint()

QSize KoDualColorButton::sizeHint ( ) const

override

Returns the minimum size needed to display the widget and all its controls.

Definition at line 140 of file KoDualColorButton.cpp.

{
    return QSize(34, 34);
}

◆ slotSetForeGroundColorFromDialog

void KoDualColorButton::slotSetForeGroundColorFromDialog ( const KoColor color )

slot

Definition at line 257 of file KoDualColorButton.cpp.

{
    d->foregroundColor = color;
    update();
    Q_EMIT foregroundColorChanged(d->foregroundColor);
}

References d, and foregroundColorChanged().

◆ updateArrows()

void KoDualColorButton::updateArrows ( )

inline

Definition at line 50 of file KoDualColorButton.cpp.

                        {
        arrowBitmap = QPixmap(12,12);
        arrowBitmap.fill(Qt::transparent);
 
        QPainter p(&arrowBitmap);
        p.setPen(dialogParent->palette().windowText().color());
 
        // arrow pointing left
        p.drawLine(0, 3, 7, 3);
        p.drawLine(1, 2, 1, 4);
        p.drawLine(2, 1, 2, 5);
        p.drawLine(3, 0, 3, 6);
 
        // arrow pointing down
        p.drawLine(8, 4, 8, 11);
        p.drawLine(5, 8, 11, 8);
        p.drawLine(6, 9, 10, 9);
        p.drawLine(7, 10, 9, 10);
    }

References p.

Member Data Documentation

◆ arrowBitmap

QPixmap KoDualColorButton::arrowBitmap

Definition at line 72 of file KoDualColorButton.cpp.

◆ backgroundColor

KoColor KoDualColorButton::backgroundColor

readwrite

Definition at line 76 of file KoDualColorButton.cpp.

◆ colorSelectorDialog

KisDlgInternalColorSelector* KoDualColorButton::colorSelectorDialog

Definition at line 77 of file KoDualColorButton.cpp.

◆ d

Private* const KoDualColorButton::d

private

Definition at line 167 of file KoDualColorButton.h.

◆ dialogParent

QWidget* KoDualColorButton::dialogParent

Definition at line 70 of file KoDualColorButton.cpp.

◆ displayRenderer

QPointer<const KoColorDisplayRendererInterface> KoDualColorButton::displayRenderer

Definition at line 81 of file KoDualColorButton.cpp.

◆ dragFlag

bool KoDualColorButton::dragFlag

Definition at line 74 of file KoDualColorButton.cpp.

◆ dragPosition

QPoint KoDualColorButton::dragPosition

Definition at line 78 of file KoDualColorButton.cpp.

◆ foregroundColor

KoColor KoDualColorButton::foregroundColor

readwrite

Definition at line 75 of file KoDualColorButton.cpp.

◆ miniCtlFlag

bool KoDualColorButton::miniCtlFlag

Definition at line 74 of file KoDualColorButton.cpp.

◆ popDialog

bool KoDualColorButton::popDialog

readwrite

Definition at line 80 of file KoDualColorButton.cpp.

◆ resetPixmap

QPixmap KoDualColorButton::resetPixmap

Definition at line 73 of file KoDualColorButton.cpp.

◆ tmpSelection

Selection KoDualColorButton::tmpSelection

Definition at line 79 of file KoDualColorButton.cpp.

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

libs/ui/widgets/KoDualColorButton.cpp
libs/ui/widgets/KoDualColorButton.h

Public Types

Public Slots

Signals

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ Selection

Constructor & Destructor Documentation

◆ KoDualColorButton() [1/2]

◆ KoDualColorButton() [2/2]

◆ ~KoDualColorButton()

Member Function Documentation

◆ backgroundColor()

◆ backgroundColorChanged

◆ changeEvent()

◆ dragEnterEvent()

◆ dropEvent()

◆ event()

◆ foregroundColor()

◆ foregroundColorChanged

◆ getColorFromDisplayRenderer

◆ init()

◆ metrics()

◆ mouseMoveEvent()

◆ mousePressEvent()

◆ mouseReleaseEvent()

◆ openBackgroundDialog

◆ openForegroundDialog

◆ paintEvent()

◆ popDialog()

◆ Private()

◆ setBackgroundColor

◆ setColorSpace

◆ setDisplayRenderer

◆ setForegroundColor

◆ setPopDialog

◆ sizeHint()

◆ slotSetForeGroundColorFromDialog

◆ updateArrows()

Member Data Documentation

◆ arrowBitmap

◆ backgroundColor

◆ colorSelectorDialog

◆ d

◆ dialogParent

◆ displayRenderer

◆ dragFlag

◆ dragPosition

◆ foregroundColor

◆ miniCtlFlag

◆ popDialog

◆ resetPixmap

◆ tmpSelection