#include <kis_color_history.h>

Inheritance diagram for KisColorHistory:

Public Slots
void	addColorToHistory (const KoColor &color)

void	clearColorHistory ()

void	colorHistoryChanged (const QList< KoColor > &history)

void	updateUserSettings ()

Public Slots inherited from KisColorPatches
void	updateSettings () override

Public Slots inherited from KisColorSelectorBase
virtual void	reset ()

virtual void	showPopup (Move move=MoveToMousePosition)

virtual void	updateSettings ()

Public Member Functions
	KisColorHistory (QWidget *parent=0)

void	setCanvas (KisCanvas2 *canvas) override

void	unsetCanvas () override

Public Member Functions inherited from KisColorPatches
void	addColorPatch (const KoColor &color)

QList< KoColor >	colors () const

	KisColorPatches (QString configPrefix, QWidget *parent=0)

void	mousePressEvent (QMouseEvent *) override

void	mouseReleaseEvent (QMouseEvent *) override

int	patchCount () const

void	setAdditionalButtons (QList< QWidget * > buttonList)

void	setCanvas (KisCanvas2 *canvas) override

void	setColors (const QList< KoColor > &colors)

void	unsetCanvas () override

Public Member Functions inherited from KisColorSelectorBase
const KoColorSpace *	colorSpace () const

KisDisplayColorConverter *	converter () const

void	enterEvent (QEnterEvent *e) override

	KisColorSelectorBase (QWidget *parent=0)

void	leaveEvent (QEvent *e) override

void	mousePressEvent (QMouseEvent *) override

void	mouseReleaseEvent (QMouseEvent *) override

virtual void	setColor (const KoColor &color)

void	setColorSpace (const KoColorSpace *colorSpace)

void	setPopupBehaviour (bool onMouseOver, bool onMouseClick)

void	showColorPreview ()

void	slotUpdateColorAndPreview (QPair< KoColor, Acs::ColorRole > color)

void	tryHideAllPopups ()

void	updateBaseColorPreview (const KoColor &color)

void	updateColor (const KoColor &color, Acs::ColorRole role, bool needsExplicitColorReset)

void	updateColorPreview (const KoColor &color)

void	updatePreviousColorPreview ()

	~KisColorSelectorBase () override

Protected Member Functions
KisColorSelectorBase *	createPopup () const override

Protected Member Functions inherited from KisColorSelectorBase
void	changeEvent (QEvent *event) override

void	dragEnterEvent (QDragEnterEvent *) override

void	dropEvent (QDropEvent *) override

bool	isPopup () const

void	keyPressEvent (QKeyEvent *) override

void	mouseMoveEvent (QMouseEvent *event) override

void	requestUpdateColorAndPreview (const KoColor &color, Acs::ColorRole role)

void	setHidingTime (int time)

void	showEvent (QShowEvent *event) override

Private Member Functions
QList< KoColor >	colorHistory ()

void	updateColorHistory (const QList< KoColor > &history)

Private Attributes
QToolButton *	m_clearButton

KisDocument *	m_document

bool	m_history_per_document = false

KisCanvasResourceProvider *	m_resourceProvider

Additional Inherited Members
Public Types inherited from KisColorPatches
enum	Direction { Horizontal , Vertical }

Public Types inherited from KisColorSelectorBase
enum	Move { MoveToMousePosition , DontMove }

Protected Slots inherited from KisColorSelectorBase
virtual void	canvasResourceChanged (int key, const QVariant &v)
	if you overwrite this, keep in mind, that you should set the color only, if m_colorUpdateAllowed is true

void	hidePopup ()

void	updateLastUsedColorPreview (const KoColor &color)

Protected Attributes inherited from KisColorSelectorBase
QPointer< KisCanvas2 >	m_canvas

bool	m_colorUpdateAllowed

bool	m_colorUpdateSelf

QWidget *	m_parent

KisColorSelectorBase *	m_popup

Detailed Description

Definition at line 16 of file kis_color_history.h.

Constructor & Destructor Documentation

◆ KisColorHistory()

KisColorHistory::KisColorHistory ( QWidget * parent = 0 )

explicit

Definition at line 23 of file kis_color_history.cpp.

    : KisColorPatches("lastUsedColors", parent)
    , m_document(0)
    , m_resourceProvider(0)
{
    m_clearButton = new QToolButton(this);
    m_clearButton->setIcon(KisIconUtils::loadIcon("dialog-cancel-16"));
    m_clearButton->setToolTip(i18n("Clear all color history"));
    m_clearButton->setAutoRaise(true);
    updateUserSettings();
 
    connect(m_clearButton, SIGNAL(clicked()), this, SLOT(clearColorHistory()));
    connect(KisConfigNotifier::instance(), SIGNAL(colorHistoryModeChanged()), this, SLOT(updateUserSettings()));
    connect(s_color_history_change_notifier, SIGNAL(colorHistoryChanged(const QList<KoColor>&)),
            this, SLOT(colorHistoryChanged(const QList<KoColor>&)));
 
    setAdditionalButtons({m_clearButton});
}

References clearColorHistory(), colorHistoryChanged(), connect(), KisConfigNotifier::instance(), KisIconUtils::loadIcon(), m_clearButton, KisColorPatches::setAdditionalButtons(), and updateUserSettings().

Member Function Documentation

◆ addColorToHistory

void KisColorHistory::addColorToHistory ( const KoColor & color )

slot

Definition at line 77 of file kis_color_history.cpp.

{
    // don't add color in erase mode. See https://bugs.kde.org/show_bug.cgi?id=298940
    if (m_resourceProvider && m_resourceProvider->currentCompositeOp() == COMPOSITE_ERASE) return;
 
    KisColorPatches::addColorPatch(color);
 
    updateColorHistory(colors());
    s_color_history_change_notifier->notifyColorHistoryChanged(colors());
}

References KisColorPatches::addColorPatch(), KisColorPatches::colors(), COMPOSITE_ERASE, KisCanvasResourceProvider::currentCompositeOp(), m_resourceProvider, and updateColorHistory().

◆ clearColorHistory

void KisColorHistory::clearColorHistory ( )

slot

Definition at line 88 of file kis_color_history.cpp.

{
    QList<KoColor> empty;
    updateColorHistory(empty);
    s_color_history_change_notifier->notifyColorHistoryChanged(empty);
}

References updateColorHistory().

◆ colorHistory()

QList< KoColor > KisColorHistory::colorHistory ( )

private

Definition at line 95 of file kis_color_history.cpp.

{
    if (m_history_per_document && m_document) {
        return m_document->colorHistory();
    } else if (m_resourceProvider) {
        return m_resourceProvider->colorHistory();
    } else {
        return QList<KoColor>();
    }
}

References KisCanvasResourceProvider::colorHistory(), KisDocument::colorHistory, m_document, m_history_per_document, and m_resourceProvider.

◆ colorHistoryChanged

void KisColorHistory::colorHistoryChanged ( const QList< KoColor > & history )

slot

Definition at line 131 of file kis_color_history.cpp.

{
    KIS_SAFE_ASSERT_RECOVER_RETURN(sender() != this);
 
    if (m_resourceProvider) {
        m_resourceProvider->setColorHistory(history);
    }
    setColors(history);
}

References KIS_SAFE_ASSERT_RECOVER_RETURN, m_resourceProvider, KisCanvasResourceProvider::setColorHistory(), and KisColorPatches::setColors().

◆ createPopup()

KisColorSelectorBase * KisColorHistory::createPopup ( ) const

overrideprotectedvirtual

Implements KisColorSelectorBase.

Definition at line 69 of file kis_color_history.cpp.

{
    KisColorHistory *ret = new KisColorHistory();
    ret->setCanvas(m_canvas);
    ret->setColors(colors());
    return ret;
}

References KisColorPatches::colors(), KisColorHistory(), KisColorSelectorBase::m_canvas, setCanvas(), and KisColorPatches::setColors().

◆ setCanvas()

void KisColorHistory::setCanvas ( KisCanvas2 * canvas )

overridevirtual

Reimplemented from KisColorSelectorBase.

Definition at line 50 of file kis_color_history.cpp.

{
    if (!canvas) return;
 
    KisColorPatches::setCanvas(canvas);
 
    if (m_resourceProvider) {
        m_resourceProvider->disconnect(this);
    }
 
    m_resourceProvider = canvas->imageView()->resourceProvider();
    m_document = canvas->viewManager()->document();
 
    setColors(colorHistory());
 
    connect(m_resourceProvider, SIGNAL(sigFGColorUsed(KoColor)),
            this, SLOT(addColorToHistory(KoColor)), Qt::UniqueConnection);
}

References addColorToHistory(), colorHistory(), connect(), KisViewManager::document(), KisCanvas2::imageView(), m_document, m_resourceProvider, KisColorPatches::setCanvas(), KisColorPatches::setColors(), and KisCanvas2::viewManager().

◆ unsetCanvas()

void KisColorHistory::unsetCanvas ( )

overridevirtual

Reimplemented from KisColorSelectorBase.

Definition at line 42 of file kis_color_history.cpp.

{
    m_resourceProvider = 0;
    m_document = 0;
 
    KisColorPatches::unsetCanvas();
}

References m_document, m_resourceProvider, and KisColorPatches::unsetCanvas().

◆ updateColorHistory()

void KisColorHistory::updateColorHistory ( const QList< KoColor > & history )

private

Resource provider saves the history all the time, whatever the option state is.

Definition at line 106 of file kis_color_history.cpp.

{
    if (m_history_per_document && m_document) {
        m_document->setColorHistory(history);
    }
 
    if (m_resourceProvider) {
        m_resourceProvider->setColorHistory(history);
    }
 
    setColors(history);
}

References m_document, m_history_per_document, m_resourceProvider, KisCanvasResourceProvider::setColorHistory(), KisDocument::setColorHistory(), and KisColorPatches::setColors().

◆ updateUserSettings

void KisColorHistory::updateUserSettings ( )

slot

Definition at line 123 of file kis_color_history.cpp.

{
 
    KisConfig config(true);
    m_history_per_document = config.colorHistoryPerDocument();
    updateColorHistory(colorHistory()); // Show with respect to the current strategy
}

References colorHistory(), KisConfig::colorHistoryPerDocument(), m_history_per_document, and updateColorHistory().

Member Data Documentation

◆ m_clearButton

QToolButton* KisColorHistory::m_clearButton

private

Definition at line 46 of file kis_color_history.h.

◆ m_document

KisDocument* KisColorHistory::m_document

private

Definition at line 47 of file kis_color_history.h.

◆ m_history_per_document

bool KisColorHistory::m_history_per_document = false

private

Definition at line 44 of file kis_color_history.h.

◆ m_resourceProvider

KisCanvasResourceProvider* KisColorHistory::m_resourceProvider

private

Definition at line 48 of file kis_color_history.h.

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

plugins/dockers/advancedcolorselector/kis_color_history.h
plugins/dockers/advancedcolorselector/kis_color_history.cpp

Public Slots

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ KisColorHistory()

Member Function Documentation

◆ addColorToHistory

◆ clearColorHistory

◆ colorHistory()

◆ colorHistoryChanged

◆ createPopup()

◆ setCanvas()

◆ unsetCanvas()

◆ updateColorHistory()

◆ updateUserSettings

Member Data Documentation

◆ m_clearButton

◆ m_document

◆ m_history_per_document

◆ m_resourceProvider