Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KTipDatabase Class Reference

#include <ktip.h>

List of all members.

Public Methods

 KTipDatabase (const QString &tipFile=QString::null)
QString tip () const
void nextTip ()
void prevTip ()


Detailed Description

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 bool 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 <mhk@caldera.de>

Definition at line 54 of file ktip.h.


Constructor & Destructor Documentation

KTipDatabase::KTipDatabase const QString &    tipFile = QString::null
 

The constructor.

This 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 name of the tips file.


Member Function Documentation

void KTipDatabase::nextTip  
 

The next tip will become the current one.

void KTipDatabase::prevTip  
 

The previous tip will become the current one.

QString KTipDatabase::tip  
 

Returns the current tip.


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:26 2003 for kdelibs by doxygen1.2.18