KPassivePopup Class Reference

A dialog-like popup that displays messages without interupting the user. More...

#include <kpassivepopup.h>

Inheritance diagram for KPassivePopup:


Public Types
enum	PopupStyle { Boxed, Balloon, CustomStyle = 128 }
Public Slots
void	setTimeout (int delay)
void	show (const QPoint &p)
virtual void	show ()
Signals
void	clicked (QPoint pos)
void	clicked ()
Public Member Functions
bool	autoDelete () const
	KPassivePopup (int popupStyle, WId parent, const char *name=0, WFlags f=0)
	KPassivePopup (int popupStyle, QWidget parent=0, const char name=0, WFlags f=0)
	KPassivePopup (WId parent, const char *name=0, WFlags f=0)
	KPassivePopup (QWidget parent=0, const char name=0, WFlags f=0)
void	setAnchor (const QPoint &anchor)
virtual void	setAutoDelete (bool autoDelete)
virtual void	setView (const QString &caption, const QString &text, const QPixmap &icon)
void	setView (const QString &caption, const QString &text=QString::null)
void	setView (QWidget *child)
QVBox *	standardView (const QString &caption, const QString &text, const QPixmap &icon, QWidget *parent=0L)
int	timeout () const
QWidget *	view () const
virtual	~KPassivePopup ()
Static Public Member Functions
static KPassivePopup *	message (int popupStyle, const QString &caption, const QString &text, const QPixmap &icon, WId parent, const char *name=0, int timeout=-1)
static KPassivePopup *	message (int popupStyle, const QString &caption, const QString &text, const QPixmap &icon, QWidget parent, const char name=0, int timeout=-1)
static KPassivePopup *	message (int popupStyle, const QString &caption, const QString &text, QWidget parent, const char name=0)
static KPassivePopup *	message (int popupStyle, const QString &text, QWidget parent, const char name=0)
static KPassivePopup *	message (const QString &caption, const QString &text, const QPixmap &icon, WId parent, const char *name=0, int timeout=-1)
static KPassivePopup *	message (const QString &caption, const QString &text, const QPixmap &icon, QWidget parent, const char name=0, int timeout=-1)
static KPassivePopup *	message (const QString &caption, const QString &text, QWidget parent, const char name=0)
static KPassivePopup *	message (const QString &text, QWidget parent, const char name=0)
Protected Member Functions
QRect	defaultArea () const
virtual void	hideEvent (QHideEvent *)
virtual void	mouseReleaseEvent (QMouseEvent *e)
void	moveNear (QRect target)
virtual void	paintEvent (QPaintEvent *pe)
virtual void	positionSelf ()
void	updateMask ()
Properties
bool	autoDelete
int	timeout

Detailed Description

A dialog-like popup that displays messages without interupting the user.

The simplest uses of KPassivePopup are by using the various message() static methods. The position the popup appears at depends on the type of the parent window:

Normal Windows: The popup is placed adjacent to the icon of the window.
System Tray Windows: The popup is placed adjact to the system tray window itself.
Skip Taskbar Windows: The popup is placed adjact to the window itself if it is visible, and at the edge of the desktop otherwise.

You also have the option of calling show with a QPoint as a parameter that removes the automatic placing of KPassivePopup and shows it in the point you want.

The most basic use of KPassivePopup displays a popup containing a piece of text:

    KPassivePopup::message( "This is the message", this );

We can create popups with titles and icons too, as this example shows:

    QPixmap px;
    px.load( "hi32-app-logtracker.png" );
    KPassivePopup::message( "Some title", "This is the main text", px, this );

For more control over the popup, you can use the setView(QWidget *) method to create a custom popup.

    KPassivePopup *pop = new KPassivePopup( parent );

    QVBox *vb = new QVBox( pop );
    (void) new QLabel( vb, "<b>Isn't this great?</b>" );

    QHBox *box = new QHBox( vb );
    (void) new QPushButton( box, "Yes" );
    (void) new QPushButton( box, "No" );

    pop->setView( vb );
    pop->show();

Version:

Id: kpassivepopup.h 428049 2005-06-22 21:24:17Z aacid

Since:: 3.1

Author:: Richard Moore, rich@kde.org
Sascha Cunz, sascha.cunz@tiscali.de

Definition at line 68 of file kpassivepopup.h.

Member Enumeration Documentation

enum KPassivePopup::PopupStyle

Styles that a KPassivePopup can have.

Since:: 3.5

Enumerator:

Boxed	Information will appear in a framed box (default).
Balloon	Information will appear in a comic-alike balloon.
CustomStyle	Ids greater than this are reserved for use by subclasses.

Definition at line 79 of file kpassivepopup.h.

Constructor & Destructor Documentation

KPassivePopup::KPassivePopup	(	QWidget *	parent = `0`,
		const char *	name = `0`,
		WFlags	f = `0`
	)

Creates a popup for the specified widget.

Definition at line 49 of file kpassivepopup.cpp.

KPassivePopup::KPassivePopup	(	WId	parent,
		const char *	name = `0`,
		WFlags	f = `0`
	)

Creates a popup for the specified window.

Definition at line 58 of file kpassivepopup.cpp.

KPassivePopup::KPassivePopup	(	int	popupStyle,
		QWidget *	parent = `0`,
		const char *	name = `0`,
		WFlags	f = `0`
	)

Creates a popup for the specified widget.

Since:: 3.5

Definition at line 67 of file kpassivepopup.cpp.

KPassivePopup::KPassivePopup	(	int	popupStyle,
		WId	parent,
		const char *	name = `0`,
		WFlags	f = `0`
	)

Creates a popup for the specified window.

Since:: 3.5

Definition at line 76 of file kpassivepopup.cpp.

KPassivePopup::~KPassivePopup ( ) [virtual]

Cleans up.

Definition at line 103 of file kpassivepopup.cpp.

Member Function Documentation

bool KPassivePopup::autoDelete ( ) const [inline]

Returns:: true if the widget auto-deletes itself when the timeout occurs.

See also:: setAutoDelete

Definition at line 173 of file kpassivepopup.h.

void KPassivePopup::clicked ( QPoint pos ) [signal]

Emitted when the popup is clicked.

void KPassivePopup::clicked ( ) [signal]

Emitted when the popup is clicked.

QRect KPassivePopup::defaultArea ( ) const [protected]

If no relative window (eg taskbar button, system tray window) is available, use this rectangle (pass it to moveNear()).

Basically KWinModule::workArea() with width and height set to 0 so that moveNear uses the upper-left position.

Returns:: The QRect to be passed to moveNear() if no other is available.

Definition at line 233 of file kpassivepopup.cpp.

void KPassivePopup::hideEvent ( QHideEvent * ) [protected, virtual]

Reimplemented to destroy the object when autoDelete() is enabled.

Definition at line 226 of file kpassivepopup.cpp.

KPassivePopup * KPassivePopup::message	(	int	popupStyle,
		const QString &	caption,
		const QString &	text,
		const QPixmap &	icon,
		WId	parent,
		const char *	name = `0`,
		int	timeout = `-1`
	)			`[static]`

Convenience method that displays popup with the specified popup-style, icon, caption and message beside the icon of the specified window.