KNotifyPlugin Class Reference

#include <knotifyplugin.h>

Inheritance diagram for KNotifyPlugin:

Signals
void	actionInvoked (int id, int action)
void	finished (int id)

Public Member Functions
	KNotifyPlugin (QObject *parent=0l, const QVariantList &args=QVariantList())
virtual	~KNotifyPlugin ()
virtual void	close (int id)
virtual void	notify (int id, KNotifyConfig *config)=0
virtual QString	optionName ()=0
virtual void	update (int id, KNotifyConfig *config)

Protected Member Functions
void	finish (int id)

Detailed Description

abstract class for KNotify actions

A KNotifyPlugin is responsible of one presentation. You can subclass it to have your own knotify presentation.

You should reimplement the KNotifyPlugin::notify method to display the notification.

Author

Olivier Goffart <ogoffart at kde.org>

Definition at line 44 of file knotifyplugin.h.

Constructor & Destructor Documentation

KNotifyPlugin::KNotifyPlugin	(	QObject *	parent = 0l,
		const QVariantList &	args = QVariantList()
	)

Definition at line 25 of file knotifyplugin.cpp.

KNotifyPlugin::~KNotifyPlugin ( )

virtual

Definition at line 33 of file knotifyplugin.cpp.

Member Function Documentation

void KNotifyPlugin::actionInvoked ( int  id, int  action  )

signal

emit this signal if one action was invoked

Parameters

id	is the id of the notification
action	is the action number. zero for the default action

void KNotifyPlugin::close ( int  id )

virtual

This function is called when the notification has been closed.

Reimplemented in NotifyByPopup, and NotifyBySound.

Definition at line 44 of file knotifyplugin.cpp.

void KNotifyPlugin::finish ( int  id )

protected

emit the finished signal you MUST call this function for each call to notify(), even if you do nothing there

call it when the presentation is finished (because the user closed the popup or the sound is finished)

If your presentation is synchronous, you can even call this function from the notify() call itself

Definition at line 49 of file knotifyplugin.cpp.

void KNotifyPlugin::finished ( int  id )

signal

the presentation is finished.

virtual void KNotifyPlugin::notify ( int  id, KNotifyConfig *  config  )

pure virtual

This function is called when the notification is sent.

(or re-sent) You should implement this function to display a notification

for each call to this function (even for re-notification), you MUST call finish(int)

Parameters

id	is the notification id
config	is the configuration of the notification

Implemented in NotifyByPopup, NotifyByKTTS, NotifyByExecute, NotifyByLogfile, NotifyBySound, and NotifyByTaskbar.

virtual QString KNotifyPlugin::optionName ( )

pure virtual

return the name of this plugin.

this is the name that should appear in the .knotifyrc file, in the field Action=... if a notification is set to use this plugin

Implemented in NotifyByPopup, NotifyByKTTS, NotifyByExecute, NotifyByLogfile, NotifyBySound, and NotifyByTaskbar.

void KNotifyPlugin::update ( int  id, KNotifyConfig *  config  )

virtual

This function is called when the notification has changed (such as the text or the icon)

Reimplemented in NotifyByPopup.

Definition at line 38 of file knotifyplugin.cpp.

---

The documentation for this class was generated from the following files:

• knotifyplugin.h
• knotifyplugin.cpp