kdeui Library API Documentation

KTipDialog Class Reference

A Tip-of-the-Day dialog. More...

#include <ktip.h>

Inheritance diagram for KTipDialog:

KDialog QDialog List of all members.

Public Member Functions

 KTipDialog (KTipDatabase *db, QWidget *parent=0, const char *name=0)

Static Public Member Functions

void showTip (QWidget *parent, const QString &tipFile=QString::null, bool force=false)
void showMultiTip (QWidget *parent, const QStringList &tipFiles, bool force=false)
void showTip (const QString &tipFile=QString::null, bool force=false)
void setShowOnStart (bool show)

Protected Member Functions

bool eventFilter (QObject *, QEvent *)
virtual void virtual_hook (int id, void *data)

Detailed Description

A Tip-of-the-Day dialog.

This dialog class presents a tip-of-the-day.

Author:
Matthias Hoelzer-Kluepfel <mhk@caldera.de>

Definition at line 108 of file ktip.h.


Constructor & Destructor Documentation

KTipDialog::KTipDialog KTipDatabase db,
QWidget parent = 0,
const char *  name = 0
 

Construct a tip dialog.

Parameters:
db TipDatabase that should be used by the TipDialog.
parent Parent widget of TipDialog.
name The object name.

Parent is 0L when TipDialog is used as a mainWidget. This should be the case only in ktip, so let's use the ktip layout.

Definition at line 151 of file ktip.cpp.

References QDialog::accept(), KGlobalSettings::activeTitleColor(), KGlobalSettings::alternateBackgroundColor(), KGlobal::dirs(), QSize::height(), QRect::height(), QStyleSheet::item(), KTipDialog(), locate(), KDialog::marginHint(), QImage::pixel(), KConfigBase::readBoolEntry(), KStandardDirs::resourceDirs(), QLabel::setAlignment(), 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().

Referenced by KTipDialog().


Member Function Documentation

void KTipDialog::showTip QWidget parent,
const QString tipFile = QString::null,
bool  force = false
[static]
 

Shows a tip.

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.

Note that you probably want an item in the help menu calling this method with force=true.

Parameters:
parent Parent widget of TipDialog.
tipFile The name of the tip file. It has be relative to the "data" resource of KStandardDirs
force If true, the dialog is show, even when the users disabled it.

Definition at line 305 of file ktip.cpp.

References showMultiTip(), and showTip().

Referenced by showTip().

void KTipDialog::showMultiTip QWidget parent,
const QStringList tipFiles,
bool  force = false
[static]
 

Shows a tip.

This method behaves essentially as the one above, but expects a list of tips

Parameters:
parent Parent widget of TipDialog.
tipFiles A List of tip files. Each has be relative to the "data" resource of KStandardDirs
force If true, the dialog is show, even when the users disabled it.

Definition at line 310 of file ktip.cpp.

References mTipOnStart, QCheckBox::setChecked(), QDialog::show(), and showMultiTip().

Referenced by showMultiTip(), and showTip().

void KTipDialog::showTip const QString tipFile = QString::null,
bool  force = false
[static]
 

Shows a tip.

This methods calls showTip() with the applications main window as parent.

Definition at line 300 of file ktip.cpp.

References showTip().

void KTipDialog::setShowOnStart bool  show  )  [static]
 

Toggles the start behavior.

Normally, the user can disable the display of the tip in the dialog. This is just a way to change this setting from outside.

Definition at line 353 of file ktip.cpp.

References setShowOnStart(), KConfigGroup::sync(), and KConfigBase::writeEntry().

Referenced by setShowOnStart().


The documentation for this class was generated from the following files:
KDE Logo
This file is part of the documentation for kdeui Library Version 3.2.3.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Aug 20 09:48:51 2004 by doxygen 1.3.7 written by Dimitri van Heesch, © 1997-2003