reSWIGged

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

diff --git a/docs/latex/wx/file.tex b/docs/latex/wx/file.tex
index d4c5f0aaa9d6511e850d0a30f06dde4a676fdfd0..84a59b84836d5725167ccff64af0b7fd646a7519 100644 (file)
--- a/docs/latex/wx/file.tex
+++ b/docs/latex/wx/file.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:     wxWindows license
+%% License:     wxWidgets license

 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFile}}\label{wxfile}
 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 
 \section{\class{wxFile}}\label{wxfile}


@@ -141,9 +141,9 @@ Closes the file.
 
 \membersection{wxFile::Create}\label{wxfilecreate}
 
 
 \membersection{wxFile::Create}\label{wxfilecreate}
 

-\func{bool}{Create}{\param{const char*}{ filename}, \param{bool}{ overwrite = FALSE}, \param{int }{access = wxS\_DEFAULT}}
+\func{bool}{Create}{\param{const char*}{ filename}, \param{bool}{ overwrite = false}, \param{int }{access = wxS\_DEFAULT}}

 
 

-Creates a file for writing. If the file already exists, setting {\bf overwrite} to TRUE
+Creates a file for writing. If the file already exists, setting {\bf overwrite} to true

 will ensure it is overwritten.
 
 \membersection{wxFile::Detach}\label{wxfiledetach}
 will ensure it is overwritten.
 
 \membersection{wxFile::Detach}\label{wxfiledetach}


@@ -151,7 +151,7 @@ will ensure it is overwritten.
 \func{void}{Detach}{\void}
 
 Get back a file descriptor from wxFile object - the caller is responsible for closing the file if this
 \func{void}{Detach}{\void}
 
 Get back a file descriptor from wxFile object - the caller is responsible for closing the file if this

-descriptor is opened. \helpref{IsOpened()}{wxfileisopened} will return FALSE after call to Detach().
+descriptor is opened. \helpref{IsOpened()}{wxfileisopened} will return false after call to Detach().

 
 \membersection{wxFile::fd}\label{wxfilefd}
 
 
 \membersection{wxFile::fd}\label{wxfilefd}
 


@@ -163,12 +163,12 @@ Returns the file descriptor associated with the file.
 
 \constfunc{bool}{Eof}{\void}
 
 
 \constfunc{bool}{Eof}{\void}
 

-Returns TRUE if the end of the file has been reached.
+Returns true if the end of the file has been reached.

 
 Note that the behaviour of the file pointer based class 
 \helpref{wxFFile}{wxffile} is different as \helpref{wxFFile::Eof}{wxffileeof} 
 
 Note that the behaviour of the file pointer based class 
 \helpref{wxFFile}{wxffile} is different as \helpref{wxFFile::Eof}{wxffileeof} 

-will return TRUE here only if an attempt has been made to read 
-{\it past} the last byte of the file, while wxFile::Eof() will return TRUE
+will return true here only if an attempt has been made to read 
+{\it past} the last byte of the file, while wxFile::Eof() will return true

 even before such attempt is made if the file pointer is at the last position
 in the file.
 
 even before such attempt is made if the file pointer is at the last position
 in the file.
 


@@ -183,7 +183,7 @@ of using Eof() as this will not work for special files under Unix.
 
 \func{static bool}{Exists}{\param{const char*}{ filename}}
 
 
 \func{static bool}{Exists}{\param{const char*}{ filename}}
 

-Returns TRUE if the given name specifies an existing regular file (not a
+Returns true if the given name specifies an existing regular file (not a

 directory or a link)
 
 \membersection{wxFile::Flush}\label{wxfileflush}
 directory or a link)
 
 \membersection{wxFile::Flush}\label{wxfileflush}


@@ -200,7 +200,7 @@ due to a missing fsync function, which reduces the usefulness of this function
 
 \constfunc{bool}{IsOpened}{\void}
 
 
 \constfunc{bool}{IsOpened}{\void}
 

-Returns TRUE if the file has been opened.
+Returns true if the file has been opened.

 
 \membersection{wxFile::Length}\label{wxfilelength}
 
 
 \membersection{wxFile::Length}\label{wxfilelength}
 


@@ -212,7 +212,7 @@ Returns the length of the file.
 
 \func{bool}{Open}{\param{const char*}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}}
 
 
 \func{bool}{Open}{\param{const char*}{ filename}, \param{wxFile::OpenMode}{ mode = wxFile::read}}
 

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

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -291,10 +291,14 @@ the number of bytes actually written
 
 \membersection{wxFile::Write}\label{wxfilewrites}
 
 
 \membersection{wxFile::Write}\label{wxfilewrites}
 

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

 
 

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

+Note that this method only works with {\tt NUL}-terminated strings, if you want
+to write data with embedded {\tt NUL}s to the file you should use the other 
+\helpref{Write() overload}{wxfilewrite}.
+