You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
pytde/doc/classref/kio/KArchive.html

289 lines
16 KiB

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN
"http://www.w3.org/TR/html4/loose.dtd"">
<html>
<head>
<title>class KArchive</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
<meta name="GENERATOR" content="wabbit dumphtml">
</head>
<body>
<h4>PyKDE - Python Bindings for KDE</h4>
<hr>
<table width="100%"><tr>
<td width ="70%">
<h1>class KArchive</h1><hr>
</td>
<td width="30%" valign="top" align="right">
<table>
<tr><td align="right"><a href="doc/index.html">Table of contents</a></td></tr>
<tr><td align="right"><a href="../index.html">Modules</a></td></tr>
<tr><td align="right"><a href="index.html">kio Classes</a></td></tr>
<tr><td align="right"><a href="../allclasses.html">All Classes</a></td></tr>
</table>
</td>
</tr></table>
<table>
<tr><td width="10%" align=left>Module</td>
<td width="30%" align=left>kio</td>
</tr>
<tr><td>Class</td>
<td>KArchive <a href = "sip/glossary.html#abstract">(<i>abstract</i>)</a></td>
</tr>
<tr><td>Inherits</td>
<td> </td>
</tr>
</table>
<h3>methods</h3><ul>
<li><b>KArchive</b> (dev)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>a KArchive instance</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>dev</td><td>TQIODevice</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addLocalDirectory</b> (path, destName)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>path</td><td>TQString</td><td></td></tr>
<tr><td>destName</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>addLocalFile</b> (fileName, destName)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>fileName</td><td>TQString</td><td></td></tr>
<tr><td>destName</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>close</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>closeArchive</b> () = 0
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td><a href = "../glossary.html#purevirtual"><i>pure virtual</i></a></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>closeSucceeded</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.5.0 and above only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>device</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(TQIODevice)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>directory</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KArchiveDirectory)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>doneWriting</b> (size) = 0
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td><a href = "../glossary.html#purevirtual"><i>pure virtual</i></a></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>size</td><td>uint</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>findOrCreate</b> (path)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KArchiveDirectory)</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>path</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>isOpened</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>mode</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(int)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>open</b> (mode)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>mode</td><td>int</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>openArchive</b> (mode) = 0
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td><a href = "../glossary.html#purevirtual"><i>pure virtual</i></a></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>mode</td><td>int</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>prepareWriting</b> (name, user, group, size) = 0
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td><a href = "../glossary.html#purevirtual"><i>pure virtual</i></a></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>TQString</td><td></td></tr>
<tr><td>user</td><td>TQString</td><td></td></tr>
<tr><td>group</td><td>TQString</td><td></td></tr>
<tr><td>size</td><td>uint</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>prepareWriting</b> (name, user, group, size, perm, atime, mtime, ctime)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>TQString</td><td></td></tr>
<tr><td>user</td><td>TQString</td><td></td></tr>
<tr><td>group</td><td>TQString</td><td></td></tr>
<tr><td>size</td><td>uint</td><td></td></tr>
<tr><td>perm</td><td>mode_t</td><td></td></tr>
<tr><td>atime</td><td>time_t</td><td></td></tr>
<tr><td>mtime</td><td>time_t</td><td></td></tr>
<tr><td>ctime</td><td>time_t</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>prepareWriting_impl</b> (name, user, group, size, perm, atime, mtime, ctime)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>TQString</td><td></td></tr>
<tr><td>user</td><td>TQString</td><td></td></tr>
<tr><td>group</td><td>TQString</td><td></td></tr>
<tr><td>size</td><td>uint</td><td></td></tr>
<tr><td>perm</td><td>mode_t</td><td></td></tr>
<tr><td>atime</td><td>time_t</td><td></td></tr>
<tr><td>mtime</td><td>time_t</td><td></td></tr>
<tr><td>ctime</td><td>time_t</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>rootDir</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(KArchiveDirectory)</i></td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setDevice</b> (dev)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>dev</td><td>TQIODevice</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>setRootDir</b> (rootDir)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>rootDir</td><td>KArchiveDirectory</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>writeData</b> (data, size)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>data</td><td>char</td><td></td></tr>
<tr><td>size</td><td>uint</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>writeData_impl</b> (data, size)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>data</td><td>char</td><td></td></tr>
<tr><td>size</td><td>uint</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>writeDir</b> (name, user, group) = 0
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td><a href = "../glossary.html#purevirtual"><i>pure virtual</i></a></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>TQString</td><td></td></tr>
<tr><td>user</td><td>TQString</td><td></td></tr>
<tr><td>group</td><td>TQString</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>writeDir</b> (name, user, group, perm, atime, mtime, ctime)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>TQString</td><td></td></tr>
<tr><td>user</td><td>TQString</td><td></td></tr>
<tr><td>group</td><td>TQString</td><td></td></tr>
<tr><td>perm</td><td>mode_t</td><td></td></tr>
<tr><td>atime</td><td>time_t</td><td></td></tr>
<tr><td>mtime</td><td>time_t</td><td></td></tr>
<tr><td>ctime</td><td>time_t</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>writeDir_impl</b> (name, user, group, perm, atime, mtime, ctime)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>TQString</td><td></td></tr>
<tr><td>user</td><td>TQString</td><td></td></tr>
<tr><td>group</td><td>TQString</td><td></td></tr>
<tr><td>perm</td><td>mode_t</td><td></td></tr>
<tr><td>atime</td><td>time_t</td><td></td></tr>
<tr><td>mtime</td><td>time_t</td><td></td></tr>
<tr><td>ctime</td><td>time_t</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>writeFile</b> (name, user, group, size, data)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>TQString</td><td></td></tr>
<tr><td>user</td><td>TQString</td><td></td></tr>
<tr><td>group</td><td>TQString</td><td></td></tr>
<tr><td>size</td><td>uint</td><td></td></tr>
<tr><td>data</td><td>char</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>writeFile</b> (name, user, group, size, perm, atime, mtime, ctime, data)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>TQString</td><td></td></tr>
<tr><td>user</td><td>TQString</td><td></td></tr>
<tr><td>group</td><td>TQString</td><td></td></tr>
<tr><td>size</td><td>uint</td><td></td></tr>
<tr><td>perm</td><td>mode_t</td><td></td></tr>
<tr><td>atime</td><td>time_t</td><td></td></tr>
<tr><td>mtime</td><td>time_t</td><td></td></tr>
<tr><td>ctime</td><td>time_t</td><td></td></tr>
<tr><td>data</td><td>char</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>writeFile_impl</b> (name, user, group, size, perm, atime, mtime, ctime, data)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>TQString</td><td></td></tr>
<tr><td>user</td><td>TQString</td><td></td></tr>
<tr><td>group</td><td>TQString</td><td></td></tr>
<tr><td>size</td><td>uint</td><td></td></tr>
<tr><td>perm</td><td>mode_t</td><td></td></tr>
<tr><td>atime</td><td>time_t</td><td></td></tr>
<tr><td>mtime</td><td>time_t</td><td></td></tr>
<tr><td>ctime</td><td>time_t</td><td></td></tr>
<tr><td>data</td><td>char</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>writeSymLink</b> (name, target, user, group, perm, atime, mtime, ctime)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>TQString</td><td></td></tr>
<tr><td>target</td><td>TQString</td><td></td></tr>
<tr><td>user</td><td>TQString</td><td></td></tr>
<tr><td>group</td><td>TQString</td><td></td></tr>
<tr><td>perm</td><td>mode_t</td><td></td></tr>
<tr><td>atime</td><td>time_t</td><td></td></tr>
<tr><td>mtime</td><td>time_t</td><td></td></tr>
<tr><td>ctime</td><td>time_t</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>writeSymLink_impl</b> (name, target, user, group, perm, atime, mtime, ctime)
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>(bool)</i></td></tr>
<tr><td>In versions KDE 3.2.0 and above only</td></tr>
</table><table><tr bgcolor="#fff0ff"><th>Argument</th><th>Type</th><th>Default</th></tr>
<tr><td>name</td><td>TQString</td><td></td></tr>
<tr><td>target</td><td>TQString</td><td></td></tr>
<tr><td>user</td><td>TQString</td><td></td></tr>
<tr><td>group</td><td>TQString</td><td></td></tr>
<tr><td>perm</td><td>mode_t</td><td></td></tr>
<tr><td>atime</td><td>time_t</td><td></td></tr>
<tr><td>mtime</td><td>time_t</td><td></td></tr>
<tr><td>ctime</td><td>time_t</td><td></td></tr>
</table>
</td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
<li><b>~KArchive</b> ()
<table width = "100%"><tr><td width="50%" valign="top"><table><tr><td>returns <i>nothing</i></td></tr>
<tr><td>In versions <i>less than</i> KDE 3.1.0 only</td></tr>
</table></td><td width="50%"><table><tr><td></td></tr></table></td></tr></table></li><hr>
</ul>
</body>
</html>