1. wxGetOsDescription() function added

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

diff --git a/docs/latex/wx/strmfile.tex b/docs/latex/wx/strmfile.tex
index fdbf8bae0846cacf9f3dbc26df31988cccb75bf2..8be893ad14a959d3dab70581c39950683ea94b5c 100644 (file)
--- a/docs/latex/wx/strmfile.tex
+++ b/docs/latex/wx/strmfile.tex
@@ -3,6 +3,13 @@
 % -----------------------------------------------------------------------------
 \section{\class{wxFileInputStream}}\label{wxfileinputstream}
 
 % -----------------------------------------------------------------------------
 \section{\class{wxFileInputStream}}\label{wxfileinputstream}
 

+This class represents data read in from a file. There are actually
+two such groups of classes: those documented here, and another group called
+wxFFileInputStream, wxFFileOutputStream and wxFFileStream which are not
+based on file descriptors (and their wxWindows equivalent wxFile) but the
+FILE* type (and wxFFile). Apart from the different constructor ("FILE *file"
+instead if "int fd") their interface is identical.
+

 \wxheading{Derived from}
 
 \helpref{wxInputStream}{wxinputstream}
 \wxheading{Derived from}
 
 \helpref{wxInputStream}{wxinputstream}


@@ -13,7 +20,7 @@
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxStreamBuffer}{wxstreamBuffer}
+\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxFileOutputStream}{wxfileoutputstream}

 
 % ----------
 % Members
 
 % ----------
 % Members


@@ -51,6 +58,13 @@ Returns TRUE if the stream is initialized and ready.
 % -----------------------------------------------------------------------------
 \section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
 
 % -----------------------------------------------------------------------------
 \section{\class{wxFileOutputStream}}\label{wxfileoutputstream}
 

+This class represents data written to a file. There are actually
+two such groups of classes: those documented here, and another group called
+wxFFileInputStream, wxFFileOutputStream and wxFFileStream which are not
+based on file descriptors (and their wxWindows equivalent wxFile) but the
+FILE* type (and wxFFile). Apart from the different constructor ("FILE *file"
+instead if "int fd") their interface is identical.
+

 \wxheading{Derived from}
 
 \helpref{wxOutputStream}{wxoutputstream}
 \wxheading{Derived from}
 
 \helpref{wxOutputStream}{wxoutputstream}


@@ -61,7 +75,7 @@ Returns TRUE if the stream is initialized and ready.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxStreamBuffer}{wxstreamBuffer}
+\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxFileInputStream}{wxfileinputstream}

 
 % ----------
 % Members
 
 % ----------
 % Members