Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KWindowInfo Class Reference

#include <kwindowinfo.h>

List of all members.

Public Slots

void message (const QString &text)
void message (const QString &text, const QPixmap &pix)
void message (const QString &text, int timeout)
void message (const QString &text, const QPixmap &pix, int timeout)
void permanent (const QString &text)
void permanent (const QString &text, const QPixmap &pix)

Public Methods

 KWindowInfo (QWidget *parent, const char *name=0)
virtual ~KWindowInfo ()
bool autoDelete () const
void setAutoDelete (bool enable)

Static Public Methods

void showMessage (QWidget *window, const QString &text, int timeout=-1)
void showMessage (QWidget *window, const QString &text, const QPixmap &pix, int timeout=-1)

Protected Slots

virtual void save ()
virtual void restore ()

Protected Methods

virtual void display (const QString &text, const QPixmap &pix)

Detailed Description

Displays messages in the window icon and title. The message is usually transient with the original title and icon being restored automatically after a specified time. The simplest use displays a text message in the window title: 
    KWindowInfo::showMessage( this, "Message Body" );
This more complex example changes the window icon, as well as displaying the text. In addition, this example overrides the default timeout to ensure the message is only displayed for 1 second. 
    QPixmap px;
    px.load( "lo16-app-logtracker.png" );
    KWindowInfo::showMessage( this, "Message Body", px, 1000 );
If the parent window inherits KSystemTray then KWindowInfo changes the pixmap and tooltip of the system window to display the message.

Author:
Richard Moore, rich@kde.org
Version:
Id:
kwindowinfo.h,v 1.5 2002/09/28 15:16:22 tjansen Exp
Since:
3.1

Definition at line 40 of file kwindowinfo.h.

Constructor & Destructor Documentation

KWindowInfo::KWindowInfo (  QWidget *    parent,
const char *    name = 0
) 
 

Creates a KWindowInfo with the specified parent.

virtual KWindowInfo::~KWindowInfo (    )  [virtual]
 

Cleans up.

Member Function Documentation

bool KWindowInfo::autoDelete (    )  const [inline]
 

Returns true iff the object should delete itself when it resets.

Definition at line 58 of file kwindowinfo.h.

virtual void KWindowInfo::display (  const QString &    text,
const QPixmap &    pix
)  [protected, virtual]
 

Displays the message in the titlebar/icon.

void KWindowInfo::message (  const QString &    text,
const QPixmap &    pix,
int    timeout
)  [slot]
 

Shows the specified icon and text in the window title and WM icon, for the specified time. The time is a delay specified in milliseconds, or one of the two special values. The special values are -1 which means the default timeout should be used, and 0 which means the message is permanent.

void KWindowInfo::message (  const QString &    text,
int    timeout
)  [slot]
 

Shows the specified text in the window title for the specified time.

void KWindowInfo::message (  const QString &    text,
const QPixmap &    pix
)  [slot]
 

Shows the specified text in the window title, and sets the window icon.

void KWindowInfo::message (  const QString &    text )  [slot]
 

Shows the specified text in the window title.

void KWindowInfo::permanent (  const QString &    text,
const QPixmap &    pix
)  [slot]
 

Shows the specified text and icon in the window title with no timeout.

void KWindowInfo::permanent (  const QString &    text )  [slot]
 

Shows the specified text in the window title with no timeout.

virtual void KWindowInfo::restore (    )  [protected, virtual, slot]
 

Resets the window title and icon to the saved values. If auto-delete is enabled then the object is deleted.

virtual void KWindowInfo::save (    )  [protected, virtual, slot]
 

Saves the window title and icon.

void KWindowInfo::setAutoDelete (  bool    enable )  [inline]
 

Set to true if you want the object to delete itself when the message timeout occurs.

Definition at line 64 of file kwindowinfo.h.

void KWindowInfo::showMessage (  QWidget *    window,
const QString &    text,
const QPixmap &    pix,
int    timeout = -1
)  [static]
 

Utility method to display a title bar message and icon for the specified window.

void KWindowInfo::showMessage (  QWidget *    window,
const QString &    text,
int    timeout = -1
)  [static]
 

Utility method to display a title bar message for the specified window.

The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:28 2003 for kdelibs by doxygen1.2.18