#include <kis_favorite_resource_manager.h>

Inheritance diagram for KisFavoriteResourceManager:

Public Slots
void	slotAddRecentColor (const KoColor &)

void	slotChangeActivePaintop (int)

void	slotChangeFGColorSelector (KoColor c)

void	slotClearHistory ()

void	slotSetBGColor (const KoColor c)

void	slotUpdateRecentColor (int)

Signals
void	hidePalettes ()

void	setSelectedColor (int)

void	sigChangeFGColorSelector (const KoColor &)

void	sigSetBGColor (const KoColor &c)

void	sigSetFGColor (const KoColor &c)

void	updatePalettes ()

Public Member Functions
KoColor	bgColor () const

QList< QImage >	favoritePresetImages ()

QVector< QString >	favoritePresetNamesList ()

	KisFavoriteResourceManager (KisPaintopBox *paintopBox)

int	numFavoritePresets ()

KoColor	recentColorAt (int pos)

int	recentColorsTotal ()

void	removingResource (QSharedPointer< KisPaintOpPreset > resource) override

void	resourceAdded (QSharedPointer< KisPaintOpPreset > resource) override

void	resourceChanged (QSharedPointer< KisPaintOpPreset > resource) override

void	setCurrentTag (const KisTagSP tag)

void	unsetResourceServer () override

void	updateFavoritePresets ()

	~KisFavoriteResourceManager () override

Public Member Functions inherited from KoResourceServerObserver< KisPaintOpPreset >
virtual	~KoResourceServerObserver ()

Private Slots
void	configChanged ()

void	presetsChanged ()

Private Member Functions
void	init ()

void	saveFavoritePresets ()

Private Attributes
KoColor	m_bgColor

QScopedPointer< KisSortedHistoryList< KoColor > >	m_colorHistoryList

KisTagSP	m_currentTag

bool	m_initialized {false}

int	m_maxPresets {0}

KisPaintopBox *	m_paintopBox {nullptr}

KisResourceModel *	m_resourceModel {nullptr}

KisTagFilterResourceProxyModel *	m_resourcesProxyModel {nullptr}

KisTagModel *	m_tagModel {nullptr}

Static Private Attributes
static const int	MAX_RECENT_COLOR = 12

Detailed Description

Definition at line 27 of file kis_favorite_resource_manager.h.

Constructor & Destructor Documentation

◆ KisFavoriteResourceManager()

KisFavoriteResourceManager::KisFavoriteResourceManager ( KisPaintopBox * paintopBox )

Definition at line 29 of file kis_favorite_resource_manager.cpp.

    : m_paintopBox(paintopBox)
    , m_colorHistoryList(new KisSortedHistoryList<KoColor>(MAX_RECENT_COLOR))
 
{
    connect(KisConfigNotifier::instance(), SIGNAL(configChanged()), SLOT(configChanged()));
    configChanged();
 
    KisPaintOpPresetResourceServer * rServer = KisResourceServerProvider::instance()->paintOpPresetServer();
    rServer->addObserver(this);
}

References KoResourceServer< T >::addObserver(), configChanged(), connect(), KisConfigNotifier::instance(), KisResourceServerProvider::instance(), and KisResourceServerProvider::paintOpPresetServer().

◆ ~KisFavoriteResourceManager()

KisFavoriteResourceManager::~KisFavoriteResourceManager ( )

override

Definition at line 41 of file kis_favorite_resource_manager.cpp.

{
    KisPaintOpPresetResourceServer *rServer = KisResourceServerProvider::instance()->paintOpPresetServer();
    rServer->removeObserver(this);
}

References KisResourceServerProvider::instance(), KisResourceServerProvider::paintOpPresetServer(), and KoResourceServer< T >::removeObserver().

Member Function Documentation

◆ bgColor()

KoColor KisFavoriteResourceManager::bgColor ( ) const

Definition at line 167 of file kis_favorite_resource_manager.cpp.

{
    return m_bgColor;
}

References m_bgColor.

◆ configChanged

void KisFavoriteResourceManager::configChanged ( )

privateslot

Definition at line 182 of file kis_favorite_resource_manager.cpp.

{
    KisConfig cfg(true);
    m_maxPresets = cfg.favoritePresets();
    updateFavoritePresets();
 
    using compare_less = KisSortedHistoryList<KoColor>::compare_less;
 
    compare_less sortingFunc;
    const QString sortingType = cfg.readEntry("popuppalette/colorHistorySorting", QString("hsv"));
    if (sortingType == "hsv") {
        sortingFunc = [] (const KoColor &lhs, const KoColor &rhs) {
            auto makeHsvTuple = [] (const KoColor &color) {
                int h, s, v;
                color.toQColor().getHsv(&h, &s, &v);
                return std::make_tuple(h, s, v);
            };
            return makeHsvTuple(lhs) < makeHsvTuple(rhs);
        };
    }
 
    m_colorHistoryList->setCompareLess(sortingFunc);
}

References KisConfig::favoritePresets(), m_colorHistoryList, m_maxPresets, KisConfig::readEntry(), updateFavoritePresets(), and v.

◆ favoritePresetImages()

QList< QImage > KisFavoriteResourceManager::favoritePresetImages ( )

Definition at line 69 of file kis_favorite_resource_manager.cpp.

{
    init();
    QList<QImage> images;
    for (int i = 0; i < m_maxPresets; i++) {
        QModelIndex index = m_resourcesProxyModel->index(i, 0);
        if (index.isValid()) {
            QVariant tmp = m_resourcesProxyModel->data(index, Qt::UserRole + KisAbstractResourceModel::Thumbnail);
            QImage image = tmp.value<QImage>();
            images << image;
        } else {
            break; // no more valid indices
        }
    }
    return images;
}

References init(), m_maxPresets, m_resourcesProxyModel, and KisAbstractResourceModel::Thumbnail.

◆ favoritePresetNamesList()

QVector< QString > KisFavoriteResourceManager::favoritePresetNamesList ( )

Definition at line 51 of file kis_favorite_resource_manager.cpp.

{
    init();
 
    QVector<QString> names;
    for (int i = 0; i < m_maxPresets; i++) {
        QModelIndex index = m_resourcesProxyModel->index(i, 0);
        if (index.isValid()) {
            QString name = m_resourcesProxyModel->data(index, Qt::UserRole + KisAbstractResourceModel::Name).toString();
            names << name;
        }  else {
            break; // no more valid indices
        }
    }
 
    return names;
}

References init(), m_maxPresets, m_resourcesProxyModel, and KisAbstractResourceModel::Name.

◆ hidePalettes

void KisFavoriteResourceManager::hidePalettes ( )

signal

◆ init()

void KisFavoriteResourceManager::init ( )

private

Definition at line 211 of file kis_favorite_resource_manager.cpp.

{
    if (!m_initialized) {
        m_initialized = true;
 
        m_tagModel = new KisTagModel(ResourceType::PaintOpPresets, this);
        m_resourcesProxyModel = new KisTagFilterResourceProxyModel(ResourceType::PaintOpPresets, this);
 
        connect(m_resourcesProxyModel, SIGNAL(rowsInserted(QModelIndex, int, int)), this, SLOT(presetsChanged()));
        connect(m_resourcesProxyModel, SIGNAL(rowsRemoved(QModelIndex, int, int)), this, SLOT(presetsChanged()));
        
        m_resourceModel = new KisResourceModel(ResourceType::PaintOpPresets, this);
 
        KisResourceServerProvider::instance()->paintOpPresetServer();
        QString currentTag = KisConfig(true).readEntry<QString>("favoritePresetsTag", "★ My Favorites");
 
        KisTagModel tagModel(ResourceType::PaintOpPresets);
        KisTagSP currentTagSP = tagModel.tagForUrl(currentTag);
        if (!currentTagSP.isNull()) {
            m_currentTag = currentTagSP;
        }
        if (m_currentTag.isNull() && tagModel.rowCount() > 0) {
            // safety measure to have at least *some* tag chosen
            QModelIndex idx = tagModel.index(0, 0);
            currentTagSP = tagModel.tagForIndex(idx);
            if (currentTagSP && !m_currentTag) {
                m_currentTag = currentTagSP;
            }
        }
        m_resourcesProxyModel->setTagFilter(m_currentTag);
        m_resourcesProxyModel->sort(KisAbstractResourceModel::Name);
 
        updateFavoritePresets();
    }
}

References connect(), KisResourceServerProvider::instance(), m_currentTag, m_initialized, m_resourceModel, m_resourcesProxyModel, m_tagModel, KisAbstractResourceModel::Name, ResourceType::PaintOpPresets, KisResourceServerProvider::paintOpPresetServer(), presetsChanged(), KisConfig::readEntry(), KisTagFilterResourceProxyModel::setTagFilter(), and updateFavoritePresets().

◆ numFavoritePresets()

int KisFavoriteResourceManager::numFavoritePresets ( )

Definition at line 107 of file kis_favorite_resource_manager.cpp.

{
    init();
    return favoritePresetNamesList().size();
}

References favoritePresetNamesList(), and init().

◆ presetsChanged

void KisFavoriteResourceManager::presetsChanged ( )

privateslot

Definition at line 206 of file kis_favorite_resource_manager.cpp.

{
    Q_EMIT updatePalettes();
}

References updatePalettes().

◆ recentColorAt()

KoColor KisFavoriteResourceManager::recentColorAt ( int pos )

Definition at line 157 of file kis_favorite_resource_manager.cpp.

{
    return m_colorHistoryList->at(pos);
}

References m_colorHistoryList.

◆ recentColorsTotal()

int KisFavoriteResourceManager::recentColorsTotal ( )

Definition at line 147 of file kis_favorite_resource_manager.cpp.

{
    return m_colorHistoryList->size();
}

References m_colorHistoryList.

◆ removingResource()

void KisFavoriteResourceManager::removingResource ( QSharedPointer< KisPaintOpPreset > resource )

overridevirtual

Will be called by the resource server before a resource will be removed

Parameters

resource the resource which is going to be removed

Implements KoResourceServerObserver< KisPaintOpPreset >.

Definition at line 132 of file kis_favorite_resource_manager.cpp.

{
    updateFavoritePresets();
}

References updateFavoritePresets().

◆ resourceAdded()

void KisFavoriteResourceManager::resourceAdded ( QSharedPointer< KisPaintOpPreset > resource )

overridevirtual

Will be called by the resource server after a resource is added

Parameters

resource the added resource

Implements KoResourceServerObserver< KisPaintOpPreset >.

Definition at line 137 of file kis_favorite_resource_manager.cpp.

{
    updateFavoritePresets();
}

References updateFavoritePresets().

◆ resourceChanged()

void KisFavoriteResourceManager::resourceChanged ( QSharedPointer< KisPaintOpPreset > resource )

overridevirtual

Will be called by the resource server when a resource is changed

Parameters

resource the resource which is going to be removed

Implements KoResourceServerObserver< KisPaintOpPreset >.

Definition at line 142 of file kis_favorite_resource_manager.cpp.

{
    updateFavoritePresets();
}

References updateFavoritePresets().

◆ saveFavoritePresets()

void KisFavoriteResourceManager::saveFavoritePresets ( )

private

◆ setCurrentTag()

void KisFavoriteResourceManager::setCurrentTag ( const KisTagSP tag )

Definition at line 86 of file kis_favorite_resource_manager.cpp.

{
    m_currentTag = tag;
    m_resourcesProxyModel->setTagFilter(tag);
    KisConfig(false).writeEntry<QString>("favoritePresetsTag", tag->url());
    updateFavoritePresets();
}

References m_currentTag, m_resourcesProxyModel, KisTagFilterResourceProxyModel::setTagFilter(), updateFavoritePresets(), and KisConfig::writeEntry().

◆ setSelectedColor

void KisFavoriteResourceManager::setSelectedColor ( int )

signal

◆ sigChangeFGColorSelector

void KisFavoriteResourceManager::sigChangeFGColorSelector ( const KoColor & )

signal

◆ sigSetBGColor

void KisFavoriteResourceManager::sigSetBGColor ( const KoColor & c )

signal

◆ sigSetFGColor

void KisFavoriteResourceManager::sigSetFGColor ( const KoColor & c )

signal

◆ slotAddRecentColor

void KisFavoriteResourceManager::slotAddRecentColor ( const KoColor & color )

slot

Definition at line 121 of file kis_favorite_resource_manager.cpp.

{
    int pos = m_colorHistoryList->append(color);
    Q_EMIT setSelectedColor(pos);
}

References m_colorHistoryList, and setSelectedColor().

◆ slotChangeActivePaintop

void KisFavoriteResourceManager::slotChangeActivePaintop ( int pos )

slot

Definition at line 94 of file kis_favorite_resource_manager.cpp.

{
    //ENTER_FUNCTION() << ppVar(pos) << ppVar(numFavoritePresets());
    if (pos < 0 || pos >= numFavoritePresets()) return;
 
    QModelIndex index = m_resourcesProxyModel->index(pos, 0);
    KoResourceSP resource = m_resourcesProxyModel->resourceForIndex(index);
 
    m_paintopBox->resourceSelected(resource);
 
    Q_EMIT hidePalettes();
}

References hidePalettes(), m_paintopBox, m_resourcesProxyModel, numFavoritePresets(), KisTagFilterResourceProxyModel::resourceForIndex(), and KisPaintopBox::resourceSelected().

◆ slotChangeFGColorSelector

void KisFavoriteResourceManager::slotChangeFGColorSelector ( KoColor c )

slot

Definition at line 127 of file kis_favorite_resource_manager.cpp.

{
    Q_EMIT sigChangeFGColorSelector(c);
}

References sigChangeFGColorSelector().

◆ slotClearHistory

void KisFavoriteResourceManager::slotClearHistory ( )

slot

Clears the color history shown in the popup palette.

Definition at line 152 of file kis_favorite_resource_manager.cpp.

{
    m_colorHistoryList->clear();
}

References m_colorHistoryList.

◆ slotSetBGColor

void KisFavoriteResourceManager::slotSetBGColor ( const KoColor c )

slot

Definition at line 162 of file kis_favorite_resource_manager.cpp.

{
    m_bgColor = c;
}

References m_bgColor.

◆ slotUpdateRecentColor

void KisFavoriteResourceManager::slotUpdateRecentColor ( int pos )

slot

Definition at line 114 of file kis_favorite_resource_manager.cpp.

{
    Q_EMIT setSelectedColor(pos);
    Q_EMIT sigSetFGColor(m_colorHistoryList->at(pos));
    Q_EMIT hidePalettes();
}

References hidePalettes(), m_colorHistoryList, setSelectedColor(), and sigSetFGColor().

◆ unsetResourceServer()

void KisFavoriteResourceManager::unsetResourceServer ( )

overridevirtual

Implements KoResourceServerObserver< KisPaintOpPreset >.

Definition at line 47 of file kis_favorite_resource_manager.cpp.

{
    // ...
}

◆ updateFavoritePresets()

void KisFavoriteResourceManager::updateFavoritePresets ( )

Definition at line 177 of file kis_favorite_resource_manager.cpp.

{
    Q_EMIT updatePalettes();
}

References updatePalettes().

◆ updatePalettes

void KisFavoriteResourceManager::updatePalettes ( )

signal

Member Data Documentation

◆ m_bgColor

KoColor KisFavoriteResourceManager::m_bgColor

private

Definition at line 103 of file kis_favorite_resource_manager.h.

◆ m_colorHistoryList

QScopedPointer<KisSortedHistoryList<KoColor> > KisFavoriteResourceManager::m_colorHistoryList

private

Definition at line 113 of file kis_favorite_resource_manager.h.

◆ m_currentTag

KisTagSP KisFavoriteResourceManager::m_currentTag

private

Definition at line 104 of file kis_favorite_resource_manager.h.

◆ m_initialized

bool KisFavoriteResourceManager::m_initialized {false}

private

Definition at line 106 of file kis_favorite_resource_manager.h.

106{false};

◆ m_maxPresets

int KisFavoriteResourceManager::m_maxPresets {0}

private

Definition at line 108 of file kis_favorite_resource_manager.h.

108{0};

◆ m_paintopBox

KisPaintopBox* KisFavoriteResourceManager::m_paintopBox {nullptr}

private

Definition at line 99 of file kis_favorite_resource_manager.h.

99{nullptr};

◆ m_resourceModel

KisResourceModel* KisFavoriteResourceManager::m_resourceModel {nullptr}

private

Definition at line 112 of file kis_favorite_resource_manager.h.

112{nullptr};

◆ m_resourcesProxyModel

KisTagFilterResourceProxyModel* KisFavoriteResourceManager::m_resourcesProxyModel {nullptr}

private

Definition at line 111 of file kis_favorite_resource_manager.h.

111{nullptr};

◆ m_tagModel

KisTagModel* KisFavoriteResourceManager::m_tagModel {nullptr}

private

Definition at line 110 of file kis_favorite_resource_manager.h.

110{nullptr};

◆ MAX_RECENT_COLOR

const int KisFavoriteResourceManager::MAX_RECENT_COLOR = 12

staticprivate

Definition at line 95 of file kis_favorite_resource_manager.h.

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

libs/ui/kis_favorite_resource_manager.h
libs/ui/kis_favorite_resource_manager.cpp

Public Slots

Signals

Public Member Functions

Private Slots

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ KisFavoriteResourceManager()

◆ ~KisFavoriteResourceManager()

Member Function Documentation

◆ bgColor()

◆ configChanged

◆ favoritePresetImages()

◆ favoritePresetNamesList()

◆ hidePalettes

◆ init()

◆ numFavoritePresets()

◆ presetsChanged

◆ recentColorAt()

◆ recentColorsTotal()

◆ removingResource()

◆ resourceAdded()

◆ resourceChanged()

◆ saveFavoritePresets()

◆ setCurrentTag()

◆ setSelectedColor

◆ sigChangeFGColorSelector

◆ sigSetBGColor

◆ sigSetFGColor

◆ slotAddRecentColor

◆ slotChangeActivePaintop

◆ slotChangeFGColorSelector

◆ slotClearHistory

◆ slotSetBGColor

◆ slotUpdateRecentColor

◆ unsetResourceServer()

◆ updateFavoritePresets()

◆ updatePalettes

Member Data Documentation

◆ m_bgColor

◆ m_colorHistoryList

◆ m_currentTag

◆ m_initialized

◆ m_maxPresets

◆ m_paintopBox

◆ m_resourceModel

◆ m_resourcesProxyModel

◆ m_tagModel

◆ MAX_RECENT_COLOR