Sophie

Sophie

distrib > Mandriva > current > i586 > media > main-updates > by-pkgid > b77dda48f87d4eda8cc559e40c49a652 > files > 334

python-kde4-doc-4.4.5-0.2mdv2010.2.i586.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" xml:lang="en">

<head>
  <title>KTemporaryFile</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">&nbsp;</div>

<h1>KTemporaryFile Class Reference</h1>
<code>from PyKDE4.kdecore import *</code>
<p>
Inherits: <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qtemporaryfile.html">QTemporaryFile</a> &#x2192; <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qfile.html">QFile</a> &#x2192; <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qiodevice.html">QIODevice</a> &#x2192; <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qobject.html">QObject</a><br />


<h2>Detailed Description</h2>

<p>\class KTemporaryFile ktemporaryfile.h &lt;KTemporaryFile&gt;
</p>
<p>
A QTemporaryFile that will save in the KDE temp directory.
</p>
<p>
This class derives from QTemporaryFile and makes sure that your temporary
files go in the temporary directory defined by KDE. (This is retrieved by
using KStandardDirs to locate the "tmp" resource.) In general, whenever you
would use a QTemporaryFile() use a KTemporaryFile() instead.
</p>
<p>
By default the filename will start with your application's instance name,
followed by six random characters and an extension of ".tmp". You can use
setPrefix() and setSuffix() to change the beginning and ending of the random
name, as well as change the directory if you wish (read the descriptions of
these functions for more information). For complex specifications, you may
be better off calling QTemporaryFile.setFileTemplate() directly.
</p>
<p>
For example, let's make a new temporary file:
</p>
<p>
<pre class="fragment">
 KTemporaryFile temp;
</pre>
</p>
<p>
This temporary file will currently be stored in the default KDE temporary
directory and have an extension of ".tmp". Now, let's change the directory:
</p>
<p>
<pre class="fragment">
 temp.setPrefix("/var/lib/foodata/");
</pre>
</p>
<p>
Now the temporary file will be stored in "/var/lib/foodata" instead of the
default KDE temporary directory, with an extension of ".tmp". It's important
to remember the leading and trailing slashes to properly define the path!
Next, let's change the suffix to a particular extension:
</p>
<p>
<pre class="fragment">
 temp.setSuffix(".pdf");
</pre>
</p>
<p>
Now the temporary file will be stored in "/var/lib/foodata" and have an
extension of ".pdf" instead of ".tmp".
</p>
<p>
Once you are done determining the name of the file, call open() to
create the file.
</p>
<p>
<pre class="fragment">
 if ( !temp.open() ) {
     // handle error...
 }
</pre>
</p>
<p>
If open() is unable to create the file it will return false. If the call to
open() returns true you are ready to use your temporary file. If you don't
want the file removed automatically when the KTemporaryFile object is
destroyed, you need to call setAutoRemove(false), but make sure you have a
good reason for leaving your temp files around.
</p>
<p>
<dl class="see" compact><dt><b>See also:</b></dt><dd> QTemporaryFile
</dd></dl> </p>
<p>

<dl class="author" compact><dt><b>Author:</b></dt><dd> Jaison Lee &lt;lee.jaison@gmail.com&gt; </dd></dl>
</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">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#KTemporaryFile">__init__</a> (self, <a href="../kdecore/KComponentData.html">KComponentData</a> componentData=KGlobal.mainComponent())</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setPrefix">setPrefix</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> prefix)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="#setSuffix">setSuffix</a> (self, <a href="http://www.riverbankcomputing.co.uk/static/Docs/PyQt4/html/qstring.html">QString</a> suffix)</td></tr>
</table>
<hr><h2>Method Documentation</h2><a class="anchor" name="KTemporaryFile"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname">__init__</td>
<td>(</td>
<td class="paramtype">&nbsp;<em>self</em>, </td>
<td class="paramname"></td>
</tr><tr>
<td class="memname"></td>
<td></td>
<td class="paramtype"><a href="../kdecore/KComponentData.html">KComponentData</a>&nbsp;</td>
<td class="paramname"><em>componentData=KGlobal.mainComponent()</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Construct a new KTemporaryFile. The file will be stored in the temporary
directory configured in KDE. The default prefix is the value of the
default KDE temporary directory, plus your application's instance name.
The default suffix is ".tmp".
</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>componentData</em>&nbsp;</td><td> The KComponentData to use for the name of the file and to look up the
directory.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setPrefix"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setPrefix</td>
<td>(</td>
<td class="paramtype">&nbsp;<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>&nbsp;</td>
<td class="paramname"><em>prefix</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets a prefix to use when creating the file.
</p>
<p>
This function sets a prefix to use when creating the file. The random
part of the filename will come after this prefix. The prefix can also
change or modify the target directory. If <b>prefix</b> is an absolute
path it will override the default temporary directory. If <b>prefix</b> is
a relative directory it will be relative to the default temporary
location. To set a relative directory for the current working directory
you should use QTemporaryFile.setFileTemplate() directly.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>prefix</em>&nbsp;</td><td> The prefix to use when creating the file. Remember to
end the prefix with a '/' if you are designating a directory.
</td></tr>
</table></dl>
<p>
</p></div></div><a class="anchor" name="setSuffix"></a>
<div class="memitem">
<div class="memproto">
<table class="memname"><tr>
<td class="memname"> setSuffix</td>
<td>(</td>
<td class="paramtype">&nbsp;<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>&nbsp;</td>
<td class="paramname"><em>suffix</em></td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td>
<td></td>
<td width="100%"> </td>
</tr></table>
</div>
<div class="memdoc"><p>Sets a suffix to use when creating the file.
</p>
<p>
Sets a suffix to use when creating the file. The random part of the
filename will come before this suffix.
</p><dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td></td><td valign="top"><em>suffix</em>&nbsp;</td><td> The suffix to use when creating the file.
</td></tr>
</table></dl>
<p>
</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="&#109;&#97;&#105;&#108;&#116;&#111;&#58;simon&#64;simonzone&#46;com">Simon Edwards</a>.<br />
        KDE<sup>&#174;</sup> and <a href="../images/kde_gear_black.png">the K Desktop Environment<sup>&#174;</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>