X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/327ac3ec2a475305d569d3f3ba1927a5a61d8926..9e9574fe45b176ee74bba8fad7574cf9906145d1:/interface/wx/filefn.h?ds=inline diff --git a/interface/wx/filefn.h b/interface/wx/filefn.h index 18fd7def0d..95cb6f7995 100644 --- a/interface/wx/filefn.h +++ b/interface/wx/filefn.h @@ -2,7 +2,6 @@ // Name: filefn.h // Purpose: interface of wxPathList and file functions // Author: wxWidgets team -// RCS-ID: $Id$ // Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// @@ -113,9 +112,9 @@ const int wxInvalidOffset = -1; /** The type used to store and provide byte offsets or byte sizes for files or streams. - It is type-defined as @c off_t on POSIX platforms - (see http://www.gnu.org/software/libc/manual/html_node/File-Position-Primitive.html) - or to @c wxLongLong_t on Windows when @c wxHAS_HUGE_FILES is defined. + This type is usually just a synonym for @c off_t but can be defined as + @c wxLongLong_t if @c wxHAS_HUGE_FILES is defined but @c off_t is only 32 + bits. */ typedef off_t wxFileOffset; @@ -322,7 +321,7 @@ wxString wxPathOnly(const wxString& path); bool wxIsWild(const wxString& pattern); /** - Returns @true if the argument is an absolute filename, i.e. with a slash + Returns @true if the argument is an absolute filename, i.e.\ with a slash or drive name at the beginning. @header{wx/filefn.h} @@ -479,9 +478,25 @@ wxString wxFindNextFile(); */ wxString wxFindFirstFile(const wxString& spec, int flags = 0); +/** + Parameter indicating how file offset should be interpreted. + + This is used by wxFFile::Seek() and wxFile::Seek(). + + @header{wx/filefn.h} +*/ +enum wxSeekMode +{ + wxFromStart, ///< Seek from the file beginning. + wxFromCurrent, ///< Seek from the current position. + wxFromEnd ///< Seek from end of the file. +}; + /** File kind enumerations returned from wxGetFileKind(). + Also used by wxFFile::GetKind() and wxFile::GetKind(). + @header{wx/filefn.h} */ enum wxFileKind