ClanLib  2.3.7
List of all members
CL_VirtualFileSource Class Referenceabstract

Virtual File System (VFS) file source. More...

#include <virtual_file_source.h>

Public Member Functions

Construction
virtual ~CL_VirtualFileSource ()
 
Operations
virtual CL_IODevice open_file (const CL_String &filename, CL_File::OpenMode mode=CL_File::open_existing, unsigned int access=CL_File::access_read|CL_File::access_write, unsigned int share=CL_File::share_all, unsigned int flags=0)=0
 Open file from this source. More...
 
virtual bool initialize_directory_listing (const CL_String &path)=0
 Initiate directory listing. More...
 
virtual bool next_file (CL_VirtualDirectoryListingEntry &entry)=0
 Update directory listing item. More...
 
virtual CL_String get_path () const =0
 Return the path of this file source. More...
 
virtual CL_String get_identifier () const =0
 Get the identifier of this file source. More...
 

Detailed Description

Virtual File System (VFS) file source.

Constructor & Destructor Documentation

virtual CL_VirtualFileSource::~CL_VirtualFileSource ( )
inlinevirtual

Member Function Documentation

virtual CL_String CL_VirtualFileSource::get_identifier ( ) const
pure virtual

Get the identifier of this file source.

The exact format of this identifier depends on the implementation of the underlying filesystem and mounts

Returns
the identifier
virtual CL_String CL_VirtualFileSource::get_path ( ) const
pure virtual

Return the path of this file source.

virtual bool CL_VirtualFileSource::initialize_directory_listing ( const CL_String path)
pure virtual

Initiate directory listing.

virtual bool CL_VirtualFileSource::next_file ( CL_VirtualDirectoryListingEntry entry)
pure virtual

Update directory listing item.

virtual CL_IODevice CL_VirtualFileSource::open_file ( const CL_String filename,
CL_File::OpenMode  mode = CL_File::open_existing,
unsigned int  access = CL_File::access_read|CL_File::access_write,
unsigned int  share = CL_File::share_all,
unsigned int  flags = 0 
)
pure virtual

Open file from this source.

param: filename = The filename to use param: mode = CL_File::OpenMode modes param: access = CL_File::AccessFlags flags param: share = CL_File::ShareFlags flags param: flags = CL_File::Flags flags

Returns
The CL_IODevice

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