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
/////////////////////////////////////////////////////////////////////////////
-
-/**
- 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
*/
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