<?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>KParts.ReadWritePart</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>ReadWritePart Class Reference</h1>
<code>from PyKDE4.kparts import *</code>
<p>
Inherits: KParts.ReadOnlyPart → KParts.Part → <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><br />
Namespace: KParts.ReadWritePart<br />
<h2>Detailed Description</h2>
<p>Base class for an "editor" part.
</p>
<p>
This class handles network transparency for you.
Anything that can open a URL, allow modifications, and save
(to the same URL or a different one).
</p>
<p>
A read-write part can be set to read-only mode, using setReadWrite().
</p>
<p>
Part writers :
Any part inheriting ReadWritePart should check isReadWrite
before allowing any action that modifies the part.
The part probably wants to reimplement setReadWrite, disable those
actions. Don't forget to call the parent setReadWrite.
</p>
<table border="0" cellpadding="0" cellspacing="0"><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="#ReadWritePart">__init__</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a> parent=0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#ReadWritePart">__init__</a> (self, <a href="../kparts/KParts.ReadWritePart.html">KParts.ReadWritePart</a> a0)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#closeUrl">closeUrl</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#closeUrl">closeUrl</a> (self, bool promptToSave)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isModified">isModified</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#isReadWrite">isReadWrite</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#queryClose">queryClose</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#save">save</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#saveAs">saveAs</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="#saveFile">saveFile</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#saveToUrl">saveToUrl</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setModified">setModified</a> (self, bool modified)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setModified">setModified</a> (self)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="#setReadWrite">setReadWrite</a> (self, bool readwrite=1)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="#waitSaveComplete">waitSaveComplete</a> (self)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="ReadWritePart"></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/qobject.html">QObject</a> </td>
<td class="paramname"><em>parent=0</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Constructor
See parent constructor for instructions.
</p></div></div><a class="anchor" name="ReadWritePart"></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="../kparts/KParts.ReadWritePart.html">KParts.ReadWritePart</a> </td>
<td class="paramname"><em>a0</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="closeUrl"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool closeUrl</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 method instead of the above if you need control if
the save prompt is shown. For example, if you call queryClose()
from KMainWindow.queryClose(), you would not want to prompt
again when closing the url.
</p>
<p>
Equivalent to promptToSave ? closeUrl() : ReadOnlyPart.closeUrl()
</p></div></div><a class="anchor" name="closeUrl"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool closeUrl</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">bool </td>
<td class="paramname"><em>promptToSave</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 method instead of the above if you need control if
the save prompt is shown. For example, if you call queryClose()
from KMainWindow.queryClose(), you would not want to prompt
again when closing the url.
</p>
<p>
Equivalent to promptToSave ? closeUrl() : ReadOnlyPart.closeUrl()
</p></div></div><a class="anchor" name="isModified"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isModified</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> true if the document has been modified.
</dd></dl>
</p></div></div><a class="anchor" name="isReadWrite"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool isReadWrite</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> true if the part is in read-write mode
</dd></dl>
</p></div></div><a class="anchor" name="queryClose"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool queryClose</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 the document has been modified, ask the user to save changes.
This method is meant to be called from KMainWindow.queryClose().
It will also be called from closeUrl().
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true if closeUrl() can be called without the user losing
important data, false if the user chooses to cancel.
</dd></dl>
</p></div></div><a class="anchor" name="save"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool save</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>Save the file in the location from which it was opened.
You can connect this to the "save" action.
Calls saveFile() and saveToUrl(), no need to reimplement.
</p></div></div><a class="anchor" name="saveAs"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool saveAs</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>Save the file to a new location.
</p>
<p>
Calls save(), no need to reimplement
</p></div></div><a class="anchor" name="saveFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool saveFile</td>
<td>(</td>
<td class="paramtype"> </td>
<td class="paramname"><em>self</em> )</td>
<td width="100%"> </td>
</tr>
</table>
</div>
<div class="memdoc"><dl compact><dt><b>Abstract method:</b></dt><dd>This method is abstract and can be overridden but not called directly.</dd></dl><p>Save to a local file.
You need to implement it, to save to the local file.
The framework takes care of re-uploading afterwards.
</p>
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, false on failure.
On failure the function should inform the user about the
problem with an appropriate message box. Standard error
messages can be constructed using KIO.buildErrorString()
in combination with the error codes defined in kio/global.h
</dd></dl>
</p></div></div><a class="anchor" name="saveToUrl"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool saveToUrl</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>Save the file.
</p>
<p>
Uploads the file, if <b>url</b> is remote.
This will emit started(), and either completed() or canceled(),
in case you want to provide feedback.
<dl class="return" compact><dt><b>Returns:</b></dt><dd> true on success, false on failure.
</dd></dl>
</p></div></div><a class="anchor" name="setModified"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setModified</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">bool </td>
<td class="paramname"><em>modified</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Call setModified() whenever the contents get modified.
This is a slot for convenience, since it simply calls setModified(true),
so that you can connect it to a signal, like textChanged().
</p></div></div><a class="anchor" name="setModified"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setModified</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 setModified() whenever the contents get modified.
This is a slot for convenience, since it simply calls setModified(true),
so that you can connect it to a signal, like textChanged().
</p></div></div><a class="anchor" name="setReadWrite"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setReadWrite</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">bool </td>
<td class="paramname"><em>readwrite=1</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Changes the behavior of this part to readonly or readwrite.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>readwrite</em> </td><td> set to true to enable readwrite mode
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="waitSaveComplete"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">bool waitSaveComplete</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>Waits for any pending upload job to finish and returns whether the
last save() action was successful.
</p></div></div>
</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
>
921
