tdeui
KTipDialog Class Reference
A Tip-of-the-Day dialog. More...
#include <ktip.h>
Inheritance diagram for KTipDialog:

Public Member Functions | |
KTipDialog (KTipDatabase *db, TQWidget *parent=0, const char *name=0) | |
Static Public Member Functions | |
static void | showTip (TQWidget *parent, const TQString &tipFile=TQString::null, bool force=false) |
static void | showMultiTip (TQWidget *parent, const TQStringList &tipFiles, bool force=false) |
static void | showTip (const TQString &tipFile=TQString::null, bool force=false) |
static void | setShowOnStart (bool show) |
Protected Member Functions | |
bool | eventFilter (TQObject *, TQEvent *) |
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.
Definition at line 108 of file ktip.h.
Constructor & Destructor Documentation
KTipDialog::KTipDialog | ( | KTipDatabase * | db, | |
TQWidget * | 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.
Member Function Documentation
void KTipDialog::setShowOnStart | ( | bool | show | ) | [static] |
void KTipDialog::showMultiTip | ( | TQWidget * | parent, | |
const TQStringList & | 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 TDEStandardDirs force If true, the dialog is show, even when the users disabled it.
void KTipDialog::showTip | ( | TQWidget * | parent, | |
const TQString & | tipFile = TQString::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 TDEStandardDirs force If true, the dialog is show, even when the users disabled it.
void KTipDialog::showTip | ( | const TQString & | tipFile = TQString::null , |
|
bool | force = false | |||
) | [static] |
The documentation for this class was generated from the following files: