Inheritance diagram for KisRecentDocumentsModelItem:

Public Member Functions
QVariant	data (int role=Qt::UserRole+1) const override

	KisRecentDocumentsModelItem (const QUrl &url)

void	setData (const QVariant &value, int role=Qt::UserRole+1) override

	~KisRecentDocumentsModelItem () override

Private Attributes
QIcon	m_fileIcon

bool	m_iconFetched {false}

QString	m_tooltip

QUrl	m_url

Detailed Description

This class implements lazy-loading of file icons when used by, for example, a QListView via a QStandardItemModel. It can be used by the welcome screen to load the thumbnail icons of recent files on demand as the user scrolls through the list, thus avoiding the need to preload all icons when the user may not even look at the list.

Definition at line 26 of file KisRecentDocumentsModelWrapper.cpp.

Constructor & Destructor Documentation

◆ KisRecentDocumentsModelItem()

KisRecentDocumentsModelItem::KisRecentDocumentsModelItem ( const QUrl & url )

explicit

Definition at line 54 of file KisRecentDocumentsModelWrapper.cpp.

    : QStandardItem(url.fileName())
    , m_url(url)
    , m_tooltip(urlToTooltip(url))
{
}

◆ ~KisRecentDocumentsModelItem()

KisRecentDocumentsModelItem::~KisRecentDocumentsModelItem ( )

override

Definition at line 61 of file KisRecentDocumentsModelWrapper.cpp.

61{}

Member Function Documentation

◆ data()

QVariant KisRecentDocumentsModelItem::data ( int role = Qt::UserRole + 1 ) const

override

Definition at line 63 of file KisRecentDocumentsModelWrapper.cpp.

{
    switch (role) {
    case Qt::DecorationRole:
        if (!m_iconFetched) {
            m_iconFetched = true;
            // This lazy-loads the icon if not already cached. Once the real
            // icon has been loaded, `KisRecentDocumentsModelItem` will be
            // notified of the icon change and sets it to this item.
            const QIcon icon = KisRecentFileIconCache::instance()->getOrQueueFileIcon(m_url);
            if (!icon.isNull()) {
                m_fileIcon = icon;
            }
        }
        if (m_fileIcon.isNull()) {
            return KisIconUtils::loadIcon("media-floppy");
        } else {
            return m_fileIcon;
        }
    case Qt::ToolTipRole:
        return m_tooltip;
    case Qt::UserRole + 1:
        return m_url;
    }
    return QStandardItem::data(role);
}

References KisRecentFileIconCache::getOrQueueFileIcon(), KisRecentFileIconCache::instance(), KisIconUtils::loadIcon(), m_fileIcon, m_iconFetched, m_tooltip, and m_url.

◆ setData()

void KisRecentDocumentsModelItem::setData	(	const QVariant &	value,
		int	role = Qt::UserRole + 1 )

override

Definition at line 90 of file KisRecentDocumentsModelWrapper.cpp.

{
    switch (role) {
    case Qt::DecorationRole:
        if (value.type() == (QVariant::Type)QMetaType::QIcon) {
            // `KisRecentDocumentsModelItem` calls `setIcon` to update the
            // file icon once it has been lazy-loaded or changed.
            m_iconFetched = true;
            m_fileIcon = value.value<QIcon>();
            emitDataChanged();
        }
        return;
    case Qt::ToolTipRole:
        qWarning() << "KisRecentDocumentsModelItem::setTooltip ignored";
        return;
    case Qt::UserRole + 1:
        qWarning() << "KisRecentDocumentsModelItem::setData ignored";
        return;
    }
    QStandardItem::setData(value, role);
}