Make storing non-trivial data in wxThreadSpecificInfo possible.

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

diff --git a/interface/wx/ffile.h b/interface/wx/ffile.h
index a19619ff9af104253768462fcd47148c1459e71e..ada146d3438dd48351e1b694ac7729c3293a2bc6 100644 (file)
--- a/interface/wx/ffile.h
+++ b/interface/wx/ffile.h
@@ -2,39 +2,12 @@
 // Name:        ffile.h
 // Purpose:     interface of wxFFile
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 
-
-/**
-    Values used for both wxFile and wxFFile.
-
-    @todo make the value names uppercase
-*/
-enum wxSeekMode
-{
-  wxFromStart,
-  wxFromCurrent,
-  wxFromEnd
-};
-
-/**
-    See wxFFile::GetKind().
-*/
-enum wxFileKind
-{
-  wxFILE_KIND_UNKNOWN,
-  wxFILE_KIND_DISK,     /**< A file supporting seeking to arbitrary offsets. */
-  wxFILE_KIND_TERMINAL, /**< A terminal. */
-  wxFILE_KIND_PIPE      /**< A pipe. */
-};
-
-
 /**
     @class wxFFile
-    @wxheader{ffile.h}
 
     wxFFile implements buffered file I/O.
 
@@ -91,7 +64,7 @@ public:
 
         The descriptor should be already opened and it will be closed by wxFFile object.
     */
-    void Attach(FILE* fp);
+    void Attach(FILE* fp, const wxString& name = wxEmptyString);
 
     /**
         Closes the file and returns @true on success.
@@ -103,11 +76,14 @@ public:
         closing the file if this descriptor is opened.
 
         IsOpened() will return @false after call to Detach().
+
+        @return The FILE pointer (this is new since wxWidgets 3.0.0, in the
+        previous versions this method didn't return anything).
     */
-    void Detach();
+    FILE* Detach();
 
     /**
-        Returns @true if the an attempt has been made to read @e past
+        Returns @true if an attempt has been made to read @e past
         the end of the file.
 
         Note that the behaviour of the file descriptor based class  wxFile is different as
@@ -147,6 +123,15 @@ public:
     */
     wxFileKind GetKind() const;
 
+    /**
+        Returns the file name.
+
+        This is the name that was specified when the object was constructed or
+        to the last call to Open(). Notice that it may be empty if Attach() was
+        called without specifying the name.
+     */
+    const wxString& GetName() const;
+
     /**
         Returns @true if the file is opened.