X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..3e8ec9540118e43f48507ba2f222a3f8e361b4bb:/interface/file.h diff --git a/interface/file.h b/interface/file.h index d019a5a31c..7ece7ce26e 100644 --- a/interface/file.h +++ b/interface/file.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: file.h -// Purpose: documentation for wxTempFile class +// Purpose: interface of wxTempFile // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -79,12 +79,12 @@ public: /** Returns @true if the file was successfully opened. */ - bool IsOpened(); + bool IsOpened() const; /** Returns the length of the file. */ - wxFileOffset Length(); + wxFileOffset Length() const; /** Open the temporary file, returns @true on success, @false if an error @@ -107,7 +107,7 @@ public: another error occurred. */ - wxFileOffset Tell(); + wxFileOffset Tell() const; /** Write to the file, return @true on success, @false on failure. @@ -119,6 +119,7 @@ public: }; + /** @class wxFile @wxheader{file.h} @@ -146,7 +147,7 @@ public: /** Associates the file with the given file descriptor, which has already been opened. - + @param filename The filename. @param mode @@ -164,7 +165,7 @@ public: /** 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(); @@ -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. */ - bool Eof(); + bool Eof() const; /** 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: */ - wxFileKind GetKind(); + wxFileKind GetKind() const; /** Returns @true if the file has been opened. */ - bool IsOpened(); + bool IsOpened() const; /** Returns the length of the file. */ - wxFileOffset Length(); + wxFileOffset Length() const; /** Opens the file, returning @true if successful. - + @param filename The filename. @param mode @@ -274,12 +275,12 @@ public: /** Seeks to the specified position. - + @param ofs Offset to seek to. @param mode One of wxFromStart, wxFromEnd, wxFromCurrent. - + @returns The actual offset position achieved, or wxInvalidOffset on failure. */ @@ -290,10 +291,10 @@ 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. - + @param ofs Number of bytes before the end of the file. - + @returns The actual offset position achieved, or wxInvalidOffset on failure. */ @@ -304,7 +305,7 @@ public: another error occurred. */ - wxFileOffset Tell(); + wxFileOffset Tell() const; /** 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. */ - int fd(); + int fd() const; }; +