1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<?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>KMessage</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.7 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>KMessage Namespace Reference</h1>
<code>from PyKDE4.kdecore.KMessage import *</code>
<p>
<h2>Detailed Description</h2>
<p>Display an informative message using a KMessageHandler.
</p>
<p>
This class does not define how to display a message, it is just
a clean interface for developers to use.
The job is done by the current KMessageHandler set in the class.
</p>
<p>
If no KMessageHandler is currently registered in KMessage,
the message will be outputed to stderr.
</p>
<p>
Use KMessage.setMessageHandler() to use a KMessageHandler.
</p>
<p>
<pre class="fragment">
KMessage.setMessageHandler( new KMessageBoxHandler(this) );
// some operation
KMessage.message( KMessage.Error, i18n("Could not load service. Use kbuildsycoca to fix the service database."), i18n("KService") );
</pre>
</p>
<p>
Some KMessageHandler are already done such as KMessageBoxMessageHandler and KPassivePopupMessageHandler.
<dl class="author" compact><dt><b>Author:</b></dt><dd> Michaël Larouche <michael.larouche@kdemail.net> </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="#MessageType">MessageType</a> </td><td class="memItemRight" valign="bottom">{ Error, Information, Warning, Sorry, Fatal }</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#message">message</a> (<a href="../kdecore/KMessage.html#MessageType">KMessage.MessageType</a> messageType, QString text, QString caption=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMessageHandler">setMessageHandler</a> (<a href="../kdecore/KMessageHandler.html">KMessageHandler</a> handler)</td></tr>
</table>
<hr><h2>Enumeration Documentation</h2><a class="anchor" name="MessageType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">MessageType</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Error</em> </td><td><tr><td valign="top"><em>Information</em> </td><td><tr><td valign="top"><em>Warning</em> </td><td><tr><td valign="top"><em>Sorry</em> </td><td><tr><td valign="top"><em>Fatal</em> </td><td></table>
</dl>
</div></div><p><hr><h2>Function Documentation</h2><a class="anchor" name="message"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> message</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KMessage.html#MessageType">KMessage.MessageType</a> </td>
<td class="paramname"><em>messageType</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">QString </td>
<td class="paramname"><em>caption=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Display a long message of a certain type.
A long message span on multiple lines and can have a caption.
</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>messageType</em> </td><td> Currrent type of message. See MessageType enum.
<tr><td></td><td valign="top"><em>text</em> </td><td> Long message to be displayed.
<tr><td></td><td valign="top"><em>caption</em> </td><td> Caption to be used. This is optional.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setMessageHandler"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setMessageHandler</td>
<td>(</td>
<td class="paramtype"><a href="../kdecore/KMessageHandler.html">KMessageHandler</a> </td>
<td class="paramname"><em>handler</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 current KMessageHandler
Note that this method takes ownership of the KMessageHandler.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>handler</em> </td><td> Instance of a real KMessageHandler.
</td></tr>
</table></dl>
<p> <dl class="warning" compact><dt><b>Warning:</b></dt><dd> This function isn't thread-safe. You don't want to
change the message handler during the program's
execution anyways. Do so <b>only</b> at start-up.
</dd></dl>
</p></div></div>
</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>
|
