#include <kpassivepopup.h>

Inheritance diagram for KPassivePopup:

Public Types
enum	PopupStyle { Boxed, Balloon, CustomStyle =128 }

Public Slots
void	setPopupStyle (int popupstyle)

void	setTimeout (int delay)

virtual void	setVisible (bool visible)

void	show ()

void	show (const QPoint &p)

Signals
void	clicked ()

void	clicked (const QPoint &pos)

Public Member Functions
	KPassivePopup (QWidget *parent=0, Qt::WindowFlags f=0)

	KPassivePopup (WId parent)

virtual	~KPassivePopup ()

QPoint	anchor () const

bool	autoDelete () const

QRect	defaultArea () const

void	setAnchor (const QPoint &anchor)

virtual void	setAutoDelete (bool autoDelete)

void	setView (QWidget *child)

void	setView (const QString &caption, const QString &text=QString())

virtual void	setView (const QString &caption, const QString &text, const QPixmap &icon)

KVBox *	standardView (const QString &caption, const QString &text, const QPixmap &icon, QWidget *parent=0L)

int	timeout () const

QWidget *	view () const

Static Public Member Functions
static KPassivePopup *	message (const QString &text, QWidget *parent)

static KPassivePopup *	message (const QString &text, QSystemTrayIcon *parent)

static KPassivePopup *	message (const QString &caption, const QString &text, QWidget *parent)

static KPassivePopup *	message (const QString &caption, const QString &text, QSystemTrayIcon *parent)

static KPassivePopup *	message (const QString &caption, const QString &text, const QPixmap &icon, QWidget *parent, int timeout=-1)

static KPassivePopup *	message (const QString &caption, const QString &text, const QPixmap &icon, QSystemTrayIcon *parent, int timeout=-1)

static KPassivePopup *	message (const QString &caption, const QString &text, const QPixmap &icon, WId parent, int timeout=-1)

static KPassivePopup *	message (int popupStyle, const QString &text, QWidget *parent)

static KPassivePopup *	message (int popupStyle, const QString &text, QSystemTrayIcon *parent)

static KPassivePopup *	message (int popupStyle, const QString &caption, const QString &text, QSystemTrayIcon *parent)

static KPassivePopup *	message (int popupStyle, const QString &caption, const QString &text, QWidget *parent)

static KPassivePopup *	message (int popupStyle, const QString &caption, const QString &text, const QPixmap &icon, QWidget *parent, int timeout=-1)

static KPassivePopup *	message (int popupStyle, const QString &caption, const QString &text, const QPixmap &icon, QSystemTrayIcon *parent, int timeout=-1)

static KPassivePopup *	message (int popupStyle, const QString &caption, const QString &text, const QPixmap &icon, WId parent, int timeout=-1)

Protected Member Functions
QPoint	calculateNearbyPoint (const QRect &target)

virtual void	hideEvent (QHideEvent *)

virtual void	mouseReleaseEvent (QMouseEvent *e)

void	moveNear (const QRect &target)

virtual void	paintEvent (QPaintEvent *pe)

virtual void	positionSelf ()

void	updateMask ()

Properties
bool	autoDelete

QRect	defaultArea

int	timeout

Detailed Description

A dialog-like popup that displays messages without interrupting 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 );

This screenshot shows a popup with both a caption and a main text which is being displayed next to the toolbar icon of the window that triggered it:

A passive popup

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

KPassivePopup *pop = new KPassivePopup( parent );
KVBox *vb = new KVBox( pop );
(void) new QLabel( "<b>Isn't this great?</b>", vb);
KHBox *box = new KHBox( vb );
(void) new QPushButton( "Yes", box );
(void) new QPushButton( "No", box );
pop->setView( vb );
pop->show();

Author: Richard Moore, rich@.nosp@m.kde..nosp@m.org; Sascha Cunz, sasch.nosp@m.a.cu.nosp@m.nz@ti.nosp@m.scal.nosp@m.i.de

Definition at line 79 of file kpassivepopup.h.

Member Enumeration Documentation

enum KPassivePopup::PopupStyle

Styles that a KPassivePopup can have.

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 90 of file kpassivepopup.h.

Constructor & Destructor Documentation

KPassivePopup::KPassivePopup	(	QWidget *	parent = `0`,
		Qt::WindowFlags	f = `0`
	)

explicit

Creates a popup for the specified widget.

Definition at line 86 of file kpassivepopup.cpp.

KPassivePopup::KPassivePopup ( WId parent )

explicit

Creates a popup for the specified window.

Definition at line 93 of file kpassivepopup.cpp.

KPassivePopup::~KPassivePopup ( )

virtual

Cleans up.

Definition at line 141 of file kpassivepopup.cpp.

Member Function Documentation

QPoint KPassivePopup::anchor ( ) const

Returns the position to which this popup is anchored.

Definition at line 427 of file kpassivepopup.cpp.

bool KPassivePopup::autoDelete ( ) const

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

See also: setAutoDelete

QPoint KPassivePopup::calculateNearbyPoint ( const QRect & target )

protected

Calculates the position to place the popup near the specified rectangle.

Definition at line 385 of file kpassivepopup.cpp.

void KPassivePopup::clicked ( )

signal

Emitted when the popup is clicked.

void KPassivePopup::clicked ( const QPoint & pos )

signal

Emitted when the popup is clicked.

QRect KPassivePopup::defaultArea ( ) const

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

Basically KWindowSystem::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.

void KPassivePopup::hideEvent ( QHideEvent * )

protectedvirtual

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

Definition at line 314 of file kpassivepopup.cpp.

KPassivePopup * KPassivePopup::message	(	const QString &	text,
		QWidget *	parent
	)

static

Convenience method that displays popup with the specified message beside the icon of the specified widget.