KRecentDocument Class Reference
Manage the "Recent Document Menu" entries displayed by applications such as Kicker and Konqueror. More...
#include <krecentdocument.h>
Static Public Member Functions | |
QStringList | recentDocuments () |
Return a list of absolute paths to recent document .desktop files, sorted by date. | |
void | add (const KURL &url) |
Add a new item to the Recent Document menu. | |
void | add (const KURL &url, const QString &desktopEntryName) |
Add a new item to the Recent Document menu, specifying the application to open it with. | |
void | add (const QString &documentStr, bool isURL=false) |
Add a new item to the Recent Document menu. | |
void | clear () |
Clear the recent document menu of all entries. | |
int | maximumItems () |
Returns the maximum amount of recent document entries allowed. | |
QString | recentDocumentDirectory () |
Returns the path to the directory where recent document .desktop files are stored. |
Detailed Description
Manage the "Recent Document Menu" entries displayed by applications such as Kicker and Konqueror.These entries are automatically generated .desktop files pointing to the current application and document. You should call the static add() method whenever the user opens or saves a new document if you want it to show up in the menu.
You don't have to worry about this if you are using any KFileDialog derived class to open and save documents, as it already calls this class. User defined limits on the maximum number of documents to save, etc... are all automatically handled.
- Author:
- Daniel M. Duley <mosfet@kde.org>
Definition at line 50 of file krecentdocument.h.
Member Function Documentation
|
Return a list of absolute paths to recent document .desktop files, sorted by date.
Definition at line 51 of file krecentdocument.cpp. References QDir::absFilePath(), QDir::entryList(), QDir::exists(), QDir::mkdir(), and recentDocumentDirectory(). Referenced by clear(). |
|
Add a new item to the Recent Document menu.
Definition at line 69 of file krecentdocument.cpp. Referenced by add(), KFileDialog::getSaveFileName(), KFileDialog::getSaveURL(), KURLRequesterDlg::getURL(), and KRun::run(). |
|
Add a new item to the Recent Document menu, specifying the application to open it with. The above add() method uses argv[0] for the app name, which isn't always flexible enough. This method is used when an application launches another one to open a document.
Definition at line 74 of file krecentdocument.cpp. References QDir::absPath(), KGlobal::config(), QFile::encodeName(), QDir::entryList(), QFile::exists(), KURL::fileName(), QString::fromLatin1(), KConfigBase::group(), KMimeType::iconForURL(), KConfigBase::readBoolEntry(), KConfigBase::readEntry(), KConfigBase::readNumEntry(), recentDocumentDirectory(), QFile::remove(), QString::replace(), KConfigBase::setDesktopGroup(), KConfigBase::setGroup(), KURL::url(), and KConfigBase::writeEntry(). |
|
Add a new item to the Recent Document menu. Calls add( url ).
Definition at line 139 of file krecentdocument.cpp. References add(), and KURL::setPath(). |
|
Clear the recent document menu of all entries.
Definition at line 150 of file krecentdocument.cpp. References recentDocuments(), and QDir::remove(). |
|
Returns the maximum amount of recent document entries allowed.
Definition at line 158 of file krecentdocument.cpp. References KGlobal::config(), QString::fromLatin1(), and KConfigBase::readNumEntry(). |
|
Returns the path to the directory where recent document .desktop files are stored.
Definition at line 45 of file krecentdocument.cpp. References QString::fromLatin1(), and locateLocal(). Referenced by add(), and recentDocuments(). |
The documentation for this class was generated from the following files: