Added default value for "pos" parameter in constructor and Create function.

[wxWidgets.git] / docs / latex / wx / ffile.tex

diff --git a/docs/latex/wx/ffile.tex b/docs/latex/wx/ffile.tex
index 72a8fd768f0a5b1144c3d75c0b837c12077f47d7..fafe340746e41fdf53ed57ecee79f093c3a3535e 100644 (file)
--- a/docs/latex/wx/ffile.tex
+++ b/docs/latex/wx/ffile.tex
@@ -6,7 +6,7 @@
 %% Created:     14.01.02 (extracted from file.tex)
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin
 %% Created:     14.01.02 (extracted from file.tex)
 %% RCS-ID:      $Id$
 %% Copyright:   (c) Vadim Zeitlin

-%% License:     wxWidgets license
+%% License:     wxWindows license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFFile}}\label{wxffile}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFFile}}\label{wxffile}


@@ -127,7 +127,7 @@ the file is not opened.
 
 \membersection{wxFFile::Error}\label{wxffileerror}
 
 
 \membersection{wxFFile::Error}\label{wxffileerror}
 

-Returns \true if an error has occured on this file, similar to the standard
+Returns \true if an error has occurred on this file, similar to the standard

 \texttt{ferror()} function.
 
 Please note that this method may only be called for opened files and may crash
 \texttt{ferror()} function.
 
 Please note that this method may only be called for opened files and may crash


@@ -145,6 +145,24 @@ if the file is not opened.
 Flushes the file and returns \true on success.
 
 
 Flushes the file and returns \true on success.
 
 

+\membersection{wxFFile::GetKind}\label{wxffilegetfilekind}
+
+\constfunc{wxFileKind}{GetKind}{\void}
+
+Returns the type of the file. Possible return values are:
+
+\begin{verbatim}
+enum wxFileKind
+{
+  wxFILE_KIND_UNKNOWN,
+  wxFILE_KIND_DISK,     // a file supporting seeking to arbitrary offsets
+  wxFILE_KIND_TERMINAL, // a tty
+  wxFILE_KIND_PIPE      // a pipe
+};
+
+\end{verbatim}
+
+

 \membersection{wxFFile::IsOpened}\label{wxffileisopened}
 
 \constfunc{bool}{IsOpened}{\void}
 \membersection{wxFFile::IsOpened}\label{wxffileisopened}
 
 \constfunc{bool}{IsOpened}{\void}


@@ -190,6 +208,24 @@ Reads the specified number of bytes into a buffer, returning the actual number r
 The number of bytes read.
 
 
 The number of bytes read.
 
 

+\membersection{wxFFile::ReadAll}\label{wxffilereadall}
+
+\func{bool}{ReadAll}{\param{wxString *}{ str}, \param{wxMBConv\&}{ conv = wxConvUTF8}}
+
+Reads the entire contents of the file into a string.
+
+\wxheading{Parameters}
+
+\docparam{str}{String to read data into.}
+
+\docparam{conv}{Conversion object to use in Unicode build; by default supposes
+that file contents is encoded in UTF-8.}
+
+\wxheading{Return value}
+
+\true if file was read successfully, \false otherwise.
+
+

 \membersection{wxFFile::Seek}\label{wxffileseek}
 
 \func{bool}{Seek}{\param{wxFileOffset }{ofs}, \param{wxSeekMode }{mode = wxFromStart}}
 \membersection{wxFFile::Seek}\label{wxffileseek}
 
 \func{bool}{Seek}{\param{wxFileOffset }{ofs}, \param{wxSeekMode }{mode = wxFromStart}}