org.kde.koala
public class KNotifyClient extends Object
[!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 ...default_presentation contains these ORed events: None=0, Sound=1, Messagebox=2, Logfile=4, Stderr=8, PassivePopup=16, Execute=32, Taskbar=64 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:
UNKNOWN: This namespace provides a method for issuing events to a KNotifyServer call KNotifyClient.event("eventname"); to issue it.
Field Summary | |
---|---|
static int | cannotOpenFile
default events you can use |
static int | catastrophe |
static int | Catastrophe |
static int | Default
Describes the notification method. |
static int | Error |
static int | Execute |
static int | fatalError |
static int | Logfile |
static int | Messagebox |
static int | notification |
static int | None |
static int | Notification
Describes the level of the error. |
static int | PassivePopup |
static int | Sound |
static int | Stderr |
static int | Taskbar |
static int | warning |
static int | Warning |
Method Summary | |
---|---|
static void | beep(String reason)
This is a simple substitution for QApplication.beep().
|
static void | beep() |
static int | event(int winId, String message, String text)
This should be the most used method in here.
|
static int | event(int winId, String message) |
static int | event(int winId, int event, String text)
You should
pass the origin-widget's winId() here so that a PassivePopup can be
placed appropriately. |
static int | event(int winId, int event) |
static String | getDefaultFile(String eventname, int present)
Gets the default File for the event of this program.
|
static int | getDefaultPresentation(String eventname)
Gets the default presentation for the event of this program.
|
static String | getFile(String eventname, int present)
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. |
static int | getPresentation(String eventname)
Gets the presentation associated with a certain event name
Remeber that they may be ORed:
if (present & KNotifyClient.Sound) { [Yes, sound is a default] } |
static KInstanceInterface | instance()
Shortcut to KNotifyClient.Instance.current() :) |
static boolean | startDaemon()
This starts the KNotify Daemon, if it's not already started.
|
static int | userEvent(int winId, String text, int present, int level, String sound, String file)
Will fire an event that's not registered.
|
static int | userEvent(int winId, String text, int present, int level, String sound) |
static int | userEvent(int winId, String text, int present, int level) |
static int | userEvent(int winId, String text, int present) |
static int | userEvent(int winId, String text) |
static int | userEvent(int winId) |
UNKNOWN: default events you can use
UNKNOWN: Describes the notification method.
UNKNOWN: Describes the level of the error.
KNotifyClient.event( KNotifyClient.notification, reason );
Parameters: reason the reason, can be null.
UNKNOWN: This is a simple substitution for QApplication.beep().
Parameters: winId The winId() of the widget where the event originates message The name of the event text The text to put in a dialog box. This won't be shown if the user connected the event to sound, only. Can be null.
Returns: a value > 0, unique for this event if successful, 0 otherwise
UNKNOWN: This should be the most used method in here.
Parameters: winId The winId() of the widget where the event originates event The event you want to raise text The text to put in a dialog box. This won't be shown if the user connected the event to sound, only. Can be null.
Returns: a value > 0, unique for this event if successful, 0 otherwise
UNKNOWN: You should pass the origin-widget's winId() here so that a PassivePopup can be placed appropriately.
Parameters: eventname the name of the event present the presentation method
Returns: the default file. Can be null if not found.
UNKNOWN: Gets the default File for the event of this program.
if (present & KNotifyClient.Sound) { [Yes, sound is a default] }
Returns: the presentation methods
UNKNOWN: Gets the default presentation for the event of this program.
Parameters: eventname the name of the event present the presentation method
Returns: the associated file. Can be null if not found.
UNKNOWN: 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.
if (present & KNotifyClient.Sound) { [Yes, sound is a default] }
Parameters: eventname the event name to check
Returns: the presentation methods
UNKNOWN: Gets the presentation associated with a certain event name Remeber that they may be ORed: if (present & KNotifyClient.Sound) { [Yes, sound is a default] }
Returns: the current KInstance.
UNKNOWN: Shortcut to KNotifyClient.Instance.current() :)
Returns: true if daemon is running (always true at the moment)
UNKNOWN: This starts the KNotify Daemon, if it's not already started.
Parameters: winId The winId() of the originating widget text The error message text, if applicable present The presentation method(s) of the event level The error message level, defaulting to "Default" sound The sound file to play if selected with present
file The log file to append the message to if selected with present
Returns: a value > 0, unique for this event if successful, 0 otherwise
UNKNOWN: Will fire an event that's not registered.