]> git.saurik.com Git - wxWidgets.git/commitdiff
Remove duplicate wxFileKind definition from documentation.
authorVadim Zeitlin <vadim@wxwidgets.org>
Thu, 23 Feb 2012 16:33:13 +0000 (16:33 +0000)
committerVadim Zeitlin <vadim@wxwidgets.org>
Thu, 23 Feb 2012 16:33:13 +0000 (16:33 +0000)
Also move wxSeekMode from interface/wx/ffile.h to filefn.h to be consistent
with the header in which this enum is really defined. And document it better.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@70675 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

interface/wx/ffile.h
interface/wx/filefn.h

index 869aed9a22c3cbca9ec59980e85c60ee330af029..43d94f1ed1cd01927ab97f64d6fc5eec561f1600 100644 (file)
@@ -7,31 +7,6 @@
 /////////////////////////////////////////////////////////////////////////////
 
 
-
-/**
-    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
 
index 18fd7def0d7e5970bf2ae6dce6fad60bb0c37658..f2c9551b4f597e2ab09220079f1cfaa150cfec28 100644 (file)
@@ -479,9 +479,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