KDEUI
KTipDialog Class Reference
A Tip-of-the-Day dialog. More...
#include <ktip.h>

Public Member Functions | |
KTipDialog (KTipDatabase *database, QWidget *parent=0) | |
~KTipDialog () | |
Static Public Member Functions | |
static void | setShowOnStart (bool show) |
static void | showMultiTip (QWidget *parent, const QStringList &tipFiles, bool force=false) |
static void | showTip (const QString &tipFile=QString(), bool force=false) |
static void | showTip (QWidget *parent, const QString &tipFile=QString(), bool force=false) |
Protected Member Functions | |
bool | eventFilter (QObject *, QEvent *) |
Detailed Description
A Tip-of-the-Day dialog.This dialog class presents a tip-of-the-day.
Definition at line 101 of file ktip.h.
Constructor & Destructor Documentation
KTipDialog::KTipDialog | ( | KTipDatabase * | database, | |
QWidget * | parent = 0 | |||
) | [explicit] |
Member Function Documentation
If the user presses Return or Space, we close the dialog as if the default button was pressed even if the KTextBrowser has the keyboard focus. This could have the bad side-effect that the user cannot use the keyboard to open urls in the KTextBrowser, so we just let it handle the key event _additionally_. (Antonio)
void KTipDialog::setShowOnStart | ( | bool | show | ) | [static] |
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.
void KTipDialog::showTip | ( | QWidget * | parent, | |
const QString & | tipFile = QString() , |
|||
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.
The documentation for this class was generated from the following files: