/////////////////////////////////////////////////////////////////////////////
// Name: filesys.h
-// Purpose: documentation for wxFileSystem class
+// Purpose: interface of wxFileSystem
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
This class provides an interface for opening files on different
file systems. It can handle absolute and/or local filenames.
- It uses a system of handlers to
+ It uses a system of handlers() to
provide access to user-defined virtual file systems.
@library{wxbase}
@category{vfs}
- @seealso
- wxFileSystemHandler, wxFSFile, Overview
+ @see wxFileSystemHandler, wxFSFile, Overview()
*/
class wxFileSystem : public wxObject
{
/**
This static function adds new handler into the list of
- handlers which provide access to virtual FS.
+ handlers() which provide access to virtual FS.
Note that if two handlers for the same protocol are added, the last one added
takes precedence.
*/
const wxString& file);
/**
- Works like wxFindFirstFile. Returns name of the first
+ Works like wxFindFirstFile(). Returns name of the first
filename (within filesystem's current path) that matches @e wildcard. @a flags
may be one of
wxFILE (only files), wxDIR (only directories) or 0 (both).
};
+
/**
@class wxFSFile
@wxheader{filesys.h}
@library{wxbase}
@category{vfs}
- @seealso
- wxFileSystemHandler, wxFileSystem, Overview
+ @see wxFileSystemHandler, wxFileSystem, Overview()
*/
class wxFSFile : public wxObject
{
};
+
/**
@class wxFileSystemHandler
@wxheader{filesys.h}
of opening the file: GetProtocol, GetLeftLocation, GetRightLocation,
GetAnchor, GetMimeTypeFromExt.
- Please have a look at overview if you don't know how locations
+ Please have a look at overview() if you don't know how locations
are constructed.
Also consult @ref overview_fs "list of available handlers".
@library{wxbase}
@category{vfs}
- @seealso
- wxFileSystem, wxFSFile, Overview
+ @see wxFileSystem, wxFSFile, Overview()
*/
class wxFileSystemHandler : public wxObject
{
virtual bool CanOpen(const wxString& location);
/**
- Works like wxFindFirstFile. Returns name of the first
+ Works like wxFindFirstFile(). Returns name of the first
filename (within filesystem's current path) that matches @e wildcard. @a flags
may be one of
wxFILE (only files), wxDIR (only directories) or 0 (both).
virtual wxFSFile* OpenFile(wxFileSystem& fs,
const wxString& location);
};
+