---

KRecentDocument Class Reference

#include <krecentdocument.h>

List of all members.

Static Public Methods
QStringList	recentDocuments ()
void	add (const KURL &url)
void	add (const KURL &url, const QString &desktopEntryName)
void	add (const QString &documentStr, bool isURL=false)
void	clear ()
int	maximumItems ()
QString	recentDocumentDirectory ()

---

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

void KRecentDocument::add (  const QString &    documentStr, bool    isURL = false )  [static]

Add a new item to the Recent Document menu. Calls add( url ). Parameters: documentStr  The full path to the document or URL to add. Set  to true if documentStr is an URL and not a local file path.

void KRecentDocument::add (  const KURL &    url, const QString &    desktopEntryName )  [static]

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. Parameters: url  The url to add. serviceDesktopName  The desktopEntryName of the service to use for opening this document.

void KRecentDocument::add (  const KURL &    url )  [static]

Add a new item to the Recent Document menu. Parameters: url  The url to add.

void KRecentDocument::clear (    )  [static]

Clear the recent document menu of all entries.

int KRecentDocument::maximumItems (    )  [static]

Returns the maximum amount of recent document entries allowed.

QString KRecentDocument::recentDocumentDirectory (    )  [static]

Returns the path to the directory where recent document .desktop files are stored.

QStringList KRecentDocument::recentDocuments (    )  [static]

Return a list of absolute paths to recent document .desktop files, sorted by date.

---

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

• krecentdocument.h

---