removing old files

[wxWidgets.git] / interface / file.h

diff --git a/interface/file.h b/interface/file.h
index d019a5a31c4660137a2254c5a57a25f17299a2f9..cb74e2dfa8f8fa72f0d70bc7f8a97f2f8273eddf 100644 (file)
--- a/interface/file.h
+++ b/interface/file.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        file.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        file.h

-// Purpose:     documentation for wxTempFile class
+// Purpose:     interface of wxTempFile

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -79,12 +79,12 @@ public:
     /**
         Returns @true if the file was successfully opened.
     */
     /**
         Returns @true if the file was successfully opened.
     */

-    bool IsOpened();
+    bool IsOpened() const;

 
     /**
         Returns the length of the file.
     */
 
     /**
         Returns the length of the file.
     */

-    wxFileOffset Length();
+    wxFileOffset Length() const;

 
     /**
         Open the temporary file, returns @true on success, @false if an error
 
     /**
         Open the temporary file, returns @true on success, @false if an error


@@ -107,7 +107,7 @@ public:
         another
         error occurred.
     */
         another
         error occurred.
     */

-    wxFileOffset Tell();
+    wxFileOffset Tell() const;

 
     /**
         Write to the file, return @true on success, @false on failure.
 
     /**
         Write to the file, return @true on success, @false on failure.


@@ -119,6 +119,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxFile
     @wxheader{file.h}
 /**
     @class wxFile
     @wxheader{file.h}


@@ -146,7 +147,7 @@ public:
     /**
         Associates the file with the given file descriptor, which has already been
         opened.
     /**
         Associates the file with the given file descriptor, which has already been
         opened.

-        
+

         @param filename
             The filename.
         @param mode
         @param filename
             The filename.
         @param mode


@@ -164,7 +165,7 @@ public:
 
     /**
         Destructor will close the file.
 
     /**
         Destructor will close the file.

-        @b NB: it is not virtual so you should not use wxFile polymorphically.
+        @note it is not virtual so you should not use wxFile polymorphically.

     */
     ~wxFile();
 
     */
     ~wxFile();
 


@@ -220,7 +221,7 @@ public:
         Read() repeatedly and tests its return condition instead
         of using Eof() as this will not work for special files under Unix.
     */
         Read() repeatedly and tests its return condition instead
         of using Eof() as this will not work for special files under Unix.
     */

-    bool Eof();
+    bool Eof() const;

 
     /**
         Returns @true if the given name specifies an existing regular file (not a
 
     /**
         Returns @true if the given name specifies an existing regular file (not a


@@ -239,21 +240,21 @@ public:
     /**
         Returns the type of the file. Possible return values are:
     */
     /**
         Returns the type of the file. Possible return values are:
     */

-    wxFileKind GetKind();
+    wxFileKind GetKind() const;

 
     /**
         Returns @true if the file has been opened.
     */
 
     /**
         Returns @true if the file has been opened.
     */

-    bool IsOpened();
+    bool IsOpened() const;

 
     /**
         Returns the length of the file.
     */
 
     /**
         Returns the length of the file.
     */

-    wxFileOffset Length();
+    wxFileOffset Length() const;

 
     /**
         Opens the file, returning @true if successful.
 
     /**
         Opens the file, returning @true if successful.

-        
+

         @param filename
             The filename.
         @param mode
         @param filename
             The filename.
         @param mode


@@ -274,13 +275,13 @@ public:
 
     /**
         Seeks to the specified position.
 
     /**
         Seeks to the specified position.

-        
+

         @param ofs
             Offset to seek to.
         @param mode
             One of wxFromStart, wxFromEnd, wxFromCurrent.
         @param ofs
             Offset to seek to.
         @param mode
             One of wxFromStart, wxFromEnd, wxFromCurrent.

-        
-        @returns The actual offset position achieved, or wxInvalidOffset on
+
+        @return The actual offset position achieved, or wxInvalidOffset on

                  failure.
     */
     wxFileOffset Seek(wxFileOffset ofs,
                  failure.
     */
     wxFileOffset Seek(wxFileOffset ofs,


@@ -290,11 +291,11 @@ public:
         Moves the file pointer to the specified number of bytes relative to the end of
         the file. For example, @c SeekEnd(-5) would position the pointer 5
         bytes before the end.
         Moves the file pointer to the specified number of bytes relative to the end of
         the file. For example, @c SeekEnd(-5) would position the pointer 5
         bytes before the end.

-        
+

         @param ofs
             Number of bytes before the end of the file.
         @param ofs
             Number of bytes before the end of the file.

-        
-        @returns The actual offset position achieved, or wxInvalidOffset on
+
+        @return The actual offset position achieved, or wxInvalidOffset on

                  failure.
     */
     wxFileOffset SeekEnd(wxFileOffset ofs = 0);
                  failure.
     */
     wxFileOffset SeekEnd(wxFileOffset ofs = 0);


@@ -304,7 +305,7 @@ public:
         another
         error occurred.
     */
         another
         error occurred.
     */

-    wxFileOffset Tell();
+    wxFileOffset Tell() const;

 
     /**
         Writes the contents of the string to the file, returns @true on success.
 
     /**
         Writes the contents of the string to the file, returns @true on success.


@@ -319,5 +320,6 @@ public:
     /**
         Returns the file descriptor associated with the file.
     */
     /**
         Returns the file descriptor associated with the file.
     */

-    int fd();
+    int fd() const;

 };
 };

+