org.kde.koala

Class KRecentDocument

public class KRecentDocument extends Object implements QtSupport

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

UNKNOWN: Manage the "Recent Document Menu" entries displayed by applications such as Kicker and Konqueror.

Constructor Summary
protected KRecentDocument(Class dummy)
KRecentDocument()
Method Summary
static voidadd(KURL url)
Add a new item to the Recent Document menu.
static voidadd(KURL url, String desktopEntryName)
Add a new item to the Recent Document menu, specifying the application to open it with.
static voidadd(String documentStr, boolean isURL)
Add a new item to the Recent Document menu.
static voidadd(String documentStr)
static voidclear()
Clear the recent document menu of all entries.
voiddispose()
Delete the wrapped C++ instance ahead of finalize()
protected voidfinalize()
Deletes the wrapped C++ instance
booleanisDisposed()
Has the wrapped C++ instance been deleted?
static intmaximumItems()
Returns the maximum amount of recent document entries allowed.
static StringrecentDocumentDirectory()
Returns the path to the directory where recent document .desktop files are stored.
static ArrayListrecentDocuments()
Return a list of absolute paths to recent document .desktop files, sorted by date.

Constructor Detail

KRecentDocument

protected KRecentDocument(Class dummy)

KRecentDocument

public KRecentDocument()

Method Detail

add

public static void add(KURL url)
Add a new item to the Recent Document menu.

Parameters: url The url to add.

UNKNOWN: Add a new item to the Recent Document menu.

add

public static void add(KURL url, String desktopEntryName)
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.

UNKNOWN: Add a new item to the Recent Document menu, specifying the application to open it with.

add

public static void add(String documentStr, boolean isURL)
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.

UNKNOWN:

add

public static void add(String documentStr)

clear

public static void clear()
Clear the recent document menu of all entries.

UNKNOWN: Clear the recent document menu of all entries.

dispose

public void dispose()
Delete the wrapped C++ instance ahead of finalize()

finalize

protected void finalize()
Deletes the wrapped C++ instance

isDisposed

public boolean isDisposed()
Has the wrapped C++ instance been deleted?

maximumItems

public static int maximumItems()
Returns the maximum amount of recent document entries allowed.

UNKNOWN: Returns the maximum amount of recent document entries allowed.

recentDocumentDirectory

public static String recentDocumentDirectory()
Returns the path to the directory where recent document .desktop files are stored.

UNKNOWN: Returns the path to the directory where recent document .

recentDocuments

public static ArrayList recentDocuments()
Return a list of absolute paths to recent document .desktop files, sorted by date.

UNKNOWN: