KRecentFilesAction Class Reference

Recent files action. More...

#include <krecentfilesaction.h>

Inheritance diagram for KRecentFilesAction:

Signals
void	urlSelected (const QUrl &url)

Public Member Functions
void	addAction (QAction *action, const QUrl &url, const QString &name)
	KRecentFilesAction (const QIcon &icon, const QString &text, QObject *parent)
	KRecentFilesAction (const QString &text, QObject *parent)
	KRecentFilesAction (QObject *parent)
QAction *	removeAction (QAction *action) override
void	setRecentFilesModel (const QStandardItemModel *model)
	~KRecentFilesAction () override

Private Slots
virtual void	clearActionTriggered ()
void	fileAdded (const QUrl &url)
void	fileRemoved (const QUrl &url)
void	listRenewed ()
void	menuAboutToShow ()
void	modelItemChanged (QStandardItem *item)
void	modelRowsInserted (const QModelIndex &parent, int first, int last)

Private Member Functions
void	clearEntries ()
	Q_PRIVATE_SLOT (d_func(), void _k_urlSelected(QAction *)) void rebuildEntries()

Private Attributes
KRecentFilesActionPrivate *	d_ptr

Detailed Description

Recent files action.

This class is an action to handle a recent files submenu. The best way to create the action is to use KStandardAction::openRecent. Then you simply need to call loadEntries on startup, saveEntries on shutdown, addURL when your application loads/saves a file.

Author

Michael Koch

Definition at line 40 of file krecentfilesaction.h.

Constructor & Destructor Documentation

KRecentFilesAction() [1/3]

KRecentFilesAction::KRecentFilesAction ( QObject * parent )

explicit

Constructs an action with the specified parent.

Parameters

parent

The parent of this action.

Definition at line 53 of file krecentfilesaction.cpp.

    : KSelectAction(parent),
      d_ptr(new KRecentFilesActionPrivate(this))
{
    Q_D(KRecentFilesAction);
    d->init();
}

KRecentFilesAction() [2/3]

KRecentFilesAction::KRecentFilesAction	(	const QString &	text,
		QObject *	parent )

Constructs an action with text; a shortcut may be specified by the ampersand character (e.g. "&Option" creates a shortcut with key O )

This is the most common KAction used when you do not have a corresponding icon (note that it won't appear in the current version of the "Edit ToolBar" dialog, because an action needs an icon to be plugged in a toolbar...).

Parameters

text	The text that will be displayed.
parent	The parent of this action.

Definition at line 61 of file krecentfilesaction.cpp.

    : KSelectAction(parent),
      d_ptr(new KRecentFilesActionPrivate(this))
{
    Q_D(KRecentFilesAction);
    d->init();
 
    // Want to keep the ampersands
    setText(text);
}

KRecentFilesAction() [3/3]

KRecentFilesAction::KRecentFilesAction	(	const QIcon &	icon,
		const QString &	text,
		QObject *	parent )

Constructs an action with text and an icon; a shortcut may be specified by the ampersand character (e.g. "&Option" creates a shortcut with key O )

This is the other common KAction used. Use it when you do have a corresponding icon.

Parameters

icon	The icon to display.
text	The text that will be displayed.
parent	The parent of this action.

Definition at line 72 of file krecentfilesaction.cpp.

    : KSelectAction(parent),
      d_ptr(new KRecentFilesActionPrivate(this))
{
    Q_D(KRecentFilesAction);
    d->init();
 
    setIcon(icon);
    // Want to keep the ampersands
    setText(text);
}

~KRecentFilesAction()

KRecentFilesAction::~KRecentFilesAction ( )

override

Destructor.

Definition at line 135 of file krecentfilesaction.cpp.

{
    delete d_ptr;
}

References d_ptr.

Member Function Documentation

addAction()

void KRecentFilesAction::addAction	(	QAction *	action,
		const QUrl &	url,
		const QString &	name )

Adds action to the list of URLs, with url and title name.

Do not use addAction(QAction*), as no url will be associated, and consequently urlSelected() will not be emitted when action is selected.

Definition at line 198 of file krecentfilesaction.cpp.

{
    Q_D(KRecentFilesAction);
 
    menu()->insertAction(menu()->actions().value(0), action);
    d->m_urls.insert(action, url);
}

References value().

clearActionTriggered

void KRecentFilesAction::clearActionTriggered ( )

privatevirtualslot

Clears the recent files list. Note that there is also an action shown to the user for clearing the list.

Definition at line 262 of file krecentfilesaction.cpp.

{
    KisRecentFilesManager::instance()->clear();
}

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

clearEntries()

void KRecentFilesAction::clearEntries ( )

private

Definition at line 267 of file krecentfilesaction.cpp.

{
    Q_D(KRecentFilesAction);
    KSelectAction::clear();
    d->m_urls.clear();
    d->m_noEntriesAction->setVisible(true);
    d->clearSeparator->setVisible(false);
    d->clearAction->setVisible(false);
    setEnabled(false);
}

fileAdded

void KRecentFilesAction::fileAdded ( const QUrl & url )

privateslot

Definition at line 317 of file krecentfilesaction.cpp.

{
    Q_D(KRecentFilesAction);
    const QString name; // Dummy
 
    if (d->m_visibleItemsCount <= 0) {
        return;
    }
 
    // remove oldest item if already maxitems in list
    if (selectableActionGroup()->actions().count() >= d->m_visibleItemsCount) {
        // remove oldest added item
        delete removeAction(selectableActionGroup()->actions().first());
    }
 
    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
 
    d->m_noEntriesAction->setVisible(false);
    d->clearSeparator->setVisible(true);
    d->clearAction->setVisible(true);
    setEnabled(true);
    // add file to list
    const QString title = titleWithSensibleWidth(tmpName, file);
    QAction *action = new QAction(title, selectableActionGroup());
    addAction(action, url, tmpName);
}

References addAction(), removeAction(), and titleWithSensibleWidth().

fileRemoved

void KRecentFilesAction::fileRemoved ( const QUrl & url )

privateslot

Definition at line 351 of file krecentfilesaction.cpp.

{
    Q_D(KRecentFilesAction);
    for (QMap<QAction *, QUrl>::ConstIterator it = d->m_urls.constBegin(); it != d->m_urls.constEnd(); ++it) {
        if (it.value() == url) {
            delete removeAction(it.key());
            return;
        }
    }
}

References removeAction().

listRenewed

void KRecentFilesAction::listRenewed ( )

privateslot

Definition at line 362 of file krecentfilesaction.cpp.

{
    rebuildEntries();
}

menuAboutToShow

void KRecentFilesAction::menuAboutToShow ( )

privateslot

Definition at line 244 of file krecentfilesaction.cpp.

{
    Q_D(KRecentFilesAction);
    if (!d->m_fileIconsPopulated) {
        d->m_fileIconsPopulated = true;
        connect(d->m_recentFilesModel, SIGNAL(itemChanged(QStandardItem *)),
                SLOT(modelItemChanged(QStandardItem *)));
        connect(d->m_recentFilesModel, SIGNAL(rowsInserted(const QModelIndex &, int, int)),
                SLOT(modelRowsInserted(const QModelIndex &, int, int)));
        // Populate the file icons only on first showing the menu, so lazy
        // loading actually works.
        const int count = d->m_recentFilesModel->rowCount();
        for (int i = 0; i < count; i++) {
            d->updateIcon(d->m_recentFilesModel->item(i));
        }
    }
}

References connect(), modelItemChanged(), and modelRowsInserted().

modelItemChanged

void KRecentFilesAction::modelItemChanged ( QStandardItem * item )

privateslot

Definition at line 230 of file krecentfilesaction.cpp.

{
    Q_D(KRecentFilesAction);
    d->updateIcon(item);
}

modelRowsInserted

void KRecentFilesAction::modelRowsInserted ( const QModelIndex & parent, int first, int last )

privateslot

Definition at line 236 of file krecentfilesaction.cpp.

{
    Q_D(KRecentFilesAction);
    for (int i = first; i <= last; i++) {
        d->updateIcon(d->m_recentFilesModel->item(i));
    }
}

Q_PRIVATE_SLOT()

KRecentFilesAction::Q_PRIVATE_SLOT ( d_func() , void _k_urlSelectedQAction * )

private

removeAction()

QAction * KRecentFilesAction::removeAction ( QAction * action )

override

Reimplemented for internal reasons.

Definition at line 206 of file krecentfilesaction.cpp.

{
    Q_D(KRecentFilesAction);
    KSelectAction::removeAction(action);
 
    d->m_urls.remove(action);
 
    return action;
}

setRecentFilesModel()

void KRecentFilesAction::setRecentFilesModel

(

const QStandardItemModel *

model

)

Definition at line 216 of file krecentfilesaction.cpp.

{
    Q_D(KRecentFilesAction);
 
    if (d->m_recentFilesModel) {
        disconnect(d->m_recentFilesModel, nullptr, this, nullptr);
    }
 
    d->m_recentFilesModel = model;
    // Do not connect the signals or populate the icons now, because we want
    // them to be lazy-loaded only when the menu is opened for the first time.
    d->m_fileIconsPopulated = false;
}

urlSelected

void KRecentFilesAction::urlSelected ( const QUrl & url )

signal

This signal gets emitted when the user selects a URL.

Parameters

url	The URL that the user selected.

Member Data Documentation

d_ptr

KRecentFilesActionPrivate* KRecentFilesAction::d_ptr

private

Definition at line 123 of file krecentfilesaction.h.

---

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

• libs/widgetutils/config/krecentfilesaction.h
• libs/widgetutils/config/krecentfilesaction.cpp