Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > b77dda48f87d4eda8cc559e40c49a652 > files > 1123

python-kde4-doc-4.4.5-0.2mdv2010.2.i586.rpm

<?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>Solid.OpticalDisc</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.4 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">&nbsp;</div>

<h1>OpticalDisc Class Reference</h1>
<code>from PyKDE4.solid import *</code>
<p>
Inherits: Solid.StorageVolume &#x2192; Solid.DeviceInterface &#x2192; <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><br />

Namespace: Solid.OpticalDisc<br />
<h2>Detailed Description</h2>

<p>This device interface is available on optical discs.
</p>
<p>
An optical disc is a volume that can be inserted in CD-R*,DVD*,Blu-Ray,HD-DVD drives.
</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="#ContentType">ContentType</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;Audio, Data, VideoCd, SuperVideoCd, VideoDvd&nbsp;}</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="#DiscType">DiscType</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;UnknownDiscType, CdRom, CdRecordable, CdRewritable, DvdRom, DvdRam, DvdRecordable, DvdRewritable, DvdPlusRecordable, DvdPlusRewritable, DvdPlusRecordableDuallayer, DvdPlusRewritableDuallayer, BluRayRom, BluRayRecordable, BluRayRewritable, HdDvdRom, HdDvdRecordable, HdDvdRewritable&nbsp;}</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#OpticalDisc">__init__</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> backendObject)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../solid/Solid.OpticalDisc.ContentTypes.html">Solid.OpticalDisc.ContentTypes</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#availableContent">availableContent</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">long&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#capacity">capacity</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../solid/Solid.DeviceInterface.html#Type">Solid.DeviceInterface.Type</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#deviceInterfaceType">deviceInterfaceType</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../solid/Solid.OpticalDisc.html#DiscType">Solid.OpticalDisc.DiscType</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#discType">discType</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#isAppendable">isAppendable</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#isBlank">isBlank</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#isRewritable">isRewritable</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="OpticalDisc"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a>&nbsp;</td>
<td class="paramname"><em>backendObject</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Creates a new OpticalDisc object.
You generally won't need this. It's created when necessary using
Device.as().
</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>backendObject</em>&nbsp;</td><td> the device interface object provided by the backend
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> Solid.Device.as()
</dd></dl>
</p></div></div><a class="anchor" name="availableContent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../solid/Solid.OpticalDisc.ContentTypes.html">Solid.OpticalDisc.ContentTypes</a> availableContent</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Retrieves the content types this disc contains (audio, video,
data...).
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the flag set indicating the available contents
</dd></dl>
</p></div></div><a class="anchor" name="capacity"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">long capacity</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Retrieves the disc capacity (that is the maximum size of a
volume could have on this disc).
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the capacity of the disc in bytes
</dd></dl>
</p></div></div><a class="anchor" name="deviceInterfaceType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../solid/Solid.DeviceInterface.html#Type">Solid.DeviceInterface.Type</a> deviceInterfaceType</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Get the Solid.DeviceInterface.Type of the OpticalDisc device interface.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the OpticalDisc device interface type
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> Solid.Ifaces.Enums.DeviceInterface.Type
</dd></dl>
</p></div></div><a class="anchor" name="discType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../solid/Solid.OpticalDisc.html#DiscType">Solid.OpticalDisc.DiscType</a> discType</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Retrieves the disc type (cdr, cdrw...).
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the disc type
</dd></dl>
</p></div></div><a class="anchor" name="isAppendable"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isAppendable</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Indicates if it's possible to write additional data to the disc.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the disc is appendable, false otherwise
</dd></dl>
</p></div></div><a class="anchor" name="isBlank"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isBlank</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Indicates if the disc is blank.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the disc is blank, false otherwise
</dd></dl>
</p></div></div><a class="anchor" name="isRewritable"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isRewritable</td>
<td>(</td>
<td class="paramtype">&nbsp;</td>
<td class="paramname"><em>self</em>&nbsp;)</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Indicates if the disc is rewritable.
</p>
<p>
A disc is rewritable if you can write on it several times.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the disc is rewritable, false otherwise
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="ContentType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">ContentType</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum type defines the type of content available in an optical disc.
</p>
<p>
- Audio : A disc containing audio
- Data : A disc containing data
- VideoCd : A Video Compact Disc (VCD)
- SuperVideoCd : A Super Video Compact Disc (SVCD)
- VideoDvd : A Video Digital Versatile Disc (DVD-Video)
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>Audio</em>&nbsp;=&nbsp;0x01</td><td><tr><td valign="top"><em>Data</em>&nbsp;=&nbsp;0x02</td><td><tr><td valign="top"><em>VideoCd</em>&nbsp;=&nbsp;0x04</td><td><tr><td valign="top"><em>SuperVideoCd</em>&nbsp;=&nbsp;0x08</td><td><tr><td valign="top"><em>VideoDvd</em>&nbsp;=&nbsp;0x10</td><td></table>
</dl>
</div></div><p><a class="anchor" name="DiscType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">DiscType</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum type defines the type of optical disc it can be.
</p>
<p>
- UnknownDiscType : An undetermined disc type
- CdRom : A Compact Disc Read-Only Memory (CD-ROM)
- CdRecordable : A Compact Disc Recordable (CD-R)
- CdRewritable : A Compact Disc ReWritable (CD-RW)
- DvdRom : A Digital Versatile Disc Read-Only Memory (DVD-ROM)
- DvdRam : A Digital Versatile Disc Random Access Memory (DVD-RAM)
- DvdRecordable : A Digital Versatile Disc Recordable (DVD-R)
- DvdRewritable : A Digital Versatile Disc ReWritable (DVD-RW)
- DvdPlusRecordable : A Digital Versatile Disc Recordable (DVD+R)
- DvdPlusRewritable : A Digital Versatile Disc ReWritable (DVD+RW)
- DvdPlusRecordableDuallayer : A Digital Versatile Disc Recordable Dual-Layer (DVD+R DL)
- DvdPlusRewritableDuallayer : A Digital Versatile Disc ReWritable Dual-Layer (DVD+RW DL)
- BluRayRom : A Blu-ray Disc (BD)
- BluRayRecordable : A Blu-ray Disc Recordable (BD-R)
- BluRayRewritable : A Blu-ray Disc (BD-RE)
- HdDvdRom: A High Density Digital Versatile Disc (HD DVD)
- HdDvdRecordable : A High Density Digital Versatile Disc Recordable (HD DVD-R)
- HdDvdRewritable : A High Density Digital Versatile Disc ReWritable (HD DVD-RW)
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>UnknownDiscType</em>&nbsp;=&nbsp;-1</td><td><tr><td valign="top"><em>CdRom</em>&nbsp;</td><td><tr><td valign="top"><em>CdRecordable</em>&nbsp;</td><td><tr><td valign="top"><em>CdRewritable</em>&nbsp;</td><td><tr><td valign="top"><em>DvdRom</em>&nbsp;</td><td><tr><td valign="top"><em>DvdRam</em>&nbsp;</td><td><tr><td valign="top"><em>DvdRecordable</em>&nbsp;</td><td><tr><td valign="top"><em>DvdRewritable</em>&nbsp;</td><td><tr><td valign="top"><em>DvdPlusRecordable</em>&nbsp;</td><td><tr><td valign="top"><em>DvdPlusRewritable</em>&nbsp;</td><td><tr><td valign="top"><em>DvdPlusRecordableDuallayer</em>&nbsp;</td><td><tr><td valign="top"><em>DvdPlusRewritableDuallayer</em>&nbsp;</td><td><tr><td valign="top"><em>BluRayRom</em>&nbsp;</td><td><tr><td valign="top"><em>BluRayRecordable</em>&nbsp;</td><td><tr><td valign="top"><em>BluRayRewritable</em>&nbsp;</td><td><tr><td valign="top"><em>HdDvdRom</em>&nbsp;</td><td><tr><td valign="top"><em>HdDvdRecordable</em>&nbsp;</td><td><tr><td valign="top"><em>HdDvdRewritable</em>&nbsp;</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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</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>