Move code removing "-psn_xxx" command line arguments to common code.

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

diff --git a/interface/wx/filefn.h b/interface/wx/filefn.h
index 9659221bdb21c49402590291d069811238d2c5fe..95cb6f79956bc5edc606a0847a60e03fdce8a157 100644 (file)
--- a/interface/wx/filefn.h
+++ b/interface/wx/filefn.h
@@ -2,8 +2,7 @@
 // Name:        filefn.h
 // Purpose:     interface of wxPathList and file functions
 // Author:      wxWidgets team
-// RCS-ID:      $Id$
-// Licence:     wxWindows license
+// Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
 /**
@@ -24,6 +23,9 @@
 class wxPathList : public wxArrayString
 {
 public:
+    /**
+        Standard constructor.
+    */
     wxPathList();
 
     /**
@@ -110,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;
 
@@ -245,9 +247,10 @@ time_t wxFileModificationTime(const wxString& filename);
 /**
     Renames @a file1 to @e file2, returning @true if successful.
 
-    If @a overwrite parameter is @true (default), the destination file is
-    overwritten if it exists, but if @a overwrite is @false, the functions
-    fails in this case.
+    If @a file2 is a directory, @a file1 is moved into it (@a overwrite is
+    ignored in this case). Otherwise, if @a file2 is an existing file, it is
+    overwritten if @a overwrite is @true (default) and the function fails if @a
+    overwrite is @false.
 
     @header{wx/filefn.h}
 */
@@ -318,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}
@@ -475,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