1
<?xml version="1.0" encoding="UTF-8"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
6
<title>DOM.MediaList</title>
7
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8
<meta http-equiv="Content-Style-Type" content="text/css" />
9
<link rel="stylesheet" type="text/css" href="../common/doxygen.css" />
10
<link rel="stylesheet" media="screen" type="text/css" title="KDE Colors" href="../common/kde.css" />
18
<img alt ="" src="../common/top-kde.jpg"/>
19
KDE 4.7 PyKDE API Reference
23
<div id="header_bottom">
26
<li>KDE's Python API</li>
32
<li><a href="../modules.html">Overview</a></li>
33
<li><a href="http://techbase.kde.org/Development/Languages/Python">PyKDE Home</a></li>
34
<li><a href="http://kde.org/family/">Sitemap</a></li>
35
<li><a href="http://kde.org/contact/">Contact Us</a></li>
41
<div id="body_wrapper">
46
<div class="clearer"> </div>
48
<h1>MediaList Class Reference</h1>
49
<code>from PyKDE4.khtml import *</code>
53
Namespace: <a href="../khtml/DOM.html">DOM</a><br />
54
<h2>Detailed Description</h2>
56
<p>The MediaList interface provides the abstraction of
57
an ordered collection of media, without defining or constraining
58
how this collection is implemented. All media are lowercase
61
<table border="0" cellpadding="0" cellspacing="0"><tr><td colspan="2"><br><h2>Methods</h2></td></tr>
62
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#MediaList">__init__</a> (self)</td></tr>
63
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#MediaList">__init__</a> (self, <a href="../khtml/DOM.MediaList.html">DOM.MediaList</a> other)</td></tr>
64
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#appendMedium">appendMedium</a> (self, <a href="../khtml/DOM.DOMString.html">DOM.DOMString</a> newMedium)</td></tr>
65
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#deleteMedium">deleteMedium</a> (self, <a href="../khtml/DOM.DOMString.html">DOM.DOMString</a> oldMedium)</td></tr>
66
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isNull">isNull</a> (self)</td></tr>
67
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.DOMString.html">DOM.DOMString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#item">item</a> (self, long index)</td></tr>
68
<tr><td class="memItemLeft" nowrap align="right" valign="top">long </td><td class="memItemRight" valign="bottom"><a class="el" href="#length">length</a> (self)</td></tr>
69
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../khtml/DOM.DOMString.html">DOM.DOMString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mediaText">mediaText</a> (self)</td></tr>
70
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMediaText">setMediaText</a> (self, <a href="../khtml/DOM.DOMString.html">DOM.DOMString</a> value)</td></tr>
72
<hr><h2>Method Documentation</h2><a class="anchor" name="MediaList"></a>
74
<div class="memproto">
75
<table class="memname"><tr>
76
<td class="memname">__init__</td>
78
<td class="paramtype"> </td>
79
<td class="paramname"><em>self</em> )</td>
80
<td width="100%"> </td>
84
<div class="memdoc"></div></div><a class="anchor" name="MediaList"></a>
86
<div class="memproto">
87
<table class="memname"><tr>
88
<td class="memname">__init__</td>
90
<td class="paramtype"> <em>self</em>, </td>
91
<td class="paramname"></td>
93
<td class="memname"></td>
95
<td class="paramtype"><a href="../khtml/DOM.MediaList.html">DOM.MediaList</a> </td>
96
<td class="paramname"><em>other</em></td>
103
<td width="100%"> </td>
106
<div class="memdoc"></div></div><a class="anchor" name="appendMedium"></a>
107
<div class="memitem">
108
<div class="memproto">
109
<table class="memname"><tr>
110
<td class="memname"> appendMedium</td>
112
<td class="paramtype"> <em>self</em>, </td>
113
<td class="paramname"></td>
115
<td class="memname"></td>
117
<td class="paramtype"><a href="../khtml/DOM.DOMString.html">DOM.DOMString</a> </td>
118
<td class="paramname"><em>newMedium</em></td>
125
<td width="100%"> </td>
128
<div class="memdoc"><p>Adds the medium newMedium to the end of the list. If the newMedium is
129
already used, it is first removed.
132
</p><dl compact><dt><b>Parameters:</b></dt><dd>
133
<table border="0" cellspacing="2" cellpadding="0">
134
<tr><td></td><td valign="top"><em>newMedium</em> </td><td> The new medium to add.
138
INVALID_CHARACTER_ERR: If the medium contains characters that are
139
invalid in the underlying style language.
142
NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly.
143
</p></div></div><a class="anchor" name="deleteMedium"></a>
144
<div class="memitem">
145
<div class="memproto">
146
<table class="memname"><tr>
147
<td class="memname"> deleteMedium</td>
149
<td class="paramtype"> <em>self</em>, </td>
150
<td class="paramname"></td>
152
<td class="memname"></td>
154
<td class="paramtype"><a href="../khtml/DOM.DOMString.html">DOM.DOMString</a> </td>
155
<td class="paramname"><em>oldMedium</em></td>
162
<td width="100%"> </td>
165
<div class="memdoc"><p>Deletes the medium indicated by oldMedium from the list.
168
</p><dl compact><dt><b>Parameters:</b></dt><dd>
169
<table border="0" cellspacing="2" cellpadding="0">
170
<tr><td></td><td valign="top"><em>oldMedium</em> </td><td> The medium to delete in the media list.
174
NO_MODIFICATION_ALLOWED_ERR: Raised if this list is readonly.
177
NOT_FOUND_ERR: Raised if oldMedium is not in the list.
178
</p></div></div><a class="anchor" name="isNull"></a>
179
<div class="memitem">
180
<div class="memproto">
181
<table class="memname"><tr>
182
<td class="memname">bool isNull</td>
184
<td class="paramtype"> </td>
185
<td class="paramname"><em>self</em> )</td>
186
<td width="100%"> </td>
190
<div class="memdoc"></div></div><a class="anchor" name="item"></a>
191
<div class="memitem">
192
<div class="memproto">
193
<table class="memname"><tr>
194
<td class="memname"><a href="../khtml/DOM.DOMString.html">DOM.DOMString</a> item</td>
196
<td class="paramtype"> <em>self</em>, </td>
197
<td class="paramname"></td>
199
<td class="memname"></td>
201
<td class="paramtype">long </td>
202
<td class="paramname"><em>index</em></td>
209
<td width="100%"> </td>
212
<div class="memdoc"><p>Returns the indexth in the list. If index is greater than or equal to
213
the number of media in the list, this returns null.
216
</p><dl compact><dt><b>Parameters:</b></dt><dd>
217
<table border="0" cellspacing="2" cellpadding="0">
218
<tr><td></td><td valign="top"><em>index</em> </td><td> Index into the collection.
221
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> The medium at the indexth position in the MediaList, or null if
222
that is not a valid index.
224
</p></div></div><a class="anchor" name="length"></a>
225
<div class="memitem">
226
<div class="memproto">
227
<table class="memname"><tr>
228
<td class="memname">long length</td>
230
<td class="paramtype"> </td>
231
<td class="paramname"><em>self</em> )</td>
232
<td width="100%"> </td>
236
<div class="memdoc"><p>The number of media in the list. The range of valid media is 0 to length-1 inclusive.
237
</p></div></div><a class="anchor" name="mediaText"></a>
238
<div class="memitem">
239
<div class="memproto">
240
<table class="memname"><tr>
241
<td class="memname"><a href="../khtml/DOM.DOMString.html">DOM.DOMString</a> mediaText</td>
243
<td class="paramtype"> </td>
244
<td class="paramname"><em>self</em> )</td>
245
<td width="100%"> </td>
249
<div class="memdoc"><p>The parsable textual representation of the media list. This is a
250
comma-separated list of media.
254
SYNTAX_ERR: Raised if the specified string value has a syntax error and
258
NO_MODIFICATION_ALLOWED_ERR: Raised if this media list is readonly.
259
</p></div></div><a class="anchor" name="setMediaText"></a>
260
<div class="memitem">
261
<div class="memproto">
262
<table class="memname"><tr>
263
<td class="memname"> setMediaText</td>
265
<td class="paramtype"> <em>self</em>, </td>
266
<td class="paramname"></td>
268
<td class="memname"></td>
270
<td class="paramtype"><a href="../khtml/DOM.DOMString.html">DOM.DOMString</a> </td>
271
<td class="paramname"><em>value</em></td>
278
<td width="100%"> </td>
281
<div class="memdoc"><p>see mediaText
289
<div class="menu_box">
290
<div class="nav_list">
292
<li><a href="../allclasses.html">Full Index</a></li>
296
<a name="cp-menu" /><div class="menutitle"><div>
297
<h2 id="cp-menu-project">Modules</h2>
299
<div class="nav_list">
300
<ul><li><a href="../akonadi/index.html">akonadi</a></li>
301
<li><a href="../dnssd/index.html">dnssd</a></li>
302
<li><a href="../kdecore/index.html">kdecore</a></li>
303
<li><a href="../kdeui/index.html">kdeui</a></li>
304
<li><a href="../khtml/index.html">khtml</a></li>
305
<li><a href="../kio/index.html">kio</a></li>
306
<li><a href="../knewstuff/index.html">knewstuff</a></li>
307
<li><a href="../kparts/index.html">kparts</a></li>
308
<li><a href="../kutils/index.html">kutils</a></li>
309
<li><a href="../nepomuk/index.html">nepomuk</a></li>
310
<li><a href="../phonon/index.html">phonon</a></li>
311
<li><a href="../plasma/index.html">plasma</a></li>
312
<li><a href="../polkitqt/index.html">polkitqt</a></li>
313
<li><a href="../solid/index.html">solid</a></li>
314
<li><a href="../soprano/index.html">soprano</a></li>
320
<div class="clearer"/>
323
<div id="end_body"></div>
325
<div id="footer"><div id="footer_text">
326
This documentation is maintained by <a href="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
327
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> |
328
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
added
removed
docs/html/khtml/DOM.MediaList.html
