ClanLib  2.3.7
List of all members
CL_VirtualDirectoryListing Class Reference

Virtual File System (VFS) directory listing class. More...

#include <virtual_directory_listing.h>

Public Member Functions

Construction
 CL_VirtualDirectoryListing ()
 Constructs a null instance. More...
 
 CL_VirtualDirectoryListing (CL_VirtualFileSource *provider, const CL_String &path)
 Constructs a virtual directory listening object. More...
 
virtual ~CL_VirtualDirectoryListing ()
 
Attributes
bool is_null () const
 Returns true if this object is invalid. More...
 
void throw_if_null () const
 Throw an exception if this object is invalid. More...
 
CL_String get_filename ()
 Returns the file name of the current item in the listing. More...
 
bool is_directory ()
 Returns true if item is a directory. More...
 
bool is_hidden ()
 Returns true if item is hidden. More...
 
bool is_writable ()
 Returns true if item is writable. More...
 
bool is_readable ()
 Returns true if item is readable. More...
 
Operations
bool next ()
 Advance to next item in listing. More...
 

Detailed Description

Virtual File System (VFS) directory listing class.

Constructor & Destructor Documentation

CL_VirtualDirectoryListing::CL_VirtualDirectoryListing ( )

Constructs a null instance.

CL_VirtualDirectoryListing::CL_VirtualDirectoryListing ( CL_VirtualFileSource provider,
const CL_String path 
)

Constructs a virtual directory listening object.

virtual CL_VirtualDirectoryListing::~CL_VirtualDirectoryListing ( )
virtual

Member Function Documentation

CL_String CL_VirtualDirectoryListing::get_filename ( )

Returns the file name of the current item in the listing.

bool CL_VirtualDirectoryListing::is_directory ( )

Returns true if item is a directory.

bool CL_VirtualDirectoryListing::is_hidden ( )

Returns true if item is hidden.

bool CL_VirtualDirectoryListing::is_null ( ) const
inline

Returns true if this object is invalid.

bool CL_VirtualDirectoryListing::is_readable ( )

Returns true if item is readable.

bool CL_VirtualDirectoryListing::is_writable ( )

Returns true if item is writable.

bool CL_VirtualDirectoryListing::next ( )

Advance to next item in listing.

void CL_VirtualDirectoryListing::throw_if_null ( ) const

Throw an exception if this object is invalid.


The documentation for this class was generated from the following file: