<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.4"/>
<title>ClanLib: virtual_directory_listing.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ClanLib
 <span id="projectnumber">2.3.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.4 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_14852d208b69b5a1926f5d908b4903da.html">Sources</a></li><li class="navelem"><a class="el" href="dir_66cde9167ab84f7398e86467706d8b82.html">API</a></li><li class="navelem"><a class="el" href="dir_e102932cffc31fbd234362e82383ea76.html">Core</a></li><li class="navelem"><a class="el" href="dir_5eef3825826f79e2166f1010cda53122.html">IOData</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">virtual_directory_listing.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="virtual__directory__listing_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">** ClanLib SDK</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">** Copyright (c) 1997-2011 The ClanLib Team</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">**</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">** This software is provided 'as-is', without any express or implied</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">** warranty. In no event will the authors be held liable for any damages</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">** arising from the use of this software.</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">**</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">** Permission is granted to anyone to use this software for any purpose,</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">** including commercial applications, and to alter it and redistribute it</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">** freely, subject to the following restrictions:</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">**</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">** 1. The origin of this software must not be misrepresented; you must not</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">** claim that you wrote the original software. If you use this software</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">** in a product, an acknowledgment in the product documentation would be</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">** appreciated but is not required.</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">** 2. Altered source versions must be plainly marked as such, and must not be</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment">** misrepresented as being the original software.</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment">** 3. This notice may not be removed or altered from any source distribution.</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment">**</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment">** Note: Some of the libraries ClanLib may link to may have additional</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="comment">** requirements or restrictions.</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment">**</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment">** File Author(s):</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">**</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment">** Harry Storbacka</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment">*/</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="preprocessor">#include "../System/sharedptr.h"</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="preprocessor">#include "../Text/string_types.h"</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span><a class="code" href="classCL__VirtualDirectoryListingEntry.html" title="Virtual File System (VFS) directory listing entry class. ">CL_VirtualDirectoryListingEntry</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">class </span><a class="code" href="classCL__VirtualFileSource.html" title="Virtual File System (VFS) file source. ">CL_VirtualFileSource</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="keyword">class </span>CL_VirtualDirectoryListing_Impl;</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> </div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="classCL__VirtualDirectoryListing.html"> 41</a></span> <span class="keyword">class </span><a class="code" href="classCL__VirtualDirectoryListing.html" title="Virtual File System (VFS) directory listing class. ">CL_VirtualDirectoryListing</a></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> {</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> </div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  <a class="code" href="classCL__VirtualDirectoryListing.html#aa2e6c7d5200276bf4abcd10b8fab3fd6" title="Constructs a null instance. ">CL_VirtualDirectoryListing</a>();</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> </div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  <a class="code" href="classCL__VirtualDirectoryListing.html#aa2e6c7d5200276bf4abcd10b8fab3fd6" title="Constructs a null instance. ">CL_VirtualDirectoryListing</a>(<a class="code" href="classCL__VirtualFileSource.html" title="Virtual File System (VFS) file source. ">CL_VirtualFileSource</a> *provider, <span class="keyword">const</span> <a class="code" href="classCL__String8.html" title="String container template. ">CL_String</a> &path);</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keyword">virtual</span> <a class="code" href="classCL__VirtualDirectoryListing.html#a23986c61621c215fb2cd8a94e707c536">~CL_VirtualDirectoryListing</a>();</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> </div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00061"></a><span class="lineno"><a class="code" href="classCL__VirtualDirectoryListing.html#a16b87f234274c51dad0f92c002a50ab6"> 61</a></span>  <span class="keywordtype">bool</span> <a class="code" href="classCL__VirtualDirectoryListing.html#a16b87f234274c51dad0f92c002a50ab6" title="Returns true if this object is invalid. ">is_null</a>()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> !impl; }</div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span> </div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span>  <span class="keywordtype">void</span> <a class="code" href="classCL__VirtualDirectoryListing.html#a17df592f908c57b044aa7613702bda51" title="Throw an exception if this object is invalid. ">throw_if_null</a>() <span class="keyword">const</span>;</div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> </div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span>  <a class="code" href="classCL__String8.html" title="String container template. ">CL_String</a> <a class="code" href="classCL__VirtualDirectoryListing.html#a446bd6cdb198eaca6e8968a6f2564536" title="Returns the file name of the current item in the listing. ">get_filename</a>();</div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> </div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keywordtype">bool</span> <a class="code" href="classCL__VirtualDirectoryListing.html#a667c337ad81d15334fa097dac953321f" title="Returns true if item is a directory. ">is_directory</a>();</div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span>  <span class="keywordtype">bool</span> <a class="code" href="classCL__VirtualDirectoryListing.html#a7cbf782008af4387c6714ae441b7fb23" title="Returns true if item is hidden. ">is_hidden</a>();</div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span> </div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span>  <span class="keywordtype">bool</span> <a class="code" href="classCL__VirtualDirectoryListing.html#a4c9e6a9bba895c6f37c085b28be6e85a" title="Returns true if item is writable. ">is_writable</a>();</div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> </div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">bool</span> <a class="code" href="classCL__VirtualDirectoryListing.html#ababfbe284aae3aa8df81680d6df1aa16" title="Returns true if item is readable. ">is_readable</a>();</div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> </div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordtype">bool</span> <a class="code" href="classCL__VirtualDirectoryListing.html#a3607193aa1332df9480f42adc88e66dd" title="Advance to next item in listing. ">next</a>();</div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a name="l00093"></a><span class="lineno"> 93</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  CL_SharedPtr<CL_VirtualDirectoryListing_Impl> impl;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> };</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Jun 14 2013 13:05:47 for ClanLib by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.4
</small></address>
</body>
</html>
