• Skip to content
  • Skip to link menu
  • KDE API Reference
  • kdelibs-4.14.38 API Reference
  • KDE Home
  • Contact Us
 

KDEUI

Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Protected Member Functions | Properties | List of all members
KPassivePopup Class Reference

#include <kpassivepopup.h>

Inheritance diagram for KPassivePopup:
QFrame

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)
 
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
 

Static Public Member Functions

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, const QPixmap &icon, WId 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)
 
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, const QPixmap &icon, WId parent, int timeout=-1)
 
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 &text, QSystemTrayIcon *parent)
 
static KPassivePopup * message (int popupStyle, 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 );
KPassivePopup::message
static KPassivePopup * message(const QString &text, QWidget *parent)
Convenience method that displays popup with the specified message beside the icon of the specified wi...
Definition: kpassivepopup.cpp:538

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();
KHBox
A container widget which arranges its children horizontally.
Definition: khbox.h:41
KPassivePopup
A dialog-like popup that displays messages without interrupting the user.
Definition: kpassivepopup.h:80
KPassivePopup::show
void show()
Reimplemented to reposition the popup.
Definition: kpassivepopup.cpp:303
KPassivePopup::setView
void setView(QWidget *child)
Sets the main view to be the specified widget (which must be a child of the popup).
Definition: kpassivepopup.cpp:164
KVBox
A container widget which arranges its children vertically.
Definition: kvbox.h:37
QLabel
QPushButton
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

◆ PopupStyle

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() [1/2]

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() [2/2]

KPassivePopup::KPassivePopup ( WId  parent)
explicit

Creates a popup for the specified window.

Definition at line 93 of file kpassivepopup.cpp.

◆ ~KPassivePopup()

KPassivePopup::~KPassivePopup ( )
virtual

Cleans up.

Definition at line 141 of file kpassivepopup.cpp.

Member Function Documentation

◆ anchor()

QPoint KPassivePopup::anchor ( ) const

Returns the position to which this popup is anchored.

Definition at line 427 of file kpassivepopup.cpp.

◆ autoDelete()

bool KPassivePopup::autoDelete ( ) const
Returns
true if the widget auto-deletes itself when the timeout occurs.
See also
setAutoDelete

Definition at line 253 of file kpassivepopup.cpp.

◆ calculateNearbyPoint()

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.

◆ clicked [1/2]

void KPassivePopup::clicked ( )
signal

Emitted when the popup is clicked.

◆ clicked [2/2]

void KPassivePopup::clicked ( const QPoint &  pos)
signal

Emitted when the popup is clicked.

◆ defaultArea()

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.

Definition at line 321 of file kpassivepopup.cpp.

◆ hideEvent()

void KPassivePopup::hideEvent ( QHideEvent *  )
protectedvirtual

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

Definition at line 314 of file kpassivepopup.cpp.

◆ message() [1/14]

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 555 of file kpassivepopup.cpp.

◆ message() [2/14]

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 531 of file kpassivepopup.cpp.

◆ message() [3/14]

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 549 of file kpassivepopup.cpp.

◆ message() [4/14]

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 567 of file kpassivepopup.cpp.

◆ message() [5/14]

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 543 of file kpassivepopup.cpp.

◆ message() [6/14]

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 562 of file kpassivepopup.cpp.

◆ message() [7/14]

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 538 of file kpassivepopup.cpp.

◆ message() [8/14]

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 612 of file kpassivepopup.cpp.

◆ message() [9/14]

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 574 of file kpassivepopup.cpp.

◆ message() [10/14]

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 599 of file kpassivepopup.cpp.

◆ message() [11/14]

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 633 of file kpassivepopup.cpp.

◆ message() [12/14]

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 593 of file kpassivepopup.cpp.

◆ message() [13/14]

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 628 of file kpassivepopup.cpp.

◆ message() [14/14]

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 588 of file kpassivepopup.cpp.

◆ mouseReleaseEvent()

void KPassivePopup::mouseReleaseEvent ( QMouseEvent *  e)
protectedvirtual

Reimplemented to detect mouse clicks.

Definition at line 263 of file kpassivepopup.cpp.

◆ moveNear()

void KPassivePopup::moveNear ( const QRect &  target)
protected

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

Definition at line 376 of file kpassivepopup.cpp.

◆ paintEvent()

void KPassivePopup::paintEvent ( QPaintEvent *  pe)
protectedvirtual

Overwrite to paint the border when PopupStyle == Balloon.

Unused if PopupStyle == Boxed

Definition at line 438 of file kpassivepopup.cpp.

◆ positionSelf()

void KPassivePopup::positionSelf ( )
protectedvirtual

This method positions the popup.

Definition at line 341 of file kpassivepopup.cpp.

◆ setAnchor()

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 432 of file kpassivepopup.cpp.

◆ setAutoDelete()

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 258 of file kpassivepopup.cpp.

◆ setPopupStyle

void KPassivePopup::setPopupStyle ( int  popupstyle)
slot

Sets the visual appearance of the popup.

See also
PopupStyle

Definition at line 146 of file kpassivepopup.cpp.

◆ setTimeout

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 240 of file kpassivepopup.cpp.

◆ setView() [1/3]

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

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

Definition at line 178 of file kpassivepopup.cpp.

◆ setView() [2/3]

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

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

Definition at line 225 of file kpassivepopup.cpp.

◆ setView() [3/3]

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 164 of file kpassivepopup.cpp.

◆ setVisible

void KPassivePopup::setVisible ( bool  visible)
virtualslot

Definition at line 273 of file kpassivepopup.cpp.

◆ show [1/2]

void KPassivePopup::show ( )
slot

Reimplemented to reposition the popup.

Definition at line 303 of file kpassivepopup.cpp.

◆ show [2/2]

void KPassivePopup::show ( const QPoint &  p)
slot

Shows the popup in the given point.

Definition at line 308 of file kpassivepopup.cpp.

◆ standardView()

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
captionThe window caption (title) on the popup
textThe text for the popup
iconThe icon to use for the popup
parentThe 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 186 of file kpassivepopup.cpp.

◆ timeout()

int KPassivePopup::timeout ( ) const

Returns the delay before the popup is removed automatically.

Definition at line 235 of file kpassivepopup.cpp.

◆ updateMask()

void KPassivePopup::updateMask ( )
protected

Updates the transparency mask.

Unused if PopupStyle == Boxed

Definition at line 449 of file kpassivepopup.cpp.

◆ view()

QWidget * KPassivePopup::view ( ) const

Returns the main view.

Definition at line 230 of file kpassivepopup.cpp.

Property Documentation

◆ autoDelete

bool KPassivePopup::autoDelete
readwrite

Definition at line 1 of file kpassivepopup.h.

◆ defaultArea

QRect KPassivePopup::defaultArea
read

Definition at line 1 of file kpassivepopup.h.

◆ timeout

int KPassivePopup::timeout
readwrite

Definition at line 1 of file kpassivepopup.h.


The documentation for this class was generated from the following files:
  • kpassivepopup.h
  • kpassivepopup.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 20 2023 00:00:00 by doxygen 1.9.6 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Namespace List
  • Namespace Members
  • Alphabetical List
  • Class List
  • Class Hierarchy
  • Class Members
  • File List
  • File Members
  • Modules
  • Related Pages

kdelibs-4.14.38 API Reference

Skip menu "kdelibs-4.14.38 API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal