org.kde.koala
Class KTipDatabase

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

public class KTipDatabase
extends java.lang.Object
implements org.kde.qt.QtSupport

A database for tips-of-the-day. This class provides convenient access to a database containing tips of the day. The database is stored in a XML file and parsed when a KTipDatabase object is created. Once the file is read in, you can access the tips to display them in the tip of the day dialog. The state of the tipdialog is saved to the applications's config file in the group "TipOfDay" with a boolean entry "RunOnStart". Check this value if you want to allow the user to enable/disable the tipdialog in the application's configuration dialog.

Author:
Matthias Hoelzer-Kluepfel

Constructor Summary
  KTipDatabase()
           
protected KTipDatabase(java.lang.Class dummy)
           
  KTipDatabase(java.lang.String tipFile)
          This constructor reads in the tips from a file with the given name.
  KTipDatabase(java.lang.String[] tipFiles)
          This constructor takes a list of files that will be merged.
 
Method Summary
 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?
 void nextTip()
          The next tip will become the current one.
 void prevTip()
          The previous tip will become the current one.
 java.lang.String tip()
          Returns the current tip.
 
Methods inherited from class java.lang.Object
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

KTipDatabase

protected KTipDatabase(java.lang.Class dummy)

KTipDatabase

public KTipDatabase(java.lang.String tipFile)
This constructor reads in the tips from a file with the given name. If no name is given, a file called 'application-name/tips' will be loaded.

Parameters:
tipFile - The absolute path to the tips file.

KTipDatabase

public KTipDatabase()

KTipDatabase

public KTipDatabase(java.lang.String[] tipFiles)
This constructor takes a list of files that will be merged. This constructor essentially behaves like the one above. It returns when tipFiles is empty.

Parameters:
tipFiles - A list of absolute paths to the tips file
Method Detail

tip

public java.lang.String tip()
Returns the current tip.


nextTip

public void nextTip()
The next tip will become the current one.


prevTip

public void prevTip()
The previous tip will become the current one.


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?