cryptonas-branches/pythonrewrite/bin2/doc/mnt/phobos/age/svn/cryptobox/branches/pythonrewrite/bin2/doc/CryptoBox/CryptoBoxProps.html
2006-08-16 11:07:57 +00:00

318 lines
8.2 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html40/loose.dtd">
<html>
<head>
<title>Class: CryptoBoxProps</title>
</head>
<body bgcolor="#ffffff">
<p><i><a href="../../../../../../../../../../index.html">Table of Contents</a></i></p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th rowspan="2"
valign="top"
align="left"
width="10%"
bgcolor="#88bbee"><font color="#000000">Class: CryptoBoxProps</font>
</th>
<th bgcolor="#88bbee"
width="90%"
align="right"><font color="#000000">CryptoBox.py</font>
</th>
</tr>
<tr>
<td>
<h3>Get and set the properties of a CryptoBox</h3>
<p> This class returns the available <u>and</u> allowed devices, which will
be used further.</p>
<table border="0" cellpadding="5" cellspacing="0" width="100%">
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="Methods">Methods</a>&nbsp;
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">&nbsp;</font>
</th>
</tr>
<tr>
<td>
<a href="#__allAvailablePartitions">__allAvailablePartitions</a><br>
<a href="#__csv2list">__csv2list</a><br>
<a href="#__deviceIsReallyAllowed">__deviceIsReallyAllowed</a><br>
<a href="#__init__">__init__</a><br>
<a href="#debugMessage">debugMessage</a><br>
<a href="#getConfigValue">getConfigValue</a><br>
<a href="#getContainerList">getContainerList</a><br>
<a href="#setConfigValue">setConfigValue</a><br>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="__allAvailablePartitions"></a>&nbsp;
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">__allAvailablePartitions&nbsp;</font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
__allAvailablePartitions ( self )
</pre></font>
<h3>retrieve a list of all available containers</h3>
<p> TODO: if the code is not like a poem, write prosadocumentation ;)</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="__csv2list"></a>&nbsp;
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">__csv2list&nbsp;</font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
__csv2list ( self, csvstring )
</pre></font>
<p>transform a csv preferences string into a list</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="__deviceIsReallyAllowed"></a>&nbsp;
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">__deviceIsReallyAllowed&nbsp;</font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
__deviceIsReallyAllowed ( self, device )
</pre></font>
<p>return &quot;true&quot; if the given device is white-listed for being used as cryptobox container</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="__init__"></a>&nbsp;
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">__init__&nbsp;</font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
__init__ ( self )
</pre></font>
<p>read config and fill class variables</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="debugMessage"></a>&nbsp;
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">debugMessage&nbsp;</font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
debugMessage (
self,
level,
text,
)
</pre></font>
<p>print a debug message to the previously choosen debugging facility</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="getConfigValue"></a>&nbsp;
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">getConfigValue&nbsp;</font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
getConfigValue ( self, key )
</pre></font>
<p>return a tuple of key+value from the configfile</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="getContainerList"></a>&nbsp;
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">getContainerList&nbsp;</font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
getContainerList ( self )
</pre></font>
<p>return a list of all actual available containers of this cryptobox</p>
<tr>
<th bgcolor="#99ccff"
rowspan="2"
valign="top"
align="left"
width="20%"
>
<font color="#000000">
<a name="setConfigValue"></a>&nbsp;
</font>
</th>
<th bgcolor="#99ccff"
valign="top"
align="left"
width="80%"
>
<font color="#000000">setConfigValue&nbsp;</font>
</th>
</tr>
<tr>
<td>
<font color="#000088"><pre>
setConfigValue (
self,
key,
value,
)
</pre></font>
<p>save the strings key+value in configfile</p>
</td></tr>
</td></tr>
</table>
</td>
</tr>
</table>
<hr>
<p><i><a href="../../../../../../../../../../index.html">Table of Contents</a></i></p>
<font size="-2"><i>This document was automatically generated
on Wed Aug 16 13:00:54 2006 by
<a href="http://happydoc.sourceforge.net">HappyDoc</a> version
2.1</i></font>
</body>
</html>