Sophie

Sophie

distrib > Fedora > 15 > i386 > by-pkgid > 1f9eb832ba1e4b88d9a5c2b384813bb4 > files > 6380

kdelibs3-apidocs-3.5.10-31.fc15.noarch.rpm

<?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_US" xml:lang="en_US">

<head>
  <title>kparts: KParts::ReadWritePart Class Reference (kparts)</title>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

  <meta http-equiv="Content-Style-Type" content="text/css" />

  <meta http-equiv="pics-label" content='(pics-1.1 "http://www.icra.org/ratingsv02.html" comment "ICRAonline DE v2.0" l gen true for "http://www.kde.org"  r (nz 1 vz 1 lz 1 oz 1 cb 1) "http://www.rsac.org/ratingsv01.html" l gen true for "http://www.kde.org"  r (n 0 s 0 v 0 l 0))' />

  <meta name="trademark" content="KDE e.V." />
  <meta name="description" content="K Desktop Environment Homepage, KDE.org" />
  <meta name="MSSmartTagsPreventParsing" content="true" />
  <meta name="robots" content="all" />

  <link rel="shortcut icon" href="../../favicon.ico" />

<link rel="stylesheet" media="screen" type="text/css" title="APIDOX" href="doxygen.css" />



</head>

<body>

<div id="nav_header_top" align="right">
  <a href="#content" class="doNotDisplay" accesskey="2">Skip to main content ::</a>

  <a href="../.."><img id="nav_header_logo" alt="Home" align="left" src="../../kde_gear_64.png" border="0" /></a>
  <span class="doNotDisplay">::</span>

  <div id="nav_header_title" align="left">KDE API Reference</div>


</div>

<div id="nav_header_bottom" align="right">
  <span class="doNotDisplay">:: <a href="#navigation" accesskey="5">Skip to Link Menu</a><br/></span>
  <div id="nav_header_bottom_right" style="text-align: left;">
/ <a href="../..">API Reference</a>
 / <a href=".">kparts</a>
  </div>
</div>


<table id="main" border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
      <td valign="top" class="menuheader" height="0"></td>

  <td id="contentcolumn" valign="top" rowspan="2" >
    <div id="content" style="padding-top: 0px;"><div style="width:100%; margin: 0px; padding: 0px;">
    <a name="content"></a>


<!-- Generated by Doxygen 1.7.4 -->
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><b>KParts</b>      </li>
      <li class="navelem"><a class="el" href="classKParts_1_1ReadWritePart.html">ReadWritePart</a>      </li>
    </ul>
  </div>
</div>
<div class="header">
  <div class="summary">
<a href="#pub-slots">Public Slots</a> &#124;
<a href="#signals">Signals</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-slots">Protected Slots</a> &#124;
<a href="#pro-methods">Protected Member Functions</a>  </div>
  <div class="headertitle">
<div class="title">KParts::ReadWritePart Class Reference</div>  </div>
</div>
<div class="contents">
<!-- doxytag: class="KParts::ReadWritePart" --><!-- doxytag: inherits="KParts::ReadOnlyPart" -->
<p>Base class for an "editor" part.  
 <a href="classKParts_1_1ReadWritePart.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="part_8h_source.html">part.h</a>&gt;</code></p>
<div class="dynheader">
Inheritance diagram for KParts::ReadWritePart:</div>
<div class="dyncontent">
 <div class="center">
  <img src="classKParts_1_1ReadWritePart.png" usemap="#KParts::ReadWritePart_map" alt=""/>
  <map id="KParts::ReadWritePart_map" name="KParts::ReadWritePart_map">
<area href="classKParts_1_1ReadOnlyPart.html" title="Base class for any &quot;viewer&quot; part." alt="KParts::ReadOnlyPart" shape="rect" coords="73,168,209,192"/>
<area href="classKParts_1_1Part.html" title="Base class for parts." alt="KParts::Part" shape="rect" coords="73,112,209,136"/>
<area href="qobject.html" alt="QObject" shape="rect" coords="0,56,136,80"/>
<area href="classKParts_1_1PartBase.html" alt="KParts::PartBase" shape="rect" coords="146,56,282,80"/>
<area doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKXMLGUIClient.html" alt="KXMLGUIClient" shape="rect" coords="146,0,282,24"/>
</map>
 </div></div>

<p><a href="classKParts_1_1ReadWritePart-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-slots"></a>
Public Slots</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#af62573db9600db7c877a05f57d81f3e8">setModified</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#abd2f5a4ce68f32b6f21635b7f97ce63a">save</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#a93827f9da0f3fdcdbb2c53710afe43ae">waitSaveComplete</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="signals"></a>
Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#adb7caee3c74e13b22dd922f67a68f830">sigQueryClose</a> (bool *handled, bool *abortClosing)</td></tr>
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#ab9d9aa50244517b3e4b7360f7ca6427e">ReadWritePart</a> (<a class="elRef" href="qobject.html">QObject</a> *<a class="elRef" href="qobject.html#parent">parent</a>=0, const char *<a class="elRef" href="qobject.html#name">name</a>=0)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#ad69aa70703adae4f0973a002b3054e47">~ReadWritePart</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#a1f77bd8acc3596f59cd07fa7918dafb1">isReadWrite</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#a09288e0b4b17a2790e5375763d7bf72c">setReadWrite</a> (bool readwrite=true)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#a61acb87afb71c5cd7dcce295693e22e4">isModified</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#a51ead3990f91223ed2ebeb8dfa0d60ec">queryClose</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#a58fa38e57de201a227b1e00c66947c32">closeURL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#a4ed64cb4e0328977c747da05eebf0b5a">closeURL</a> (bool promptToSave)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#a22aad3951888316852f482355bf4f1d2">saveAs</a> (const <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> &amp;url)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#a8d6fe0168095b3333dc80884888f02f2">setModified</a> (bool modified)</td></tr>
<tr><td colspan="2"><h2><a name="pro-slots"></a>
Protected Slots</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adc0ecb0c77f2bc56d725d69b738f3d7a"></a><!-- doxytag: member="KParts::ReadWritePart::slotUploadFinished" ref="adc0ecb0c77f2bc56d725d69b738f3d7a" args="(KIO::Job *job)" -->
void&#160;</td><td class="memItemRight" valign="bottom"><b>slotUploadFinished</b> (KIO::Job *job)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#a599af24081c3dc1c261c04dce1de4f41">saveFile</a> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadWritePart.html#a2c0edc21fbf53acc7ebda46cc518edfe">saveToURL</a> ()</td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><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 <a class="el" href="classKParts_1_1ReadWritePart.html#a09288e0b4b17a2790e5375763d7bf72c" title="Changes the behavior of this part to readonly or readwrite.">setReadWrite()</a>.</p>
<p><a class="el" href="classKParts_1_1Part.html" title="Base class for parts.">Part</a> writers : Any part inheriting <a class="el" href="classKParts_1_1ReadWritePart.html" title="Base class for an &quot;editor&quot; part.">ReadWritePart</a> should check <a class="el" href="classKParts_1_1ReadWritePart.html#a1f77bd8acc3596f59cd07fa7918dafb1">isReadWrite()</a> 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 <a class="el" href="classKParts_1_1ReadWritePart.html#a09288e0b4b17a2790e5375763d7bf72c" title="Changes the behavior of this part to readonly or readwrite.">setReadWrite()</a>. </p>

<p>Definition at line <a class="el" href="part_8h_source.html#l00544">544</a> of file <a class="el" href="part_8h_source.html">part.h</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="ab9d9aa50244517b3e4b7360f7ca6427e"></a><!-- doxytag: member="KParts::ReadWritePart::ReadWritePart" ref="ab9d9aa50244517b3e4b7360f7ca6427e" args="(QObject *parent=0, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ReadWritePart::ReadWritePart </td>
          <td>(</td>
          <td class="paramtype"><a class="elRef" href="qobject.html">QObject</a> *&#160;</td>
          <td class="paramname"><em>parent</em> = <code>0</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const char *&#160;</td>
          <td class="paramname"><em>name</em> = <code>0</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Constructor. </p>
<p>See parent constructor for instructions. </p>

<p>Definition at line <a class="el" href="part_8cpp_source.html#l00447">447</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="ad69aa70703adae4f0973a002b3054e47"></a><!-- doxytag: member="KParts::ReadWritePart::~ReadWritePart" ref="ad69aa70703adae4f0973a002b3054e47" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">ReadWritePart::~ReadWritePart </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Destructor. </p>
<p>Applications using a <a class="el" href="classKParts_1_1ReadWritePart.html" title="Base class for an &quot;editor&quot; part.">ReadWritePart</a> should make sure, before destroying it, to call <a class="el" href="classKParts_1_1ReadWritePart.html#a58fa38e57de201a227b1e00c66947c32" title="Called when closing the current url (e.g.">closeURL()</a>. In <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKMainWindow.html#af8c5708414be62f259114b0453ef8432">KMainWindow::queryClose()</a>, for instance, they should allow closing only if the return value of <a class="el" href="classKParts_1_1ReadWritePart.html#a58fa38e57de201a227b1e00c66947c32" title="Called when closing the current url (e.g.">closeURL()</a> was true. This allows to cancel. </p>

<p>Definition at line <a class="el" href="part_8cpp_source.html#l00453">453</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a58fa38e57de201a227b1e00c66947c32"></a><!-- doxytag: member="KParts::ReadWritePart::closeURL" ref="a58fa38e57de201a227b1e00c66947c32" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ReadWritePart::closeURL </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Called when closing the current url (e.g. </p>
<p>document), for instance when switching to another url (note that <a class="el" href="classKParts_1_1ReadOnlyPart.html#a1717bbae9cbdfd38c6d9130914c29cd9" title="Only reimplement openURL if you don&#39;t want the network transparency support to download from the url ...">openURL()</a> calls it automatically in this case).</p>
<p>If the current URL is not fully loaded yet, aborts loading.</p>
<p>If <a class="el" href="classKParts_1_1ReadWritePart.html#a61acb87afb71c5cd7dcce295693e22e4">isModified()</a>, <a class="el" href="classKParts_1_1ReadWritePart.html#a51ead3990f91223ed2ebeb8dfa0d60ec" title="If the document has been modified, ask the user to save changes.">queryClose()</a> will be called.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>false on cancel </dd></dl>

<p>Reimplemented from <a class="el" href="classKParts_1_1ReadOnlyPart.html#ac93c4c7c3bd6133ae3c81a7d255cea58">KParts::ReadOnlyPart</a>.</p>

<p>Definition at line <a class="el" href="part_8cpp_source.html#l00525">525</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a4ed64cb4e0328977c747da05eebf0b5a"></a><!-- doxytag: member="KParts::ReadWritePart::closeURL" ref="a4ed64cb4e0328977c747da05eebf0b5a" args="(bool promptToSave)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ReadWritePart::closeURL </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>promptToSave</em></td><td>)</td>
          <td></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. </p>
<p>For example, if you call <a class="el" href="classKParts_1_1ReadWritePart.html#a51ead3990f91223ed2ebeb8dfa0d60ec" title="If the document has been modified, ask the user to save changes.">queryClose()</a> from <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKMainWindow.html#af8c5708414be62f259114b0453ef8432">KMainWindow::queryClose()</a>, you would not want to prompt again when closing the url.</p>
<p>Equivalent to promptToSave ? <a class="el" href="classKParts_1_1ReadWritePart.html#a58fa38e57de201a227b1e00c66947c32" title="Called when closing the current url (e.g.">closeURL()</a> : <a class="el" href="classKParts_1_1ReadOnlyPart.html#ac93c4c7c3bd6133ae3c81a7d255cea58" title="Called when closing the current url (e.g.">ReadOnlyPart::closeURL()</a></p>
<dl class="since"><dt><b>Since:</b></dt><dd>3.2 </dd></dl>

<p>Definition at line <a class="el" href="part_8cpp_source.html#l00537">537</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a61acb87afb71c5cd7dcce295693e22e4"></a><!-- doxytag: member="KParts::ReadWritePart::isModified" ref="a61acb87afb71c5cd7dcce295693e22e4" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool KParts::ReadWritePart::isModified </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the document has been modified. </dd></dl>

<p>Definition at line <a class="el" href="part_8h_source.html#l00577">577</a> of file <a class="el" href="part_8h_source.html">part.h</a>.</p>

</div>
</div>
<a class="anchor" id="a1f77bd8acc3596f59cd07fa7918dafb1"></a><!-- doxytag: member="KParts::ReadWritePart::isReadWrite" ref="a1f77bd8acc3596f59cd07fa7918dafb1" args="() const " -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool KParts::ReadWritePart::isReadWrite </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the part is in read-write mode </dd></dl>

<p>Definition at line <a class="el" href="part_8h_source.html#l00566">566</a> of file <a class="el" href="part_8h_source.html">part.h</a>.</p>

</div>
</div>
<a class="anchor" id="a51ead3990f91223ed2ebeb8dfa0d60ec"></a><!-- doxytag: member="KParts::ReadWritePart::queryClose" ref="a51ead3990f91223ed2ebeb8dfa0d60ec" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ReadWritePart::queryClose </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>If the document has been modified, ask the user to save changes. </p>
<p>This method is meant to be called from <a class="elRef" doxygen="kdeui.tag:../../kdeui/html/" href="../../kdeui/html/classKMainWindow.html#af8c5708414be62f259114b0453ef8432">KMainWindow::queryClose()</a>. It will also be called from <a class="el" href="classKParts_1_1ReadWritePart.html#a58fa38e57de201a227b1e00c66947c32" title="Called when closing the current url (e.g.">closeURL()</a>.</p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if <a class="el" href="classKParts_1_1ReadWritePart.html#a58fa38e57de201a227b1e00c66947c32" title="Called when closing the current url (e.g.">closeURL()</a> can be called without the user losing important data, false if the user chooses to cancel.</dd></dl>
<dl class="since"><dt><b>Since:</b></dt><dd>3.2 </dd></dl>

<p>Definition at line <a class="el" href="part_8cpp_source.html#l00483">483</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="abd2f5a4ce68f32b6f21635b7f97ce63a"></a><!-- doxytag: member="KParts::ReadWritePart::save" ref="abd2f5a4ce68f32b6f21635b7f97ce63a" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ReadWritePart::save </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual, slot]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Save the file in the location from which it was opened. </p>
<p>You can connect this to the "save" action. Calls <a class="el" href="classKParts_1_1ReadWritePart.html#a599af24081c3dc1c261c04dce1de4f41" title="Save to a local file.">saveFile()</a> and <a class="el" href="classKParts_1_1ReadWritePart.html#a2c0edc21fbf53acc7ebda46cc518edfe" title="Save the file.">saveToURL()</a>, no need to reimplement. </p>

<p>Definition at line <a class="el" href="part_8cpp_source.html#l00542">542</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a22aad3951888316852f482355bf4f1d2"></a><!-- doxytag: member="KParts::ReadWritePart::saveAs" ref="a22aad3951888316852f482355bf4f1d2" args="(const KURL &amp;url)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ReadWritePart::saveAs </td>
          <td>(</td>
          <td class="paramtype">const <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> &amp;&#160;</td>
          <td class="paramname"><em>url</em></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Save the file to a new location. </p>
<p>Calls <a class="el" href="classKParts_1_1ReadWritePart.html#abd2f5a4ce68f32b6f21635b7f97ce63a" title="Save the file in the location from which it was opened.">save()</a>, no need to reimplement </p>

<p>Definition at line <a class="el" href="part_8cpp_source.html#l00554">554</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a599af24081c3dc1c261c04dce1de4f41"></a><!-- doxytag: member="KParts::ReadWritePart::saveFile" ref="a599af24081c3dc1c261c04dce1de4f41" args="()=0" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">virtual bool KParts::ReadWritePart::saveFile </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [protected, pure virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Save to a local file. </p>
<p>You need to implement it, to save to <code>m_file</code>. The framework takes care of re-uploading afterwards.</p>
<dl class="return"><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>

</div>
</div>
<a class="anchor" id="a2c0edc21fbf53acc7ebda46cc518edfe"></a><!-- doxytag: member="KParts::ReadWritePart::saveToURL" ref="a2c0edc21fbf53acc7ebda46cc518edfe" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ReadWritePart::saveToURL </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [protected, virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Save the file. </p>
<p>Uploads the file, if <code>m_url</code> is remote. This will emit <a class="el" href="classKParts_1_1ReadOnlyPart.html#a1839e6f2741b7fca77cd4b04b5acdc6d" title="The part emits this when starting data.">started()</a>, and either <a class="el" href="classKParts_1_1ReadOnlyPart.html#a7dbe7a0dd64ed631d7d7fc763167de31" title="Emit this when you have completed loading data.">completed()</a> or <a class="el" href="classKParts_1_1ReadOnlyPart.html#ab1083f7c30e868d66e1f326b94851d8c" title="Emit this if loading is canceled by the user or by an error.">canceled()</a>, in case you want to provide feedback. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true on success, false on failure. </dd></dl>

<p>Definition at line <a class="el" href="part_8cpp_source.html#l00607">607</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a8d6fe0168095b3333dc80884888f02f2"></a><!-- doxytag: member="KParts::ReadWritePart::setModified" ref="a8d6fe0168095b3333dc80884888f02f2" args="(bool modified)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ReadWritePart::setModified </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>modified</em></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Sets the modified flag of the part. </p>

<p>Definition at line <a class="el" href="part_8cpp_source.html#l00467">467</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="af62573db9600db7c877a05f57d81f3e8"></a><!-- doxytag: member="KParts::ReadWritePart::setModified" ref="af62573db9600db7c877a05f57d81f3e8" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ReadWritePart::setModified </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [virtual, slot]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Call <a class="el" href="classKParts_1_1ReadWritePart.html#af62573db9600db7c877a05f57d81f3e8" title="Call setModified() whenever the contents get modified.">setModified()</a> whenever the contents get modified. </p>
<p>This is a slot for convenience, so that you can connect it to a signal, like textChanged(). </p>

<p>Definition at line <a class="el" href="part_8cpp_source.html#l00478">478</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="a09288e0b4b17a2790e5375763d7bf72c"></a><!-- doxytag: member="KParts::ReadWritePart::setReadWrite" ref="a09288e0b4b17a2790e5375763d7bf72c" args="(bool readwrite=true)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void ReadWritePart::setReadWrite </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>readwrite</em> = <code>true</code></td><td>)</td>
          <td><code> [virtual]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Changes the behavior of this part to readonly or readwrite. </p>
<dl><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">readwrite</td><td>set to true to enable readwrite mode </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="part_8cpp_source.html#l00461">461</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>

</div>
</div>
<a class="anchor" id="adb7caee3c74e13b22dd922f67a68f830"></a><!-- doxytag: member="KParts::ReadWritePart::sigQueryClose" ref="adb7caee3c74e13b22dd922f67a68f830" args="(bool *handled, bool *abortClosing)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void KParts::ReadWritePart::sigQueryClose </td>
          <td>(</td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>handled</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool *&#160;</td>
          <td class="paramname"><em>abortClosing</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td><code> [signal]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<dl class="since"><dt><b>Since:</b></dt><dd>3.2, remove in <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/namespaceKDE.html">KDE</a> 4, when queryClose is made virtual</dd></dl>
<p>set handled to true, if you don't want the default handling set abortClosing to true, if you handled the request, but for any reason don't want to allow closing the document </p>

</div>
</div>
<a class="anchor" id="a93827f9da0f3fdcdbb2c53710afe43ae"></a><!-- doxytag: member="KParts::ReadWritePart::waitSaveComplete" ref="a93827f9da0f3fdcdbb2c53710afe43ae" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool ReadWritePart::waitSaveComplete </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td><code> [slot]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Waits for any pending upload job to finish and returns whether the last <a class="el" href="classKParts_1_1ReadWritePart.html#abd2f5a4ce68f32b6f21635b7f97ce63a" title="Save the file in the location from which it was opened.">save()</a> action was successful. </p>

<p>Definition at line <a class="el" href="part_8cpp_source.html#l00685">685</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="part_8h_source.html">part.h</a></li>
<li><a class="el" href="part_8cpp_source.html">part.cpp</a></li>
</ul>
</div>
    </div></div>


      </td>
  </tr>
  <tr>
    <td valign="top" id="leftmenu" width="25%">
      <a name="navigation"></a>
      <div class="menu_box"><h2>kparts</h2>
<div class="nav_list">
<ul><li><a href="index.html">Main Page</a></li><li><a href="namespaces.html">Namespace List</a></li><li><a href="hierarchy.html">Class Hierarchy</a></li><li><a href="classes.html">Alphabetical List</a></li><li><a href="annotated.html">Class List</a></li><li><a href="files.html">File List</a></li><li><a href="namespacemembers.html">Namespace Members</a></li><li><a href="functions.html">Class Members</a></li></ul>
<!--
<h2>Class Picker</h2>
<div style="text-align: center;">
<form name="guideform">
<select name="guidelinks" style="width:100%;" onChange="window.location=document.guideform.guidelinks.options[document.guideform.guidelinks.selectedIndex].value">
<option value="annotated.html">-- Choose --</option>
  <option value="classKParts_1_1BrowserExtension.html">kparts::browserextension</option>,  <option value="classKParts_1_1BrowserHostExtension.html">kparts::browserhostextension</option>,  <option value="classKParts_1_1BrowserInterface.html">kparts::browserinterface</option>,  <option value="classKParts_1_1BrowserRun.html">kparts::browserrun</option>,  <option value="classKParts_1_1DockMainWindow.html">kparts::dockmainwindow</option>,  <option value="classKParts_1_1Event.html">kparts::event</option>,  <option value="classKParts_1_1Factory.html">kparts::factory</option>,  <option value="classKParts_1_1GenericFactory.html">kparts::genericfactory</option>,  <option value="classKParts_1_1GUIActivateEvent.html">kparts::guiactivateevent</option>,  <option value="classKParts_1_1HistoryProvider.html">kparts::historyprovider</option>,  <option value="classKParts_1_1LiveConnectExtension.html">kparts::liveconnectextension</option>,  <option value="classKParts_1_1MainWindow.html">kparts::mainwindow</option>,  <option value="classKParts_1_1OpenURLEvent.html">kparts::openurlevent</option>,  <option value="classKParts_1_1Part.html">kparts::part</option>,  <option value="classKParts_1_1PartActivateEvent.html">kparts::partactivateevent</option>,  <option value="classKParts_1_1PartBase.html">kparts::partbase</option>,  <option value="classKParts_1_1PartManager.html">kparts::partmanager</option>,  <option value="classKParts_1_1PartSelectEvent.html">kparts::partselectevent</option>,  <option value="classKParts_1_1Plugin.html">kparts::plugin</option>,  <option value="classKParts_1_1ReadOnlyPart.html">kparts::readonlypart</option>,  <option value="classKParts_1_1ReadWritePart.html">kparts::readwritepart</option>,  <option value="classKParts_1_1StatusBarExtension.html">kparts::statusbarextension</option>,
</select>
</form>
</div>
-->
</div></div>
<div class="menu_box"><h2>API Dox</h2>
<div class="nav_list">
<ul>
<li><a href="../../arts/html/index.html">arts</a></li><li><a href="../../dcop/html/index.html">dcop</a></li><li><a href="../../dnssd/html/index.html">dnssd</a></li><li><a href="../../interfaces/html/index.html">interfaces</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li>&nbsp;&nbsp;&nbsp;&nbsp;<a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li>&nbsp;&nbsp;<a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li>&nbsp;&nbsp;<a href="../../interfaces/ktexteditor/html/index.html">ktexteditor</a></li><li><a href="../../kabc/html/index.html">kabc</a></li><li><a href="../../kate/html/index.html">kate</a></li><li><a href="../../kcmshell/html/index.html">kcmshell</a></li><li><a href="../../kdecore/html/index.html">kdecore</a></li><li><a href="../../kded/html/index.html">kded</a></li><li><a href="../../kdefx/html/index.html">kdefx</a></li><li><a href="../../kdeprint/html/index.html">kdeprint</a></li><li><a href="../../kdesu/html/index.html">kdesu</a></li><li><a href="../../kdeui/html/index.html">kdeui</a></li><li><a href="../../kdoctools/html/index.html">kdoctools</a></li><li><a href="../../khtml/html/index.html">khtml</a></li><li><a href="../../kimgio/html/index.html">kimgio</a></li><li><a href="../../kinit/html/index.html">kinit</a></li><li><a href="../../kio/html/index.html">kio</a></li><li>&nbsp;&nbsp;<a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li>&nbsp;&nbsp;<a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li>&nbsp;&nbsp;<a href="../../kio/kfile/html/index.html">kfile</a></li><li>&nbsp;&nbsp;<a href="../../kio/kio/html/index.html">kio</a></li><li>&nbsp;&nbsp;<a href="../../kio/kioexec/html/index.html">kioexec</a></li><li>&nbsp;&nbsp;<a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li>&nbsp;&nbsp;<a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li>&nbsp;&nbsp;<a href="../../kioslave/http/html/index.html">http</a></li><li><a href="../../kjs/html/index.html">kjs</a></li><li><a href="../../kmdi/html/index.html">kmdi</a></li><li>&nbsp;&nbsp;<a href="../../kmdi/kmdi/html/index.html">kmdi</a></li><li><a href="../../knewstuff/html/index.html">knewstuff</a></li><li><a href="../../kparts/html/index.html">kparts</a></li><li><a href="../../kresources/html/index.html">kresources</a></li><li><a href="../../kspell2/html/index.html">kspell2</a></li><li><a href="../../kunittest/html/index.html">kunittest</a></li><li><a href="../../kutils/html/index.html">kutils</a></li><li><a href="../../kwallet/html/index.html">kwallet</a></li><li><a href="../../libkmid/html/index.html">libkmid</a></li><li><a href="../../libkscreensaver/html/index.html">libkscreensaver</a></li>
</ul></div></div>


        </td>
</tr>
</table>

<span class="doNotDisplay">
  <a href="http://www.kde.org/" accesskey="8">KDE Home</a> |
  <a href="http://accessibility.kde.org/" accesskey="9">KDE Accessibility Home</a> |
  <a href="http://www.kde.org/media/accesskeys.php" accesskey="0">Description of Access Keys</a>
</span>


<div style="height: 8px"></div>

<div id="footer">
  <div id="footer_left">
    Maintained by <a href="&#109;&#97;&#105;&#108;&#116;&#111;&#58;groo&#116;&#64;kde&#46;or&#x67;">Adriaan de Groot</a>
and
<a href="&#109;a&#105;&#108;&#116;&#111;&#58;w&#105;nter&#64;kde&#46;or&#x67">Allen Winter</a>.
<br/>
    KDE and K Desktop Environment are trademarks of <a href="http://www.kde.org/areas/kde-ev/" 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 id="footer_right"><img src="/media/images/footer_right.png" style="margin: 0px" alt="" /></div>
</div>

<!--
WARNING: DO NOT SEND MAIL TO THE FOLLOWING EMAIL ADDRESS! YOU WILL
BE BLOCKED INSTANTLY AND PERMANENTLY!
<a href="mailto:aaaatrap-425acc3b5374943f@kde.org">Block me</a>
WARNING END
-->

</body>
</html>