<?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::ReadOnlyPart 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_1ReadOnlyPart.html">ReadOnlyPart</a> </li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-slots">Public Slots</a> |
<a href="#signals">Signals</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pro-slots">Protected Slots</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="#friends">Friends</a> </div>
<div class="headertitle">
<div class="title">KParts::ReadOnlyPart Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="KParts::ReadOnlyPart" --><!-- doxytag: inherits="KParts::Part" -->
<p>Base class for any "viewer" part.
<a href="classKParts_1_1ReadOnlyPart.html#details">More...</a></p>
<p><code>#include <<a class="el" href="part_8h_source.html">part.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for KParts::ReadOnlyPart:</div>
<div class="dyncontent">
<div class="center">
<img src="classKParts_1_1ReadOnlyPart.png" usemap="#KParts::ReadOnlyPart_map" alt=""/>
<map id="KParts::ReadOnlyPart_map" name="KParts::ReadOnlyPart_map">
<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"/>
<area href="classKParts_1_1ReadWritePart.html" title="Base class for an "editor" part." alt="KParts::ReadWritePart" shape="rect" coords="73,224,209,248"/>
</map>
</div></div>
<p><a href="classKParts_1_1ReadOnlyPart-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 bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#a1717bbae9cbdfd38c6d9130914c29cd9">openURL</a> (const <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> &url)</td></tr>
<tr><td colspan="2"><h2><a name="signals"></a>
Signals</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#a1839e6f2741b7fca77cd4b04b5acdc6d">started</a> (KIO::Job *)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#a7dbe7a0dd64ed631d7d7fc763167de31">completed</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#a48ddc679f4b303102237f8e33b29c904">completed</a> (bool pendingAction)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#ab1083f7c30e868d66e1f326b94851d8c">canceled</a> (const <a class="elRef" href="qstring.html">QString</a> &errMsg)</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"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#a7b282ec258bf759fb0bfd515ca593465">ReadOnlyPart</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#a9e6ac2807367409576ee2f4b369118e7">~ReadOnlyPart</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#a2d8af6ecaf7d70e2670af6420fee7af3">setProgressInfoEnabled</a> (bool show)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#a5bac89c69212a926becaada085ef609c">isProgressInfoEnabled</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac57cae74a71dc5457df027100c666448"></a><!-- doxytag: member="KParts::ReadOnlyPart::showProgressInfo" ref="ac57cae74a71dc5457df027100c666448" args="(bool show)" -->
void </td><td class="memItemRight" valign="bottom"><b>showProgressInfo</b> (bool show)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#acb4ef957a59d80168a38c4bf24d0dd11">url</a> () const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#ac93c4c7c3bd6133ae3c81a7d255cea58">closeURL</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#a8f8e34baa73c676564cc62de66661a1a">openStream</a> (const <a class="elRef" href="qstring.html">QString</a> &mimeType, const <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> &url)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#aea4c1981f0f9bea442450895a43b4bcb">writeStream</a> (const <a class="elRef" href="qbytearray.html">QByteArray</a> &data)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#aa828fc225a2f32563624053f80f40257">closeStream</a> ()</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="aed0957ebc51befa75f4d11edd5976238"></a><!-- doxytag: member="KParts::ReadOnlyPart::slotJobFinished" ref="aed0957ebc51befa75f4d11edd5976238" args="(KIO::Job *job)" -->
void </td><td class="memItemRight" valign="bottom"><b>slotJobFinished</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 </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#adcb2e097d01e4bf11b3eb040d366f9f5">openFile</a> ()=0</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa23121934cc4a6419a85d911142b2abc"></a><!-- doxytag: member="KParts::ReadOnlyPart::abortLoad" ref="aa23121934cc4a6419a85d911142b2abc" args="()" -->
void </td><td class="memItemRight" valign="bottom"><b>abortLoad</b> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#a5faf42b421d9fabc6f688a19f98652aa">guiActivateEvent</a> (<a class="el" href="classKParts_1_1GUIActivateEvent.html">GUIActivateEvent</a> *<a class="elRef" href="qobject.html#event">event</a>)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#abb12306b8cece9b06d37d73f54d9f61a">m_url</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="elRef" href="qstring.html">QString</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#a7f869d5891287f1374fe2c3264bcb7c1">m_file</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classKParts_1_1ReadOnlyPart.html#a506e9a103aa8bea1c4176b41e631b93e">m_bTemp</a></td></tr>
<tr><td colspan="2"><h2><a name="friends"></a>
Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a93249e7edfdea1ff59ef222a9ea336cc"></a><!-- doxytag: member="KParts::ReadOnlyPart::ReadWritePart" ref="a93249e7edfdea1ff59ef222a9ea336cc" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>ReadWritePart</b></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>Base class for any "viewer" part. </p>
<p>This class takes care of network transparency for you, in the simplest way (downloading to a temporary file, then letting the part load from the temporary file). To use the built-in network transparency, you only need to implement <a class="el" href="classKParts_1_1ReadOnlyPart.html#adcb2e097d01e4bf11b3eb040d366f9f5" title="If the part uses the standard implementation of openURL(), it must reimplement this, to open m_file.">openFile()</a>, not <a class="el" href="classKParts_1_1ReadOnlyPart.html#a1717bbae9cbdfd38c6d9130914c29cd9" title="Only reimplement openURL if you don't want the network transparency support to download from the url ...">openURL()</a>.</p>
<p>To implement network transparency differently (e.g. for progressive loading, like a web browser does for instance), or to prevent network transparency (but why would you do that?), you can override <a class="el" href="classKParts_1_1ReadOnlyPart.html#a1717bbae9cbdfd38c6d9130914c29cd9" title="Only reimplement openURL if you don't want the network transparency support to download from the url ...">openURL()</a>.</p>
<p>KParts Application can use the signals to show feedback while the URL is being loaded.</p>
<p><a class="el" href="classKParts_1_1ReadOnlyPart.html" title="Base class for any "viewer" part.">ReadOnlyPart</a> handles the window caption by setting it to the current URL (set in <a class="el" href="classKParts_1_1ReadOnlyPart.html#a1717bbae9cbdfd38c6d9130914c29cd9" title="Only reimplement openURL if you don't want the network transparency support to download from the url ...">openURL()</a>, and each time the part is activated). If you want another caption, set it in <a class="el" href="classKParts_1_1ReadOnlyPart.html#adcb2e097d01e4bf11b3eb040d366f9f5" title="If the part uses the standard implementation of openURL(), it must reimplement this, to open m_file.">openFile()</a> and (if the part might ever be used with a part manager) in <a class="el" href="classKParts_1_1ReadOnlyPart.html#a5faf42b421d9fabc6f688a19f98652aa" title="Reimplemented from Part, so that the window caption is set to the current url (decoded) when the part...">guiActivateEvent()</a> </p>
<p>Definition at line <a class="el" href="part_8h_source.html#l00338">338</a> of file <a class="el" href="part_8h_source.html">part.h</a>.</p>
</div><hr/><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" id="a7b282ec258bf759fb0bfd515ca593465"></a><!-- doxytag: member="KParts::ReadOnlyPart::ReadOnlyPart" ref="a7b282ec258bf759fb0bfd515ca593465" args="(QObject *parent=0, const char *name=0)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ReadOnlyPart::ReadOnlyPart </td>
<td>(</td>
<td class="paramtype"><a class="elRef" href="qobject.html">QObject</a> * </td>
<td class="paramname"><em>parent</em> = <code>0</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>name</em> = <code>0</code> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Constructor See also <a class="el" href="classKParts_1_1Part.html" title="Base class for parts.">Part</a> for the setXXX methods to call. </p>
<p>Definition at line <a class="el" href="part_8cpp_source.html#l00304">304</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a9e6ac2807367409576ee2f4b369118e7"></a><!-- doxytag: member="KParts::ReadOnlyPart::~ReadOnlyPart" ref="a9e6ac2807367409576ee2f4b369118e7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ReadOnlyPart::~ReadOnlyPart </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Destructor. </p>
<p>Definition at line <a class="el" href="part_8cpp_source.html#l00310">310</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="ab1083f7c30e868d66e1f326b94851d8c"></a><!-- doxytag: member="KParts::ReadOnlyPart::canceled" ref="ab1083f7c30e868d66e1f326b94851d8c" args="(const QString &errMsg)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KParts::ReadOnlyPart::canceled </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>errMsg</em></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Emit this if loading is canceled by the user or by an error. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">errMsg</td><td>the error message, empty if the user canceled the loading voluntarily. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="aa828fc225a2f32563624053f80f40257"></a><!-- doxytag: member="KParts::ReadOnlyPart::closeStream" ref="aa828fc225a2f32563624053f80f40257" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ReadOnlyPart::closeStream </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Terminate the sending of data to the part. </p>
<p>With some data types (text, html...) closeStream might never actually be called, in the case of continuous streams, for instance plain text or HTML data. </p>
<p>Definition at line <a class="el" href="part_8cpp_source.html#l00440">440</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="ac93c4c7c3bd6133ae3c81a7d255cea58"></a><!-- doxytag: member="KParts::ReadOnlyPart::closeURL" ref="ac93c4c7c3bd6133ae3c81a7d255cea58" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ReadOnlyPart::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't want the network transparency support to download from the url ...">openURL()</a> calls it automatically in this case). If the current URL is not fully loaded yet, aborts loading. Deletes the temporary file used when the url is remote. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>always true, but the return value exists for reimplementations </dd></dl>
<p>Reimplemented in <a class="el" href="classKParts_1_1ReadWritePart.html#a58fa38e57de201a227b1e00c66947c32">KParts::ReadWritePart</a>.</p>
<p>Definition at line <a class="el" href="part_8cpp_source.html#l00385">385</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a7dbe7a0dd64ed631d7d7fc763167de31"></a><!-- doxytag: member="KParts::ReadOnlyPart::completed" ref="a7dbe7a0dd64ed631d7d7fc763167de31" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KParts::ReadOnlyPart::completed </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Emit this when you have completed loading data. </p>
<p>Hosting apps will want to know when the process of loading the data is finished, so that they can access the data when everything is loaded. </p>
</div>
</div>
<a class="anchor" id="a48ddc679f4b303102237f8e33b29c904"></a><!-- doxytag: member="KParts::ReadOnlyPart::completed" ref="a48ddc679f4b303102237f8e33b29c904" args="(bool pendingAction)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KParts::ReadOnlyPart::completed </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>pendingAction</em></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Same as the above signal except it indicates whether there is a pending action to be executed on a delay timer. </p>
<p>An example of this is the meta-refresh tags on web pages used to reload/redirect after a certain period of time. This signal is useful if you want to give the user the ability to cancel such pending actions.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">pendingAction</td><td>true if a pending action exists, false otherwise. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a class="anchor" id="a5faf42b421d9fabc6f688a19f98652aa"></a><!-- doxytag: member="KParts::ReadOnlyPart::guiActivateEvent" ref="a5faf42b421d9fabc6f688a19f98652aa" args="(GUIActivateEvent *event)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ReadOnlyPart::guiActivateEvent </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classKParts_1_1GUIActivateEvent.html">GUIActivateEvent</a> * </td>
<td class="paramname"><em>event</em></td><td>)</td>
<td><code> [protected, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reimplemented from <a class="el" href="classKParts_1_1Part.html" title="Base class for parts.">Part</a>, so that the window caption is set to the current url (decoded) when the part is activated. </p>
<p>This is the usual behavior in 99% of the apps. Reimplement if you don't like it - test for event->activated() !</p>
<p>Technical note : this is done with <a class="el" href="classKParts_1_1GUIActivateEvent.html" title="This event is sent to a Part when its GUI has been activated or deactivated.">GUIActivateEvent</a> and not with <a class="el" href="classKParts_1_1PartActivateEvent.html" title="This event is sent by the part manager when the active part changes.">PartActivateEvent</a> because it's handled by the mainwindow (which gets the even after the <a class="el" href="classKParts_1_1PartActivateEvent.html" title="This event is sent by the part manager when the active part changes.">PartActivateEvent</a> events have been sent) </p>
<p>Reimplemented from <a class="el" href="classKParts_1_1Part.html#aac6f064a320fa83b31bf67520df3761f">KParts::Part</a>.</p>
<p>Definition at line <a class="el" href="part_8cpp_source.html#l00415">415</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a5bac89c69212a926becaada085ef609c"></a><!-- doxytag: member="KParts::ReadOnlyPart::isProgressInfoEnabled" ref="a5bac89c69212a926becaada085ef609c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ReadOnlyPart::isProgressInfoEnabled </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns whether the part shows the progress info dialog used by internal KIO job. </p>
<p>Definition at line <a class="el" href="part_8cpp_source.html#l00321">321</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="adcb2e097d01e4bf11b3eb040d366f9f5"></a><!-- doxytag: member="KParts::ReadOnlyPart::openFile" ref="adcb2e097d01e4bf11b3eb040d366f9f5" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool KParts::ReadOnlyPart::openFile </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td><code> [protected, pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If the part uses the standard implementation of <a class="el" href="classKParts_1_1ReadOnlyPart.html#a1717bbae9cbdfd38c6d9130914c29cd9" title="Only reimplement openURL if you don't want the network transparency support to download from the url ...">openURL()</a>, it must reimplement this, to open <code>m_file</code>. </p>
<p>Otherwise simply define it to { return false; } </p>
</div>
</div>
<a class="anchor" id="a8f8e34baa73c676564cc62de66661a1a"></a><!-- doxytag: member="KParts::ReadOnlyPart::openStream" ref="a8f8e34baa73c676564cc62de66661a1a" args="(const QString &mimeType, const KURL &url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ReadOnlyPart::openStream </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qstring.html">QString</a> & </td>
<td class="paramname"><em>mimeType</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> & </td>
<td class="paramname"><em>url</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Initiate sending data to this part. </p>
<p>This is an alternative to openURL, which allows the user of the part to load the data itself, and send it progressively to the part.</p>
<dl><dt><b>Parameters:</b></dt><dd>
<table class="params">
<tr><td class="paramname">mimeType</td><td>the type of data that is going to be sent to this part. </td></tr>
<tr><td class="paramname">url</td><td>the URL representing this data. Although not directly used, every <a class="el" href="classKParts_1_1ReadOnlyPart.html" title="Base class for any "viewer" part.">ReadOnlyPart</a> has a URL (see <a class="el" href="classKParts_1_1ReadOnlyPart.html#acb4ef957a59d80168a38c4bf24d0dd11" title="Returns the currently in part used URL.">url()</a>), so this simply sets it. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the part supports progressive loading and accepts data, false otherwise. </dd></dl>
<p>Definition at line <a class="el" href="part_8cpp_source.html#l00427">427</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1717bbae9cbdfd38c6d9130914c29cd9"></a><!-- doxytag: member="KParts::ReadOnlyPart::openURL" ref="a1717bbae9cbdfd38c6d9130914c29cd9" args="(const KURL &url)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ReadOnlyPart::openURL </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td><code> [virtual, slot]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Only reimplement openURL if you don't want the network transparency support to download from the url into a temporary file (when the url isn't local). </p>
<p>Otherwise, reimplement <a class="el" href="classKParts_1_1ReadOnlyPart.html#adcb2e097d01e4bf11b3eb040d366f9f5" title="If the part uses the standard implementation of openURL(), it must reimplement this, to open m_file.">openFile()</a> only .</p>
<p>If you reimplement it, don't forget to set the caption, usually with emit setWindowCaption( url.prettyURL() ); </p>
<p>Definition at line <a class="el" href="part_8cpp_source.html#l00333">333</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a2d8af6ecaf7d70e2670af6420fee7af3"></a><!-- doxytag: member="KParts::ReadOnlyPart::setProgressInfoEnabled" ref="a2d8af6ecaf7d70e2670af6420fee7af3" args="(bool show)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ReadOnlyPart::setProgressInfoEnabled </td>
<td>(</td>
<td class="paramtype">bool </td>
<td class="paramname"><em>show</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Call this to turn off the progress info dialog used by the internal KIO job. </p>
<p>Use this if you provide another way of displaying progress info (e.g. a statusbar), using the signals emitted by this class, and/or those emitted by the Job given by started. </p>
<p>Definition at line <a class="el" href="part_8cpp_source.html#l00316">316</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>
</div>
</div>
<a class="anchor" id="a1839e6f2741b7fca77cd4b04b5acdc6d"></a><!-- doxytag: member="KParts::ReadOnlyPart::started" ref="a1839e6f2741b7fca77cd4b04b5acdc6d" args="(KIO::Job *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void KParts::ReadOnlyPart::started </td>
<td>(</td>
<td class="paramtype">KIO::Job * </td>
<td class="paramname"></td><td>)</td>
<td><code> [signal]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>The part emits this when starting data. </p>
<p>If using a KIO::Job, it sets the job in the signal, so that progress information can be shown. Otherwise, job is 0. </p>
</div>
</div>
<a class="anchor" id="acb4ef957a59d80168a38c4bf24d0dd11"></a><!-- doxytag: member="KParts::ReadOnlyPart::url" ref="acb4ef957a59d80168a38c4bf24d0dd11" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> KParts::ReadOnlyPart::url </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Returns the currently in part used URL. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The current used URL. </dd></dl>
<p>Definition at line <a class="el" href="part_8h_source.html#l00390">390</a> of file <a class="el" href="part_8h_source.html">part.h</a>.</p>
</div>
</div>
<a class="anchor" id="aea4c1981f0f9bea442450895a43b4bcb"></a><!-- doxytag: member="KParts::ReadOnlyPart::writeStream" ref="aea4c1981f0f9bea442450895a43b4bcb" args="(const QByteArray &data)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ReadOnlyPart::writeStream </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="qbytearray.html">QByteArray</a> & </td>
<td class="paramname"><em>data</em></td><td>)</td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Send some data to the part. </p>
<p>openStream must have been called previously, and must have returned true. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if the data was accepted by the part. If false is returned, the application should stop sending data, and doesn't have to call closeStream. </dd></dl>
<p>Definition at line <a class="el" href="part_8cpp_source.html#l00435">435</a> of file <a class="el" href="part_8cpp_source.html">part.cpp</a>.</p>
</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a506e9a103aa8bea1c4176b41e631b93e"></a><!-- doxytag: member="KParts::ReadOnlyPart::m_bTemp" ref="a506e9a103aa8bea1c4176b41e631b93e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classKParts_1_1ReadOnlyPart.html#a506e9a103aa8bea1c4176b41e631b93e">KParts::ReadOnlyPart::m_bTemp</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>If <code>true</code>, <code>m_file</code> is a temporary file that needs to be deleted later. </p>
<p>Definition at line <a class="el" href="part_8h_source.html#l00523">523</a> of file <a class="el" href="part_8h_source.html">part.h</a>.</p>
</div>
</div>
<a class="anchor" id="a7f869d5891287f1374fe2c3264bcb7c1"></a><!-- doxytag: member="KParts::ReadOnlyPart::m_file" ref="a7f869d5891287f1374fe2c3264bcb7c1" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="qstring.html">QString</a> <a class="el" href="classKParts_1_1ReadOnlyPart.html#a7f869d5891287f1374fe2c3264bcb7c1">KParts::ReadOnlyPart::m_file</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Local file - the only one the part implementation should deal with. </p>
<p>Definition at line <a class="el" href="part_8h_source.html#l00519">519</a> of file <a class="el" href="part_8h_source.html">part.h</a>.</p>
</div>
</div>
<a class="anchor" id="abb12306b8cece9b06d37d73f54d9f61a"></a><!-- doxytag: member="KParts::ReadOnlyPart::m_url" ref="abb12306b8cece9b06d37d73f54d9f61a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" doxygen="kdecore.tag:../../kdecore/html/" href="../../kdecore/html/classKURL.html">KURL</a> <a class="el" href="classKParts_1_1ReadOnlyPart.html#abb12306b8cece9b06d37d73f54d9f61a">KParts::ReadOnlyPart::m_url</a><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Remote (or local) url - the one displayed to the user. </p>
<p>Definition at line <a class="el" href="part_8h_source.html#l00515">515</a> of file <a class="el" href="part_8h_source.html">part.h</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> <a href="../../interfaces/kimproxy/interface/html/index.html">interface</a></li><li> <a href="../../interfaces/kimproxy/library/html/index.html">library</a></li><li> <a href="../../interfaces/kspeech/html/index.html">kspeech</a></li><li> <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> <a href="../../kio/bookmarks/html/index.html">bookmarks</a></li><li> <a href="../../kio/httpfilter/html/index.html">httpfilter</a></li><li> <a href="../../kio/kfile/html/index.html">kfile</a></li><li> <a href="../../kio/kio/html/index.html">kio</a></li><li> <a href="../../kio/kioexec/html/index.html">kioexec</a></li><li> <a href="../../kio/kpasswdserver/html/index.html">kpasswdserver</a></li><li> <a href="../../kio/kssl/html/index.html">kssl</a></li><li><a href="../../kioslave/html/index.html">kioslave</a></li><li> <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> <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="mailto:groot@kde.org">Adriaan de Groot</a>
and
<a href="mailto:winter@kde.org">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>
