KTipDialog Class Reference

#include <ktip.h>

Inheritance diagram for KTipDialog:

Public Member Functions
	KTipDialog (KTipDatabase *database, QWidget *parent=0)
	~KTipDialog ()
Public Member Functions inherited from KDialog
	KDialog (QWidget *parent=0, Qt::WindowFlags flags=0)
	~KDialog ()
KPushButton *	button (ButtonCode id) const
KIcon	buttonIcon (ButtonCode id) const
QString	buttonText (ButtonCode id) const
QString	buttonToolTip (ButtonCode id) const
QString	buttonWhatsThis (ButtonCode id) const
ButtonCode	defaultButton () const
QString	helpLinkText () const
void	incrementInitialSize (const QSize &size)
bool	isButtonEnabled (ButtonCode id) const
QWidget *	mainWidget ()
virtual QSize	minimumSizeHint () const
void	restoreDialogSize (const KConfigGroup &config)
void	saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const
void	setButtonFocus (ButtonCode id)
void	setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void	setButtonIcon (ButtonCode id, const KIcon &icon)
void	setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup)
void	setButtons (ButtonCodes buttonMask)
void	setButtonsOrientation (Qt::Orientation orientation)
void	setButtonText (ButtonCode id, const QString &text)
void	setButtonToolTip (ButtonCode id, const QString &text)
void	setButtonWhatsThis (ButtonCode id, const QString &text)
void	setDefaultButton (ButtonCode id)
void	setEscapeButton (ButtonCode id)
void	setInitialSize (const QSize &size)
void	setMainWidget (QWidget *widget)
void	showButton (ButtonCode id, bool state)
void	showButtonSeparator (bool state)
virtual QSize	sizeHint () const

Static Public Member Functions
static void	setShowOnStart (bool show)
static void	showMultiTip (QWidget *parent, const QStringList &tipFiles, bool force=false)
static void	showTip (QWidget *parent, const QString &tipFile=QString(), bool force=false)
static void	showTip (const QString &tipFile=QString(), bool force=false)
Static Public Member Functions inherited from KDialog
static bool	avoidArea (QWidget *widget, const QRect &area, int screen=-1)
static void	centerOnScreen (QWidget *widget, int screen=-1)
static int	groupSpacingHint ()
static QString	makeStandardCaption (const QString &userCaption, QWidget *window=0, CaptionFlags flags=HIGCompliantCaption)
static int	marginHint ()
static void	resizeLayout (QWidget *widget, int margin, int spacing)
static void	resizeLayout (QLayout *lay, int margin, int spacing)
static void	setAllowEmbeddingInGraphicsView (bool allowEmbedding)
static int	spacingHint ()

Protected Member Functions
bool	eventFilter (QObject *, QEvent *)
Protected Member Functions inherited from KDialog
	KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags=0)
virtual void	closeEvent (QCloseEvent *e)
virtual void	hideEvent (QHideEvent *)
virtual void	keyPressEvent (QKeyEvent *)

Additional Inherited Members
Public Types inherited from KDialog
enum	ButtonCode {   None = 0x00000000, Help = 0x00000001, Default = 0x00000002, Ok = 0x00000004,   Apply = 0x00000008, Try = 0x00000010, Cancel = 0x00000020, Close = 0x00000040,   No = 0x00000080, Yes = 0x00000100, Reset = 0x00000200, Details = 0x00000400,   User1 = 0x00001000, User2 = 0x00002000, User3 = 0x00004000, NoDefault = 0x00008000 }
enum	ButtonPopupMode { InstantPopup = 0, DelayedPopup = 1 }
enum	CaptionFlag { NoCaptionFlags = 0, AppNameCaption = 1, ModifiedCaption = 2, HIGCompliantCaption = AppNameCaption }
Public Slots inherited from KDialog
void	delayedDestruct ()
void	enableButton (ButtonCode id, bool state)
void	enableButtonApply (bool state)
void	enableButtonCancel (bool state)
void	enableButtonOk (bool state)
void	enableLinkedHelp (bool state)
bool	isDetailsWidgetVisible () const
virtual void	setCaption (const QString &caption)
virtual void	setCaption (const QString &caption, bool modified)
void	setDetailsWidget (QWidget *detailsWidget)
void	setDetailsWidgetVisible (bool visible)
void	setHelp (const QString &anchor, const QString &appname=QString())
void	setHelpLinkText (const QString &text)
virtual void	setPlainCaption (const QString &caption)
Signals inherited from KDialog
void	aboutToShowDetails ()
void	applyClicked ()
void	buttonClicked (KDialog::ButtonCode button)
void	cancelClicked ()
void	closeClicked ()
void	defaultClicked ()
void	finished ()
void	helpClicked ()
void	hidden ()
void	layoutHintChanged ()
void	noClicked ()
void	okClicked ()
void	resetClicked ()
void	tryClicked ()
void	user1Clicked ()
void	user2Clicked ()
void	user3Clicked ()
void	yesClicked ()
Protected Slots inherited from KDialog
virtual void	slotButtonClicked (int button)
void	updateGeometry ()
Protected Attributes inherited from KDialog
KDialogPrivate *const	d_ptr

Detailed Description

A Tip-of-the-Day dialog.

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

Author

Matthias Hoelzer-Kluepfel mhk@c.nosp@m.alde.nosp@m.ra.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 ( 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.

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.

---

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

• ktip.h
• ktip.cpp