KisRecentDocumentsModelWrapper Class Reference

#include <KisRecentDocumentsModelWrapper.h>

Inheritance diagram for KisRecentDocumentsModelWrapper:

Signals
void	sigModelIsUpToDate ()

Public Member Functions
QStandardItemModel &	model ()

Static Public Member Functions
static KisRecentDocumentsModelWrapper *	instance ()

Static Public Attributes
static constexpr const int	ICON_SIZE_LENGTH = 200

Private Slots
void	fileAdded (const QUrl &url)
void	fileRemoved (const QUrl &url)
void	listRenewed ()
void	slotFileIconChanged (const QUrl &url, const QIcon &icon)

Private Member Functions
	KisRecentDocumentsModelWrapper ()
void	setFiles (const QList< QUrl > &urls)
	~KisRecentDocumentsModelWrapper ()

Private Attributes
QStandardItemModel	m_filesAndThumbnailsModel

Detailed Description

This singleton class provides a QStandardItemModel representing the recent files list and also supports lazy-loading of the file thumbnail icons. Each recent file entry is represented as a QStandardItem. When QStandardItem::icon() is called for the first time, it fetches the icon via KisRecentFileIconCache, which triggers loading the file icon in background if it hasn't already been loaded and cached.

See also KisRecentFilesManager.

Definition at line 26 of file KisRecentDocumentsModelWrapper.h.

Constructor & Destructor Documentation

KisRecentDocumentsModelWrapper()

KisRecentDocumentsModelWrapper::KisRecentDocumentsModelWrapper ( )

private

Definition at line 113 of file KisRecentDocumentsModelWrapper.cpp.

{
    connect(KisRecentFileIconCache::instance(),
            SIGNAL(fileIconChanged(const QUrl &, const QIcon &)),
            SLOT(slotFileIconChanged(const QUrl &, const QIcon &)));
    connect(KisRecentFilesManager::instance(),
            SIGNAL(fileAdded(const QUrl &)),
            SLOT(fileAdded(const QUrl &)));
    connect(KisRecentFilesManager::instance(),
            SIGNAL(fileRemoved(const QUrl &)),
            SLOT(fileRemoved(const QUrl &)));
    connect(KisRecentFilesManager::instance(),
            SIGNAL(listRenewed()),
            SLOT(listRenewed()));
 
    // Load the initial recent files list
    listRenewed();
}

References connect(), fileAdded(), fileRemoved(), KisRecentFileIconCache::instance(), KisRecentFilesManager::instance(), listRenewed(), and slotFileIconChanged().

~KisRecentDocumentsModelWrapper()

KisRecentDocumentsModelWrapper::~KisRecentDocumentsModelWrapper ( )

private

Definition at line 132 of file KisRecentDocumentsModelWrapper.cpp.

{}

Member Function Documentation

fileAdded

void KisRecentDocumentsModelWrapper::fileAdded ( const QUrl & url )

privateslot

Definition at line 169 of file KisRecentDocumentsModelWrapper.cpp.

{
    m_filesAndThumbnailsModel.insertRow(0, new KisRecentDocumentsModelItem(url));
    Q_EMIT sigModelIsUpToDate();
}

References m_filesAndThumbnailsModel, and sigModelIsUpToDate().

fileRemoved

void KisRecentDocumentsModelWrapper::fileRemoved ( const QUrl & url )

privateslot

Definition at line 175 of file KisRecentDocumentsModelWrapper.cpp.

{
    const int count = m_filesAndThumbnailsModel.rowCount();
    for (int i = 0; i < count; i++) {
        QStandardItem *item = m_filesAndThumbnailsModel.item(i);
        if (item && item->data() == url) {
            m_filesAndThumbnailsModel.removeRow(i);
            Q_EMIT sigModelIsUpToDate();
            return;
        }
    }
}

References m_filesAndThumbnailsModel, and sigModelIsUpToDate().

instance()

KisRecentDocumentsModelWrapper * KisRecentDocumentsModelWrapper::instance ( )

static

Definition at line 134 of file KisRecentDocumentsModelWrapper.cpp.

{
    if (QThread::currentThread() != qApp->thread()) {
        qWarning() << "KisRecentDocumentsModelWrapper::instance() called from non-GUI thread!";
        return nullptr;
    }
    static KisRecentDocumentsModelWrapper s_instance;
    return &s_instance;
}

listRenewed

void KisRecentDocumentsModelWrapper::listRenewed ( )

privateslot

Definition at line 188 of file KisRecentDocumentsModelWrapper.cpp.

{
    setFiles(KisRecentFilesManager::instance()->recentUrlsLatestFirst());
}

References KisRecentFilesManager::instance(), and setFiles().

model()

QStandardItemModel & KisRecentDocumentsModelWrapper::model

(

)

Get underlying model

No need for any extra setup. This will hold the provided files

Definition at line 193 of file KisRecentDocumentsModelWrapper.cpp.

{
    return m_filesAndThumbnailsModel;
}

References m_filesAndThumbnailsModel.

setFiles()

void KisRecentDocumentsModelWrapper::setFiles ( const QList< QUrl > & urls )

private

Update m_filesAndThumbnailsModel and launch worker thread to fetch icons in background

Definition at line 144 of file KisRecentDocumentsModelWrapper.cpp.

{
    // Replace all items in the model. The existing items are deleted by
    // `QStandardItemModel`.
    m_filesAndThumbnailsModel.setRowCount(urls.count());
    for (int i = 0; i < urls.count(); i++) {
        QStandardItem *item = new KisRecentDocumentsModelItem(urls[i]);
        m_filesAndThumbnailsModel.setItem(i, item);
    }
 
    Q_EMIT sigModelIsUpToDate();
}

References m_filesAndThumbnailsModel, and sigModelIsUpToDate().

sigModelIsUpToDate

void KisRecentDocumentsModelWrapper::sigModelIsUpToDate ( )

signal

Report when the model has been updated with the latest recent file list.

slotFileIconChanged

void KisRecentDocumentsModelWrapper::slotFileIconChanged ( const QUrl & url, const QIcon & icon )

privateslot

Definition at line 157 of file KisRecentDocumentsModelWrapper.cpp.

{
    const int count = m_filesAndThumbnailsModel.rowCount();
    for (int i = 0; i < count; i++) {
        QStandardItem *item = m_filesAndThumbnailsModel.item(i);
        if (item && item->data() == url) {
            item->setIcon(icon);
            return;
        }
    }
}

References m_filesAndThumbnailsModel.

Member Data Documentation

ICON_SIZE_LENGTH

constexpr const int KisRecentDocumentsModelWrapper::ICON_SIZE_LENGTH = 200

staticconstexpr

Definition at line 30 of file KisRecentDocumentsModelWrapper.h.

m_filesAndThumbnailsModel

QStandardItemModel KisRecentDocumentsModelWrapper::m_filesAndThumbnailsModel

private

Definition at line 52 of file KisRecentDocumentsModelWrapper.h.

---

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

• libs/ui/utils/KisRecentDocumentsModelWrapper.h
• libs/ui/utils/KisRecentDocumentsModelWrapper.cpp