KisRecentFilesManager Class Reference

#include <KisRecentFilesManager.h>

Inheritance diagram for KisRecentFilesManager:

Classes
class	Private

Signals
void	fileAdded (const QUrl &url)
void	fileRemoved (const QUrl &url)
void	listRenewed ()

Public Member Functions
void	add (const QUrl &url)
void	clear ()
QVector< KisRecentFilesEntry >	recentFiles () const
QList< QUrl >	recentUrlsLatestFirst () const
void	remove (const QUrl &url)

Static Public Member Functions
static KisRecentFilesManager *	instance ()

Private Member Functions
	KisRecentFilesManager ()
void	loadEntries (const KConfigGroup &config)
void	saveEntries (const KConfigGroup &config)
	~KisRecentFilesManager ()

Private Attributes
Private *	m_d

Detailed Description

Definition at line 25 of file KisRecentFilesManager.h.

Constructor & Destructor Documentation

KisRecentFilesManager()

KisRecentFilesManager::KisRecentFilesManager ( )

private

Definition at line 74 of file KisRecentFilesManager.cpp.

    : m_d(new Private(this))
{
    loadEntries(KSharedConfig::openConfig()->group("RecentFiles"));
}

References loadEntries().

~KisRecentFilesManager()

KisRecentFilesManager::~KisRecentFilesManager ( )

private

Definition at line 80 of file KisRecentFilesManager.cpp.

{
    delete m_d;
}

References m_d.

Member Function Documentation

add()

void KisRecentFilesManager::add

(

const QUrl &

url

)

Definition at line 121 of file KisRecentFilesManager_p.h.

{
    const QString name; // Dummy
 
    if (m_d->m_maxItems <= 0) {
        return;
    }
 
    if (url.isLocalFile() && url.toLocalFile().startsWith(QDir::tempPath())) {
        return;
    }
    const QString tmpName = name.isEmpty() ? url.fileName() : name;
    const QString pathOrUrl(url.toDisplayString(QUrl::PreferLocalFile));
 
#ifdef Q_OS_WIN
    const QString file = url.isLocalFile() ? QDir::toNativeSeparators(pathOrUrl) : pathOrUrl;
#else
    const QString file = pathOrUrl;
#endif
 
    // remove file if already in list
    {
        int removeIndex = m_d->indexOfUrl(url);
        if (removeIndex >= 0) {
            m_d->m_entries.removeAt(removeIndex);
            Q_EMIT fileRemoved(url);
        }
    }
 
    // remove oldest item if already maxitems in list
    if (m_d->m_entries.count() >= m_d->m_maxItems) {
        // remove oldest added item
        m_d->m_entries.removeFirst();
    }
 
    m_d->m_entries.append(KisRecentFilesEntry {
        url, // m_url
        tmpName, // m_displayName
    });
    Q_EMIT fileAdded(url);
    m_d->requestSaveOnNextTick();
}

References fileAdded(), fileRemoved(), KisRecentFilesManager::Private::indexOfUrl(), m_d, KisRecentFilesManager::Private::m_entries, KisRecentFilesManager::Private::m_maxItems, and KisRecentFilesManager::Private::requestSaveOnNextTick().

clear()

void KisRecentFilesManager::clear

(

)

Definition at line 95 of file KisRecentFilesManager.cpp.

{
    m_d->m_entries.clear();
    Q_EMIT listRenewed();
    m_d->requestSaveOnNextTick();
}

References listRenewed(), m_d, KisRecentFilesManager::Private::m_entries, and KisRecentFilesManager::Private::requestSaveOnNextTick().

fileAdded

void KisRecentFilesManager::fileAdded ( const QUrl & url )

signal

fileRemoved

void KisRecentFilesManager::fileRemoved ( const QUrl & url )

signal

instance()

KisRecentFilesManager * KisRecentFilesManager::instance ( )

static

Definition at line 85 of file KisRecentFilesManager.cpp.

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

listRenewed

void KisRecentFilesManager::listRenewed ( )

signal

loadEntries()

void KisRecentFilesManager::loadEntries ( const KConfigGroup & config )

private

Definition at line 28 of file KisRecentFilesManager_p.h.

{
    m_d->m_entries.clear();
 
    KConfigGroup cg = _config;
    if (cg.name().isEmpty()) {
        cg = KConfigGroup(cg.config(), "RecentFiles");
    }
 
    m_d->m_maxItems = cg.readEntry("maxRecentFileItems", 100);
    
    for (int i = 0; i < m_d->m_maxItems; ++i) {
        const QString key = QString("File%1").arg(i+1);
        QString value;
#ifdef Q_OS_ANDROID
        value = cg.readEntry(key, QString());
#else
        value = cg.readPathEntry(key, QString());
#endif
        if (value.isEmpty()) {
            continue;
        }
        QUrl url = QUrl::fromUserInput(value);
 
        if (url.isLocalFile()) {
            QString localFilePath = url.toLocalFile();
            QFileInfo fileInfo = QFileInfo(localFilePath);
 
            // Don't restore if file doesn't exist anymore
            if (!fileInfo.exists()) {
                continue;
            }
 
            // When KConfigGroup substitutes $HOME, it may produce a path
            // with two consecutive forward slashes. This may cause duplicated
            // entries of the same file when opened using the file selector,
            // in which the path does not include this double slash.
            // `absoluteFilePath` replaces the double slash to a single slash.
            value = fileInfo.absoluteFilePath();
            url = QUrl::fromLocalFile(value);
        }
 
        // Don't restore where the url is already known (eg. broken config)
        if (m_d->containsUrl(url)) {
            continue;
        }
 
#ifdef Q_OS_WIN
        // convert to backslashes
        if (url.isLocalFile()) {
            value = QDir::toNativeSeparators(value);
        }
#endif
 
        const QString nameKey = QString("Name%1").arg(i+1);
        const QString nameValue = cg.readEntry(nameKey, url.fileName());
        m_d->m_entries.append(KisRecentFilesEntry {
            url, // m_url
            nameValue, // m_displayName
        });
    }
 
    Q_EMIT listRenewed();
}

References KisRecentFilesManager::Private::containsUrl(), listRenewed(), m_d, KisRecentFilesManager::Private::m_entries, KisRecentFilesManager::Private::m_maxItems, and value().

recentFiles()

QVector< KisRecentFilesEntry > KisRecentFilesManager::recentFiles

(

)

const

Definition at line 112 of file KisRecentFilesManager.cpp.

{
    return m_d->m_entries;
}

References m_d, and KisRecentFilesManager::Private::m_entries.

recentUrlsLatestFirst()

QList< QUrl > KisRecentFilesManager::recentUrlsLatestFirst

(

)

const

Definition at line 117 of file KisRecentFilesManager.cpp.

{
    // switch order so last opened file is first
    QList<QUrl> sortedList;
    for (int i = m_d->m_entries.length() - 1; i >= 0; i--) {
        sortedList.append(m_d->m_entries[i].m_url);
    }
 
    return sortedList;
}

References m_d, and KisRecentFilesManager::Private::m_entries.

remove()

void KisRecentFilesManager::remove

(

const QUrl &

url

)

Definition at line 102 of file KisRecentFilesManager.cpp.

{
    int removeIndex = m_d->indexOfUrl(url);
    if (removeIndex >= 0) {
        m_d->m_entries.removeAt(removeIndex);
        Q_EMIT fileRemoved(url);
        m_d->requestSaveOnNextTick();
    }
}

References fileRemoved(), KisRecentFilesManager::Private::indexOfUrl(), m_d, KisRecentFilesManager::Private::m_entries, and KisRecentFilesManager::Private::requestSaveOnNextTick().

saveEntries()

void KisRecentFilesManager::saveEntries ( const KConfigGroup & config )

private

Definition at line 93 of file KisRecentFilesManager_p.h.

{
    KConfigGroup cg = _cg;
    if (cg.name().isEmpty()) {
        cg = KConfigGroup(cg.config(), "RecentFiles");
    }
 
    cg.deleteGroup();
 
    cg.writeEntry("maxRecentFileItems", m_d->m_maxItems);
 
    // write file list
    for (int i = 0; i < m_d->m_entries.count(); ++i) {
        const QString key = QString("File%1").arg(i+1);
        QString value;
#ifdef Q_OS_ANDROID
        value = m_d->m_entries[i].m_url.toDisplayString();
        cg.writeEntry(key, value);
#else
        value = m_d->m_entries[i].m_url.toDisplayString(QUrl::PreferLocalFile);
        cg.writePathEntry(key, value);
#endif
        const QString nameKey = QString("Name%1").arg(i+1);
        const QString nameValue = m_d->m_entries[i].m_displayName;
        cg.writeEntry(nameKey, nameValue);
    }
}

References m_d, KisRecentFilesManager::Private::m_entries, KisRecentFilesManager::Private::m_maxItems, and value().

Member Data Documentation

m_d

Private* KisRecentFilesManager::m_d

private

Definition at line 30 of file KisRecentFilesManager.h.

---

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

• libs/widgetutils/KisRecentFilesManager.h
• libs/widgetutils/KisRecentFilesManager.cpp
• libs/widgetutils/KisRecentFilesManager_p.h