org.kde.koala
Class KRecentDocument

java.lang.Object
  extended by org.kde.koala.KRecentDocument
All Implemented Interfaces:
org.kde.qt.QtSupport

public class KRecentDocument
extends java.lang.Object
implements org.kde.qt.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

Constructor Summary
  KRecentDocument()
           
protected KRecentDocument(java.lang.Class dummy)
           
 
Method Summary
static void add(KURL url)
          Add a new item to the Recent Document menu.
static void add(KURL url, java.lang.String desktopEntryName)
          Add a new item to the Recent Document menu, specifying the application to open it with.
static void add(java.lang.String documentStr)
           
static void add(java.lang.String documentStr, boolean isURL)
          Add a new item to the Recent Document menu.
static void clear()
          Clear the recent document menu of all entries.
 void dispose()
          Delete the wrapped C++ instance ahead of finalize()
protected  void finalize()
          Deletes the wrapped C++ instance
 boolean isDisposed()
          Has the wrapped C++ instance been deleted?
static int maximumItems()
          Returns the maximum amount of recent document entries allowed.
static java.lang.String recentDocumentDirectory()
          Returns the path to the directory where recent document .desktop files are stored.
static java.util.ArrayList recentDocuments()
          Return a list of absolute paths to recent document .desktop files, sorted by date.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KRecentDocument

protected KRecentDocument(java.lang.Class dummy)

KRecentDocument

public KRecentDocument()
Method Detail

recentDocuments

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


add

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

Parameters:
url - The url to add.

add

public static void add(KURL url,
                       java.lang.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.

add

public static void add(java.lang.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.

add

public static void add(java.lang.String documentStr)

clear

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


maximumItems

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


recentDocumentDirectory

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


finalize

protected void finalize()
                 throws java.lang.InternalError
Deletes the wrapped C++ instance

Overrides:
finalize in class java.lang.Object
Throws:
java.lang.InternalError

dispose

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


isDisposed

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