cleanup (mainly wrapping lines to be < 80 chars); added IsExpanded()

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

diff --git a/docs/latex/wx/ffile.tex b/docs/latex/wx/ffile.tex
index ada4a407af2400a44b368869766ac4db91003331..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}


@@ -155,7 +173,7 @@ be used for an opened file.
 
 \membersection{wxFFile::Length}\label{wxffilelength}
 
 
 \membersection{wxFFile::Length}\label{wxffilelength}
 

-\constfunc{size\_t}{Length}{\void}
+\constfunc{wxFileOffset}{Length}{\void}

 
 Returns the length of the file.
 
 
 Returns the length of the file.
 


@@ -175,7 +193,7 @@ Opens the file, returning \true if successful.
 
 \membersection{wxFFile::Read}\label{wxffileread}
 
 
 \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.
 
 
 Reads the specified number of bytes into a buffer, returning the actual number read.
 


@@ -190,9 +208,27 @@ 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}
 
 \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.
 
 
 Seeks to the specified position and returns \true on success.
 


@@ -205,7 +241,7 @@ Seeks to the specified position and returns \true on success.
 
 \membersection{wxFFile::SeekEnd}\label{wxffileseekend}
 
 
 \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.
 
 Moves the file pointer to the specified number of bytes before the end of the file
 and returns \true on success.


@@ -217,7 +253,7 @@ and returns \true on success.
 
 \membersection{wxFFile::Tell}\label{wxffiletell}
 
 
 \membersection{wxFFile::Tell}\label{wxffiletell}
 

-\constfunc{size\_t}{Tell}{\void}
+\constfunc{wxFileOffset}{Tell}{\void}

 
 Returns the current position.
 
 
 Returns the current position.