tdeui
KWindowInfo Class Reference
Displays messages in the window icon and title. More...
#include <twindowinfo.h>

Public Slots | |
void | message (const TQString &text) |
void | message (const TQString &text, const TQPixmap &pix) |
void | message (const TQString &text, int timeout) |
void | message (const TQString &text, const TQPixmap &pix, int timeout) |
void | permanent (const TQString &text) |
void | permanent (const TQString &text, const TQPixmap &pix) |
Public Member Functions | |
KWindowInfo (TQWidget *parent, const char *name=0) | |
virtual | ~KWindowInfo () |
bool | autoDelete () const |
void | setAutoDelete (bool enable) |
Static Public Member Functions | |
static void | showMessage (TQWidget *window, const TQString &text, int timeout=-1) |
static void | showMessage (TQWidget *window, const TQString &text, const TQPixmap &pix, int timeout=-1) |
Protected Slots | |
virtual void | save () |
virtual void | restore () |
Protected Member Functions | |
virtual void | display (const TQString &text, const TQPixmap &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, i18n("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.
TQPixmap px; px.load( "lo16-app-logtracker.png" ); KWindowInfo::showMessage( this, i18n("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.
- Since:
- 3.1
Definition at line 41 of file twindowinfo.h.
Constructor & Destructor Documentation
KWindowInfo::KWindowInfo | ( | TQWidget * | parent, | |
const char * | name = 0 | |||
) |
Creates a KWindowInfo with the specified parent.
Definition at line 20 of file twindowinfo.cpp.
KWindowInfo::~KWindowInfo | ( | ) | [virtual] |
Cleans up.
Definition at line 25 of file twindowinfo.cpp.
Member Function Documentation
bool KWindowInfo::autoDelete | ( | ) | const [inline] |
Returns true iff the object should delete itself when it resets.
Definition at line 59 of file twindowinfo.h.
Displays the message in the titlebar/icon.
Definition at line 103 of file twindowinfo.cpp.
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.
Definition at line 60 of file twindowinfo.cpp.
void KWindowInfo::message | ( | const TQString & | text, | |
int | timeout | |||
) | [slot] |
Shows the specified text in the window title for the specified time.
Definition at line 55 of file twindowinfo.cpp.
Shows the specified text in the window title, and sets the window icon.
Definition at line 50 of file twindowinfo.cpp.
void KWindowInfo::message | ( | const TQString & | text | ) | [slot] |
Shows the specified text in the window title.
Definition at line 45 of file twindowinfo.cpp.
Shows the specified text and icon in the window title with no timeout.
Definition at line 85 of file twindowinfo.cpp.
void KWindowInfo::permanent | ( | const TQString & | text | ) | [slot] |
Shows the specified text in the window title with no timeout.
Definition at line 73 of file twindowinfo.cpp.
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.
Definition at line 154 of file twindowinfo.cpp.
void KWindowInfo::save | ( | ) | [protected, virtual, slot] |
Saves the window title and icon.
Definition at line 125 of file twindowinfo.cpp.
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 65 of file twindowinfo.h.
void KWindowInfo::showMessage | ( | TQWidget * | window, | |
const TQString & | text, | |||
const TQPixmap & | pix, | |||
int | timeout = -1 | |||
) | [static] |
Utility method to display a title bar message and icon for the specified window.
Definition at line 38 of file twindowinfo.cpp.
void KWindowInfo::showMessage | ( | TQWidget * | window, | |
const TQString & | text, | |||
int | timeout = -1 | |||
) | [static] |
Utility method to display a title bar message for the specified window.
Definition at line 29 of file twindowinfo.cpp.
The documentation for this class was generated from the following files: