File: Solid.DeviceInterface.html

package info (click to toggle)
pykde4 4%3A4.14.0-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie, jessie-kfreebsd
  • size: 30,864 kB
  • ctags: 18,431
  • sloc: python: 2,063; cpp: 327; makefile: 52; sh: 5
file content (237 lines) | stat: -rw-r--r-- 10,630 bytes parent folder | download | duplicates (2)
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
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
<?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.DeviceInterface</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">&nbsp;</div>

<h1>DeviceInterface Class Reference</h1>
<code>from PyKDE4.solid import *</code>
<p>
Inherits: QObject<br />
Subclasses: <a href="../solid/Solid.AcAdapter.html">Solid.AcAdapter</a>, <a href="../solid/Solid.AudioInterface.html">Solid.AudioInterface</a>, <a href="../solid/Solid.Battery.html">Solid.Battery</a>, <a href="../solid/Solid.Block.html">Solid.Block</a>, <a href="../solid/Solid.Button.html">Solid.Button</a>, <a href="../solid/Solid.Camera.html">Solid.Camera</a>, <a href="../solid/Solid.DvbInterface.html">Solid.DvbInterface</a>, <a href="../solid/Solid.GenericInterface.html">Solid.GenericInterface</a>, <a href="../solid/Solid.InternetGateway.html">Solid.InternetGateway</a>, <a href="../solid/Solid.NetworkInterface.html">Solid.NetworkInterface</a>, <a href="../solid/Solid.NetworkShare.html">Solid.NetworkShare</a>, <a href="../solid/Solid.PortableMediaPlayer.html">Solid.PortableMediaPlayer</a>, <a href="../solid/Solid.Processor.html">Solid.Processor</a>, <a href="../solid/Solid.SerialInterface.html">Solid.SerialInterface</a>, <a href="../solid/Solid.SmartCardReader.html">Solid.SmartCardReader</a>, <a href="../solid/Solid.StorageAccess.html">Solid.StorageAccess</a>, <a href="../solid/Solid.StorageDrive.html">Solid.StorageDrive</a>, <a href="../solid/Solid.StorageVolume.html">Solid.StorageVolume</a>, <a href="../solid/Solid.Video.html">Solid.Video</a><br />
Namespace: <a href="../solid/Solid.html">Solid</a><br />
<h2>Detailed Description</h2>

<p>Base class of all the device interfaces.
</p>
<p>
A device interface describes what a device can do. A device generally has
a set of device interfaces.
</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="#Type">Type</a>&nbsp;</td><td class="memItemRight" valign="bottom">{&nbsp;Unknown, GenericInterface, Processor, Block, StorageAccess, StorageDrive, OpticalDrive, StorageVolume, OpticalDisc, Camera, PortableMediaPlayer, NetworkInterface, AcAdapter, Battery, Button, AudioInterface, DvbInterface, Video, SerialInterface, SmartCardReader, InternetGateway, NetworkShare, Last&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="#DeviceInterface">__init__</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="#isValid">isValid</a> (self)</td></tr>
<tr><td colspan="2"><br><h2>Static Methods</h2></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="#stringToType">stringToType</a> (QString type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#typeDescription">typeDescription</a> (<a href="../solid/Solid.DeviceInterface.html#Type">Solid.DeviceInterface.Type</a> type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">QString&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#typeToString">typeToString</a> (<a href="../solid/Solid.DeviceInterface.html#Type">Solid.DeviceInterface.Type</a> type)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="DeviceInterface"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</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"></div></div><a class="anchor" name="isValid"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isValid</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 this device interface is valid.
A device interface is considered valid if the device it is referring is available in the system.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if this device interface's device is available, false otherwise
</dd></dl>
</p></div></div><hr><h2>Static Method Documentation</h2><a class="anchor" name="stringToType"></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> stringToType</td>
<td>(</td>
<td class="paramtype">QString&nbsp;</td>
<td class="paramname"><em>type</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the device interface type for the given class name
</dd></dl>
</p></div></div><a class="anchor" name="typeDescription"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString typeDescription</td>
<td>(</td>
<td class="paramtype"><a href="../solid/Solid.DeviceInterface.html#Type">Solid.DeviceInterface.Type</a>&nbsp;</td>
<td class="paramname"><em>type</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> a description suitable to display in the UI of the device interface type
</dd></dl> <dl class="since" compact><dt><b>Since:</b></dt><dd> 4.4
</dd></dl>
</p></div></div><a class="anchor" name="typeToString"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">QString typeToString</td>
<td>(</td>
<td class="paramtype"><a href="../solid/Solid.DeviceInterface.html#Type">Solid.DeviceInterface.Type</a>&nbsp;</td>
<td class="paramname"><em>type</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p><dl class="return" compact><dt><b>Returns:</b></dt><dd> the class name of the device interface type
</dd></dl>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="Type"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">Type</td>
</tr>
</table>
</div>
<div class="memdoc"><p>This enum type defines the type of device interface that a Device can have.
</p>
<p>
- Unknown : An undetermined device interface
- Processor : A processor
- Block : A block device
- StorageAccess : A mechanism to access data on a storage device
- StorageDrive : A storage drive
- OpticalDrive : An optical drive (CD-ROM, DVD, ...)
- StorageVolume : A volume
- OpticalDisc : An optical disc
- Camera : A digital camera
- PortableMediaPlayer: A portable media player
- NetworkInterface: A network interface
- SerialInterface: A serial interface
- SmartCardReader: A smart card reader interface
- NetworkShare: A network share interface
</p><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>PropertyCheck</em>&nbsp;</td><td><tr><td valign="top"><em>Conjunction</em>&nbsp;</td><td><tr><td valign="top"><em>Disjunction</em>&nbsp;</td><td><tr><td valign="top"><em>InterfaceCheck</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>