.TH "KTipDatabase" kde3 "11 Jun 2005" "Version Version 3.4.1" "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
.ti -1c
.RI "\fBKTipDatabase\fP (const \fBQStringList\fP &tipFiles)"
.br
.ti -1c
.RI "\fBQString\fP \fBtip\fP () const "
.br
.ti -1c
.RI "void \fBnextTip\fP ()"
.br
.ti -1c
.RI "void \fBprevTip\fP ()"
.br
.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@kde.org> 
.RE
.PP

.PP
Definition at line 55 of file ktip.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KTipDatabase::KTipDatabase (const \fBQString\fP & tipFile = \fCQString::null\fP)"
.PP
This constructor reads in the tips from a file with the given name. 
.PP
If no name is given, a file called 'application-name/tips' will be loaded.
.PP
\fBParameters:\fP
.RS 4
\fItipFile\fP The absolute path to the tips file. 
.RE
.PP

.PP
Definition at line 55 of file ktip.cpp.
.PP
References QString::fromLatin1(), and QString::isEmpty().
.SS "KTipDatabase::KTipDatabase (const \fBQStringList\fP & tipFiles)"
.PP
This constructor takes a list of files that will be merged. 
.PP
This constructor essentially behaves like the one above. It returns when tipFiles is empty.
.PP
\fBParameters:\fP
.RS 4
\fItipFiles\fP A list of absolute paths to the tips file 
.RE
.PP

.PP
Definition at line 68 of file ktip.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBQString\fP KTipDatabase::tip () const"
.PP
Returns the current tip. 
.PP
Definition at line 158 of file ktip.cpp.
.SS "void KTipDatabase::nextTip ()"
.PP
The next tip will become the current one. 
.PP
Definition at line 138 of file ktip.cpp.
.SS "void KTipDatabase::prevTip ()"
.PP
The previous tip will become the current one. 
.PP
Definition at line 148 of file ktip.cpp.

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