TDERecentDocument Class Reference

#include <tderecentdocument.h>

Static Public Member Functions
static TQStringList	recentDocuments ()
static void	add (const KURL &url)
static void	add (const KURL &url, const TQString &desktopEntryName)
static void	add (const TQString &documentStr, bool isURL=false)
static void	clear ()
static int	maximumItems ()
static TQString	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 mosfe.nosp@m.t@kd.nosp@m.e.org

Definition at line 50 of file tderecentdocument.h.

Member Function Documentation

add() [1/3]

void TDERecentDocument::add ( const KURL &  url )

static

Add a new item to the Recent Document menu.

Parameters

url	The url to add.

Definition at line 75 of file tderecentdocument.cpp.

add() [2/3]

void TDERecentDocument::add ( const KURL &  url, const TQString &  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.
desktopEntryName	The desktopEntryName of the service to use for opening this document.

Definition at line 80 of file tderecentdocument.cpp.

add() [3/3]

void TDERecentDocument::add ( const TQString &  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.
isURL	Set to true if documentStr is an URL and not a local file path.

Definition at line 151 of file tderecentdocument.cpp.

clear()

void TDERecentDocument::clear ( )

static

Clear the recent document menu of all entries.

Definition at line 162 of file tderecentdocument.cpp.

maximumItems()

int TDERecentDocument::maximumItems ( )

static

Returns the maximum amount of recent document entries allowed.

Definition at line 170 of file tderecentdocument.cpp.

recentDocumentDirectory()

TQString TDERecentDocument::recentDocumentDirectory ( )

static

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

Definition at line 45 of file tderecentdocument.cpp.

recentDocuments()

TQStringList TDERecentDocument::recentDocuments ( )

static

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

Definition at line 51 of file tderecentdocument.cpp.

---

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

• tderecentdocument.h
• tderecentdocument.cpp