remove C++ comment

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

diff --git a/docs/latex/wx/ffile.tex b/docs/latex/wx/ffile.tex
index c6f9ebabc0c071f5c7f9c52424a90751e17ed4ab..611569f1f972323abfc0d1d2c7da6512e2fae0b7 100644 (file)
--- a/docs/latex/wx/ffile.tex
+++ b/docs/latex/wx/ffile.tex
@@ -25,6 +25,10 @@ None.
 
 <wx/ffile.h>
 
 
 <wx/ffile.h>
 

+\wxheading{Library}
+
+\helpref{wxBase}{librarieslist}
+

 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt%
 \twocolitem{{\bf wxFromStart}}{Count offset from the start of the file}
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt%
 \twocolitem{{\bf wxFromStart}}{Count offset from the start of the file}


@@ -34,13 +38,14 @@ None.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxFFile::wxFFile}\label{wxffileconstr}
+
+\membersection{wxFFile::wxFFile}\label{wxffilector}

 
 \func{}{wxFFile}{\void}
 
 Default constructor.
 
 
 \func{}{wxFFile}{\void}
 
 Default constructor.
 

-\func{}{wxFFile}{\param{const char*}{ filename}, \param{const char*}{ mode = "r"}}
+\func{}{wxFFile}{\param{const wxString\&}{ filename}, \param{const wxString\&}{ mode = "r"}}

 
 Opens a file with the given mode. As there is no way to return whether the
 operation was successful or not from the constructor you should test the
 
 Opens a file with the given mode. As there is no way to return whether the
 operation was successful or not from the constructor you should test the


@@ -62,7 +67,8 @@ for the text files.}
 
 \docparam{fp}{An existing file descriptor, such as stderr.}
 
 
 \docparam{fp}{An existing file descriptor, such as stderr.}
 

-\membersection{wxFFile::\destruct{wxFFile}}
+
+\membersection{wxFFile::\destruct{wxFFile}}\label{wxffiledtor}

 
 \func{}{\destruct{wxFFile}}{\void}
 
 
 \func{}{\destruct{wxFFile}}{\void}
 


@@ -70,6 +76,7 @@ Destructor will close the file.
 
 NB: it is not virtual so you should {\it not} derive from wxFFile!
 
 
 NB: it is not virtual so you should {\it not} derive from wxFFile!
 

+

 \membersection{wxFFile::Attach}\label{wxffileattach}
 
 \func{void}{Attach}{\param{FILE*}{ fp}}
 \membersection{wxFFile::Attach}\label{wxffileattach}
 
 \func{void}{Attach}{\param{FILE*}{ fp}}


@@ -79,18 +86,21 @@ Attaches an existing file pointer to the wxFFile object.
 The descriptor should be already opened and it will be closed by wxFFile
 object.
 
 The descriptor should be already opened and it will be closed by wxFFile
 object.
 

+

 \membersection{wxFFile::Close}\label{wxffileclose}
 
 \func{bool}{Close}{\void}
 
 \membersection{wxFFile::Close}\label{wxffileclose}
 
 \func{bool}{Close}{\void}
 

-Closes the file and returns true on success.
+Closes the file and returns \true on success.
+

 
 \membersection{wxFFile::Detach}\label{wxffiledetach}
 
 \func{void}{Detach}{\void}
 
 
 \membersection{wxFFile::Detach}\label{wxffiledetach}
 
 \func{void}{Detach}{\void}
 

-Get back a file pointer from wxFFile object - the caller is responsible for closing the file if this
-descriptor is opened. \helpref{IsOpened()}{wxffileisopened} will return false after call to Detach().
+Get back a file pointer from wxFFile object -- the caller is responsible for closing the file if this
+descriptor is opened. \helpref{IsOpened()}{wxffileisopened} will return \false after call to Detach().
+

 
 \membersection{wxFFile::fp}\label{wxffilefp}
 
 
 \membersection{wxFFile::fp}\label{wxffilefp}
 


@@ -98,41 +108,85 @@ descriptor is opened. \helpref{IsOpened()}{wxffileisopened} will return false af
 
 Returns the file pointer associated with the file.
 
 
 Returns the file pointer associated with the file.
 

+

 \membersection{wxFFile::Eof}\label{wxffileeof}
 
 \constfunc{bool}{Eof}{\void}
 
 \membersection{wxFFile::Eof}\label{wxffileeof}
 
 \constfunc{bool}{Eof}{\void}
 

-Returns true if the an attempt has been made to read {\it past}
+Returns \true if the an attempt has been made to read {\it past}

 the end of the file. 
 
 Note that the behaviour of the file descriptor based class
 \helpref{wxFile}{wxfile} is different as \helpref{wxFile::Eof}{wxfileeof}
 the end of the file. 
 
 Note that the behaviour of the file descriptor based class
 \helpref{wxFile}{wxfile} is different as \helpref{wxFile::Eof}{wxfileeof}

-will return true here as soon as the last byte of the file has been
+will return \true here as soon as the last byte of the file has been

 read.
 
 read.
 

+Also note that this method may only be called for opened files and may crash if
+the file is not opened.
+
+\wxheading{See also}
+
+\helpref{IsOpened}{wxffileisopened}
+
+
+\membersection{wxFFile::Error}\label{wxffileerror}
+
+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
+if the file is not opened.
+
+\wxheading{See also}
+
+\helpref{IsOpened}{wxffileisopened}
+
+

 \membersection{wxFFile::Flush}\label{wxffileflush}
 
 \func{bool}{Flush}{\void}
 
 \membersection{wxFFile::Flush}\label{wxffileflush}
 
 \func{bool}{Flush}{\void}
 

-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}
 

-Returns true if the file has been opened.
+Returns \true if the file is opened. Most of the methods of this class may only
+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.
 

+

 \membersection{wxFFile::Open}\label{wxffileopen}
 
 \membersection{wxFFile::Open}\label{wxffileopen}
 

-\func{bool}{Open}{\param{const char*}{ filename}, \param{const char*}{ mode = "r"}}
+\func{bool}{Open}{\param{const wxString\&}{ filename}, \param{const wxString\&}{ mode = "r"}}

 
 

-Opens the file, returning true if successful.
+Opens the file, returning \true if successful.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -140,9 +194,10 @@ Opens the file, returning true if successful.
 
 \docparam{mode}{The mode in which to open the file.}
 
 
 \docparam{mode}{The mode in which to open the file.}
 

+

 \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.
 


@@ -156,11 +211,30 @@ 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{const wxMBConv\&}{ conv = wxConvAuto()}}
+
+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.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -168,23 +242,26 @@ Seeks to the specified position and returns true on success.
 
 \docparam{mode}{One of {\bf wxFromStart}, {\bf wxFromEnd}, {\bf wxFromCurrent}.}
 
 
 \docparam{mode}{One of {\bf wxFromStart}, {\bf wxFromEnd}, {\bf wxFromCurrent}.}
 

+

 \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
 
 Moves the file pointer to the specified number of bytes before the end of the file

-and returns true on success.
+and returns \true on success.

 
 \wxheading{Parameters}
 
 \docparam{ofs}{Number of bytes before the end of the file.}
 
 
 \wxheading{Parameters}
 
 \docparam{ofs}{Number of bytes before the end of the file.}
 

+

 \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.
 

+

 \membersection{wxFFile::Write}\label{wxffilewrite}
 
 \func{size\_t}{Write}{\param{const void*}{ buffer}, \param{size\_t}{ count}}
 \membersection{wxFFile::Write}\label{wxffilewrite}
 
 \func{size\_t}{Write}{\param{const void*}{ buffer}, \param{size\_t}{ count}}


@@ -201,13 +278,14 @@ Writes the specified number of bytes from a buffer.
 
 Number of bytes written.
 
 
 Number of bytes written.
 

+

 \membersection{wxFFile::Write}\label{wxffilewrites}
 
 \membersection{wxFFile::Write}\label{wxffilewrites}
 

-\func{bool}{Write}{\param{const wxString\& }{s}, \param{wxMBConv\&}{ conv = wxConvLibc}}
+\func{bool}{Write}{\param{const wxString\& }{s}, \param{const wxMBConv\&}{ conv = wxConvAuto()}}

 
 

-Writes the contents of the string to the file, returns true on success.
+Writes the contents of the string to the file, returns \true on success.

 
 

-The second argument is only meaningful in Unicode build of wxWindows when
+The second argument is only meaningful in Unicode build of wxWidgets when

 {\it conv} is used to convert {\it s} to multibyte representation.
 
 
 {\it conv} is used to convert {\it s} to multibyte representation.