]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/strmfile.tex
Typos in sizer docs.
[wxWidgets.git] / docs / latex / wx / strmfile.tex
index c96b0610222471d6c99d12fcdf2321386cffa062..8be893ad14a959d3dab70581c39950683ea94b5c 100644 (file)
@@ -3,6 +3,13 @@
 % -----------------------------------------------------------------------------
 \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}
@@ -13,7 +20,7 @@
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer}{wxstreamBuffer}
+\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxFileOutputStream}{wxfileoutputstream}
 
 % ----------
 % Members
@@ -51,6 +58,13 @@ Returns TRUE if the stream is initialized and ready.
 % -----------------------------------------------------------------------------
 \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}
@@ -61,7 +75,7 @@ Returns TRUE if the stream is initialized and ready.
 
 \wxheading{See also}
 
-\helpref{wxStreamBuffer}{wxstreamBuffer}
+\helpref{wxStreamBuffer}{wxstreamBuffer}, \helpref{wxFileInputStream}{wxfileinputstream}
 
 % ----------
 % Members
@@ -75,7 +89,7 @@ Returns TRUE if the stream is initialized and ready.
 Creates a new file with \it{ofilename} name and initializes the stream in
 write-only mode. 
 
-\func{}{wxFileOutputStream}{\param{wxFile&}{ file}}
+\func{}{wxFileOutputStream}{\param{wxFile\&}{ file}}
 
 Initializes a file stream in write-only mode using the file I/O object \it{file}.