KRecentFilesAction Class
Recent files action. More...
| Header: | #include <KRecentFilesAction> |
| CMake: | find_package(KF6 REQUIRED COMPONENTS ConfigWidgets)target_link_libraries(mytarget PRIVATE KF6::ConfigWidgets) |
| Inherits: | KSelectAction |
Public Functions
| KRecentFilesAction(QObject *parent) | |
| KRecentFilesAction(const QString &text, QObject *parent) | |
| KRecentFilesAction(const QIcon &icon, const QString &text, QObject *parent) | |
| void | addAction(QAction *action, const QUrl &url, const QString &name, const QMimeType &mimeType = QMimeType()) |
| void | addUrl(const QUrl &url, const QString &name = QString()) |
| void | loadEntries(const KConfigGroup &config) |
| int | maxItems() const |
| void | removeUrl(const QUrl &url) |
| void | saveEntries(const KConfigGroup &config) |
| void | setMaxItems(int maxItems) |
| QList<QUrl> | urls() const |
Public Slots
| virtual void | clear() |
Signals
(since 4.3) void | recentListCleared() |
| void | urlSelected(const QUrl &url) |
Detailed Description
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.
Member Function Documentation
[explicit] KRecentFilesAction::KRecentFilesAction(QObject *parent)
Constructs an action with the specified parent.
parent The parent of this action.
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...).
text The text that will be displayed.
parent The parent of this action.
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.
icon The icon to display.
text The text that will be displayed.
parent The parent of this action.
void KRecentFilesAction::addAction(QAction *action, const QUrl &url, const QString &name, const QMimeType &mimeType = QMimeType())
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.
void KRecentFilesAction::addUrl(const QUrl &url, const QString &name = QString())
Add URL to the recent files list. This will enable this action.
url The URL of the file
name The user visible pretty name that appears before the URL
Note: URLs corresponding to local files in the temporary directory (see QDir::tempPath()) are automatically ignored by this method.
[virtual slot] void KRecentFilesAction::clear()
Clears the recent files list. Note that there is also an action shown to the user for clearing the list.
void KRecentFilesAction::loadEntries(const KConfigGroup &config)
Loads the recent files entries from a given KConfigGroup object. You can provide the name of the group used to load the entries. If the groupname is empty, entries are loaded from a group called 'RecentFiles'. Local file entries that do not exist anymore are not restored.
int KRecentFilesAction::maxItems() const
Returns the maximum of items in the recent files list.
Note: Getter function for property maxItems.
See also setMaxItems().
[signal, since 4.3] void KRecentFilesAction::recentListCleared()
This signal gets emitted when the user clear list. So when user store url in specific config file it can saveEntry.
This function was introduced in 4.3.
void KRecentFilesAction::removeUrl(const QUrl &url)
Remove an URL from the recent files list.
url The URL of the file
void KRecentFilesAction::saveEntries(const KConfigGroup &config)
Saves the current recent files entries to a given KConfigGroup object. You can provide the name of the group used to load the entries. If the groupname is empty, entries are saved to a group called 'RecentFiles'.
void KRecentFilesAction::setMaxItems(int maxItems)
Sets the maximum of items in the recent files list. The default for this value is 10 set in the constructor.
If this value is lesser than the number of items currently in the recent files list the last items are deleted until the number of items are equal to the new maximum.
Negative values will be normalized to 0.
Note: Setter function for property maxItems.
See also maxItems().
[signal] void KRecentFilesAction::urlSelected(const QUrl &url)
This signal gets emitted when the user selects an URL.
url The URL that the user selected.
QList<QUrl> KRecentFilesAction::urls() const
Retrieve a list of all URLs in the recent files list.