KNotifyClient Namespace Reference
Detailed Description
This namespace provides a method for issuing events to a KNotifyServer call KNotifyClient::event("eventname"); to issue it.On installation, there should be a file called $KDEDIR/share/apps/appname/eventsrc which contains the events.
The file looks like this:
[!Global!] IconName=Filename (e.g. kdesktop, without any extension) Comment=FriendlyNameOfApp [eventname] Name=FriendlyNameOfEvent Comment=Description Of Event default_sound=filetoplay.wav default_logfile=logfile.txt default_commandline=command default_presentation=1 ...
KNotify will search for sound files given with a relative path first in the application's sound directory (share/apps/Application Name/sounds), then in the KDE global sound directory (share/sounds).
You can also use the "nopresentation" key, with any the presentations ORed. Those that are in that field will not appear in the kcontrol module. This was intended for software like KWin to not allow a window-opening that opens a window (e.g., allowing to disable KMessageBoxes from appearing) If the user edits the eventsrc file manually, it will appear. This only affects the KcmNotify.
You can also use the following events, which are system controlled and do not need to be placed in your eventsrc:
- cannotopenfile
- notification
- warning
- fatalerror
- catastrophe
The events can be configured in an application using KNotifyDialog, which is part of KIO.
- Author:
- Charles Samuels <charles@kde.org>
Classes | |
class | Instance |
Makes it possible to use KNotifyClient with a KInstance that is not the application.Enables KNotifyClient to use a different KInstance. More... | |
Enumerations | |
enum | { Default = -1, None = 0, Sound = 1, Messagebox = 2, Logfile = 4, Stderr = 8, PassivePopup = 16, Execute = 32, Taskbar = 64 } |
enum | { Notification = 1, Warning = 2, Error = 4, Catastrophe = 8 } |
enum | StandardEvent { cannotOpenFile, notification, warning, fatalError, catastrophe } |
Functions | |
int | event (StandardEvent event, const QString &text=QString::null) KDE_DEPRECATED |
int | event (const QString &message, const QString &text=QString::null) KDE_DEPRECATED |
int | userEvent (const QString &text=QString::null, int present=Default, int level=Default, const QString &sound=QString::null, const QString &file=QString::null) KDE_DEPRECATED |
int | event (int winId, StandardEvent event, const QString &text=QString::null) |
int | event (int winId, const QString &message, const QString &text=QString::null) |
int | userEvent (int winId, const QString &text=QString::null, int present=Default, int level=Default, const QString &sound=QString::null, const QString &file=QString::null) |
int | getPresentation (const QString &eventname) |
QString | getFile (const QString &eventname, int present) |
int | getDefaultPresentation (const QString &eventname) |
QString | getDefaultFile (const QString &eventname, int present) |
bool | startDaemon () |
void | beep (const QString &reason=QString::null) |
KInstance * | instance () |
Enumeration Type Documentation
|
Describes the notification method.
Definition at line 138 of file knotifyclient.h. |
|
Describes the level of the error.
Definition at line 153 of file knotifyclient.h. |
|
default events you can use
Definition at line 163 of file knotifyclient.h. |
Function Documentation
|
This is a simple substitution for QApplication::beep(). It simply calls KNotifyClient::event( KNotifyClient::notification, reason );
Definition at line 239 of file knotifyclient.cpp. |
|
This should be the most used method in here. Pass the origin-widget's winId() here so that a PassivePopup can be placed appropriately. Call it by KNotifyClient::event(widget->winId(), "EventName"); It will use KApplication::kApplication->dcopClient() to communicate to the server
Definition at line 150 of file knotifyclient.cpp. |
|
You should pass the origin-widget's winId() here so that a PassivePopup can be placed appropriately.
Definition at line 124 of file knotifyclient.cpp. |
|
Definition at line 112 of file knotifyclient.cpp. |
|
Definition at line 107 of file knotifyclient.cpp. |
|
Gets the default File for the event of this program. It gets it in relation to present. Some events don't apply to this function ("Message Box") Some do (Sound)
Definition at line 207 of file knotifyclient.cpp. |
|
Gets the default presentation for the event of this program. Remember that the Presentation may be ORed. Try this: if (present & KNotifyClient::Sound) { [Yes, sound is a default] }
Definition at line 194 of file knotifyclient.cpp. |
|
Gets the default file associated with a certain event name The control panel module will list all the event names This has the potential for being slow.
Definition at line 176 of file knotifyclient.cpp. |
|
Gets the presentation associated with a certain event name Remeber that they may be ORed:.
if (present & KNotifyClient::Sound) { [Yes, sound is a default] }
Definition at line 163 of file knotifyclient.cpp. |
|
Shortcut to KNotifyClient::Instance::current() :).
Definition at line 267 of file knotifyclient.cpp. |
|
This starts the KNotify Daemon, if it's not already started. This will be useful for games that use sound effects. Run this at the start of the program, and there won't be a pause when it is first triggered.
Definition at line 225 of file knotifyclient.cpp. |
|
Will fire an event that's not registered. You should pass the origin-widget's winId() here so that a PassivePopup can be placed appropriately.
Definition at line 156 of file knotifyclient.cpp. |
|
Definition at line 117 of file knotifyclient.cpp. |