Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KTipDialog Class Reference

#include <ktip.h>

Inheritance diagram for KTipDialog:

KDialog List of all members.

Public Methods

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

Static Public Methods

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

Protected Methods

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 99 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.


Member Function Documentation

void KTipDialog::setShowOnStart bool    show [static]
 

Toggles the start behaviour.

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

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.

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.
force  If true, the dialog is show, even when the users disabled it.


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:26 2003 for kdelibs by doxygen1.2.18