---

KPassivePopup Class Reference

#include <kpassivepopup.h>

List of all members.

Public Slots
void	setTimeout (int delay)
virtual void	show ()
Signals
void	clicked ()
void	clicked (QPoint pos)
Public Methods
	KPassivePopup (QWidget *parent=0, const char *name=0, WFlags f=0)
	KPassivePopup (WId parent, const char *name=0, WFlags f=0)
virtual	~KPassivePopup ()
void	setView (QWidget *child)
void	setView (const QString &caption, const QString &text=QString::null)
virtual void	setView (const QString &caption, const QString &text, const QPixmap &icon)
QVBox *	standardView (const QString &caption, const QString &text, const QPixmap &icon, QWidget *parent=0L)
QWidget *	view () const
int	timeout () const
virtual void	setAutoDelete (bool autoDelete)
bool	autoDelete () const
Static Public Methods
KPassivePopup *	message (const QString &text, QWidget *parent, const char *name=0)
KPassivePopup *	message (const QString &caption, const QString &text, QWidget *parent, const char *name=0)
KPassivePopup *	message (const QString &caption, const QString &text, const QPixmap &icon, QWidget *parent, const char *name=0, int timeout=-1)
KPassivePopup *	message (const QString &caption, const QString &text, const QPixmap &icon, WId parent, const char *name=0, int timeout=-1)
Protected Methods
virtual void	positionSelf ()
virtual void	hideEvent (QHideEvent *)
void	moveNear (QRect target)
virtual void	mouseReleaseEvent (QMouseEvent *e)
QRect	defaultArea () const

---

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.

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( "<b>Isn't this great?</b>", vb );

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

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

Version:

Id:

kpassivepopup.h,v 1.11 2002/11/15 12:29:38 amantia Exp

Since:

3.1

Author:

Richard Moore, rich@kde.org

Definition at line 59 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.

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

Creates a popup for the specified window.

virtual KPassivePopup::~KPassivePopup (    )  [virtual]

Cleans up.

---

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 136 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 (    )  [protected]

If no relative window (e.g. 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() ifno other is available.

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

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

KPassivePopup* KPassivePopup::message (  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 icon, caption and message beside the icon of the specified window. Note that the returned object is destroyed when it is hidden. See also: setAutoDelete

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

Convenience method that displays popup with the specified icon, caption and message beside the icon of the specified widget. Note that the returned object is destroyed when it is hidden. See also: setAutoDelete

KPassivePopup* KPassivePopup::message (  const QString &    caption, const QString &    text, QWidget *    parent, const char *    name = 0 )  [static]

Convenience method that displays popup with the specified caption and message beside the icon of the specified widget. Note that the returned object is destroyed when it is hidden. See also: setAutoDelete

KPassivePopup* KPassivePopup::message (  const QString &    text, QWidget *    parent, const char *    name = 0 )  [static]

Convenience method that displays popup with the specified message beside the icon of the specified widget. Note that the returned object is destroyed when it is hidden. See also: setAutoDelete

virtual void KPassivePopup::mouseReleaseEvent (  QMouseEvent *    e )  [protected, virtual]

Reimplemented to detect mouse clicks.

void KPassivePopup::moveNear (  QRect    target )  [protected]

Moves the popup to be adjacent to the icon of the specified rectangle.

virtual void KPassivePopup::positionSelf (    )  [protected, virtual]

This method positions the popup.

virtual void KPassivePopup::setAutoDelete (  bool    autoDelete )  [virtual]

Enables / disables auto-deletion of this widget when the timeout occurs. The default is false. If you use the class-methods message(), auto-delection is turned on by default.

void KPassivePopup::setTimeout (  int    delay )  [slot]

Sets the delay for the popup is removed automatically. Setting the delay to 0 disables the timeout, if you're doing this, you may want to connect the clicked() signal to the hide() slot. Setting the delay to -1 makes it use the default value.

virtual void KPassivePopup::setView (  const QString &    caption, const QString &    text, const QPixmap &    icon )  [virtual]

Creates a standard view then calls setView(QWidget*) .

void KPassivePopup::setView (  const QString &    caption, const QString &    text = QString::null )

Creates a standard view then calls setView(QWidget*) .

void KPassivePopup::setView (  QWidget *    child )

Sets the main view to be the specified widget (which must be a child of the popup).

virtual void KPassivePopup::show (    )  [virtual, slot]

Reimplemented to reposition the popup.

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

Returns a widget that is used as standard view if one of the setView() methods taking the QString arguments is used. You can use the returned widget to customize the passivepopup while keeping the look similar to the "standard" passivepopups. After customizing the widget, pass it to setView( QWidget* ) Parameters: parent  The parent widget used for the returned QVBox. If left 0L, then "this", i.e. the passive popup object will be used. Returns: a QVBox containing the given arguments, looking like the standard passivepopups. See also: setView( QWidget * ) , setView( const QString&, const QString& ) , setView( const QString&, const QString&, const QPixmap& )

int KPassivePopup::timeout (    )  const [inline]

Returns the delay before the popup is removed automatically. Definition at line 122 of file kpassivepopup.h.

QWidget* KPassivePopup::view (    )  const [inline]

Returns the main view. Definition at line 117 of file kpassivepopup.h.

---

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

• kpassivepopup.h

---