<?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>KIO.SlaveBase</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>SlaveBase Class Reference</h1>
<code>from PyKDE4.kio import *</code>
<p>
Subclasses: <a href="../kio/KIO.ForwardingSlaveBase.html">KIO.ForwardingSlaveBase</a>, <a href="../kio/KIO.TCPSlaveBase.html">KIO.TCPSlaveBase</a><br />
Namespace: KIO.SlaveBase<br />
<h2>Detailed Description</h2>
<p>There are two classes that specifies the protocol between application (job)
and kioslave. SlaveInterface is the class to use on the application end,
SlaveBase is the one to use on the slave end.
</p>
<p>
Slave implementations should simply inherit SlaveBase
</p>
<p>
A call to foo() results in a call to slotFoo() on the other end.
</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="#MessageBoxType">MessageBoxType</a> </td><td class="memItemRight" valign="bottom">{ QuestionYesNo, WarningYesNo, WarningContinueCancel, WarningYesNoCancel, Information, SSLMessageBox }</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="#SlaveBase">__init__</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> protocol, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> pool_socket, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> app_socket)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#SlaveBase">__init__</a> (self, <a href="../kio/KIO.SlaveBase.html">KIO.SlaveBase</a> other)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KIO.MetaData.html">KIO.MetaData</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#allMetaData">allMetaData</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#cacheAuthentication">cacheAuthentication</a> (self, <a href="../kio/KIO.AuthInfo.html">KIO.AuthInfo</a> info)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#canResume">canResume</a> (self, <a href="../kio/KIO.filesize_t.html">KIO.filesize_t</a> offset)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#canResume">canResume</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#checkCachedAuthentication">checkCachedAuthentication</a> (self, <a href="../kio/KIO.AuthInfo.html">KIO.AuthInfo</a> info)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#chmod">chmod</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url, int permissions)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#chown">chown</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> owner, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> group)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#closeConnection">closeConnection</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#config">config</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#connectSlave">connectSlave</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">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#connectTimeout">connectTimeout</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#connected">connected</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#copy">copy</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> src, <a href="../kdecore/KUrl.html">KUrl</a> dest, int permissions, <a href="../kio/KIO.JobFlags.html">KIO.JobFlags</a> flags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#data">data</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#dataReq">dataReq</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#del">del_</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url, bool isfile)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#disconnectSlave">disconnectSlave</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#dispatch">dispatch</a> (self, int command, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#dispatchLoop">dispatchLoop</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#dispatchOpenCommand">dispatchOpenCommand</a> (self, int command, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#dropNetwork">dropNetwork</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> host=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#error">error</a> (self, int _errid, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> _text)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#errorPage">errorPage</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#exit">exit</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#finished">finished</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#get">get</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#hasMetaData">hasMetaData</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#infoMessage">infoMessage</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#listDir">listDir</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#listEntries">listEntries</a> (self, <a href="../kio/KIO.UDSEntryList.html">KIO.UDSEntryList</a> _entry)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#listEntry">listEntry</a> (self, <a href="../kio/KIO.UDSEntry.html">KIO.UDSEntry</a> _entry, bool ready)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#lookupHost">lookupHost</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> host)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#messageBox">messageBox</a> (self, <a href="../kio/KIO.SlaveBase.html#MessageBoxType">KIO.SlaveBase.MessageBoxType</a> type, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> text, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> caption=QString(), <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> buttonYes=i18n("&Yes"), <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> buttonNo=i18n("&No"))</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#messageBox">messageBox</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> text, <a href="../kio/KIO.SlaveBase.html#MessageBoxType">KIO.SlaveBase.MessageBoxType</a> type, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> caption=QString(), <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> buttonYes=i18n("&Yes"), <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> buttonNo=i18n("&No"), <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> dontAskAgainName=QString())</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="#metaData">metaData</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> key)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mimeType">mimeType</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> _type)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mimetype">mimetype</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#mkdir">mkdir</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url, int permissions)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#multiGet">multiGet</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#needSubUrlData">needSubUrlData</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#open">open</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url, <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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#openConnection">openConnection</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#openPasswordDialog">openPasswordDialog</a> (self, <a href="../kio/KIO.AuthInfo.html">KIO.AuthInfo</a> info, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> errorMsg=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#opened">opened</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#position">position</a> (self, <a href="../kio/KIO.filesize_t.html">KIO.filesize_t</a> _pos)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#processedPercent">processedPercent</a> (self, float percent)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#processedSize">processedSize</a> (self, <a href="../kio/KIO.filesize_t.html">KIO.filesize_t</a> _bytes)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#proxyConnectTimeout">proxyConnectTimeout</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#put">put</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url, int permissions, <a href="../kio/KIO.JobFlags.html">KIO.JobFlags</a> flags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#read">read</a> (self, <a href="../kio/KIO.filesize_t.html">KIO.filesize_t</a> size)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#readData">readData</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> buffer)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#readTimeout">readTimeout</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#redirection">redirection</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> _url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a href="../kio/KRemoteEncoding.html">KRemoteEncoding</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="#remoteEncoding">remoteEncoding</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#rename">rename</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> src, <a href="../kdecore/KUrl.html">KUrl</a> dest, <a href="../kio/KIO.JobFlags.html">KIO.JobFlags</a> flags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#reparseConfiguration">reparseConfiguration</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#requestNetwork">requestNetwork</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> host=QString())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#responseTimeout">responseTimeout</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#seek">seek</a> (self, <a href="../kio/KIO.filesize_t.html">KIO.filesize_t</a> offset)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#sendAndKeepMetaData">sendAndKeepMetaData</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#sendMetaData">sendMetaData</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setHost">setHost</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> host, int port, <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> pass)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setKillFlag">setKillFlag</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setLinkDest">setLinkDest</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> target)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setMetaData">setMetaData</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> key, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> value)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setModificationTime">setModificationTime</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qdatetime.html">QDateTime</a> mtime)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setSubUrl">setSubUrl</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setTimeoutSpecialCommand">setTimeoutSpecialCommand</a> (self, int timeout, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> data=QByteArray())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slaveStatus">slaveStatus</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> host, bool connected)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#slave_status">slave_status</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#special">special</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#speed">speed</a> (self, long _bytes_per_second)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#stat">stat</a> (self, <a href="../kdecore/KUrl.html">KUrl</a> url)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#statEntry">statEntry</a> (self, <a href="../kio/KIO.UDSEntry.html">KIO.UDSEntry</a> _entry)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#symlink">symlink</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> target, <a href="../kdecore/KUrl.html">KUrl</a> dest, <a href="../kio/KIO.JobFlags.html">KIO.JobFlags</a> flags)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#totalSize">totalSize</a> (self, <a href="../kio/KIO.filesize_t.html">KIO.filesize_t</a> _bytes)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int, int pCmd </td><td class="memItemRight" valign="bottom"><a class="el" href="#waitForAnswer">waitForAnswer</a> (self, int expected1, int expected2, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="#waitForHostInfo">waitForHostInfo</a> (self, QHostInfo info)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#warning">warning</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> msg)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#wasKilled">wasKilled</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#write">write</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> data)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#written">written</a> (self, <a href="../kio/KIO.filesize_t.html">KIO.filesize_t</a> _bytes)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="SlaveBase"></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/qbytearray.html">QByteArray</a> </td>
<td class="paramname"><em>protocol</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> </td>
<td class="paramname"><em>pool_socket</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> </td>
<td class="paramname"><em>app_socket</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="SlaveBase"></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/KIO.SlaveBase.html">KIO.SlaveBase</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="allMetaData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KIO.MetaData.html">KIO.MetaData</a> allMetaData</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><dl class="internal" compact><dt><b>Internal:</b></dt><dd> for ForwardingSlaveBase
Contains all metadata (but no config) sent by the application to the slave.
</dd></dl>
</p></div></div><a class="anchor" name="cacheAuthentication"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool cacheAuthentication</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/KIO.AuthInfo.html">KIO.AuthInfo</a> </td>
<td class="paramname"><em>info</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Explicitly store authentication information. openPasswordDialog already
stores password information automatically, you only need to call
this function if you want to store authentication information that
is different from the information returned by openPasswordDialog.
</p></div></div><a class="anchor" name="canResume"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool canResume</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/KIO.filesize_t.html">KIO.filesize_t</a> </td>
<td class="paramname"><em>offset</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call this at the beginning of get(), if the "resume" metadata was set
and resuming is implemented by this protocol.
</p></div></div><a class="anchor" name="canResume"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> canResume</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>Call this at the beginning of get(), if the "resume" metadata was set
and resuming is implemented by this protocol.
</p></div></div><a class="anchor" name="checkCachedAuthentication"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool checkCachedAuthentication</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/KIO.AuthInfo.html">KIO.AuthInfo</a> </td>
<td class="paramname"><em>info</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Checks for cached authentication based on parameters
given by <b>info.</b>
</p>
<p>
Use this function to check if any cached password exists
for the URL given by <b>info.</b> If <b>AuthInfo.realmValue</b>
and/or <b>AuthInfo.verifyPath</b> flag is specified, then
they will also be factored in determining the presence
of a cached password. Note that <b>Auth.url</b> is a required
parameter when attempting to check for cached authorization
info. Here is a simple example:
</p>
<p>
<pre class="fragment">
AuthInfo info;
info.url = KUrl("http://www.foobar.org/foo/bar");
info.username = "somename";
info.verifyPath = true;
if ( !checkCachedAuthentication( info ) )
{
if ( !openPasswordDialog(info) )
....
}
</pre>
</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></em> </td><td> info See AuthInfo.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> <b>true</b> if cached Authorization is found, false otherwise.
</dd></dl>
</p></div></div><a class="anchor" name="chmod"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> chmod</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>permissions</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Change permissions on <b>url</b>
The slave emits ERR_DOES_NOT_EXIST or ERR_CANNOT_CHMOD
</p></div></div><a class="anchor" name="chown"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> chown</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</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>owner</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></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Change ownership of <b>url</b>
The slave emits ERR_DOES_NOT_EXIST or ERR_CANNOT_CHOWN
</p></div></div><a class="anchor" name="close"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> 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"></div></div><a class="anchor" name="closeConnection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> closeConnection</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 connection (forced)
Called when the application disconnects the slave to close
any open network connections.
</p>
<p>
When the slave was operating in connection-oriented mode,
it should reset itself to connectionless (default) mode.
</p></div></div><a class="anchor" name="config"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kdecore/KConfigGroup.html">KConfigGroup</a> config</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 a configuration object to query config/meta-data information
from.
</p>
<p>
The application provides the slave with all configuration information
relevant for the current protocol and host.
</p></div></div><a class="anchor" name="connectSlave"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> connectSlave</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>internal function to connect a slave to/ disconnect from
either the slave pool or the application
</p></div></div><a class="anchor" name="connectTimeout"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int connectTimeout</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> timeout value for connecting to remote host.
</dd></dl>
</p></div></div><a class="anchor" name="connected"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> connected</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>Call in openConnection, if you reimplement it, when you're done.
</p></div></div><a class="anchor" name="copy"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> copy</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>permissions</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.JobFlags.html">KIO.JobFlags</a> </td>
<td class="paramname"><em>flags</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Copy <b>src</b> into <b>dest.</b>
</p>
<p>
By default, copy() is only called when copying a file from
yourproto://host/path to yourproto://host/otherpath.
</p>
<p>
If you set copyFromFile=true then copy() will also be called when
moving a file from file:path to yourproto://host/otherpath.
Otherwise such a copy would have to be done the slow way (get+put).
See also KProtocolManager.canCopyFromFile().
</p>
<p>
If you set copyToFile=true then copy() will also be called when
moving a file from yourproto: to file:.
See also KProtocolManager.canCopyToFile().
</p>
<p>
If the slave returns an error ERR_UNSUPPORTED_ACTION, the job will
ask for get + put instead.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>src</em> </td><td> where to copy the file from (decoded)
<tr><td></td><td valign="top"><em>dest</em> </td><td> where to copy the file to (decoded)
<tr><td></td><td valign="top"><em>permissions</em> </td><td> may be -1. In this case no special permission mode is set.
<tr><td></td><td valign="top"><em>flags:</em> </td><td> We support Overwrite here
</td></tr>
</table></dl>
<p> Don't forget to set the modification time of <b>dest</b> to be the modification time of <b>src.</b>
</p></div></div><a class="anchor" name="data"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> data</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/qbytearray.html">QByteArray</a> </td>
<td class="paramname"><em>data</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sends data in the slave to the job (i.e. in get).
</p>
<p>
To signal end of data, simply send an empty
QByteArray().
</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>data</em> </td><td> the data read by the slave
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="dataReq"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> dataReq</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>Asks for data from the job.
<dl class="see" compact><dt><b>See also:</b></dt><dd> readData
</dd></dl>
</p></div></div><a class="anchor" name="del"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> del_</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>isfile</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Delete a file or directory.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>url</em> </td><td> file/directory to delete
<tr><td></td><td valign="top"><em>isfile</em> </td><td> if true, a file should be deleted.
if false, a directory should be deleted.
</td></tr>
</table></dl>
<p> By default, del() on a directory should FAIL if the directory is not empty.
However, if metadata("recurse") == "true", then the slave can do a recursive deletion.
This behavior is only invoked if the slave specifies deleteRecursive=true in its protocol file.
</p></div></div><a class="anchor" name="disconnectSlave"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> disconnectSlave</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"></div></div><a class="anchor" name="dispatch"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> dispatch</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">int </td>
<td class="paramname"><em>command</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> </td>
<td class="paramname"><em>data</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="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="dispatchLoop"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> dispatchLoop</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><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="dispatchOpenCommand"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> dispatchOpenCommand</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">int </td>
<td class="paramname"><em>command</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> </td>
<td class="paramname"><em>data</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="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="dropNetwork"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> dropNetwork</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>host=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Used by the slave to withdraw a connection requested by
requestNetwork. This function cancels the last call to
requestNetwork. If a client uses more than one internet
connection, it must use dropNetwork(host) to
stop each request.
</p>
<p>
If KNetMgr is not running, then this is a no-op.
</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>host</em> </td><td> the host passed to requestNetwork
</td></tr>
</table></dl>
<p> A slave should call this function every time it disconnect from a host.
</p></div></div><a class="anchor" name="error"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> error</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">int </td>
<td class="paramname"><em>_errid</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>_text</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call to signal an error.
This also finishes the job, so you must not call
finished() after calling this.
</p>
<p>
If the error code is KIO.ERR_SLAVE_DEFINED then the
_text should contain the complete translated text of
of the error message.
</p>
<p>
For all other error codes, _text should match the corresponding
error code. Usually,, _text is a file or host name, or the error which
was passed from the server.<br>
For example, for KIO.ERR_DOES_NOT_EXIST, _text may only
be the file or folder which does not exist, nothing else. Otherwise,
this would break error strings generated by KIO.buildErrorString().<br>
If you have to add more details than what the standard error codes
provide, you'll need to use KIO.ERR_SLAVE_DEFINED.
For a complete list of what _text should contain for each error code,
look at the source of KIO.buildErrorString().
</p>
<p>
You can add rich text markup to the message, the places where the
error message will be displayed are rich text aware.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> KIO.Error
</dd></dl> <dl class="see" compact><dt><b>See also:</b></dt><dd> KIO.buildErrorString
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>_errid</em> </td><td> the error code from KIO.Error
<tr><td></td><td valign="top"><em>_text</em> </td><td> the rich text error message
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="errorPage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> errorPage</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>Tell that we will only get an error page here.
This means: the data you'll get isn't the data you requested,
but an error page (usually HTML) that describes an error.
</p></div></div><a class="anchor" name="exit"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> exit</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><dl class="internal" compact><dt><b>Internal:</b></dt><dd>
Terminate the slave by calling the destructor and then .exit()
</dd></dl>
</p></div></div><a class="anchor" name="finished"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> finished</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>Call to signal successful completion of any command
besides openConnection and closeConnection. Do not
call this after calling error().
</p></div></div><a class="anchor" name="get"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> get</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>get, aka read.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>url</em> </td><td> the full url for this request. Host, port and user of the URL
can be assumed to be the same as in the last setHost() call.
</td></tr>
</table></dl>
<p> The slave should first "emit" the mimetype by calling mimeType(),
and then "emit" the data using the data() method.
</p>
<p>
The reason why we need get() to emit the mimetype is:
when pasting a URL in krunner, or konqueror's location bar,
we have to find out what is the mimetype of that URL.
Rather than doing it with a call to mimetype(), then the app or part
would have to do a second request to the same server, this is done
like this: get() is called, and when it emits the mimetype, the job
is put on hold and the right app or part is launched. When that app
or part calls get(), the slave is magically reused, and the download
can now happen. All with a single call to get() in the slave.
This mechanism is also described in KIO.get().
</p></div></div><a class="anchor" name="hasMetaData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool hasMetaData</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>key</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Queries for the existence of a certain config/meta-data entry
send by the application to the slave.
</p></div></div><a class="anchor" name="infoMessage"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> infoMessage</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>msg</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call to signal a message, to be displayed if the application wants to,
for instance in a status bar. Usual examples are "connecting to host xyz", etc.
</p></div></div><a class="anchor" name="listDir"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> listDir</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Lists the contents of <b>url.</b>
The slave should emit ERR_CANNOT_ENTER_DIRECTORY if it doesn't exist,
if we don't have enough permissions, or if it is a file
It should also emit totalFiles as soon as it knows how many
files it will list.
</p></div></div><a class="anchor" name="listEntries"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> listEntries</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/KIO.UDSEntryList.html">KIO.UDSEntryList</a> </td>
<td class="paramname"><em>_entry</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call this in listDir, each time you have a bunch of entries
to report.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>_entry</em> </td><td> The UDSEntry containing all of the object attributes.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="listEntry"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> listEntry</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/KIO.UDSEntry.html">KIO.UDSEntry</a> </td>
<td class="paramname"><em>_entry</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>ready</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>internal function to be called by the slave.
It collects entries and emits them via listEntries
when enough of them are there or a certain time
frame exceeded (to make sure the app gets some
items in time but not too many items one by one
as this will cause a drastic performance penalty)
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>_entry</em> </td><td> The UDSEntry containing all of the object attributes.
<tr><td></td><td valign="top"><em>ready</em> </td><td> set to true after emitting all items. <b>_entry</b> is not
used in this case
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="lookupHost"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> lookupHost</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>host</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Internally used
<dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="messageBox"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int messageBox</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/KIO.SlaveBase.html#MessageBoxType">KIO.SlaveBase.MessageBoxType</a> </td>
<td class="paramname"><em>type</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>text</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>caption=QString()</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>buttonYes=i18n("&Yes")</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>buttonNo=i18n("&No")</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call this to show a message box from the slave
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> Message string. May contain newlines.
<tr><td></td><td valign="top"><em>type</em> </td><td> type of message box: QuestionYesNo, WarningYesNo, WarningContinueCancel...
<tr><td></td><td valign="top"><em>caption</em> </td><td> Message box title.
<tr><td></td><td valign="top"><em>buttonYes</em> </td><td> The text for the first button.
The default is i18n("&Yes").
<tr><td></td><td valign="top"><em>buttonNo</em> </td><td> The text for the second button.
The default is i18n("&No").
Note: for ContinueCancel, buttonYes is the continue button and buttonNo is unused.
and for Information, none is used.
<tr><td></td><td valign="top"><em>dontAskAgain</em> </td><td> A checkbox is added with which further confirmation can be turned off.
If the checkbox was ticked @p*dontAskAgain will be set to true, otherwise false.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a button code, as defined in KMessageBox, or 0 on communication error.
</dd></dl>
</p></div></div><a class="anchor" name="messageBox"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int messageBox</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>text</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.SlaveBase.html#MessageBoxType">KIO.SlaveBase.MessageBoxType</a> </td>
<td class="paramname"><em>type</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>caption=QString()</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>buttonYes=i18n("&Yes")</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>buttonNo=i18n("&No")</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>dontAskAgainName=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call this to show a message box from the slave
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>text</em> </td><td> Message string. May contain newlines.
<tr><td></td><td valign="top"><em>type</em> </td><td> type of message box: QuestionYesNo, WarningYesNo, WarningContinueCancel...
<tr><td></td><td valign="top"><em>caption</em> </td><td> Message box title.
<tr><td></td><td valign="top"><em>buttonYes</em> </td><td> The text for the first button.
The default is i18n("&Yes").
<tr><td></td><td valign="top"><em>buttonNo</em> </td><td> The text for the second button.
The default is i18n("&No").
Note: for ContinueCancel, buttonYes is the continue button and buttonNo is unused.
and for Information, none is used.
<tr><td></td><td valign="top"><em>dontAskAgain</em> </td><td> A checkbox is added with which further confirmation can be turned off.
If the checkbox was ticked @p*dontAskAgain will be set to true, otherwise false.
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> a button code, as defined in KMessageBox, or 0 on communication error.
</dd></dl>
</p></div></div><a class="anchor" name="metaData"></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> metaData</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>key</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Queries for config/meta-data send by the application to the slave.
</p></div></div><a class="anchor" name="mimeType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> mimeType</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>_type</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call this in mimetype() and in get(), when you know the mimetype.
See mimetype about other ways to implement it.
</p></div></div><a class="anchor" name="mimetype"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> mimetype</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Finds mimetype for one file or directory.
</p>
<p>
This method should either emit 'mimeType' or it
should send a block of data big enough to be able
to determine the mimetype.
</p>
<p>
If the slave doesn't reimplement it, a get will
be issued, i.e. the whole file will be downloaded before
determining the mimetype on it - this is obviously not a
good thing in most cases.
</p></div></div><a class="anchor" name="mkdir"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> mkdir</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>permissions</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Create a directory
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>url</em> </td><td> path to the directory to create
<tr><td></td><td valign="top"><em>permissions</em> </td><td> the permissions to set after creating the directory
(-1 if no permissions to be set)
The slave emits ERR_COULD_NOT_MKDIR if failure.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="multiGet"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> multiGet</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/qbytearray.html">QByteArray</a> </td>
<td class="paramname"><em>data</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Used for multiple get. Currently only used foir HTTP pielining
support.
</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>data</em> </td><td> packed data; Contains number of URLs to fetch, and for
each URL the URL itself and its associated MetaData.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="needSubUrlData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> needSubUrlData</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>Call to signal that data from the sub-URL is needed
</p></div></div><a class="anchor" name="open"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> 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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </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>open.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>url</em> </td><td> the full url for this request. Host, port and user of the URL
can be assumed to be the same as in the last setHost() call.
<tr><td></td><td valign="top"><em>mode</em> </td><td> see QIODevice.OpenMode
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="openConnection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> openConnection</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>Opens the connection (forced)
When this function gets called the slave is operating in
connection-oriented mode.
When a connection gets lost while the slave operates in
connection oriented mode, the slave should report
ERR_CONNECTION_BROKEN instead of reconnecting. The user is
expected to disconnect the slave in the error handler.
</p></div></div><a class="anchor" name="openPasswordDialog"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool openPasswordDialog</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/KIO.AuthInfo.html">KIO.AuthInfo</a> </td>
<td class="paramname"><em>info</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>errorMsg=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Prompt the user for Authorization info (login & password).
</p>
<p>
Use this function to request authorization information from
the end user. You can also pass an error message which explains
why a previous authorization attempt failed. Here is a very
simple example:
</p>
<p>
<pre class="fragment">
KIO.AuthInfo authInfo;
if ( openPasswordDialog( authInfo ) )
{
kDebug() << QLatin1String("User: ")
<< authInfo.username << endl;
kDebug() << QLatin1String("Password: ")
<< QLatin1String("Not displayed here!") << endl;
}
</pre>
</p>
<p>
You can also preset some values like the username, caption or
comment as follows:
</p>
<p>
<pre class="fragment">
KIO.AuthInfo authInfo;
authInfo.caption= "Acme Password Dialog";
authInfo.username= "Wile E. Coyote";
QString errorMsg = "You entered an incorrect password.";
if ( openPasswordDialog( authInfo, errorMsg ) )
{
kDebug() << QLatin1String("User: ")
<< authInfo.username << endl;
kDebug() << QLatin1String("Password: ")
<< QLatin1String("Not displayed here!") << endl;
}
</pre>
</p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> You should consider using checkCachedAuthentication() to
see if the password is available in kpasswdserver before calling
this function.
</dd></dl> </p>
<p>
<dl class="note" compact><dt><b>Note:</b></dt><dd> A call to this function can fail and return <b>false,</b>
if the UIServer could not be started for whatever reason.
</dd></dl> </p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> checkCachedAuthentication
</dd></dl> </p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>info</em> </td><td> See AuthInfo.
<tr><td></td><td valign="top"><em>errorMsg</em> </td><td> Error message to show
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> <b>true</b> if user clicks on "OK", <b>false</b> otherwsie.
</dd></dl>
</p></div></div><a class="anchor" name="opened"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> opened</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>open succedes
<dl class="see" compact><dt><b>See also:</b></dt><dd> open
</dd></dl>
</p></div></div><a class="anchor" name="position"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> position</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/KIO.filesize_t.html">KIO.filesize_t</a> </td>
<td class="paramname"><em>_pos</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="processedPercent"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> processedPercent</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">float </td>
<td class="paramname"><em>percent</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Only use this if you can't know in advance the size of the
copied data. For example, if you're doing variable bitrate
compression of the source.
</p>
<p>
STUB ! Currently unimplemented. Here now for binary compatibility.
</p>
<p>
Call this during get and copy, once in a while,
to give some info about the current state.
Don't emit it in listDir, listEntries speaks for itself.
</p></div></div><a class="anchor" name="processedSize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> processedSize</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/KIO.filesize_t.html">KIO.filesize_t</a> </td>
<td class="paramname"><em>_bytes</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call this during get and copy, once in a while,
to give some info about the current state.
Don't emit it in listDir, listEntries speaks for itself.
</p></div></div><a class="anchor" name="proxyConnectTimeout"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int proxyConnectTimeout</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> timeout value for connecting to proxy in secs.
</dd></dl>
</p></div></div><a class="anchor" name="put"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> put</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>permissions</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.JobFlags.html">KIO.JobFlags</a> </td>
<td class="paramname"><em>flags</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>put, i.e. write data into a file.
</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>url</em> </td><td> where to write the file
<tr><td></td><td valign="top"><em>permissions</em> </td><td> may be -1. In this case no special permission mode is set.
<tr><td></td><td valign="top"><em>flags:</em> </td><td> We support Overwrite here. Hopefully, we're going to
support Resume in the future, too.
If the file indeed already exists, the slave should NOT apply the
permissions change to it.
The support for resuming using .part files is done by calling canResume().
</td></tr>
</table></dl>
<p> IMPORTANT: Use the "modified" metadata in order to set the modification time of the file.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> canResume()
</dd></dl>
</p></div></div><a class="anchor" name="read"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> read</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/KIO.filesize_t.html">KIO.filesize_t</a> </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"></div></div><a class="anchor" name="readData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int readData</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/qbytearray.html">QByteArray</a> </td>
<td class="paramname"><em>buffer</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Read data sent by the job, after a dataReq
</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>buffer</em> </td><td> buffer where data is stored
</td></tr> </table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> 0 on end of data,
> 0 bytes read
< 0 error
</dd></dl>
</p></div></div><a class="anchor" name="readTimeout"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int readTimeout</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> timeout value for read from subsequent data from
remote host in secs.
</dd></dl>
</p></div></div><a class="anchor" name="redirection"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> redirection</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>_url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call this to signal a redirection
The job will take care of going to that url.
</p></div></div><a class="anchor" name="remoteEncoding"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"><a href="../kio/KRemoteEncoding.html">KRemoteEncoding</a> remoteEncoding</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 an object that can translate remote filenames into proper
Unicode forms. This encoding can be set by the user.
</p></div></div><a class="anchor" name="rename"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> rename</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>src</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.JobFlags.html">KIO.JobFlags</a> </td>
<td class="paramname"><em>flags</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Rename <b>oldname</b> into <b>newname.</b>
If the slave returns an error ERR_UNSUPPORTED_ACTION, the job will
ask for copy + del instead.
</p>
<p>
Important: the slave must implement the logic "if the destination already
exists, error ERR_DIR_ALREADY_EXIST or ERR_FILE_ALREADY_EXIST".
For performance reasons no stat is done in the destination before hand,
the slave must do it.
</p>
<p>
By default, rename() is only called when renaming (moving) from
yourproto://host/path to yourproto://host/otherpath.
</p>
<p>
If you set renameFromFile=true then rename() will also be called when
moving a file from file:path to yourproto://host/otherpath.
Otherwise such a move would have to be done the slow way (copy+delete).
See KProtocolManager.canRenameFromFile() for more details.
</p>
<p>
If you set renameToFile=true then rename() will also be called when
moving a file from yourproto: to file:.
See KProtocolManager.canRenameToFile() for more details.
</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>src</em> </td><td> where to move the file from
<tr><td></td><td valign="top"><em>dest</em> </td><td> where to move the file to
<tr><td></td><td valign="top"><em>flags:</em> </td><td> We support Overwrite here
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="reparseConfiguration"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> reparseConfiguration</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>Called by the scheduler to tell the slave that the configuration
changed (i.e. proxy settings) .
</p></div></div><a class="anchor" name="requestNetwork"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool requestNetwork</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>host=QString()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Used by the slave to check if it can connect
to a given host. This should be called where the slave is ready
to do a .connect() on a socket. For each call to
requestNetwork must exist a matching call to
dropNetwork, or the system will stay online until
KNetMgr gets closed (or the SlaveBase gets destructed)!
</p>
<p>
If KNetMgr is not running, then this is a no-op and returns true
</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>host</em> </td><td> tells the netmgr the host the slave wants to connect
to. As this could also be a proxy, we can't just take
the host currenctly connected to (but that's the default
value)
</td></tr>
</table></dl>
<p> <dl class="return" compact><dt><b>Returns:</b></dt><dd> true in theorie, the host is reachable
false the system is offline and the host is in a remote network.
</dd></dl>
</p></div></div><a class="anchor" name="responseTimeout"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int responseTimeout</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><dl class="return" compact><dt><b>Returns:</b></dt><dd> timeout value for read from first data from
remote host in seconds.
</dd></dl>
</p></div></div><a class="anchor" name="seek"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> seek</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/KIO.filesize_t.html">KIO.filesize_t</a> </td>
<td class="paramname"><em>offset</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="sendAndKeepMetaData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> sendAndKeepMetaData</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>Internal function to transmit meta data to the application.
Like sendMetaData() but m_outgoingMetaData will not be cleared.
This method is mainly useful in code that runs before the slave is connected
to its final job.
</p></div></div><a class="anchor" name="sendMetaData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> sendMetaData</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>Internal function to transmit meta data to the application.
m_outgoingMetaData will be cleared; this means that if the slave is for
example put on hold and picked up by a different KIO.Job later the new
job will not see the metadata sent before.
See kio/DESIGN.krun for an overview of the state
progression of a job/slave.
<dl class="warning" compact><dt><b>Warning:</b></dt><dd> calling this method may seriously interfere with the operation
of KIO which relies on the presence of some metadata at some points in time.
You should not use it if you are not familiar with KIO and not before
the slave is connected to the last job before returning to idle state.
</dd></dl>
</p></div></div><a class="anchor" name="setHost"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setHost</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>host</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>port</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>pass</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Set the host
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>host</em> </td><td>
<tr><td></td><td valign="top"><em>port</em> </td><td>
<tr><td></td><td valign="top"><em>user</em> </td><td>
<tr><td></td><td valign="top"><em>pass</em> </td><td>
Called directly by createSlave, this is why there is no equivalent in
SlaveInterface, unlike the other methods.
</td></tr>
</table></dl>
<p> This method is called whenever a change in host, port or user occurs.
</p></div></div><a class="anchor" name="setKillFlag"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setKillFlag</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>Internally used.
<dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="setLinkDest"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setLinkDest</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</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></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Change the destination of a symlink
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>url</em> </td><td> the url of the symlink to modify
<tr><td></td><td valign="top"><em>target</em> </td><td> the new destination (target) of the symlink
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setMetaData"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setMetaData</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>key</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>value</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets meta-data to be send to the application before the first
data() or finished() signal.
</p></div></div><a class="anchor" name="setModificationTime"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setModificationTime</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qdatetime.html">QDateTime</a> </td>
<td class="paramname"><em>mtime</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets the modification time for <b>url</b>
For instance this is what CopyJob uses to set mtime on dirs at the end of a copy.
It could also be used to set the mtime on any file, in theory.
The usual implementation on unix is to call utime(path, &myutimbuf).
The slave emits ERR_DOES_NOT_EXIST or ERR_CANNOT_SETTIME
</p></div></div><a class="anchor" name="setSubUrl"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setSubUrl</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Prepare slave for streaming operation
</p></div></div><a class="anchor" name="setTimeoutSpecialCommand"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setTimeoutSpecialCommand</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">int </td>
<td class="paramname"><em>timeout</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> </td>
<td class="paramname"><em>data=QByteArray()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>This function sets a timeout of <b>timeout</b> seconds and calls
special(data) when the timeout occurs as if it was called by the
application.
</p>
<p>
A timeout can only occur when the slave is waiting for a command
from the application.
</p>
<p>
Specifying a negative timeout cancels a pending timeout.
</p>
<p>
Only one timeout at a time is supported, setting a timeout
cancels any pending timeout.
</p></div></div><a class="anchor" name="slaveStatus"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> slaveStatus</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>host</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"><em>connected</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Used to report the status of the slave.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>host</em> </td><td> the slave is currently connected to. (Should be
empty if not connected)
<tr><td></td><td valign="top"><em>connected</em> </td><td> Whether an actual network connection exists.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="slave_status"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> slave_status</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>Called to get the status of the slave. Slave should respond
by calling slaveStatus(...)
</p></div></div><a class="anchor" name="special"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> special</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/qbytearray.html">QByteArray</a> </td>
<td class="paramname"><em>data</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Used for any command that is specific to this slave (protocol)
Examples are : HTTP POST, mount and unmount (kio_file)
</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>data</em> </td><td> packed data; the meaning is completely dependent on the
slave, but usually starts with an int for the command number.
Document your slave's commands, at least in its header file.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="speed"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> speed</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>_bytes_per_second</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call this in get and copy, to give the current transfer
speed, but only if it can't be calculated out of the size you
passed to processedSize (in most cases you don't want to call it)
</p></div></div><a class="anchor" name="stat"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> stat</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="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>url</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Finds all details for one file or directory.
The information returned is the same as what listDir returns,
but only for one file or directory.
Call statEntry() after creating the appropriate UDSEntry for this
url.
</p>
<p>
You can use the "details" metadata to optimize this method to only
do as much work as needed by the application.
By default details is 2 (all details wanted, including modification time, size, etc.),
details==1 is used when deleting: we don't need all the information if it takes
too much time, no need to follow symlinks etc.
details==0 is used for very simple probing: we'll only get the answer
"it's a file or a directory (or a symlink), or it doesn't exist".
</p></div></div><a class="anchor" name="statEntry"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> statEntry</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/KIO.UDSEntry.html">KIO.UDSEntry</a> </td>
<td class="paramname"><em>_entry</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call this from stat() to express details about an object, the
UDSEntry customarily contains the atoms describing file name, size,
mimetype, etc.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>_entry</em> </td><td> The UDSEntry containing all of the object attributes.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="symlink"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> symlink</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>target</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KUrl.html">KUrl</a> </td>
<td class="paramname"><em>dest</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kio/KIO.JobFlags.html">KIO.JobFlags</a> </td>
<td class="paramname"><em>flags</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 symbolic link named <b>dest,</b> pointing to <b>target,</b> which
may be a relative or an absolute path.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>target</em> </td><td> The string that will become the "target" of the link (can be relative)
<tr><td></td><td valign="top"><em>dest</em> </td><td> The symlink to create.
<tr><td></td><td valign="top"><em>flags:</em> </td><td> We support Overwrite here
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="totalSize"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> totalSize</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/KIO.filesize_t.html">KIO.filesize_t</a> </td>
<td class="paramname"><em>_bytes</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call this in get and copy, to give the total size
of the file
Call in listDir too, when you know the total number of items.
</p></div></div><a class="anchor" name="waitForAnswer"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int, int pCmd waitForAnswer</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">int </td>
<td class="paramname"><em>expected1</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>expected2</em>, </td>
</tr>
<tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qbytearray.html">QByteArray</a> </td>
<td class="paramname"><em>data</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Wait for an answer to our request, until we get <b>expected1</b> or <b>expected2</b>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> the result from readData, as well as the cmd in *pCmd if set, and the data in <b>data</b>
</dd></dl>
</p></div></div><a class="anchor" name="waitForHostInfo"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">int waitForHostInfo</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">QHostInfo </td>
<td class="paramname"><em>info</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Internally used
<dl class="internal" compact><dt><b>Internal:</b></dt><dd>
</dd></dl>
</p></div></div><a class="anchor" name="warning"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> warning</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>msg</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call to signal a warning, to be displayed in a dialog box.
</p></div></div><a class="anchor" name="wasKilled"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool wasKilled</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 your ioslave was killed by a signal, wasKilled() returns true.
Check it regularly in lengthy functions (e.g. in get();) and return
as fast as possible from this function if wasKilled() returns true.
This will ensure that your slave destructor will be called correctly.
</p></div></div><a class="anchor" name="write"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> write</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/qbytearray.html">QByteArray</a> </td>
<td class="paramname"><em>data</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="written"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> written</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/KIO.filesize_t.html">KIO.filesize_t</a> </td>
<td class="paramname"><em>_bytes</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"></div></div><hr><h2>Enumeration Documentation</h2><a class="anchor" name="MessageBoxType"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr><td class="memname">MessageBoxType</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>QuestionYesNo</em> = 1</td><td><tr><td valign="top"><em>WarningYesNo</em> = 2</td><td><tr><td valign="top"><em>WarningContinueCancel</em> = 3</td><td><tr><td valign="top"><em>WarningYesNoCancel</em> = 4</td><td><tr><td valign="top"><em>Information</em> = 5</td><td><tr><td valign="top"><em>SSLMessageBox</em> = 6</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
>
822
