KTipDialog Class Reference

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

#include <ktip.h>

Inheritance diagram for KTipDialog:

List of all members.

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.

Author:

Matthias Hoelzer-Kluepfel <mhk@caldera.de>

Definition at line 103 of file ktip.h.

---

Constructor & Destructor Documentation

KTipDialog::KTipDialog	(	KTipDatabase *	database,
		QWidget *	parent = 0
	)		[explicit]

Construct a tip dialog.

Parameters:

database	TipDatabase that should be used by the TipDialog. The KTipDialog will take ownership of the database, including deleting it.
parent	Parent widget of TipDialog.

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 225 of file ktip.cpp.

KTipDialog::~KTipDialog

(

)

Destroys the tip dialog.

Definition at line 329 of file ktip.cpp.

---

Member Function Documentation

bool KTipDialog::eventFilter	(	QObject *	object,
		QEvent *	event
	)		[protected]

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)

Definition at line 396 of file ktip.cpp.

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 390 of file ktip.cpp.

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 350 of file ktip.cpp.

void KTipDialog::showTip	(	const QString &	tipFile = QString(),
		bool	force = false
	)		[static]

Shows a tip.

use the one with a parent window as parameter instead of this one or you will get focus problems

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

Definition at line 340 of file ktip.cpp.

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.

Definition at line 345 of file ktip.cpp.

---

The documentation for this class was generated from the following files:

• ktip.h
• ktip.cpp