]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/ffile.tex
Added GetPureVitualSize() returning just m_virtualSize.
[wxWidgets.git] / docs / latex / wx / ffile.tex
index bfeb65e11b908d9aec4e0297087feb2c889ab2bb..5dd496b9be40b66f4938ae6559a1d70924e8fb46 100644 (file)
@@ -35,7 +35,7 @@ None.
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
-\membersection{wxFFile::wxFFile}\label{wxffileconstr}
+\membersection{wxFFile::wxFFile}\label{wxffilector}
 
 \func{}{wxFFile}{\void}
 
@@ -64,7 +64,7 @@ for the text files.}
 \docparam{fp}{An existing file descriptor, such as stderr.}
 
 
-\membersection{wxFFile::\destruct{wxFFile}}
+\membersection{wxFFile::\destruct{wxFFile}}\label{wxffiledtor}
 
 \func{}{\destruct{wxFFile}}{\void}
 
@@ -145,6 +145,24 @@ if the file is not opened.
 Flushes the file and returns \true on success.
 
 
+\membersection{wxFFile::GetFileType}\label{wxffilegetfiletype}
+
+\constfunc{wxFileTypeEnum}{GetFileType}{\void}
+
+Returns the type of the file. Possible return values are:
+
+\begin{verbatim}
+enum wxFileTypeEnum
+{
+  wxFILE_TYPE_UNKNOWN,
+  wxFILE_TYPE_DISK,     // a file supporting seeking to arbitrary offsets
+  wxFILE_TYPE_TERMINAL, // a tty
+  wxFILE_TYPE_PIPE      // a pipe
+};
+
+\end{verbatim}
+
+
 \membersection{wxFFile::IsOpened}\label{wxffileisopened}
 
 \constfunc{bool}{IsOpened}{\void}
@@ -155,7 +173,7 @@ be used for an opened file.
 
 \membersection{wxFFile::Length}\label{wxffilelength}
 
-\constfunc{size\_t}{Length}{\void}
+\constfunc{wxFileOffset}{Length}{\void}
 
 Returns the length of the file.
 
@@ -175,7 +193,7 @@ Opens the file, returning \true if successful.
 
 \membersection{wxFFile::Read}\label{wxffileread}
 
-\func{size\_t}{Read}{\param{void*}{ buffer}, \param{off\_t}{ count}}
+\func{size\_t}{Read}{\param{void*}{ buffer}, \param{size\_t}{ count}}
 
 Reads the specified number of bytes into a buffer, returning the actual number read.
 
@@ -192,7 +210,7 @@ The number of bytes read.
 
 \membersection{wxFFile::Seek}\label{wxffileseek}
 
-\func{bool}{Seek}{\param{long }{ofs}, \param{wxSeekMode }{mode = wxFromStart}}
+\func{bool}{Seek}{\param{wxFileOffset }{ofs}, \param{wxSeekMode }{mode = wxFromStart}}
 
 Seeks to the specified position and returns \true on success.
 
@@ -205,7 +223,7 @@ Seeks to the specified position and returns \true on success.
 
 \membersection{wxFFile::SeekEnd}\label{wxffileseekend}
 
-\func{bool}{SeekEnd}{\param{long }{ofs = 0}}
+\func{bool}{SeekEnd}{\param{wxFileOffset }{ofs = 0}}
 
 Moves the file pointer to the specified number of bytes before the end of the file
 and returns \true on success.
@@ -217,7 +235,7 @@ and returns \true on success.
 
 \membersection{wxFFile::Tell}\label{wxffiletell}
 
-\constfunc{size\_t}{Tell}{\void}
+\constfunc{wxFileOffset}{Tell}{\void}
 
 Returns the current position.