document that dragging in wxTreeCtrl needs to be explicitely allowed (fixes #3915)

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

diff --git a/interface/wx/filesys.h b/interface/wx/filesys.h
index c9d534e86aa8ac5b74cf9bd9fa9cfdd2f335591b..80accecb768140f5e821ca251e22f7f466f48385 100644 (file)
--- a/interface/wx/filesys.h
+++ b/interface/wx/filesys.h
@@ -19,7 +19,6 @@ enum wxFileSystemOpenFlags
 
 /**
     @class wxFileSystem
-    @wxheader{filesys.h}
 
     This class provides an interface for opening files on different file systems.
     It can handle absolute and/or local filenames.
@@ -101,14 +100,14 @@ public:
         If the file is found in any directory, returns @true and the full path
         of the file in @a str, otherwise returns @false and doesn't modify @a str.
 
-        @param str
+        @param pStr
             Receives the full path of the file, must not be @NULL
         @param path
             wxPATH_SEP-separated list of directories
         @param file
             the name of the file to look for
     */
-    bool FindFileInPath(wxString str, const wxString& path,
+    bool FindFileInPath(wxString* pStr, const wxString& path,
                         const wxString& file);
 
     /**
@@ -132,7 +131,7 @@ public:
     /**
         Returns the actual path (set by wxFileSystem::ChangePathTo).
     */
-    wxString GetPath();
+    wxString GetPath() const;
 
     /**
         This static function returns @true if there is a registered handler which can
@@ -171,7 +170,6 @@ public:
 
 /**
     @class wxFSFile
-    @wxheader{filesys.h}
 
     This class represents a single file opened by wxFileSystem.
     It provides more information than wxWindow's input stream
@@ -226,10 +224,12 @@ public:
             not be empty in this case).
         @param anchor
             Anchor. See GetAnchor() for details.
+        @param modif
+            Modification date and time for this file.
     */
-    wxFSFile(wxInputStream stream, const wxString& loc,
-             const wxString& mimetype,
-             const wxString& anchor, wxDateTime modif);
+    wxFSFile(wxInputStream* stream, const wxString& location,
+             const wxString& mimetype, const wxString& anchor,
+             wxDateTime modif);
 
     /**
         Detaches the stream from the wxFSFile object. That is, the
@@ -238,7 +238,7 @@ public:
 
         You will have to delete the stream yourself.
     */
-    void DetachStream();
+    wxInputStream* DetachStream();
 
     /**
         Returns anchor (if present). The term of @b anchor can be easily
@@ -300,7 +300,6 @@ public:
 
 /**
     @class wxFileSystemHandler
-    @wxheader{filesys.h}
 
     Classes derived from wxFileSystemHandler are used to access virtual file systems.
 
@@ -357,7 +356,7 @@ public:
 
         Must be overridden in derived handlers.
     */
-    virtual bool CanOpen(const wxString& location);
+    virtual bool CanOpen(const wxString& location) = 0;
 
     /**
         Works like ::wxFindFirstFile().
@@ -390,7 +389,7 @@ public:
 
         @note the anchor is NOT part of the left location.
     */
-    wxString GetAnchor(const wxString& location) const;
+    static wxString GetAnchor(const wxString& location);
 
     /**
         Returns the left location string extracted from @e location.
@@ -400,7 +399,7 @@ public:
         GetLeftLocation("file:myzipfile.zip#zip:index.htm") == "file:myzipfile.zip"
         @endcode
     */
-    wxString GetLeftLocation(const wxString& location) const;
+    static wxString GetLeftLocation(const wxString& location);
 
     /**
         Returns the MIME type based on @b extension of @a location.
@@ -412,7 +411,7 @@ public:
         GetMimeTypeFromExt("index.htm") == "text/html"
         @endcode
     */
-    wxString GetMimeTypeFromExt(const wxString& location);
+    static wxString GetMimeTypeFromExt(const wxString& location);
 
     /**
         Returns the protocol string extracted from @a location.
@@ -422,7 +421,7 @@ public:
         GetProtocol("file:myzipfile.zip#zip:index.htm") == "zip"
         @endcode
     */
-    wxString GetProtocol(const wxString& location) const;
+    static wxString GetProtocol(const wxString& location);
 
     /**
         Returns the right location string extracted from @a location.
@@ -432,7 +431,7 @@ public:
         GetRightLocation("file:myzipfile.zip#zip:index.htm") == "index.htm"
         @endcode
     */
-    wxString GetRightLocation(const wxString& location) const;
+    static wxString GetRightLocation(const wxString& location);
 
     /**
         Opens the file and returns wxFSFile pointer or @NULL if failed.
@@ -444,7 +443,6 @@ public:
         @param location
             The absolute location of file.
     */
-    virtual wxFSFile* OpenFile(wxFileSystem& fs,
-                               const wxString& location);
+    virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location) = 0;
 };