directory_scanner.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 **    Magnus Norddahl
00027 **    (if your name is missing here, please add it)
00028 */
00029 
00032 
00033 #pragma once
00034 
00035 #include "../api_core.h"
00036 #include "../System/sharedptr.h"
00037 #include "../Text/string_types.h"
00038 
00039 class CL_DirectoryScanner_Impl;
00040 
00057 class CL_API_CORE CL_DirectoryScanner
00058 {
00061 
00062 public:
00064         CL_DirectoryScanner();
00065 
00067         ~CL_DirectoryScanner();
00068 
00072 
00073 public:
00075 
00076         CL_String get_directory_path();
00077 
00079 
00080         CL_String get_name();
00081 
00083 
00084         int get_size();
00085 
00087 
00088         CL_String get_pathname();
00089 
00091 
00092         bool is_directory();
00093 
00095 
00096         bool is_hidden();
00097 
00099 
00100         bool is_readable();
00101 
00103 
00104         bool is_writable();
00105 
00109 
00110 public:
00112 
00115         bool scan(const CL_String& pathname);
00116 
00118 
00124         bool scan(const CL_String& pathname, const CL_String& pattern);
00125 
00127 
00128         bool next();
00129 
00133 
00134 private:
00135         CL_SharedPtr<CL_DirectoryScanner_Impl> impl;
00137 };
00138