X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2723cfeba2a842e82d7473f7d17c5038f80f7f43..4179da8a81ee3110e2a8b5615e1a4f8c8b75a16b:/docs/latex/wx/tstream.tex diff --git a/docs/latex/wx/tstream.tex b/docs/latex/wx/tstream.tex index 9c407d2d04..e3f3bb7215 100644 --- a/docs/latex/wx/tstream.tex +++ b/docs/latex/wx/tstream.tex @@ -1,4 +1,4 @@ -\section{Streams in wxWindows overview}\label{wxstreamoverview} +\section{wxStreams overview}\label{wxstreamoverview} Classes: \helpref{wxStreamBase}{wxstreambase}, \helpref{wxStreamBuffer}{wxstreambuffer}, \helpref{wxInputStream}{wxinputstream}, @@ -14,7 +14,7 @@ they have many problems. Some Borland Compilers refuse to work at all with them and using iostreams on Linux makes writing programs, that are binary compatible across different Linux distributions, impossible. -Therefore, wxStreams have been added to wxWindows because an application should +Therefore, wxStreams have been added to wxWidgets because an application should compile and run on all supported platforms and we don't want users to depend on release X.XX of libg++ or some other compiler to run the program. @@ -27,7 +27,7 @@ wxFilterIn/OutputStream \end{enumerate} wxStreamBase is the base definition of a stream. It defines, for example, -the API of OnSysRead, OnSysWrite, OnSysSeek and OnSysTell. These functions are +the API of OnSysRead, OnSysWrite, OnSysSeek and OnSysTell. These functions are really implemented by the "IO" classes. wxInputStream and wxOutputStream inherit from it. @@ -39,8 +39,8 @@ wxInputStream is the base class for read-only streams. It implements Read, SeekI (I for Input), and all read or IO generic related functions. wxOutputStream does the same thing but it is for write-only streams. -wxFilterIn/OutputStream is base class definition for stream filtering. -I mean by stream filtering, a stream which does no syscall but filter datas +wxFilterIn/OutputStream is the base class definition for stream filtering. +Stream filtering means a stream which does no syscall but filters data which are passed to it and then pass them to another stream. For example, wxZLibInputStream is an inline stream decompressor. @@ -62,13 +62,13 @@ code: // Ok, read some bytes ... nb_datas is expressed in bytes. in_stream.Read(data, nb_datas); - if (in_stream.LastError() != wxStream_NOERROR) { + if (in_stream.LastError() != wxSTREAM_NOERROR) { // Oh oh, something bad happens. // For a complete list, look into the documentation at wxStreamBase. } // You can also inline all like this. - if (in_stream.Read(data, nb_datas).LastError() != wxStream_NOERROR) { + if (in_stream.Read(data, nb_datas).LastError() != wxSTREAM_NOERROR) { // Do something. } @@ -89,5 +89,5 @@ code: As I said previously, we could add a filter stream so it takes an istream argument and builds a wxInputStream from it: I don't think it should -be difficult to implement it and it may be available in the fix of wxWindows 2.0. +be difficult to implement it and it may be available in the fix of wxWidgets 2.0.