KTipDatabase Class Reference

#include <ktip.h>

Public Member Functions
	KTipDatabase (const QString &tipFile=QString())
	KTipDatabase (const QStringList &tipFiles)
	~KTipDatabase ()
void	nextTip ()
void	prevTip ()
QString	tip () const

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.

KDE Tip-of-the-Day Dialog

Author

Matthias Hoelzer-Kluepfel mhk@k.nosp@m.de.o.nosp@m.rg

Definition at line 53 of file ktip.h.

Constructor & Destructor Documentation

KTipDatabase::KTipDatabase ( const QString &  tipFile = QString() )

explicit

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.

Definition at line 115 of file ktip.cpp.

KTipDatabase::KTipDatabase ( const QStringList &  tipFiles )

explicit

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

Definition at line 129 of file ktip.cpp.

KTipDatabase::~KTipDatabase

(

)

Definition at line 143 of file ktip.cpp.

Member Function Documentation

void KTipDatabase::nextTip

(

)

The next tip will become the current one.

Definition at line 148 of file ktip.cpp.

void KTipDatabase::prevTip

(

)

The previous tip will become the current one.

Definition at line 159 of file ktip.cpp.

QString KTipDatabase::tip

(

)

const

Returns the current tip.

Definition at line 170 of file ktip.cpp.

---

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

• ktip.h
• ktip.cpp