KDEUI
KPassivePopup Class Reference
A dialog-like popup that displays messages without interrupting the user. More...
#include <kpassivepopup.h>

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 (const QPoint &p) |
void | show () |
Signals | |
void | clicked (const QPoint &pos) |
void | clicked () |
Public Member Functions | |
QPoint | anchor () const |
bool | autoDelete () const |
QRect | defaultArea () const |
KPassivePopup (WId parent) | |
KPassivePopup (QWidget *parent=0, Qt::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()) |
void | setView (QWidget *child) |
KVBox * | 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, 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, QWidget *parent, int timeout=-1) |
static KPassivePopup * | message (int popupStyle, const QString &caption, const QString &text, QWidget *parent) |
static KPassivePopup * | message (int popupStyle, const QString &caption, const QString &text, QSystemTrayIcon *parent) |
static KPassivePopup * | message (int popupStyle, const QString &text, QSystemTrayIcon *parent) |
static KPassivePopup * | message (int popupStyle, const QString &text, QWidget *parent) |
static KPassivePopup * | message (const QString &caption, const QString &text, const QPixmap &icon, WId 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, QWidget *parent, int timeout=-1) |
static KPassivePopup * | message (const QString &caption, const QString &text, QSystemTrayIcon *parent) |
static KPassivePopup * | message (const QString &caption, const QString &text, QWidget *parent) |
static KPassivePopup * | message (const QString &text, QSystemTrayIcon *parent) |
static KPassivePopup * | message (const QString &text, QWidget *parent) |
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( vb, "<b>Isn't this great?</b>" ); KHBox *box = new KHBox( vb ); (void) new QPushButton( "Yes", box ); (void) new QPushButton( "No", box ); pop->setView( vb ); pop->show();
Definition at line 82 of file kpassivepopup.h.
Member Enumeration Documentation
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 93 of file kpassivepopup.h.
Constructor & Destructor Documentation
KPassivePopup::KPassivePopup | ( | QWidget * | parent = 0 , |
|
Qt::WFlags | f = 0 | |||
) | [explicit] |
Creates a popup for the specified widget.
Definition at line 89 of file kpassivepopup.cpp.
KPassivePopup::KPassivePopup | ( | WId | parent | ) | [explicit] |
Creates a popup for the specified window.
Definition at line 96 of file kpassivepopup.cpp.
KPassivePopup::~KPassivePopup | ( | ) | [virtual] |
Cleans up.
Definition at line 144 of file kpassivepopup.cpp.
Member Function Documentation
QPoint KPassivePopup::anchor | ( | ) | const |
Returns the position to which this popup is anchored.
Definition at line 430 of file kpassivepopup.cpp.
bool KPassivePopup::autoDelete | ( | ) | const |
- Returns:
- true if the widget auto-deletes itself when the timeout occurs.
- See also:
- setAutoDelete
Calculates the position to place the popup near the specified rectangle.
Definition at line 388 of file kpassivepopup.cpp.
void KPassivePopup::clicked | ( | const QPoint & | pos | ) | [signal] |
Emitted when the popup is clicked.
void KPassivePopup::clicked | ( | ) | [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 * | ) | [protected, virtual] |
Reimplemented to destroy the object when autoDelete() is enabled.
Definition at line 317 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | int | popupStyle, | |
const QString & | caption, | |||
const QString & | text, | |||
const QPixmap & | icon, | |||
WId | parent, | |||
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.
Note that the returned object is destroyed when it is hidden.
- See also:
- setAutoDelete
Definition at line 602 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | int | popupStyle, | |
const QString & | caption, | |||
const QString & | text, | |||
const QPixmap & | icon, | |||
QSystemTrayIcon * | parent, | |||
int | timeout = -1 | |||
) | [static] |
Convenience method that displays popup with the specified popup-style, icon, caption and message beside the icon of the specified QSystemTrayIcon.
Note that the returned object is destroyed when it is hidden.
- See also:
- setAutoDelete
Definition at line 615 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | int | popupStyle, | |
const QString & | caption, | |||
const QString & | text, | |||
const QPixmap & | icon, | |||
QWidget * | parent, | |||
int | timeout = -1 | |||
) | [static] |
Convenience method that displays popup with the specified popup-style, 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
Definition at line 577 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | int | popupStyle, | |
const QString & | caption, | |||
const QString & | text, | |||
QWidget * | parent | |||
) | [static] |
Convenience method that displays popup with the specified popup-style, caption and message beside the icon of the specified widget.
Note that the returned object is destroyed when it is hidden.
- See also:
- setAutoDelete
Definition at line 596 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | int | popupStyle, | |
const QString & | caption, | |||
const QString & | text, | |||
QSystemTrayIcon * | parent | |||
) | [static] |
Convenience method that displays popup with the specified popup-style, caption and message beside the icon of the specified QSystemTrayIcon.
Note that the returned object is destroyed when it is hidden.
- See also:
- setAutoDelete
Definition at line 636 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | int | popupStyle, | |
const QString & | text, | |||
QSystemTrayIcon * | parent | |||
) | [static] |
Convenience method that displays popup with the specified popup-style and message beside the icon of the specified QSystemTrayIcon.
Note that the returned object is destroyed when it is hidden.
- See also:
- setAutoDelete
Definition at line 631 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | int | popupStyle, | |
const QString & | text, | |||
QWidget * | parent | |||
) | [static] |
Convenience method that displays popup with the specified popup-style and message beside the icon of the specified widget.
Note that the returned object is destroyed when it is hidden.
- See also:
- setAutoDelete
Definition at line 591 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | const QString & | caption, | |
const QString & | text, | |||
const QPixmap & | icon, | |||
WId | parent, | |||
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
Definition at line 552 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | const QString & | caption, | |
const QString & | text, | |||
const QPixmap & | icon, | |||
QSystemTrayIcon * | parent, | |||
int | timeout = -1 | |||
) | [static] |
Convenience method that displays popup with the specified icon, caption and message beside the icon of the specified QSystemTrayIcon.
Note that the returned object is destroyed when it is hidden.
- See also:
- setAutoDelete
Definition at line 558 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | const QString & | caption, | |
const QString & | text, | |||
const QPixmap & | icon, | |||
QWidget * | parent, | |||
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
Definition at line 534 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | const QString & | caption, | |
const QString & | text, | |||
QSystemTrayIcon * | parent | |||
) | [static] |
Convenience method that displays popup with the specified caption and message beside the icon of the specified QSystemTrayIcon.
Note that the returned object is destroyed when it is hidden.
- See also:
- setAutoDelete
Definition at line 570 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | const QString & | caption, | |
const QString & | text, | |||
QWidget * | parent | |||
) | [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
Definition at line 546 of file kpassivepopup.cpp.
KPassivePopup * KPassivePopup::message | ( | const QString & | text, | |
QSystemTrayIcon * | parent | |||
) | [static] |
Convenience method that displays popup with the specified message beside the icon of the specified QSystemTrayIcon.
Note that the returned object is destroyed when it is hidden.
- See also:
- setAutoDelete
Definition at line 565 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.
Note that the returned object is destroyed when it is hidden.
- See also:
- setAutoDelete
Definition at line 541 of file kpassivepopup.cpp.
void KPassivePopup::mouseReleaseEvent | ( | QMouseEvent * | e | ) | [protected, virtual] |
Reimplemented to detect mouse clicks.
Definition at line 266 of file kpassivepopup.cpp.
void KPassivePopup::moveNear | ( | const QRect & | target | ) | [protected] |
Moves the popup to be adjacent to the icon of the specified rectangle.
Definition at line 379 of file kpassivepopup.cpp.
void KPassivePopup::paintEvent | ( | QPaintEvent * | pe | ) | [protected, virtual] |
Overwrite to paint the border when PopupStyle == Balloon.
Unused if PopupStyle == Boxed
Definition at line 441 of file kpassivepopup.cpp.
void KPassivePopup::positionSelf | ( | ) | [protected, virtual] |
This method positions the popup.
Definition at line 344 of file kpassivepopup.cpp.
void KPassivePopup::setAnchor | ( | const QPoint & | anchor | ) |
Sets the anchor of this popup.
The popup tries automatically to adjust itself somehow around the point.
Definition at line 435 of file kpassivepopup.cpp.
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-deletion is turned on by default.
Definition at line 261 of file kpassivepopup.cpp.
void KPassivePopup::setPopupStyle | ( | int | popupstyle | ) | [slot] |
Sets the visual appearance of the popup.
- See also:
- PopupStyle
Definition at line 149 of file kpassivepopup.cpp.
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.
- See also:
- timeout
Definition at line 243 of file kpassivepopup.cpp.
void KPassivePopup::setView | ( | const QString & | caption, | |
const QString & | text, | |||
const QPixmap & | icon | |||
) | [virtual] |
Creates a standard view then calls setView(QWidget*) .
Definition at line 181 of file kpassivepopup.cpp.
Creates a standard view then calls setView(QWidget*) .
Definition at line 228 of file kpassivepopup.cpp.
void KPassivePopup::setView | ( | QWidget * | child | ) |
Sets the main view to be the specified widget (which must be a child of the popup).
Definition at line 167 of file kpassivepopup.cpp.
void KPassivePopup::setVisible | ( | bool | visible | ) | [virtual, slot] |
Definition at line 276 of file kpassivepopup.cpp.
void KPassivePopup::show | ( | const QPoint & | p | ) | [slot] |
Shows the popup in the given point.
Definition at line 311 of file kpassivepopup.cpp.
void KPassivePopup::show | ( | ) | [slot] |
Reimplemented to reposition the popup.
Definition at line 306 of file kpassivepopup.cpp.
KVBox * 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:
-
caption The window caption (title) on the popup text The text for the popup icon The icon to use for the popup parent The parent widget used for the returned KVBox. If left 0L, then "this", i.e. the passive popup object will be used.
- Returns:
- a KVBox 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& )
Definition at line 189 of file kpassivepopup.cpp.
int KPassivePopup::timeout | ( | ) | const |
Returns the delay before the popup is removed automatically.
void KPassivePopup::updateMask | ( | ) | [protected] |
Updates the transparency mask.
Unused if PopupStyle == Boxed
Definition at line 452 of file kpassivepopup.cpp.
QWidget * KPassivePopup::view | ( | ) | const |
Returns the main view.
Definition at line 233 of file kpassivepopup.cpp.
Property Documentation
bool KPassivePopup::autoDelete [read, write] |
Definition at line 85 of file kpassivepopup.h.
QRect KPassivePopup::defaultArea [read] |
Definition at line 87 of file kpassivepopup.h.
int KPassivePopup::timeout [read, write] |
Definition at line 86 of file kpassivepopup.h.
The documentation for this class was generated from the following files: