<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Vidalia: file.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="annotated.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>File Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_b47abd1aad201a152869566145babb61.html">src</a> » <a class="el" href="dir_3459d97d61361c9d41d467fba45f9c61.html">common</a>
</div>
</div>
<div class="contents">
<h1>file.h</h1><a href="file_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
<a name="l00002"></a>00002 <span class="comment">** This file is part of Vidalia, and is subject to the license terms in the</span>
<a name="l00003"></a>00003 <span class="comment">** LICENSE file, found in the top level directory of this distribution. If you</span>
<a name="l00004"></a>00004 <span class="comment">** did not receive the LICENSE file with this file, you may obtain it from the</span>
<a name="l00005"></a>00005 <span class="comment">** Vidalia source package distributed by the Vidalia Project at</span>
<a name="l00006"></a>00006 <span class="comment">** http://www.vidalia-project.net/. No part of Vidalia, including this file,</span>
<a name="l00007"></a>00007 <span class="comment">** may be copied, modified, propagated, or distributed except according to the</span>
<a name="l00008"></a>00008 <span class="comment">** terms described in the LICENSE file.</span>
<a name="l00009"></a>00009 <span class="comment">*/</span>
<a name="l00010"></a>00010
<a name="l00011"></a>00011 <span class="comment">/*</span>
<a name="l00012"></a>00012 <span class="comment">** \file file.h</span>
<a name="l00013"></a>00013 <span class="comment">** \version $Id: file.h 3505 2009-02-03 02:21:55Z edmanm $</span>
<a name="l00014"></a>00014 <span class="comment">** \brief Functions and definitions for common file I/O operations</span>
<a name="l00015"></a>00015 <span class="comment">*/</span>
<a name="l00016"></a>00016
<a name="l00017"></a>00017 <span class="preprocessor">#ifndef _FILE_H</span>
<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define _FILE_H</span>
<a name="l00019"></a>00019 <span class="preprocessor"></span>
<a name="l00020"></a>00020 <span class="preprocessor">#include <QString></span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="comment"></span>
<a name="l00023"></a>00023 <span class="comment">/** Create an empty file named <b>filename</b>. if <b>createdir</b> is true,</span>
<a name="l00024"></a>00024 <span class="comment"> * then the full path to <b>filename</b> will be created. Returns true on </span>
<a name="l00025"></a>00025 <span class="comment"> * success, or false on error and <b>errmsg</b> will be set. */</span>
<a name="l00026"></a>00026 <span class="keywordtype">bool</span> <a class="code" href="file_8cpp.html#a78d929c62dc850cf52672fa1904729b5">touch_file</a>(<span class="keyword">const</span> QString &filename, <span class="keywordtype">bool</span> createdir = <span class="keyword">false</span>,
<a name="l00027"></a>00027 QString *errmsg = 0);
<a name="l00028"></a>00028 <span class="comment"></span>
<a name="l00029"></a>00029 <span class="comment">/** Creates all directories in <b>path</b>, if they do not exist. */</span>
<a name="l00030"></a>00030 <span class="keywordtype">bool</span> <a class="code" href="file_8cpp.html#ae15354f79a89888da691222de003851f">create_path</a>(<span class="keyword">const</span> QString &path);
<a name="l00031"></a>00031 <span class="comment"></span>
<a name="l00032"></a>00032 <span class="comment">/** Expands <b>filename</b> if it starts with "~/". On Windows, this will</span>
<a name="l00033"></a>00033 <span class="comment"> * expand "%APPDATA%" and "%PROGRAMFILES%". If <b>filename</b> does not</span>
<a name="l00034"></a>00034 <span class="comment"> * start with a shortcut, <b>filename</b> will be returned unmodified. */</span>
<a name="l00035"></a>00035 QString <a class="code" href="file_8cpp.html#aaa3960262cc91df6d2400eb7ba888ae5">expand_filename</a>(<span class="keyword">const</span> QString &filename);
<a name="l00036"></a>00036 <span class="comment"></span>
<a name="l00037"></a>00037 <span class="comment">/** Recursively copy the contents of one directory to another. The</span>
<a name="l00038"></a>00038 <span class="comment"> * destination must already exist. Returns true on success, and false</span>
<a name="l00039"></a>00039 <span class="comment"> * otherwise. */</span>
<a name="l00040"></a>00040 <span class="keywordtype">bool</span> <a class="code" href="file_8cpp.html#a80dd03f007cf94c4222a6b6e1f5b4c38">copy_dir</a>(<span class="keyword">const</span> QString &source, <span class="keyword">const</span> QString &dest);
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="preprocessor">#endif</span>
<a name="l00043"></a>00043 <span class="preprocessor"></span>
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Mon Aug 30 22:58:54 2010 for Vidalia by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
