.TH "KTipDialog" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdeui Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KTipDialog \- A Tip-of-the-Day dialog.  

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

.in +1c
.ti -1c
.RI "\fBKTipDialog\fP (\fBKTipDatabase\fP *db, \fBQWidget\fP *parent=0, const char *name=0)"
.br
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "static void \fBshowTip\fP (\fBQWidget\fP *parent, const \fBQString\fP &tipFile=QString::null, bool force=false)"
.br
.ti -1c
.RI "static void \fBshowMultiTip\fP (\fBQWidget\fP *parent, const \fBQStringList\fP &tipFiles, bool force=false)"
.br
.ti -1c
.RI "static void \fBshowTip\fP (const \fBQString\fP &tipFile=QString::null, bool force=false)"
.br
.ti -1c
.RI "static void \fBsetShowOnStart\fP (bool \fBshow\fP)"
.br
.in -1c
.SS "Protected Member Functions"

.in +1c
.ti -1c
.RI "bool \fBeventFilter\fP (\fBQObject\fP *, \fBQEvent\fP *)"
.br
.ti -1c
.RI "virtual void \fBvirtual_hook\fP (int id, void *data)"
.br
.in -1c
.SH "Detailed Description"
.PP 
A Tip-of-the-Day dialog. 

This dialog class presents a tip-of-the-day.
.PP
\fBAuthor:\fP
.RS 4
Matthias Hoelzer-Kluepfel <mhk@caldera.de> 
.RE
.PP

.PP
Definition at line 108 of file ktip.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KTipDialog::KTipDialog (\fBKTipDatabase\fP * db, \fBQWidget\fP * parent = \fC0\fP, const char * name = \fC0\fP)"
.PP
Construct a tip dialog. 
.PP
\fBParameters:\fP
.RS 4
\fIdb\fP TipDatabase that should be used by the TipDialog. 
.br
\fIparent\fP Parent widget of TipDialog. 
.br
\fIname\fP The object name. 
.RE
.PP

.PP
Definition at line 168 of file ktip.cpp.
.PP
References QDialog::accept(), KGlobalSettings::activeTitleColor(), KGlobalSettings::alternateBackgroundColor(), KIconEffect::colorize(), KGlobal::dirs(), QSize::height(), QRect::height(), QStyleSheet::item(), locate(), KDialog::marginHint(), QImage::pixel(), KStandardDirs::resourceDirs(), QLabel::setAlignment(), KDialog::setCaption(), QCheckBox::setChecked(), QPalette::setColor(), QPushButton::setDefault(), QLabel::setFont(), QStyleSheetItem::setFontWeight(), QColor::setHsv(), QLabel::setPixmap(), QHBox::setSpacing(), KPushButton::setText(), QLabel::setText(), KDialog::spacingHint(), KGlobalSettings::splashScreenDesktopGeometry(), KGlobalSettings::textColor(), QSize::width(), QRect::width(), QRect::x(), and QRect::y().
.PP
Referenced by showMultiTip().
.SH "Member Function Documentation"
.PP 
.SS "void KTipDialog::showTip (\fBQWidget\fP * parent, const \fBQString\fP & tipFile = \fCQString::null\fP, bool force = \fCfalse\fP)\fC [static]\fP"
.PP
Shows a tip. 
.PP
This static method is all that is needed to add a tip-of-the-day dialog to an application. It will pop up the dialog, unless the user has asked that the dialog does not pop up on startup.
.PP
Note that you probably want an item in the help menu calling this method with force=true.
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP Parent widget of TipDialog. 
.br
\fItipFile\fP The name of the tip file. It has be relative to the 'data' resource of \fBKStandardDirs\fP 
.br
\fIforce\fP If true, the dialog is show, even when the users disabled it. 
.RE
.PP

.PP
Definition at line 324 of file ktip.cpp.
.PP
References showMultiTip().
.PP
Referenced by showTip().
.SS "void KTipDialog::showMultiTip (\fBQWidget\fP * parent, const \fBQStringList\fP & tipFiles, bool force = \fCfalse\fP)\fC [static]\fP"
.PP
Shows a tip. 
.PP
This method behaves essentially as the one above, but expects a list of tips
.PP
\fBParameters:\fP
.RS 4
\fIparent\fP Parent widget of TipDialog. 
.br
\fItipFiles\fP A List of tip files. Each has be relative to the 'data' resource of \fBKStandardDirs\fP 
.br
\fIforce\fP If true, the dialog is show, even when the users disabled it. 
.RE
.PP

.PP
Definition at line 329 of file ktip.cpp.
.PP
References KTipDialog(), mTipOnStart, QDateTime::secsTo(), QCheckBox::setChecked(), and QDialog::show().
.PP
Referenced by showTip().
.SS "void KTipDialog::showTip (const \fBQString\fP & tipFile = \fCQString::null\fP, bool force = \fCfalse\fP)\fC [static]\fP"
.PP
Shows a tip. 
.PP
This methods calls \fBshowTip()\fP with the applications main window as parent. 
.PP
Definition at line 319 of file ktip.cpp.
.PP
References showTip().
.SS "void KTipDialog::setShowOnStart (bool show)\fC [static]\fP"
.PP
Toggles the start behavior. 
.PP
Normally, the user can disable the display of the tip in the dialog. This is just a way to change this setting from outside. 
.PP
Definition at line 390 of file ktip.cpp.

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