virtual_directory_listing.h

Go to the documentation of this file.
00001 /*
00002 **  ClanLib SDK
00003 **  Copyright (c) 1997-2011 The ClanLib Team
00004 **
00005 **  This software is provided 'as-is', without any express or implied
00006 **  warranty.  In no event will the authors be held liable for any damages
00007 **  arising from the use of this software.
00008 **
00009 **  Permission is granted to anyone to use this software for any purpose,
00010 **  including commercial applications, and to alter it and redistribute it
00011 **  freely, subject to the following restrictions:
00012 **
00013 **  1. The origin of this software must not be misrepresented; you must not
00014 **     claim that you wrote the original software. If you use this software
00015 **     in a product, an acknowledgment in the product documentation would be
00016 **     appreciated but is not required.
00017 **  2. Altered source versions must be plainly marked as such, and must not be
00018 **     misrepresented as being the original software.
00019 **  3. This notice may not be removed or altered from any source distribution.
00020 **
00021 **  Note: Some of the libraries ClanLib may link to may have additional
00022 **  requirements or restrictions.
00023 **
00024 **  File Author(s):
00025 **
00026 **    Harry Storbacka
00027 */
00028 
00029 #pragma once
00030 
00031 #include "../System/sharedptr.h"
00032 #include "../Text/string_types.h"
00033 
00034 class CL_VirtualDirectoryListingEntry;
00035 class CL_VirtualFileSource;
00036 class CL_VirtualDirectoryListing_Impl;
00037 
00041 class CL_VirtualDirectoryListing
00042 {
00045 
00046 public:
00048         CL_VirtualDirectoryListing();
00049 
00051         CL_VirtualDirectoryListing(CL_VirtualFileSource *provider, const CL_String &path);
00052 
00053         virtual ~CL_VirtualDirectoryListing();
00054 
00058 
00059 public:
00061         bool is_null() const { return !impl; }
00062 
00064         void throw_if_null() const;
00065 
00067         CL_String get_filename();
00068 
00070         bool is_directory();
00071 
00073         bool is_hidden();
00074 
00076         bool is_writable();
00077 
00079         bool is_readable();
00080 
00084 
00085 public:
00087         bool next();
00088 
00092 
00093 private:
00094         CL_SharedPtr<CL_VirtualDirectoryListing_Impl> impl;
00096 };
00097