KisScreenColorSampler Class Reference

The KisScreenColorSampler class Based on the original QColorDialog's screen color picker, this class provides a button that can be used to activate a color sampler that can sample from anywhere on the screen. More...

#include <KisScreenColorSampler.h>

Inheritance diagram for KisScreenColorSampler:

Classes
struct	Private

Public Slots
void	cancel ()
void	sampleScreenColor ()
void	setCurrentColor (KoColor c)
void	setPerformRealColorSamplingOfCanvas (bool enable)

Signals
void	sigNewColorHovered (KoColor c)
void	sigNewColorSampled (KoColor c)
Signals inherited from KisScreenColorSamplerBase
void	sigNewColorSampled (KoColor)

Public Member Functions
KoColor	currentColor ()
bool	handleColorSamplingKeyPress (QKeyEvent *e)
bool	handleColorSamplingMouseButtonRelease (QMouseEvent *e)
bool	handleColorSamplingMouseMove (QMouseEvent *e)
	KisScreenColorSampler (bool showInfoLabel=false, QWidget *parent=0)
bool	performRealColorSamplingOfCanvas () const
void	updateIcons () override
	reloads icon(s) when theme is updated
	~KisScreenColorSampler () override
Public Member Functions inherited from KisScreenColorSamplerBase
	KisScreenColorSamplerBase (QWidget *parent=0)
virtual	~KisScreenColorSamplerBase ()

Static Public Member Functions
static KisScreenColorSampler *	createScreenColorSampler (QWidget *parent=0)

Protected Member Functions
void	changeEvent (QEvent *event) override

Private Slots
void	updateColorSampling ()

Private Member Functions
void	continueUpdateColorSampling (const QPoint &globalPos)
KoColor	grabScreenColor (const QPoint &p)
void	releaseColorSampling ()
void	updateColorLabelText (const QPoint &globalPos)

Private Attributes
const QScopedPointer< Private >	m_d

Detailed Description

The KisScreenColorSampler class Based on the original QColorDialog's screen color picker, this class provides a button that can be used to activate a color sampler that can sample from anywhere on the screen.

Definition at line 23 of file KisScreenColorSampler.h.

Constructor & Destructor Documentation

KisScreenColorSampler()

KisScreenColorSampler::KisScreenColorSampler ( bool showInfoLabel = false, QWidget * parent = 0 )

explicit

Definition at line 59 of file KisScreenColorSampler.cpp.

                                                                                : KisScreenColorSamplerBase(parent), m_d(new Private)
{
    QVBoxLayout *layout = new QVBoxLayout(this);
    m_d->screenColorSamplerButton = new QPushButton();
 
    m_d->screenColorSamplerButton->setMinimumHeight(25);
    layout->addWidget(m_d->screenColorSamplerButton);
 
    if (showInfoLabel) {
        m_d->lblScreenColorInfo = new QLabel(QLatin1String("\n"));
        layout->addWidget(m_d->lblScreenColorInfo);
    }
 
    layout->setContentsMargins(0, 0, 0, 0);
 
    connect(m_d->screenColorSamplerButton, SIGNAL(clicked()), SLOT(sampleScreenColor()));
 
    updateIcons();
 
#ifdef Q_OS_WIN32
    m_d->updateTimer = new QTimer(this);
    m_d->dummyTransparentWindow.resize(1, 1);
    m_d->dummyTransparentWindow.setFlags(Qt::Tool | Qt::FramelessWindowHint);
    connect(m_d->updateTimer, SIGNAL(timeout()), SLOT(updateColorSampling()));
#endif
}

References connect(), m_d, sampleScreenColor(), updateColorSampling(), and updateIcons().

~KisScreenColorSampler()

KisScreenColorSampler::~KisScreenColorSampler ( )

override

Definition at line 86 of file KisScreenColorSampler.cpp.

{
}

Member Function Documentation

cancel

void KisScreenColorSampler::cancel ( )

slot

Definition at line 153 of file KisScreenColorSampler.cpp.

{
    releaseColorSampling();
    setCurrentColor(m_d->beforeScreenColorSampling);
    Q_EMIT sigNewColorSampled(currentColor());
}

References currentColor(), m_d, releaseColorSampling(), setCurrentColor(), and sigNewColorSampled().

changeEvent()

void KisScreenColorSampler::changeEvent ( QEvent * event )

overrideprotected

Definition at line 269 of file KisScreenColorSampler.cpp.

{
    QWidget::changeEvent(e);
}

continueUpdateColorSampling()

void KisScreenColorSampler::continueUpdateColorSampling ( const QPoint & globalPos )

private

Definition at line 290 of file KisScreenColorSampler.cpp.

{
    const KoColor color = grabScreenColor(globalPos);
    // QTBUG-39792, do not change standard, custom color selectors while moving as
    // otherwise it is not possible to preselect a custom cell for assignment.
    setCurrentColor(color);
    Q_EMIT sigNewColorHovered(currentColor());
    updateColorLabelText(globalPos);
}

References currentColor(), grabScreenColor(), setCurrentColor(), sigNewColorHovered(), and updateColorLabelText().

createScreenColorSampler()

static KisScreenColorSampler * KisScreenColorSampler::createScreenColorSampler ( QWidget * parent = 0 )

inlinestatic

Definition at line 41 of file KisScreenColorSampler.h.

{return new KisScreenColorSampler(parent);}

currentColor()

KoColor KisScreenColorSampler::currentColor

(

)

Definition at line 95 of file KisScreenColorSampler.cpp.

{
    return m_d->currentColor;
}

References m_d.

grabScreenColor()

KoColor KisScreenColorSampler::grabScreenColor ( const QPoint & p )

private

Definition at line 160 of file KisScreenColorSampler.cpp.

{
     // First check whether we're clicking on a Krita window for some real color sampling
    if (m_d->performRealColorSamplingOfCanvas) {
        Q_FOREACH(KisView *view, KisPart::instance()->views()) {
            const KisCanvas2 *canvas = view->canvasBase();
            const QWidget *canvasWidget = canvas->canvasWidget();
            QPoint widgetPoint = canvasWidget->mapFromGlobal(p);
 
            if (canvasWidget->visibleRegion().contains(widgetPoint)) {
                KisImageWSP image = view->image();
 
                if (image) {
                    QPointF imagePoint = canvas->coordinatesConverter()->widgetToImage(widgetPoint);
                    // sample from reference images first
                    KisSharedPtr<KisReferenceImagesLayer> referenceImageLayer = view->document()->referenceImagesLayer();
 
                    if (referenceImageLayer && canvas->referenceImagesDecoration()->visible()) {
                        QColor color = referenceImageLayer->getPixel(imagePoint);
                        if (color.isValid()) {
                            return KoColor(color, image->colorSpace());
                        }
                     }
                    if (image->wrapAroundModePermitted()) {
                        imagePoint = KisWrappedRect::ptToWrappedPt(imagePoint.toPoint(), image->bounds(), image->wrapAroundModeAxis());
                    }
                    KoColor sampledColor = KoColor();
                    image->projection()->pixel(imagePoint.x(), imagePoint.y(), &sampledColor);
                    return sampledColor;
                 }
             }
         }
     }
 
    KoColor col = KoColor();
    QScreen *targetScreen = QGuiApplication::screenAt(p);
 
    if (targetScreen) {
        const QPoint screenPos = p - targetScreen->geometry().topLeft();
 
        QImage grabImage = targetScreen->grabWindow(0, screenPos.x(), screenPos.y(), 1, 1).toImage();
        col.fromQColor(QColor::fromRgb(grabImage.pixel(0, 0)));
    }
 
    return col;
}

References KisImage::bounds(), KisView::canvasBase(), KisCanvas2::canvasWidget, KisImage::colorSpace(), KisCanvas2::coordinatesConverter, KisView::document, KoColor::fromQColor(), KisView::image(), KisPart::instance(), m_d, p, KisPaintDevice::pixel(), KisImage::projection(), KisWrappedRect::ptToWrappedPt(), KisCanvas2::referenceImagesDecoration(), KisCanvasDecoration::visible(), KisCoordinatesConverter::widgetToImage(), KisImage::wrapAroundModeAxis(), and KisImage::wrapAroundModePermitted().

handleColorSamplingKeyPress()

bool KisScreenColorSampler::handleColorSamplingKeyPress

(

QKeyEvent *

e

)

Definition at line 235 of file KisScreenColorSampler.cpp.

{
    if (e->matches(QKeySequence::Cancel)) {
        cancel();
    } else if (e->key() == Qt::Key_Return || e->key() == Qt::Key_Enter) {
        setCurrentColor(grabScreenColor(QCursor::pos()));
        Q_EMIT sigNewColorSampled(currentColor());
        releaseColorSampling();
    }
    e->accept();
    return true;
}

References cancel(), currentColor(), grabScreenColor(), releaseColorSampling(), setCurrentColor(), and sigNewColorSampled().

handleColorSamplingMouseButtonRelease()

bool KisScreenColorSampler::handleColorSamplingMouseButtonRelease

(

QMouseEvent *

e

)

Definition at line 227 of file KisScreenColorSampler.cpp.

{
    setCurrentColor(grabScreenColor(e->globalPos()));
    Q_EMIT sigNewColorSampled(currentColor());
    releaseColorSampling();
    return true;
}

References currentColor(), grabScreenColor(), releaseColorSampling(), setCurrentColor(), and sigNewColorSampled().

handleColorSamplingMouseMove()

bool KisScreenColorSampler::handleColorSamplingMouseMove

(

QMouseEvent *

e

)

Definition at line 218 of file KisScreenColorSampler.cpp.

{
    // If the cross is visible the grabbed color will be black most of the times
    //cp->setCrossVisible(!cp->geometry().contains(e->pos()));
 
    continueUpdateColorSampling(e->globalPos());
    return true;
}

References continueUpdateColorSampling().

performRealColorSamplingOfCanvas()

bool KisScreenColorSampler::performRealColorSamplingOfCanvas

(

)

const

Definition at line 100 of file KisScreenColorSampler.cpp.

{
    return m_d->performRealColorSamplingOfCanvas;
}

References m_d.

releaseColorSampling()

void KisScreenColorSampler::releaseColorSampling ( )

private

Definition at line 248 of file KisScreenColorSampler.cpp.

{
    // HACK: see class KisGrabKeyboardFocusRecoveryWorkaround
    KisGrabKeyboardFocusRecoveryWorkaround::instance()->recoverFocus();
 
    m_d->inputGrabberWidget->removeEventFilter(m_d->colorSamplingEventFilter);
    m_d->inputGrabberWidget->releaseMouse();
#ifdef Q_OS_WIN32
    m_d->updateTimer->stop();
    m_d->dummyTransparentWindow.setVisible(false);
#endif
    m_d->inputGrabberWidget->releaseKeyboard();
    m_d->inputGrabberWidget->setMouseTracking(false);
 
    if (m_d->lblScreenColorInfo) {
        m_d->lblScreenColorInfo->setText(QLatin1String("\n"));
    }
 
    m_d->screenColorSamplerButton->setDisabled(false);
}

References KisGrabKeyboardFocusRecoveryWorkaround::instance(), m_d, and KisGrabKeyboardFocusRecoveryWorkaround::recoverFocus().

sampleScreenColor

void KisScreenColorSampler::sampleScreenColor ( )

slot

Definition at line 110 of file KisScreenColorSampler.cpp.

{
    m_d->updateInputGrabberWidget();
    if (m_d->inputGrabberWidget == nullptr) {
        Q_EMIT sigNewColorSampled(currentColor());
        return;
    }
 
    if (!m_d->colorSamplingEventFilter) {
        m_d->colorSamplingEventFilter = new KisScreenColorSamplingEventFilter(this, this);
    }
    m_d->inputGrabberWidget->installEventFilter(m_d->colorSamplingEventFilter);
     // If user pushes Escape, the last color before sampling will be restored.
    m_d->beforeScreenColorSampling = currentColor();
    m_d->inputGrabberWidget->grabMouse(Qt::CrossCursor);
 
#ifdef Q_OS_WIN32 // excludes WinCE and WinRT
    // On Windows mouse tracking doesn't work over other processes's windows
    m_d->updateTimer->start(30);
 
    // HACK: Because mouse grabbing doesn't work across processes, we have to have a dummy,
    // invisible window to catch the mouse click, otherwise we will click whatever we clicked
    // and loose focus.
    m_d->dummyTransparentWindow.show();
#endif
    m_d->inputGrabberWidget->grabKeyboard();
     /* With setMouseTracking(true) the desired color can be more precisely sampled,
      * and continuously pushing the mouse button is not necessary.
      */
    m_d->inputGrabberWidget->setMouseTracking(true);
 
    m_d->screenColorSamplerButton->setDisabled(true);
 
    const QPoint globalPos = QCursor::pos();
    setCurrentColor(grabScreenColor(globalPos));
    updateColorLabelText(globalPos);
}

References currentColor(), grabScreenColor(), m_d, setCurrentColor(), sigNewColorSampled(), and updateColorLabelText().

setCurrentColor

void KisScreenColorSampler::setCurrentColor ( KoColor c )

slot

Definition at line 148 of file KisScreenColorSampler.cpp.

{
    m_d->currentColor = c;
}

References m_d.

setPerformRealColorSamplingOfCanvas

void KisScreenColorSampler::setPerformRealColorSamplingOfCanvas ( bool enable )

slot

Definition at line 105 of file KisScreenColorSampler.cpp.

{
    m_d->performRealColorSamplingOfCanvas = enable;
}

References m_d.

sigNewColorHovered

void KisScreenColorSampler::sigNewColorHovered ( KoColor c )

signal

sigNewColorSampled

void KisScreenColorSampler::sigNewColorSampled ( KoColor c )

signal

updateColorLabelText()

void KisScreenColorSampler::updateColorLabelText ( const QPoint & globalPos )

private

Definition at line 207 of file KisScreenColorSampler.cpp.

{
    if (m_d->lblScreenColorInfo) {
        KoColor col = grabScreenColor(globalPos);
        QString colname = KoColor::toQString(col);
        QString location = QString::number(globalPos.x())+QString(", ")+QString::number(globalPos.y());
        m_d->lblScreenColorInfo->setWordWrap(true);
        m_d->lblScreenColorInfo->setText(location+QString(": ")+colname);
    }
}

References grabScreenColor(), m_d, and KoColor::toQString().

updateColorSampling

void KisScreenColorSampler::updateColorSampling ( )

privateslot

Definition at line 274 of file KisScreenColorSampler.cpp.

{
    static QPoint lastGlobalPos;
    QPoint newGlobalPos = QCursor::pos();
    if (lastGlobalPos == newGlobalPos)
        return;
    lastGlobalPos = newGlobalPos;
 
    if (!rect().contains(mapFromGlobal(newGlobalPos))) { // Inside the dialog mouse tracking works, handleColorSamplingMouseMove will be called
        continueUpdateColorSampling(newGlobalPos);
#ifdef Q_OS_WIN32
        m_d->dummyTransparentWindow.setPosition(newGlobalPos);
#endif
    }
}

References continueUpdateColorSampling(), and m_d.

updateIcons()

void KisScreenColorSampler::updateIcons ( )

overridevirtual

reloads icon(s) when theme is updated

Implements KisScreenColorSamplerBase.

Definition at line 90 of file KisScreenColorSampler.cpp.

{
    m_d->screenColorSamplerButton->setIcon(kisIcon("krita_tool_color_sampler"));
}

References kisIcon, and m_d.

Member Data Documentation

m_d

const QScopedPointer<Private> KisScreenColorSampler::m_d

private

Definition at line 59 of file KisScreenColorSampler.h.

---

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

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