document various enumerations defined in defs.h; give a name to the anonymous enum...

[wxWidgets.git] / include / wx / filesys.h

diff --git a/include/wx/filesys.h b/include/wx/filesys.h
index e3df47187a0738c0ec19721ea2a68e139fb9a9e0..80f772c0b7a6e34e5d6c9a0828cd6c44bd490a89 100644 (file)
--- a/include/wx/filesys.h
+++ b/include/wx/filesys.h
@@ -1,5 +1,5 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        filesys.h
+// Name:        wx/filesys.h

 // Purpose:     class for opening files - virtual file system
 // Author:      Vaclav Slavik
 // Copyright:   (c) 1999 Vaclav Slavik
 // Purpose:     class for opening files - virtual file system
 // Author:      Vaclav Slavik
 // Copyright:   (c) 1999 Vaclav Slavik


@@ -12,6 +12,8 @@
 
 #include "wx/defs.h"
 
 
 #include "wx/defs.h"
 

+#if wxUSE_FILESYSTEM
+

 #if !wxUSE_STREAMS
 #error You cannot compile virtual file systems without wxUSE_STREAMS
 #endif
 #if !wxUSE_STREAMS
 #error You cannot compile virtual file systems without wxUSE_STREAMS
 #endif


@@ -20,16 +22,14 @@
 #error You cannot compile wxHTML without virtual file systems
 #endif
 
 #error You cannot compile wxHTML without virtual file systems
 #endif
 

-#if wxUSE_FILESYSTEM
-

 #include "wx/stream.h"
 #include "wx/datetime.h"
 #include "wx/filename.h"
 #include "wx/hashmap.h"
 
 #include "wx/stream.h"
 #include "wx/datetime.h"
 #include "wx/filename.h"
 #include "wx/hashmap.h"
 

-class WXDLLIMPEXP_BASE wxFSFile;
-class WXDLLIMPEXP_BASE wxFileSystemHandler;
-class WXDLLIMPEXP_BASE wxFileSystem;
+class WXDLLIMPEXP_FWD_BASE wxFSFile;
+class WXDLLIMPEXP_FWD_BASE wxFileSystemHandler;
+class WXDLLIMPEXP_FWD_BASE wxFileSystem;

 
 //--------------------------------------------------------------------------------
 // wxFSFile
 
 //--------------------------------------------------------------------------------
 // wxFSFile


@@ -50,7 +50,7 @@ public:
     {
         m_Stream = stream;
         m_Location = loc;
     {
         m_Stream = stream;
         m_Location = loc;

-        m_MimeType = mimetype; m_MimeType.MakeLower();
+        m_MimeType = mimetype.Lower();

         m_Anchor = anchor;
 #if wxUSE_DATETIME
         m_Modif = modif;
         m_Anchor = anchor;
 #if wxUSE_DATETIME
         m_Modif = modif;


@@ -78,7 +78,7 @@ public:
     }
 
     // returns file's mime type
     }
 
     // returns file's mime type

-    const wxString& GetMimeType() const { return m_MimeType; }
+    const wxString& GetMimeType() const;

 
     // returns the original location (aka filename) of the file
     const wxString& GetLocation() const { return m_Location; }
 
     // returns the original location (aka filename) of the file
     const wxString& GetLocation() const { return m_Location; }


@@ -132,28 +132,28 @@ public:
     virtual wxString FindFirst(const wxString& spec, int flags = 0);
     virtual wxString FindNext();
 
     virtual wxString FindFirst(const wxString& spec, int flags = 0);
     virtual wxString FindNext();
 

+    // Returns MIME type of the file - w/o need to open it
+    // (default behaviour is that it returns type based on extension)
+    static wxString GetMimeTypeFromExt(const wxString& location);
+

 protected:
     // returns protocol ("file", "http", "tar" etc.) The last (most right)
     // protocol is used:
     // {it returns "tar" for "file:subdir/archive.tar.gz#tar:/README.txt"}
 protected:
     // returns protocol ("file", "http", "tar" etc.) The last (most right)
     // protocol is used:
     // {it returns "tar" for "file:subdir/archive.tar.gz#tar:/README.txt"}

-    wxString GetProtocol(const wxString& location) const;
+    static wxString GetProtocol(const wxString& location);

 
     // returns left part of address:
     // {it returns "file:subdir/archive.tar.gz" for "file:subdir/archive.tar.gz#tar:/README.txt"}
 
     // returns left part of address:
     // {it returns "file:subdir/archive.tar.gz" for "file:subdir/archive.tar.gz#tar:/README.txt"}

-    wxString GetLeftLocation(const wxString& location) const;
+    static wxString GetLeftLocation(const wxString& location);

 
     // returns anchor part of address:
     // {it returns "anchor" for "file:subdir/archive.tar.gz#tar:/README.txt#anchor"}
     // NOTE:  anchor is NOT a part of GetLeftLocation()'s return value
 
     // returns anchor part of address:
     // {it returns "anchor" for "file:subdir/archive.tar.gz#tar:/README.txt#anchor"}
     // NOTE:  anchor is NOT a part of GetLeftLocation()'s return value

-    wxString GetAnchor(const wxString& location) const;
+    static wxString GetAnchor(const wxString& location);

 
     // returns right part of address:
     // {it returns "/README.txt" for "file:subdir/archive.tar.gz#tar:/README.txt"}
 
     // returns right part of address:
     // {it returns "/README.txt" for "file:subdir/archive.tar.gz#tar:/README.txt"}

-    wxString GetRightLocation(const wxString& location) const;
-
-    // Returns MIME type of the file - w/o need to open it
-    // (default behaviour is that it returns type based on extension)
-    wxString GetMimeTypeFromExt(const wxString& location);
+    static wxString GetRightLocation(const wxString& location);

 
     DECLARE_ABSTRACT_CLASS(wxFileSystemHandler)
 };
 
     DECLARE_ABSTRACT_CLASS(wxFileSystemHandler)
 };


@@ -168,9 +168,9 @@ protected:
 //--------------------------------------------------------------------------------
 
 // Open Bit Flags
 //--------------------------------------------------------------------------------
 
 // Open Bit Flags

-enum {
+enum wxFileSystemOpenFlags
+{

     wxFS_READ = 1,      // Open for reading
     wxFS_READ = 1,      // Open for reading

-    wxFS_WRITE = 2,     // Open for writing

     wxFS_SEEKABLE = 4   // Returned stream will be seekable
 };
 
     wxFS_SEEKABLE = 4   // Returned stream will be seekable
 };
 


@@ -206,7 +206,8 @@ public:
     wxString FindNext();
 
     // find a file in a list of directories, returns false if not found
     wxString FindNext();
 
     // find a file in a list of directories, returns false if not found

-    bool FindFileInPath(wxString *pStr, const wxChar *path, const wxChar *file);
+    bool FindFileInPath(wxString *pStr,
+                        const wxString& path, const wxString& file);

 
     // Adds FS handler.
     // In fact, this class is only front-end to the FS handlers :-)
 
     // Adds FS handler.
     // In fact, this class is only front-end to the FS handlers :-)