Remove wrong const from wxMenu::GetMenuItems() documentation.

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

diff --git a/interface/wx/ffile.h b/interface/wx/ffile.h
index a19619ff9af104253768462fcd47148c1459e71e..43d94f1ed1cd01927ab97f64d6fc5eec561f1600 100644 (file)
--- a/interface/wx/ffile.h
+++ b/interface/wx/ffile.h
@@ -3,38 +3,12 @@
 // Purpose:     interface of wxFFile
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // 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
 /**
     @class wxFFile

-    @wxheader{ffile.h}

 
     wxFFile implements buffered file I/O.
 
 
     wxFFile implements buffered file I/O.
 


@@ -91,7 +65,7 @@ public:
 
         The descriptor should be already opened and it will be closed by wxFFile object.
     */
 
         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.
 
     /**
         Closes the file and returns @true on success.


@@ -107,7 +81,7 @@ public:
     void Detach();
 
     /**
     void 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
         the end of the file.
 
         Note that the behaviour of the file descriptor based class  wxFile is different as


@@ -147,6 +121,15 @@ public:
     */
     wxFileKind GetKind() const;
 
     */
     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.
 
     /**
         Returns @true if the file is opened.