mirror of
https://bitbucket.org/smil3y/kde-playground.git
synced 2025-02-24 10:52:52 +00:00
1481 lines
53 KiB
HTML
1481 lines
53 KiB
HTML
<?xml version="1.0" encoding="UTF-8"?>
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
|
|
|
|
<head>
|
|
<title>KNotification</title>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
<meta http-equiv="Content-Style-Type" content="text/css" />
|
|
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
|
|
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
|
|
</head>
|
|
<body>
|
|
<div id="container">
|
|
<div id="header">
|
|
<div id="header_top">
|
|
<div>
|
|
<div>
|
|
<img alt ="" src="../common/top-kde.jpg"/>
|
|
KDE 4.9 PyKDE API Reference
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="header_bottom">
|
|
<div id="location">
|
|
<ul>
|
|
<li>KDE's Python API</li>
|
|
</ul>
|
|
</div>
|
|
|
|
<div id="menu">
|
|
<ul>
|
|
<li><a href="../modules.html">Overview</a></li>
|
|
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
|
|
<li><a href="http://kde.org/family/">Sitemap</a></li>
|
|
<li><a href="http://kde.org/contact/">Contact Us</a></li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="body_wrapper">
|
|
<div id="body">
|
|
<div id="right">
|
|
<div class="content">
|
|
<div id="main">
|
|
<div class="clearer"> </div>
|
|
|
|
<h1>KNotification Class Reference</h1>
|
|
<code>from PyKDE4.kdeui import *</code>
|
|
<p>
|
|
Inherits: QObject<br />
|
|
|
|
|
|
<h2>Detailed Description</h2>
|
|
|
|
<p>KNotification is used to notify the user of an event.
|
|
</p>
|
|
<p>
|
|
<b>introduction </b>
|
|
</p>
|
|
<p>
|
|
There are two main kinds of notifications:
|
|
</p>
|
|
<p>
|
|
<li> Feedback events: </li>
|
|
For notifying the user that he/she just performed an operation, like maximizing a
|
|
window. This allows us to play sounds when a dialog appears.
|
|
This is an instant notification. It ends automatically after a small timeout.
|
|
</p>
|
|
<p>
|
|
<li> persistant notifications: </li>
|
|
Notify when the user received a new message, or when something else important happened
|
|
the user has to know about. This notification has a start and a end. It begins when
|
|
the event actually occurs, and finishes when the message is acknowledged or read.
|
|
</p>
|
|
<p>
|
|
Example of a persistent notification in an instant messaging application:
|
|
The application emits the notification when the message is actually received, and closes it only
|
|
when the user has read the message (when the message window has received the focus) using the close() slot
|
|
Persistent notifications must have the Persistent flag.
|
|
</p>
|
|
<p>
|
|
By default a notification will use the application name as title, but you
|
|
can also provide a brief text in the title and a more precise description in
|
|
the body text. This is especially useful for notifications coming from
|
|
applications which should be considered "part of the system", like a battery
|
|
monitor or a network connection manager.
|
|
For example a battery indicator could use "Low Battery" as a title and "Only
|
|
12 minutes left." as a body text.
|
|
</p>
|
|
<p>
|
|
In order to perform a notification, you need to create a description file, which contains
|
|
default parameters of the notification, and use KNotification.event at the place in the
|
|
application code where the notification occurs.
|
|
The returned KNotification pointer may be used to connect signals or slots
|
|
</p>
|
|
<p>
|
|
<b>The global config file </b>
|
|
Your application should install a file called:
|
|
<em>$KDEDIR/share/apps/appname/appname.notifyrc</em>
|
|
</p>
|
|
<p>
|
|
You can do this with the following CMake command:
|
|
install( FILES appname.notifyrc DESTINATION ${DATA_INSTALL_DIR}/appname))
|
|
</p>
|
|
<p>
|
|
This file contains mainly 3 parts
|
|
<ol><li>\ref global "Global information"</li>
|
|
<li>\ref context "Context information"</li>
|
|
<li>\ref events "Definition of individual events"</li></ol>
|
|
</p>
|
|
<p>
|
|
The global part looks like that
|
|
<pre>
|
|
[Global]
|
|
IconName=Filename
|
|
Comment=Friendly Name of app
|
|
Name=Name of app
|
|
</pre>
|
|
The icon filename is just the name, without extension, it's found with the KIconLoader.
|
|
The Comment field will be used in KControl to describe the application.
|
|
The Name field is optional and may be used as the application name for popup,
|
|
if Name is not present, Comment is used instead
|
|
</p>
|
|
<p>
|
|
This part consists of hints for the configuration widget
|
|
<pre>
|
|
[Context/group]
|
|
Name=Group name
|
|
Comment=The name of the group for contacts
|
|
</p>
|
|
<p>
|
|
[Context/folder]
|
|
Name=Group name
|
|
</pre>
|
|
The second part of the groupname is the context identifier.
|
|
It should not contain special characters.
|
|
The Name field is the one the user will see (and which is translated)
|
|
</p>
|
|
<p>
|
|
The definition of the events forms the most important part of the config file
|
|
<pre>
|
|
[Event/newmail]
|
|
Name=New email
|
|
Comment=You have got a new email
|
|
Contexts=folder,group
|
|
Action=Sound|Popup
|
|
</p>
|
|
<p>
|
|
[Event/contactOnline]
|
|
Name=Contact goes online
|
|
Comment=One of your contact has been connected
|
|
Contexts=group
|
|
Sound=filetoplay.ogg
|
|
Action=None
|
|
</pre>
|
|
These are the default settings for each notifiable event.
|
|
Action is the string representing the action. Actions can be added to
|
|
the KNotify daemon as plugins, by deriving from KNotifyPlugin.
|
|
At the time of writing, the following actions are available: Taskbar,
|
|
Sound, Popup, Logfile, KTTS, Execute.
|
|
Actions can be combined by seperating them with '|'.
|
|
</p>
|
|
<p>
|
|
Contexts is a comma separated list of possible context for this event.
|
|
</p>
|
|
<p>
|
|
<b>The user's config file </b>
|
|
</p>
|
|
<p>
|
|
This is an implementation detail, and is described here for your information.
|
|
</p>
|
|
<p>
|
|
In the config file, there are two parts: the event configuration, and the context information
|
|
These are hints for the configuration dialog. They contain both the internal id of the context, and the user visible string.
|
|
<pre>
|
|
[Context/group]
|
|
Values=1:Friends,2:Work,3:Family
|
|
</pre>
|
|
This contains the configuration of events for the user.
|
|
It contains the same fields as the description file.
|
|
The key of groups is in the form
|
|
<em>Event/&lt;EventName&gt;/&lt;ContextName&gt;/&lt;ContextValue&gt;</em>
|
|
<pre>
|
|
[Event/contactOnline]
|
|
Action=Sound
|
|
Sound=/usr/share/sounds/super.ogg
|
|
</p>
|
|
<p>
|
|
[Event/contactOnline/group/1]
|
|
Action=Popup|Sound
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
<b>Example of code </b>
|
|
</p>
|
|
<p>
|
|
This portion of code will fire the event for the "contactOnline" event
|
|
</p>
|
|
<p>
|
|
<pre class="fragment">
|
|
KNotification *notification= new KNotification ( "contactOnline", widget );
|
|
notification->setText( i18n("The contact <i>%1</i> has gone online", contact->name() );
|
|
notification->setPixmap( contact->pixmap() );
|
|
notification->setActions( QStringList( i18n( "Open chat" ) ) );
|
|
|
|
foreach( const QString &group , contact->groups() ) {
|
|
notification->addContext( "group" , group ) ;
|
|
}
|
|
|
|
connect(notification, SIGNAL(activated(unsigned int )), contact , SLOT(slotOpenChat()) );
|
|
|
|
notification->sendEvent();
|
|
</pre>
|
|
</p>
|
|
<p>
|
|
|
|
<dl class="author" compact><dt><b>Author:</b></dt><dd> Olivier Goffart <ogoffart at kde.org> </dd></dl>
|
|
</p>
|
|
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Enumerations</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#NotificationFlag">NotificationFlag</a> </td><td class="memItemRight" valign="bottom">{ RaiseWidgetOnActivation, CloseOnTimeout, Persistent, CloseWhenWidgetActivated, Persistant, DefaultEvent }</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#StandardEvent">StandardEvent</a> </td><td class="memItemRight" valign="bottom">{ Notification, Warning, Error, Catastrophe }</td></tr>
|
|
<tr><td colspan="2"><br><h2>Signals</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#action1Activated">action1Activated</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#action2Activated">action2Activated</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#action3Activated">action3Activated</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#activated">activated</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#activated">activated</a> (long action)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#closed">closed</a> ()</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ignored">ignored</a> ()</td></tr>
|
|
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KNotification">__init__</a> (self, QString eventId, QWidget widget=0, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags=KNotification.CloseOnTimeout)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KNotification">__init__</a> (self, QString eventId, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags, QObject parent=NULL)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QStringList </td><td class="memItemRight" valign="bottom"><a class="el" href="#actions">actions</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#activate">activate</a> (self, long action=0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addContext">addContext</a> (self, (QString,QString) context)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#addContext">addContext</a> (self, QString context_key, QString context_value)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#close">close</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">[(QString,QString)] </td><td class="memItemRight" valign="bottom"><a class="el" href="#contexts">contexts</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#deref">deref</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#eventFilter">eventFilter</a> (self, QObject watched, QEvent event)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#eventId">eventId</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#flags">flags</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QPixmap </td><td class="memItemRight" valign="bottom"><a class="el" href="#pixmap">pixmap</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#raiseWidget">raiseWidget</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ref">ref</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#sendEvent">sendEvent</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setActions">setActions</a> (self, QStringList actions)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setComponentData">setComponentData</a> (self, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setContexts">setContexts</a> (self, [(QString,QString)] contexts)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setFlags">setFlags</a> (self, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setPixmap">setPixmap</a> (self, QPixmap pix)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setText">setText</a> (self, QString text)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setTitle">setTitle</a> (self, QString title)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setWidget">setWidget</a> (self, QWidget widget)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#text">text</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString </td><td class="memItemRight" valign="bottom"><a class="el" href="#title">title</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#update">update</a> (self)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top">QWidget </td><td class="memItemRight" valign="bottom"><a class="el" href="#widget">widget</a> (self)</td></tr>
|
|
<tr><td colspan="2"><br><h2>Static Methods</h2></td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#beep">beep</a> (QString reason=QString(), QWidget widget=0)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KNotification.html">KNotification</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#event">event</a> (QString eventId, QString text=QString(), QPixmap pixmap=QPixmap(), QWidget widget=0, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags=KNotification.CloseOnTimeout, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData=KComponentData())</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KNotification.html">KNotification</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#event">event</a> (<a href="../kdeui/KNotification.html#StandardEvent">KNotification.StandardEvent</a> eventId, QString text=QString(), QPixmap pixmap=QPixmap(), QWidget widget=0, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags=KNotification.CloseOnTimeout)</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KNotification.html">KNotification</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#event">event</a> (QString eventId, QString title, QString text, QPixmap pixmap=QPixmap(), QWidget widget=0, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags=KNotification.CloseOnTimeout, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData=KComponentData())</td></tr>
|
|
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdeui/KNotification.html">KNotification</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#event">event</a> (<a href="../kdeui/KNotification.html#StandardEvent">KNotification.StandardEvent</a> eventId, QString title, QString text, QPixmap pixmap=QPixmap(), QWidget widget=0, <a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags=KNotification.CloseOnTimeout)</td></tr>
|
|
</table>
|
|
<hr><h2>Signal Documentation</h2><a class="anchor" name="action1Activated"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> action1Activated</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Convenience signal that is emitted when the first action is activated.
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("action1Activated()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="action2Activated"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> action2Activated</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("action2Activated()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="action3Activated"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> action3Activated</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("action3Activated()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="activated"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> activated</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Emit when an action has been activated.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>action</em> </td><td> will be 0 is the default aciton was activated, or any action id
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("activated()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="activated"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> activated</td>
|
|
<td>(</td>
|
|
<td class="paramtype">long </td>
|
|
<td class="paramname"><em>action</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Emit when an action has been activated.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>action</em> </td><td> will be 0 is the default aciton was activated, or any action id
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("activated(unsigned int)"), target_slot)</code></dd></dl></div></div><a class="anchor" name="closed"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> closed</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Emitted when the notification is closed. Both when it is activated or if it is just ignored.
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("closed()"), target_slot)</code></dd></dl></div></div><a class="anchor" name="ignored"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> ignored</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname">)</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>The notification has been ignored
|
|
</p><dl compact><dt><b>Signal syntax:</b></dt><dd><code>QObject.connect(source, SIGNAL("ignored()"), target_slot)</code></dd></dl></div></div><hr><h2>Method Documentation</h2><a class="anchor" name="KNotification"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">__init__</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>eventId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget </td>
|
|
<td class="paramname"><em>widget=0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
|
|
<td class="paramname"><em>flags=KNotification.CloseOnTimeout</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Create a new notification.
|
|
</p>
|
|
<p>
|
|
You have to use sendEvent to show the notification.
|
|
</p>
|
|
<p>
|
|
The pointer is automatically deleted when the event is closed.
|
|
</p>
|
|
<p>
|
|
Make sure you use one of the NotificationFlags CloseOnTimeOut or
|
|
CloseWhenWidgetActivated, if not,
|
|
you have to close the notification yourself.
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>eventId</em> </td><td> is the name of the event
|
|
|
|
<tr><td></td><td valign="top"><em>widget</em> </td><td> is a widget where the notification reports to
|
|
|
|
<tr><td></td><td valign="top"><em>flags</em> </td><td> is a bitmask of NotificationFlag
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="KNotification"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">__init__</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>eventId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
|
|
<td class="paramname"><em>flags</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QObject </td>
|
|
<td class="paramname"><em>parent=NULL</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Create a new notification.
|
|
</p>
|
|
<p>
|
|
You have to use sendEvent to show the notification.
|
|
</p>
|
|
<p>
|
|
The pointer is automatically deleted when the event is closed.
|
|
</p>
|
|
<p>
|
|
Make sure you use one of the NotificationFlags CloseOnTimeOut or
|
|
CloseWhenWidgetActivated, if not,
|
|
you have to close the notification yourself.
|
|
</p>
|
|
<p>
|
|
<dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
|
|
</dd></dl> </p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>eventId</em> </td><td> is the name of the event
|
|
|
|
<tr><td></td><td valign="top"><em>flags</em> </td><td> is a bitmask of NotificationFlag
|
|
|
|
<tr><td></td><td valign="top"><em>parent</em> </td><td> parent object
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="actions"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QStringList actions</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the list of actions
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="activate"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> activate</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">long </td>
|
|
<td class="paramname"><em>action=0</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Activate the action specified action
|
|
If the action is zero, then the default action is activated
|
|
</p></div></div><a class="anchor" name="addContext"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> addContext</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">(QString,QString) </td>
|
|
<td class="paramname"><em>context</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>context_key</em> </td><td> is the key of the context
|
|
|
|
<tr><td></td><td valign="top"><em>context_value</em> </td><td> is the value of the context
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="addContext"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> addContext</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>context_key</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>context_value</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>context_key</em> </td><td> is the key of the context
|
|
|
|
<tr><td></td><td valign="top"><em>context_value</em> </td><td> is the value of the context
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="close"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> close</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Close the notification without activating it.
|
|
</p>
|
|
<p>
|
|
This will delete the notification.
|
|
</p></div></div><a class="anchor" name="contexts"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">[(QString,QString)] contexts</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the list of contexts, see KNotification.Context
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="deref"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> deref</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>remove a reference made with ref()
|
|
the notification may be closed when calling this.
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> ref
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="eventFilter"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">bool eventFilter</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QObject </td>
|
|
<td class="paramname"><em>watched</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QEvent </td>
|
|
<td class="paramname"><em>event</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>reimplemented for internal reasons
|
|
</p></div></div><a class="anchor" name="eventId"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QString eventId</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the name of the event
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="flags"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> flags</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the notification flags.
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="pixmap"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QPixmap pixmap</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the pixmap shown in the popup
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setPixmap
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="raiseWidget"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> raiseWidget</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Raise the widget.
|
|
This will change the desktop, activate the window, and the tab if needed.
|
|
</p></div></div><a class="anchor" name="ref"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> ref</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>The notification will automatically be closed if all presentations are finished.
|
|
if you want to show your own presentation in your application, you should use this
|
|
function, so it will not be automatically closed when there is nothing to show.
|
|
</p>
|
|
<p>
|
|
don't forgot to deref, or the notification may be never closed if there is no timeout.
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> ref
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="sendEvent"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> sendEvent</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Emit or re-emit the event.
|
|
</p></div></div><a class="anchor" name="setActions"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setActions</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QStringList </td>
|
|
<td class="paramname"><em>actions</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Set the list of actions link shown in the popup.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>actions</em> </td><td> the list of actions
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="setComponentData"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setComponentData</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a> </td>
|
|
<td class="paramname"><em>componentData</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>The componentData is used to determine the location of the config file. By default, kapp is used
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>componentData</em> </td><td> the new componentData
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="setContexts"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setContexts</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">[(QString,QString)] </td>
|
|
<td class="paramname"><em>contexts</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>set the list of contexts, see KNotification.Context
|
|
</p>
|
|
<p>
|
|
The list of contexts must be set before calling sendEvent;
|
|
</p></div></div><a class="anchor" name="setFlags"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setFlags</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
|
|
<td class="paramname"><em>flags</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Set the notification flags.
|
|
should be called before sendEvent().
|
|
</p></div></div><a class="anchor" name="setPixmap"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setPixmap</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QPixmap </td>
|
|
<td class="paramname"><em>pix</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>set the pixmap that will be shown in the popup.
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>pix</em> </td><td> the pixmap
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="setText"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setText</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>text</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Set the notification text that will appear in the popup.
|
|
</p>
|
|
<p>
|
|
The text is shown in a QLabel, you should make sure to escape any html that is needed.
|
|
You can use some of the qt basic html tags.
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>text</em> </td><td> the text
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="setTitle"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setTitle</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>title</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Set the title of the notification popup.
|
|
If no title is set, the application name will be used.
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>title</em> </td><td> the title
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="setWidget"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> setWidget</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> <em>self</em>, </td>
|
|
<td class="paramname"></td>
|
|
</tr><tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget </td>
|
|
<td class="paramname"><em>widget</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>Set the widget associated to the notification.
|
|
The notification is reparented to the new widget.
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> widget()
|
|
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>widget</em> </td><td> the new widget
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="text"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QString text</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the notification text
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setText
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="title"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QString title</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the notification title
|
|
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> setTitle
|
|
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.3
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="update"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> update</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
|
|
update the texts, the icon, and the actions of one existing notification
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="widget"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname">QWidget widget</td>
|
|
<td>(</td>
|
|
<td class="paramtype"> </td>
|
|
<td class="paramname"><em>self</em> )</td>
|
|
<td width="100%"> </td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>the widget associated to the notification
|
|
</p>
|
|
<p>
|
|
If the widget is destroyed, the notification will be automatically cancelled.
|
|
If the widget is activated, the notification will be automatically closed if the NotificationFlags specify that
|
|
</p>
|
|
<p>
|
|
When the notification is activated, the widget might be raised.
|
|
Depending on the configuration, the taskbar entry of the window containing the widget may blink.
|
|
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="beep"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"> beep</td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>reason=QString()</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget </td>
|
|
<td class="paramname"><em>widget=0</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>This is a simple substitution for QApplication.beep()
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>reason</em> </td><td> a short text explaining what has happened (may be empty)
|
|
|
|
<tr><td></td><td valign="top"><em>widget</em> </td><td> the widget the notification refers to
|
|
</td></tr>
|
|
</table></dl>
|
|
<p>
|
|
</p></div></div><a class="anchor" name="event"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdeui/KNotification.html">KNotification</a> event</td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>eventId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>text=QString()</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QPixmap </td>
|
|
<td class="paramname"><em>pixmap=QPixmap()</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget </td>
|
|
<td class="paramname"><em>widget=0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
|
|
<td class="paramname"><em>flags=KNotification.CloseOnTimeout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a> </td>
|
|
<td class="paramname"><em>componentData=KComponentData()</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>emit a standard event
|
|
</p>
|
|
<p>
|
|
|
|
</p>
|
|
<p>
|
|
This will emit a standard event
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>eventId</em> </td><td> is the name of the event
|
|
|
|
<tr><td></td><td valign="top"><em>title</em> </td><td> is title of the notification to show in the popup.
|
|
|
|
<tr><td></td><td valign="top"><em>text</em> </td><td> is the text of the notification to show in the popup
|
|
|
|
<tr><td></td><td valign="top"><em>pixmap</em> </td><td> is a picture which may be shown in the popup
|
|
|
|
<tr><td></td><td valign="top"><em>widget</em> </td><td> is a widget where the notification reports to
|
|
|
|
<tr><td></td><td valign="top"><em>flags</em> </td><td> is a bitmask of NotificationFlag
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="event"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdeui/KNotification.html">KNotification</a> event</td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a href="../kdeui/KNotification.html#StandardEvent">KNotification.StandardEvent</a> </td>
|
|
<td class="paramname"><em>eventId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>text=QString()</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QPixmap </td>
|
|
<td class="paramname"><em>pixmap=QPixmap()</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget </td>
|
|
<td class="paramname"><em>widget=0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
|
|
<td class="paramname"><em>flags=KNotification.CloseOnTimeout</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>emit a standard event
|
|
</p>
|
|
<p>
|
|
|
|
</p>
|
|
<p>
|
|
This will emit a standard event
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>eventId</em> </td><td> is the name of the event
|
|
|
|
<tr><td></td><td valign="top"><em>title</em> </td><td> is title of the notification to show in the popup.
|
|
|
|
<tr><td></td><td valign="top"><em>text</em> </td><td> is the text of the notification to show in the popup
|
|
|
|
<tr><td></td><td valign="top"><em>pixmap</em> </td><td> is a picture which may be shown in the popup
|
|
|
|
<tr><td></td><td valign="top"><em>widget</em> </td><td> is a widget where the notification reports to
|
|
|
|
<tr><td></td><td valign="top"><em>flags</em> </td><td> is a bitmask of NotificationFlag
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="event"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdeui/KNotification.html">KNotification</a> event</td>
|
|
<td>(</td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>eventId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>title</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>text</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QPixmap </td>
|
|
<td class="paramname"><em>pixmap=QPixmap()</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget </td>
|
|
<td class="paramname"><em>widget=0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
|
|
<td class="paramname"><em>flags=KNotification.CloseOnTimeout</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a> </td>
|
|
<td class="paramname"><em>componentData=KComponentData()</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>emit a standard event
|
|
</p>
|
|
<p>
|
|
|
|
</p>
|
|
<p>
|
|
This will emit a standard event
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>eventId</em> </td><td> is the name of the event
|
|
|
|
<tr><td></td><td valign="top"><em>title</em> </td><td> is title of the notification to show in the popup.
|
|
|
|
<tr><td></td><td valign="top"><em>text</em> </td><td> is the text of the notification to show in the popup
|
|
|
|
<tr><td></td><td valign="top"><em>pixmap</em> </td><td> is a picture which may be shown in the popup
|
|
|
|
<tr><td></td><td valign="top"><em>widget</em> </td><td> is a widget where the notification reports to
|
|
|
|
<tr><td></td><td valign="top"><em>flags</em> </td><td> is a bitmask of NotificationFlag
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
|
|
</dd></dl>
|
|
</p></div></div><a class="anchor" name="event"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname"><tr>
|
|
<td class="memname"><a href="../kdeui/KNotification.html">KNotification</a> event</td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a href="../kdeui/KNotification.html#StandardEvent">KNotification.StandardEvent</a> </td>
|
|
<td class="paramname"><em>eventId</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>title</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QString </td>
|
|
<td class="paramname"><em>text</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QPixmap </td>
|
|
<td class="paramname"><em>pixmap=QPixmap()</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype">QWidget </td>
|
|
<td class="paramname"><em>widget=0</em>, </td>
|
|
</tr>
|
|
<tr>
|
|
<td class="memname"></td>
|
|
<td></td>
|
|
<td class="paramtype"><a href="../kdeui/KNotification.html">KNotification.NotificationFlags</a> </td>
|
|
<td class="paramname"><em>flags=KNotification.CloseOnTimeout</em></td>
|
|
</tr>
|
|
<tr>
|
|
<td></td>
|
|
<td>)</td>
|
|
<td></td>
|
|
<td></td>
|
|
<td width="100%"> </td>
|
|
</tr></table>
|
|
</div>
|
|
<div class="memdoc"><p>emit a standard event
|
|
</p>
|
|
<p>
|
|
|
|
</p>
|
|
<p>
|
|
This will emit a standard event
|
|
</p>
|
|
<p>
|
|
</p><dl compact><dt><b>Parameters:</b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0">
|
|
<tr><td></td><td valign="top"><em>eventId</em> </td><td> is the name of the event
|
|
|
|
<tr><td></td><td valign="top"><em>title</em> </td><td> is title of the notification to show in the popup.
|
|
|
|
<tr><td></td><td valign="top"><em>text</em> </td><td> is the text of the notification to show in the popup
|
|
|
|
<tr><td></td><td valign="top"><em>pixmap</em> </td><td> is a picture which may be shown in the popup
|
|
|
|
<tr><td></td><td valign="top"><em>widget</em> </td><td> is a widget where the notification reports to
|
|
|
|
<tr><td></td><td valign="top"><em>flags</em> </td><td> is a bitmask of NotificationFlag
|
|
</td></tr> </table></dl>
|
|
<p> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
|
|
</dd></dl>
|
|
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="NotificationFlag"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr><td class="memname">NotificationFlag</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>Sometimes the user may want different notifications for the same event,
|
|
depending the source of the event. Example, you want to be notified for mails
|
|
that arrive in your folder "personal inbox" but not for those in "spam" folder
|
|
</p>
|
|
<p>
|
|
A notification context is a pair of two strings.
|
|
The first string is a key from what the context is. example "group" or
|
|
"filter" (not translated).
|
|
The second is the id of the context. In our example, the group id or the
|
|
filter id in the applications.
|
|
These strings are the ones present in the config file, and are in theory not
|
|
shown in the user interface.
|
|
</p>
|
|
<p>
|
|
The order of contexts in the list is is important, the most important context
|
|
should be placed first. They are processed in that order when the notification occurs.
|
|
</p>
|
|
<p>
|
|
<dl class="see" compact><dt><b>See also:</b></dt><dd> event
|
|
</dd></dl>
|
|
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>RaiseWidgetOnActivation</em> = 0x01</td><td><tr><td valign="top"><em>CloseOnTimeout</em> = 0x00</td><td><tr><td valign="top"><em>Persistent</em> = 0x02</td><td><tr><td valign="top"><em>CloseWhenWidgetActivated</em> = 0x04</td><td><tr><td valign="top"><em>Persistant</em> = Persistent</td><td><tr><td valign="top"><em>DefaultEvent</em> = 0xF000</td><td></table>
|
|
</dl>
|
|
</div></div><p><a class="anchor" name="StandardEvent"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr><td class="memname">StandardEvent</td>
|
|
</tr>
|
|
</table>
|
|
</div>
|
|
<div class="memdoc"><p>default events you can use in the event function
|
|
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
|
|
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Notification</em> </td><td><tr><td valign="top"><em>Warning</em> </td><td><tr><td valign="top"><em>Error</em> </td><td><tr><td valign="top"><em>Catastrophe</em> </td><td></table>
|
|
</dl>
|
|
</div></div><p>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="left">
|
|
|
|
<div class="menu_box">
|
|
<div class="nav_list">
|
|
<ul>
|
|
<li><a href="../allclasses.html">Full Index</a></li>
|
|
</ul>
|
|
</div>
|
|
|
|
<a name="cp-menu" /><div class="menutitle"><div>
|
|
<h2 id="cp-menu-project">Modules</h2>
|
|
</div></div>
|
|
<div class="nav_list">
|
|
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
|
|
<li><a href="../dnssd/index.html">dnssd</a></li>
|
|
<li><a href="../kdecore/index.html">kdecore</a></li>
|
|
<li><a href="../kdeui/index.html">kdeui</a></li>
|
|
<li><a href="../khtml/index.html">khtml</a></li>
|
|
<li><a href="../kio/index.html">kio</a></li>
|
|
<li><a href="../knewstuff/index.html">knewstuff</a></li>
|
|
<li><a href="../kparts/index.html">kparts</a></li>
|
|
<li><a href="../kutils/index.html">kutils</a></li>
|
|
<li><a href="../nepomuk/index.html">nepomuk</a></li>
|
|
<li><a href="../phonon/index.html">phonon</a></li>
|
|
<li><a href="../plasma/index.html">plasma</a></li>
|
|
<li><a href="../polkitqt/index.html">polkitqt</a></li>
|
|
<li><a href="../solid/index.html">solid</a></li>
|
|
<li><a href="../soprano/index.html">soprano</a></li>
|
|
</ul></div></div>
|
|
|
|
</div>
|
|
|
|
</div>
|
|
<div class="clearer"/>
|
|
</div>
|
|
|
|
<div id="end_body"></div>
|
|
</div>
|
|
<div id="footer"><div id="footer_text">
|
|
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
|
|
KDE<sup>®</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>®</sup> logo</a> are registered trademarks of <a href="http://ev.kde.org/" title="Homepage of the KDE non-profit Organization">KDE e.V.</a> |
|
|
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
|
|
</div></div>
|
|
</body>
|
|
</html>
|