.TH "KNotifyDialog" 3 "28 Jan 2004" "kio Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KNotifyDialog \- KNotifyDialog presents an interface for configuring an application's KNotify events.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <knotifydialog.h>\fP
.PP
Inherits \fBKDialogBase\fP.
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKNotifyDialog\fP (\fBQWidget\fP *parent=0, const  char *name=0, bool modal=true, const  \fBKAboutData\fP *aboutData=\fBKGlobal::instance\fP()->aboutData())"
.br
.RI "\fIIf you want a non-modal dialog, you need to instantiate KNotifyDialog yourself instead of using the \fBconfigure\fP() method. \fP"
.ti -1c
.RI "virtual \fB~KNotifyDialog\fP ()"
.br
.RI "\fIDestroys the KNotifyDialog. \fP"
.ti -1c
.RI "virtual void \fBaddApplicationEvents\fP (const  char *appName)"
.br
.RI "\fIWith this method, you can add the KNotify events of one eventsrc files to the view. \fP"
.ti -1c
.RI "virtual void \fBaddApplicationEvents\fP (const  \fBQString\fP &path)"
.br
.RI "\fIWith this method, you can add the KNotify events of one eventsrc files to the view. \fP"
.ti -1c
.RI "virtual void \fBclearApplicationEvents\fP ()"
.br
.RI "\fIRemoves all the events added with \fBaddApplicationEvents\fP(). \fP"
.in -1c
.SS "Static Public Member Functions"

.in +1c
.ti -1c
.RI "int \fBconfigure\fP (\fBQWidget\fP *parent=0, const  char *name=0, const  \fBKAboutData\fP *aboutData=\fBKGlobal::instance\fP()->aboutData())"
.br
.RI "\fIConvenience method to create \fBexec\fP() a modal KNotifyDialog. \fP"
.in -1c
.SH "Detailed Description"
.PP 
KNotifyDialog presents an interface for configuring an application's KNotify events. 

Rather than requiring the user to wade through the entire list of applications' events in KControl, your application can make the list of its own notifications available here.
.PP
Typical usage is calling the static \fBconfigure\fP() method: 
.PP
.nf

 (void) KNotifyDialog::configure( someParentWidget );
 
.PP
.PP
\fBSince:\fP
.RS 4
3.1 
.RE
.PP
\fBAuthor:\fP
.RS 4
Carsten Pfeiffer <pfeiffer@kde.org> 
.RE
.PP

.PP
Definition at line 53 of file knotifydialog.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KNotifyDialog::KNotifyDialog (\fBQWidget\fP * parent = 0, const char * name = 0, bool modal = true, const \fBKAboutData\fP * aboutData = \fBKGlobal::instance\fP()-, aboutData())"
.PP
If you want a non-modal dialog, you need to instantiate KNotifyDialog yourself instead of using the \fBconfigure\fP() method. \fBParameters:\fP
.RS 4
\fIparent\fP The parent widget for the dialog 
.br
\fIname\fP The widget name 
.br
\fImodal\fP If true, this will be a modal dialog, otherwise non-modal. 
.br
\fIaboutData\fP A pointer to a \fBKAboutData\fP object. \fBKAboutData::appName\fP() will be used to find the KNotify events (in the eventsrc file). Set this to 0L if you want to add all events yourself with \fBaddApplicationEvents\fP(). 
.RE
.PP

.SS "KNotifyDialog::~\fBKNotifyDialog\fP ()\fC [virtual]\fP"
.PP
Destroys the KNotifyDialog. Definition at line 123 of file knotifydialog.cpp.
.SH "Member Function Documentation"
.PP 
.SS "int KNotifyDialog::configure (\fBQWidget\fP * parent = 0, const char * name = 0, const \fBKAboutData\fP * aboutData = \fBKGlobal::instance\fP()-, aboutData())\fC [static]\fP"
.PP
Convenience method to create \fBexec\fP() a modal KNotifyDialog. \fBParameters:\fP
.RS 4
\fIparent\fP The parent widget for the dialog 
.br
\fIname\fP The widget name 
.br
\fIaboutData\fP A pointer to a \fBKAboutData\fP object. \fBKAboutData::appName\fP() will be used to find the KNotify events (in the eventsrc file). 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBexec\fP for the return values. 
.RE
.PP
\fBReturns:\fP
.RS 4
The value of \fBQDialog::exec()\fP 
.RE
.PP

.SS "void KNotifyDialog::addApplicationEvents (const char * appName)\fC [virtual]\fP"
.PP
With this method, you can add the KNotify events of one eventsrc files to the view. KNotifyDialog can handle events for multiple applications (i.e. eventsrc files). Successive calls with a different \fCappName\fP will add them. 
.PP
\fBParameters:\fP
.RS 4
\fIappName\fP The application's name, i.e. the name passed to the \fBKApplication\fP constructor or \fBKAboutData\fP. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBclearApplicationEvents()\fP 
.RE
.PP
Definition at line 127 of file knotifydialog.cpp.
.PP
References QString::fromLatin1(), and QString::fromUtf8().
.SS "void KNotifyDialog::addApplicationEvents (const \fBQString\fP & path)\fC [virtual]\fP"
.PP
With this method, you can add the KNotify events of one eventsrc files to the view. KNotifyDialog can handle events for multiple applications (i.e. eventsrc files). Successive calls with a different \fCpath\fP will add them. 
.PP
\fBParameters:\fP
.RS 4
\fIpath\fP The absolute or relative path to the eventsrc file to be configured. A relative path would be e.g. 'kwin/eventsrc'. 
.RE
.PP
\fBSee also:\fP
.RS 4
\fBclearApplicationEvents()\fP 
.RE
.PP
Definition at line 133 of file knotifydialog.cpp.
.SS "void KNotifyDialog::clearApplicationEvents ()\fC [virtual]\fP"
.PP
Removes all the events added with \fBaddApplicationEvents\fP(). \fBSee also:\fP
.RS 4
\fBaddApplicationEvents()\fP 
.RE
.PP
Definition at line 143 of file knotifydialog.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kio Library from the source code.
