class KWindowInfo

# class KWindowInfo | Displays messages in the window icon and title. More...
Definition | `#include <kwindowinfo.h>`
Inherits | QObject (qt) [public ]
List of all Methods
Annotated List
Files
Globals
Hierarchy
Index

#### Public Methods

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

#### 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 Static Methods

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

#### Protected Methods

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

#### Protected Slots

- virtual void save ()
- virtual void restore ()

## 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.

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

Creates a KWindowInfo with the specified parent.

~KWindowInfo () | ### ~KWindowInfo

[virtual]

Cleans up.

bool autoDelete () | ### autoDelete

[const]

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

void setAutoDelete ( bool enable ) | ### setAutoDelete

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

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

[static]

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

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

[static]

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

void message ( const QString &text ) | ### message

[slot]

Shows the specified text in the window title.

void message ( const QString &text, const QPixmap &pix ) | ### message

[slot]

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

void message ( const QString &text, int timeout ) | ### message

[slot]

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

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

[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 permanent ( const QString &text ) | ### permanent

[slot]

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

void permanent ( const QString &text, const QPixmap &pix ) | ### permanent

[slot]

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

void display ( const QString &text, const QPixmap &pix ) | ### display

[protected virtual]

Displays the message in the titlebar/icon.

void save () | ### save

[protected slots virtual slot]

Saves the window title and icon.

void restore () | ### restore

[protected slots virtual slot]

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

- Version: $Id: kwindowinfo.h,v 1.5 2002/09/28 15:16:22 tjansen Exp $
- Author: Richard Moore, rich@kde.org
- Generated: root on macppc.ports.openbsd.org on Sat Sep 6 10:36:37 2003, using kdoc 2.0a54.