<?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>KArchive</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"> </div>
<h1>KArchive Class Reference</h1>
<code>from PyKDE4.kio import *</code>
<p>
Subclasses: <a href="../kio/KAr.html">KAr</a>, <a href="../kio/KTar.html">KTar</a>, <a href="../kio/KZip.html">KZip</a><br />
<h2>Detailed Description</h2>
<p>KArchive is a base class for reading and writing archives.
generic class for reading/writing archives
<dl class="author" compact><dt><b>Author:</b></dt><dd> David Faure <faure@kde.org> </dd></dl>
</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="#obj478537900"><anonymous></a> </td><td class="memItemRight" valign="bottom">{ UnknownTime }</td></tr>
<tr><td colspan="2"><br><h2>Methods</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KArchive">__init__</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> fileName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KArchive">__init__</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qiodevice.html">QIODevice</a> dev)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#KArchive">__init__</a> (self, <a href="../kio/KArchive.html">KArchive</a> other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#addLocalDirectory">addLocalDirectory</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> path, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> destName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#addLocalFile">addLocalFile</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> fileName, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> destName)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#close">close</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#closeArchive">closeArchive</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#createDevice">createDevice</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qiodevice::openmode.html">QIODevice.OpenMode</a> mode)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qiodevice.html">QIODevice</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#device">device</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KArchiveDirectory.html">KArchiveDirectory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#directory">directory</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#doFinishWriting">doFinishWriting</a> (self, long size)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#doPrepareWriting">doPrepareWriting</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> name, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> user, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> group, long size, <a href="../kdecore/mode_t.html">mode_t</a> perm, <a href="../kdecore/time_t.html">time_t</a> atime, <a href="../kdecore/time_t.html">time_t</a> mtime, <a href="../kdecore/time_t.html">time_t</a> ctime)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#doWriteDir">doWriteDir</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> name, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> user, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> group, <a href="../kdecore/mode_t.html">mode_t</a> perm, <a href="../kdecore/time_t.html">time_t</a> atime, <a href="../kdecore/time_t.html">time_t</a> mtime, <a href="../kdecore/time_t.html">time_t</a> ctime)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#doWriteSymLink">doWriteSymLink</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> name, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> target, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> user, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> group, <a href="../kdecore/mode_t.html">mode_t</a> perm, <a href="../kdecore/time_t.html">time_t</a> atime, <a href="../kdecore/time_t.html">time_t</a> mtime, <a href="../kdecore/time_t.html">time_t</a> ctime)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#fileName">fileName</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KArchiveDirectory.html">KArchiveDirectory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#findOrCreate">findOrCreate</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> path)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#finishWriting">finishWriting</a> (self, long size)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isOpen">isOpen</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qiodevice::openmode.html">QIODevice.OpenMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mode">mode</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#open">open</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qiodevice::openmode.html">QIODevice.OpenMode</a> mode)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#openArchive">openArchive</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qiodevice::openmode.html">QIODevice.OpenMode</a> mode)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#prepareWriting">prepareWriting</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> name, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> user, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> group, long size, <a href="../kdecore/mode_t.html">mode_t</a> perm=0100644, <a href="../kdecore/time_t.html">time_t</a> atime=UnknownTime, <a href="../kdecore/time_t.html">time_t</a> mtime=UnknownTime, <a href="../kdecore/time_t.html">time_t</a> ctime=UnknownTime)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KArchiveDirectory.html">KArchiveDirectory</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#rootDir">rootDir</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setDevice">setDevice</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qiodevice.html">QIODevice</a> dev)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setRootDir">setRootDir</a> (self, <a href="../kio/KArchiveDirectory.html">KArchiveDirectory</a> rootDir)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#writeData">writeData</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> data, long size)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#writeDir">writeDir</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> name, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> user, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> group, <a href="../kdecore/mode_t.html">mode_t</a> perm=040755, <a href="../kdecore/time_t.html">time_t</a> atime=UnknownTime, <a href="../kdecore/time_t.html">time_t</a> mtime=UnknownTime, <a href="../kdecore/time_t.html">time_t</a> ctime=UnknownTime)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#writeFile">writeFile</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> name, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> user, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> group, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> data, long size, <a href="../kdecore/mode_t.html">mode_t</a> perm=0100644, <a href="../kdecore/time_t.html">time_t</a> atime=UnknownTime, <a href="../kdecore/time_t.html">time_t</a> mtime=UnknownTime, <a href="../kdecore/time_t.html">time_t</a> ctime=UnknownTime)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#writeSymLink">writeSymLink</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> name, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> target, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> user, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> group, <a href="../kdecore/mode_t.html">mode_t</a> perm=0120755, <a href="../kdecore/time_t.html">time_t</a> atime=UnknownTime, <a href="../kdecore/time_t.html">time_t</a> mtime=UnknownTime, <a href="../kdecore/time_t.html">time_t</a> ctime=UnknownTime)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KArchive"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <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/qstring.html">QString</a> </td>
<td class="paramname"><em>fileName</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Base constructor (protected since this is a pure virtual class).
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>fileName</em> </td><td> is a local path (e.g. "/tmp/myfile.ext"),
from which the archive will be read from, or into which the archive
will be written, depending on the mode given to open().
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="KArchive"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <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/qiodevice.html">QIODevice</a> </td>
<td class="paramname"><em>dev</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Base constructor (protected since this is a pure virtual class).
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>dev</em> </td><td> the I/O device where the archive reads its data
Note that this can be a file, but also a data buffer, a compression filter, etc.
For a file in writing mode it is better to use the other constructor
though, to benefit from the use of KSaveFile when saving.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="KArchive"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KArchive.html">KArchive</a> </td>
<td class="paramname"><em>other</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="addLocalDirectory"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool addLocalDirectory</td>
<td>(</td>
<td class="paramtype"> <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/qstring.html">QString</a> </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>destName</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Writes a local directory into the archive, including all its contents, recursively.
Calls addLocalFile for each file to be added.
</p>
<p>
Since KDE 3.2 it will also add a <b>path</b> that is a symbolic link to a
directory. The symbolic link will be dereferenced and the content of the
directory it is pointing to added recursively. However, symbolic links
*under* <b>path</b> will be stored as is.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>path</em> </td><td> full path to an existing local directory, to be added to the archive.
<tr><td></td><td valign="top"><em>destName</em> </td><td> the resulting name (or relative path) of the file in the archive.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="addLocalFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool addLocalFile</td>
<td>(</td>
<td class="paramtype"> <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/qstring.html">QString</a> </td>
<td class="paramname"><em>fileName</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>destName</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Writes a local file into the archive. The main difference with writeFile,
is that this method minimizes memory usage, by not loading the whole file
into memory in one go.
</p>
<p>
If <b>fileName</b> is a symbolic link, it will be written as is, i. e.
it will not be resolved before.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>fileName</em> </td><td> full path to an existing local file, to be added to the archive.
<tr><td></td><td valign="top"><em>destName</em> </td><td> the resulting name (or relative path) of the file in the archive.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="close"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool close</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Closes the archive.
Inherited classes might want to reimplement closeArchive instead.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if close succeeded without problems
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> open
</dd></dl>
</p></div></div><a class="anchor" name="closeArchive"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool closeArchive</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Closes the archive.
Called by close.
</p></div></div><a class="anchor" name="createDevice"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool createDevice</td>
<td>(</td>
<td class="paramtype"> <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/qiodevice::openmode.html">QIODevice.OpenMode</a> </td>
<td class="paramname"><em>mode</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Can be reimplemented in order to change the creation of the device
(when using the fileName constructor). By default this method uses
KSaveFile when saving, and a simple QFile on reading.
This method is called by open().
</p></div></div><a class="anchor" name="device"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qiodevice.html">QIODevice</a> device</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The underlying device.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the underlying device.
</dd></dl>
</p></div></div><a class="anchor" name="directory"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KArchiveDirectory.html">KArchiveDirectory</a> directory</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>If an archive is opened for reading, then the contents
of the archive can be accessed via this function.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the directory of the archive
</dd></dl>
</p></div></div><a class="anchor" name="doFinishWriting"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool doFinishWriting</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>size</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Called after writing the data.
This virtual method must be implemented by subclasses.
</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>size</em> </td><td> the size of the file
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> finishWriting()
</dd></dl>
</p></div></div><a class="anchor" name="doPrepareWriting"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool doPrepareWriting</td>
<td>(</td>
<td class="paramtype"> <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/qstring.html">QString</a> </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/mode_t.html">mode_t</a> </td>
<td class="paramname"><em>perm</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>atime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>mtime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>ctime</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>This virtual method must be implemented by subclasses.
</p>
<p>
Depending on the archive type not all metadata might be used.
</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>name</em> </td><td> the name of the file
<tr><td></td><td valign="top"><em>user</em> </td><td> the user that owns the file
<tr><td></td><td valign="top"><em>group</em> </td><td> the group that owns the file
<tr><td></td><td valign="top"><em>size</em> </td><td> the size of the file
<tr><td></td><td valign="top"><em>perm</em> </td><td> permissions of the file. Use 0100644 if you don't have any more specific permissions to set.
<tr><td></td><td valign="top"><em>atime</em> </td><td> time the file was last accessed
<tr><td></td><td valign="top"><em>mtime</em> </td><td> modification time of the file
<tr><td></td><td valign="top"><em>ctime</em> </td><td> time of last status change
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> prepareWriting
</dd></dl>
</p></div></div><a class="anchor" name="doWriteDir"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool doWriteDir</td>
<td>(</td>
<td class="paramtype"> <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/qstring.html">QString</a> </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/mode_t.html">mode_t</a> </td>
<td class="paramname"><em>perm</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>atime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>mtime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>ctime</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Write a directory to the archive.
This virtual method must be implemented by subclasses.
</p>
<p>
Depending on the archive type not all metadata might be used.
</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>name</em> </td><td> the name of the directory
<tr><td></td><td valign="top"><em>user</em> </td><td> the user that owns the directory
<tr><td></td><td valign="top"><em>group</em> </td><td> the group that owns the directory
<tr><td></td><td valign="top"><em>perm</em> </td><td> permissions of the directory. Use 040755 if you don't have any other information.
<tr><td></td><td valign="top"><em>atime</em> </td><td> time the file was last accessed
<tr><td></td><td valign="top"><em>mtime</em> </td><td> modification time of the file
<tr><td></td><td valign="top"><em>ctime</em> </td><td> time of last status change
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> writeDir
</dd></dl>
</p></div></div><a class="anchor" name="doWriteSymLink"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool doWriteSymLink</td>
<td>(</td>
<td class="paramtype"> <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/qstring.html">QString</a> </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/mode_t.html">mode_t</a> </td>
<td class="paramname"><em>perm</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>atime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>mtime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>ctime</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Writes a symbolic link to the archive.
This virtual method must be implemented by subclasses.
</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>name</em> </td><td> name of symbolic link
<tr><td></td><td valign="top"><em>target</em> </td><td> target of symbolic link
<tr><td></td><td valign="top"><em>user</em> </td><td> the user that owns the directory
<tr><td></td><td valign="top"><em>group</em> </td><td> the group that owns the directory
<tr><td></td><td valign="top"><em>perm</em> </td><td> permissions of the directory
<tr><td></td><td valign="top"><em>atime</em> </td><td> time the file was last accessed
<tr><td></td><td valign="top"><em>mtime</em> </td><td> modification time of the file
<tr><td></td><td valign="top"><em>ctime</em> </td><td> time of last status change
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> writeSymLink
</dd></dl>
</p></div></div><a class="anchor" name="fileName"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> fileName</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>The name of the archive file, as passed to the constructor that takes a
fileName, or an empty string if you used the QIODevice constructor.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the name of the file, or QString() if unknown
</dd></dl>
</p></div></div><a class="anchor" name="findOrCreate"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KArchiveDirectory.html">KArchiveDirectory</a> findOrCreate</td>
<td>(</td>
<td class="paramtype"> <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/qstring.html">QString</a> </td>
<td class="paramname"><em>path</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Ensures that <b>path</b> exists, create otherwise.
This handles e.g. tar files missing directory entries, like mico-2.3.0.tar.gz :)
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>path</em> </td><td> the path of the directory
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> the directory with the given <b>path</b>
</dd></dl>
</p></div></div><a class="anchor" name="finishWriting"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool finishWriting</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>size</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call finishWriting after writing the data.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>size</em> </td><td> the size of the file
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> prepareWriting()
</dd></dl>
</p></div></div><a class="anchor" name="isOpen"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isOpen</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Checks whether the archive is open.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if the archive is opened
</dd></dl>
</p></div></div><a class="anchor" name="mode"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qiodevice::openmode.html">QIODevice.OpenMode</a> mode</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Returns the mode in which the archive was opened
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the mode in which the archive was opened (QIODevice.ReadOnly or QIODevice.WriteOnly)
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> open()
</dd></dl>
</p></div></div><a class="anchor" name="open"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool open</td>
<td>(</td>
<td class="paramtype"> <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/qiodevice::openmode.html">QIODevice.OpenMode</a> </td>
<td class="paramname"><em>mode</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Opens the archive for reading or writing.
Inherited classes might want to reimplement openArchive instead.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>mode</em> </td><td> may be QIODevice.ReadOnly or QIODevice.WriteOnly
</td></tr> </table></dl>
<p> <dl class="see" compact><dt><b>See also:</b></dt><dd> close
</dd></dl>
</p></div></div><a class="anchor" name="openArchive"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool openArchive</td>
<td>(</td>
<td class="paramtype"> <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/qiodevice::openmode.html">QIODevice.OpenMode</a> </td>
<td class="paramname"><em>mode</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Opens an archive for reading or writing.
Called by open.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>mode</em> </td><td> may be QIODevice.ReadOnly or QIODevice.WriteOnly
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="prepareWriting"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool prepareWriting</td>
<td>(</td>
<td class="paramtype"> <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/qstring.html">QString</a> </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/mode_t.html">mode_t</a> </td>
<td class="paramname"><em>perm=0100644</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>atime=UnknownTime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>mtime=UnknownTime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>ctime=UnknownTime</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Here's another way of writing a file into an archive:
Call prepareWriting(), then call writeData()
as many times as wanted then call finishWriting( totalSize ).
For tar.gz files, you need to know the size before hand, it is needed in the header!
For zip files, size isn't used.
</p>
<p>
This method also allows some file metadata to be
set. However, depending on the archive type not all metadata might be
regarded.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> the name of the file
<tr><td></td><td valign="top"><em>user</em> </td><td> the user that owns the file
<tr><td></td><td valign="top"><em>group</em> </td><td> the group that owns the file
<tr><td></td><td valign="top"><em>size</em> </td><td> the size of the file
<tr><td></td><td valign="top"><em>perm</em> </td><td> permissions of the file
<tr><td></td><td valign="top"><em>atime</em> </td><td> time the file was last accessed
<tr><td></td><td valign="top"><em>mtime</em> </td><td> modification time of the file
<tr><td></td><td valign="top"><em>ctime</em> </td><td> time of last status change
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="rootDir"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KArchiveDirectory.html">KArchiveDirectory</a> rootDir</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><p>Retrieves or create the root directory.
The default implementation assumes that openArchive() did the parsing,
so it creates a dummy rootdir if none was set (write mode, or no '/' in the archive).
Reimplement this to provide parsing/listing on demand.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the root directory
</dd></dl>
</p></div></div><a class="anchor" name="setDevice"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setDevice</td>
<td>(</td>
<td class="paramtype"> <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/qiodevice.html">QIODevice</a> </td>
<td class="paramname"><em>dev</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Can be called by derived classes in order to set the underlying device.
Note that KArchive will -not- own the device, it must be deleted by the derived class.
</p></div></div><a class="anchor" name="setRootDir"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setRootDir</td>
<td>(</td>
<td class="paramtype"> <em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KArchiveDirectory.html">KArchiveDirectory</a> </td>
<td class="paramname"><em>rootDir</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Derived classes call setRootDir from openArchive,
to set the root directory after parsing an existing archive.
</p></div></div><a class="anchor" name="writeData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool writeData</td>
<td>(</td>
<td class="paramtype"> <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/qstring.html">QString</a> </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>size</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Write data into the current file - to be called after calling prepareWriting
</p></div></div><a class="anchor" name="writeDir"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool writeDir</td>
<td>(</td>
<td class="paramtype"> <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/qstring.html">QString</a> </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/mode_t.html">mode_t</a> </td>
<td class="paramname"><em>perm=040755</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>atime=UnknownTime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>mtime=UnknownTime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>ctime=UnknownTime</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>If an archive is opened for writing then you can add new directories
using this function. KArchive won't write one directory twice.
</p>
<p>
This method also allows some file metadata to be set.
However, depending on the archive type not all metadata might be regarded.
</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>name</em> </td><td> the name of the directory
<tr><td></td><td valign="top"><em>user</em> </td><td> the user that owns the directory
<tr><td></td><td valign="top"><em>group</em> </td><td> the group that owns the directory
<tr><td></td><td valign="top"><em>perm</em> </td><td> permissions of the directory
<tr><td></td><td valign="top"><em>atime</em> </td><td> time the file was last accessed
<tr><td></td><td valign="top"><em>mtime</em> </td><td> modification time of the file
<tr><td></td><td valign="top"><em>ctime</em> </td><td> time of last status change
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="writeFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool writeFile</td>
<td>(</td>
<td class="paramtype"> <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/qstring.html">QString</a> </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">long </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/mode_t.html">mode_t</a> </td>
<td class="paramname"><em>perm=0100644</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>atime=UnknownTime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>mtime=UnknownTime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>ctime=UnknownTime</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>If an archive is opened for writing then you can add a new file
using this function. If the file name is for example "mydir/test1" then
the directory "mydir" is automatically appended first if that did not
happen yet.
</p>
<p>
This method also allows some file metadata to be
set. However, depending on the archive type not all metadata might be
regarded.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>name</em> </td><td> the name of the file
<tr><td></td><td valign="top"><em>user</em> </td><td> the user that owns the file
<tr><td></td><td valign="top"><em>group</em> </td><td> the group that owns the file
<tr><td></td><td valign="top"><em>data</em> </td><td> the data to write (@p size bytes)
<tr><td></td><td valign="top"><em>size</em> </td><td> the size of the file
<tr><td></td><td valign="top"><em>perm</em> </td><td> permissions of the file
<tr><td></td><td valign="top"><em>atime</em> </td><td> time the file was last accessed
<tr><td></td><td valign="top"><em>mtime</em> </td><td> modification time of the file
<tr><td></td><td valign="top"><em>ctime</em> </td><td> time of last status change
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="writeSymLink"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool writeSymLink</td>
<td>(</td>
<td class="paramtype"> <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/qstring.html">QString</a> </td>
<td class="paramname"><em>name</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>target</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>user</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> </td>
<td class="paramname"><em>group</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/mode_t.html">mode_t</a> </td>
<td class="paramname"><em>perm=0120755</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>atime=UnknownTime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>mtime=UnknownTime</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/time_t.html">time_t</a> </td>
<td class="paramname"><em>ctime=UnknownTime</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Writes a symbolic link to the archive if supported.
The archive must be opened for writing.
</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>name</em> </td><td> name of symbolic link
<tr><td></td><td valign="top"><em>target</em> </td><td> target of symbolic link
<tr><td></td><td valign="top"><em>user</em> </td><td> the user that owns the directory
<tr><td></td><td valign="top"><em>group</em> </td><td> the group that owns the directory
<tr><td></td><td valign="top"><em>perm</em> </td><td> permissions of the directory
<tr><td></td><td valign="top"><em>atime</em> </td><td> time the file was last accessed
<tr><td></td><td valign="top"><em>mtime</em> </td><td> modification time of the file
<tr><td></td><td valign="top"><em>ctime</em> </td><td> time of last status change
</td></tr>
</table></dl>
<p>
</p></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="obj478537900"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">anonymous</td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Enumerator: </b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0"><tr><td valign="top"><em>UnknownTime</em> </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="mailto:simon@simonzone.com">Simon Edwards</a>.<br />
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> |
<a href="http://www.kde.org/contact/impressum.php">Legal</a>
</div></div>
</body>
</html>
distrib
>
Mandriva
>
current
>
i586
>
media
>
main-updates
>
by-pkgid
>
b77dda48f87d4eda8cc559e40c49a652
>
files
>
725
