removed useless spaces
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@51911 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -7,9 +7,9 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/*!
|
||||
|
||||
|
||||
@page stream_overview wxStreams overview
|
||||
|
||||
|
||||
Classes: #wxStreamBase,
|
||||
#wxStreamBuffer, #wxInputStream,
|
||||
#wxOutputStream,
|
||||
@@ -25,15 +25,15 @@
|
||||
reliably compile and run on all supported platforms without dependence on a
|
||||
particular release of libg++.
|
||||
wxStreams is divided in two main parts:
|
||||
|
||||
|
||||
|
||||
|
||||
the core: wxStreamBase, wxStreamBuffer, wxInputStream, wxOutputStream,
|
||||
wxFilterIn/OutputStream
|
||||
the "IO" classes: wxSocketIn/OutputStream, wxDataIn/OutputStream, wxFileIn/OutputStream, ...
|
||||
|
||||
|
||||
|
||||
|
||||
wxStreamBase is the base definition of a stream. It defines, for example,
|
||||
the API of OnSysRead, OnSysWrite, OnSysSeek and OnSysTell. These functions
|
||||
the API of OnSysRead, OnSysWrite, OnSysSeek and OnSysTell. These functions
|
||||
are really implemented by the "IO" classes.
|
||||
wxInputStream and wxOutputStream inherit from it.
|
||||
wxStreamBuffer is a cache manager for wxStreamBase: it manages a stream buffer
|
||||
@@ -53,38 +53,38 @@
|
||||
@b Generic usage: an example
|
||||
Usage is simple. We can take the example of wxFileInputStream and here is some sample
|
||||
code:
|
||||
|
||||
|
||||
@code
|
||||
...
|
||||
// The constructor initializes the stream buffer and open the file descriptor
|
||||
// associated to the name of the file.
|
||||
wxFileInputStream in_stream("the_file_to_be_read");
|
||||
|
||||
|
||||
// Ok, read some bytes ... nb_datas is expressed in bytes.
|
||||
in_stream.Read(data, nb_datas);
|
||||
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) {
|
||||
// Do something.
|
||||
}
|
||||
|
||||
|
||||
// You can also get the last number of bytes REALLY put into the buffer.
|
||||
size_t really_read = in_stream.LastRead();
|
||||
|
||||
// Ok, moves to the beginning of the stream. SeekI returns the last position
|
||||
|
||||
// Ok, moves to the beginning of the stream. SeekI returns the last position
|
||||
// in the stream counted from the beginning.
|
||||
off_t old_position = in_stream.SeekI(0, wxFromBeginning);
|
||||
|
||||
|
||||
// What is my current position ?
|
||||
off_t position = in_stream.TellI();
|
||||
|
||||
|
||||
// wxFileInputStream will close the file descriptor on destruction.
|
||||
@endcode
|
||||
|
||||
|
||||
*/
|
||||
|
||||
|
||||
|
||||
|
||||
|
Reference in New Issue
Block a user