.TH "KTipDatabase" 3 "28 Jan 2004" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KTipDatabase \- A database for tips-of-the-day.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <ktip.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKTipDatabase\fP (const  \fBQString\fP &tipFile=QString::null)"
.br
.RI "\fIThe constructor. \fP"
.ti -1c
.RI "\fBQString\fP \fBtip\fP () const "
.br
.RI "\fIReturns the current tip. \fP"
.ti -1c
.RI "void \fBnextTip\fP ()"
.br
.RI "\fIThe next tip will become the current one. \fP"
.ti -1c
.RI "void \fBprevTip\fP ()"
.br
.RI "\fIThe previous tip will become the current one. \fP"
.in -1c
.SH "Detailed Description"
.PP 
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.
.PP
Once the file is read in, you can access the tips to display them in the tip of the day dialog.
.PP
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.
.PP
\fBAuthor:\fP
.RS 4
Matthias Hoelzer-Kluepfel <mhk@caldera.de> 
.RE
.PP

.PP
Definition at line 54 of file ktip.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KTipDatabase::KTipDatabase (const \fBQString\fP & tipFile = QString::null)"
.PP
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.
.PP
\fBParameters:\fP
.RS 4
\fItipFile\fP The name of the tips file. 
.RE
.PP
Definition at line 53 of file ktip.cpp.
.PP
References QString::fromLatin1(), KGlobal::instance(), and QString::isEmpty().
.SH "Member Function Documentation"
.PP 
.SS "\fBQString\fP KTipDatabase::tip () const"
.PP
Returns the current tip. Definition at line 122 of file ktip.cpp.
.SS "void KTipDatabase::nextTip ()"
.PP
The next tip will become the current one. Definition at line 102 of file ktip.cpp.
.SS "void KTipDatabase::prevTip ()"
.PP
The previous tip will become the current one. Definition at line 112 of file ktip.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdeui Library from the source code.
