adjusted indentation with astyle; added Id keyword
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52383 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -9,24 +9,24 @@
|
||||
/**
|
||||
@class wxDataOutputStream
|
||||
@wxheader{datstrm.h}
|
||||
|
||||
|
||||
This class provides functions that write binary data types in a
|
||||
portable way. Data can be written in either big-endian or little-endian
|
||||
format, little-endian being the default on all architectures.
|
||||
|
||||
If you want to write data to text files (or streams) use
|
||||
|
||||
If you want to write data to text files (or streams) use
|
||||
wxTextOutputStream instead.
|
||||
|
||||
The operator is overloaded and you can use this class like a standard
|
||||
C++ iostream. See wxDataInputStream for its
|
||||
|
||||
The operator is overloaded and you can use this class like a standard
|
||||
C++ iostream. See wxDataInputStream for its
|
||||
usage and caveats.
|
||||
|
||||
See also wxDataInputStream.
|
||||
|
||||
|
||||
See also wxDataInputStream.
|
||||
|
||||
@library{wxbase}
|
||||
@category{streams}
|
||||
*/
|
||||
class wxDataOutputStream
|
||||
class wxDataOutputStream
|
||||
{
|
||||
public:
|
||||
//@{
|
||||
@@ -36,11 +36,11 @@ public:
|
||||
Constructs a datastream object from an output stream. Only write methods will
|
||||
be available. The second form is only available in Unicode build of wxWidgets.
|
||||
|
||||
@param stream
|
||||
@param stream
|
||||
The output stream.
|
||||
|
||||
@param conv
|
||||
Charset conversion object object used to encoding Unicode
|
||||
@param conv
|
||||
Charset conversion object object used to encoding Unicode
|
||||
strings before writing them to the stream
|
||||
in Unicode mode (see WriteString()
|
||||
documentation for detailed description). Note that you must not destroy
|
||||
@@ -48,7 +48,7 @@ public:
|
||||
recommended to use default value (UTF-8).
|
||||
*/
|
||||
wxDataOutputStream(wxOutputStream& stream);
|
||||
wxDataOutputStream(wxOutputStream& stream);
|
||||
wxDataOutputStream(wxOutputStream& stream);
|
||||
//@}
|
||||
|
||||
/**
|
||||
@@ -70,7 +70,7 @@ public:
|
||||
16 bit unsigned integer to write is specified with the @e size variable.
|
||||
*/
|
||||
void Write16(wxUint16 i16);
|
||||
void Write16(const wxUint16 * buffer, size_t size);
|
||||
void Write16(const wxUint16 * buffer, size_t size);
|
||||
//@}
|
||||
|
||||
//@{
|
||||
@@ -79,7 +79,7 @@ public:
|
||||
32 bit unsigned integer to write is specified with the @e size variable.
|
||||
*/
|
||||
void Write32(wxUint32 i32);
|
||||
void Write32(const wxUint32 * buffer, size_t size);
|
||||
void Write32(const wxUint32 * buffer, size_t size);
|
||||
//@}
|
||||
|
||||
//@{
|
||||
@@ -88,7 +88,7 @@ public:
|
||||
64 bit unsigned integer to write is specified with the @e size variable.
|
||||
*/
|
||||
void Write64(wxUint64 i64);
|
||||
void Write64(const wxUint64 * buffer, size_t size);
|
||||
void Write64(const wxUint64 * buffer, size_t size);
|
||||
//@}
|
||||
|
||||
//@{
|
||||
@@ -97,7 +97,7 @@ public:
|
||||
specified with the @e size variable.
|
||||
*/
|
||||
void Write8(wxUint8 i8);
|
||||
void Write8(const wxUint8 * buffer, size_t size);
|
||||
void Write8(const wxUint8 * buffer, size_t size);
|
||||
//@}
|
||||
|
||||
//@{
|
||||
@@ -106,7 +106,7 @@ public:
|
||||
specified with the @e size variable.
|
||||
*/
|
||||
void WriteDouble(double f);
|
||||
void WriteDouble(const double * buffer, size_t size);
|
||||
void WriteDouble(const double * buffer, size_t size);
|
||||
//@}
|
||||
|
||||
/**
|
||||
@@ -116,7 +116,7 @@ public:
|
||||
In ANSI build of wxWidgets, the string is written to the stream in exactly
|
||||
same way it is represented in memory. In Unicode build, however, the string
|
||||
is first converted to multibyte representation with @e conv object passed
|
||||
to stream's constructor (consequently, ANSI application can read data
|
||||
to stream's constructor (consequently, ANSI application can read data
|
||||
written by Unicode application, as long as they agree on encoding) and this
|
||||
representation is written to the stream. UTF-8 is used by default.
|
||||
*/
|
||||
@@ -127,14 +127,14 @@ public:
|
||||
/**
|
||||
@class wxDataInputStream
|
||||
@wxheader{datstrm.h}
|
||||
|
||||
|
||||
This class provides functions that read binary data types in a
|
||||
portable way. Data can be read in either big-endian or little-endian
|
||||
format, little-endian being the default on all architectures.
|
||||
|
||||
If you want to read data from text files (or streams) use
|
||||
|
||||
If you want to read data from text files (or streams) use
|
||||
wxTextInputStream instead.
|
||||
|
||||
|
||||
The operator is overloaded and you can use this class like a standard C++
|
||||
iostream.
|
||||
Note, however, that the arguments are the fixed size types wxUint32, wxInt32 etc
|
||||
@@ -143,27 +143,27 @@ public:
|
||||
is defined as signed int on 32-bit architectures) so that you cannot use long.
|
||||
To avoid
|
||||
problems (here and elsewhere), make use of the wxInt32, wxUint32, etc types.
|
||||
|
||||
|
||||
For example:
|
||||
|
||||
|
||||
@code
|
||||
wxFileInputStream input( "mytext.dat" );
|
||||
wxDataInputStream store( input );
|
||||
wxUint8 i1;
|
||||
float f2;
|
||||
wxString line;
|
||||
|
||||
|
||||
store i1; // read a 8 bit integer.
|
||||
store i1 f2; // read a 8 bit integer followed by float.
|
||||
store line; // read a text line
|
||||
@endcode
|
||||
|
||||
See also wxDataOutputStream.
|
||||
|
||||
|
||||
See also wxDataOutputStream.
|
||||
|
||||
@library{wxbase}
|
||||
@category{streams}
|
||||
*/
|
||||
class wxDataInputStream
|
||||
class wxDataInputStream
|
||||
{
|
||||
public:
|
||||
//@{
|
||||
@@ -173,17 +173,17 @@ public:
|
||||
Constructs a datastream object from an input stream. Only read methods will
|
||||
be available. The second form is only available in Unicode build of wxWidgets.
|
||||
|
||||
@param stream
|
||||
@param stream
|
||||
The input stream.
|
||||
|
||||
@param conv
|
||||
Charset conversion object object used to decode strings in Unicode
|
||||
@param conv
|
||||
Charset conversion object object used to decode strings in Unicode
|
||||
mode (see ReadString()
|
||||
documentation for detailed description). Note that you must not destroy
|
||||
conv before you destroy this wxDataInputStream instance!
|
||||
*/
|
||||
wxDataInputStream(wxInputStream& stream);
|
||||
wxDataInputStream(wxInputStream& stream);
|
||||
wxDataInputStream(wxInputStream& stream);
|
||||
//@}
|
||||
|
||||
/**
|
||||
@@ -193,8 +193,8 @@ public:
|
||||
|
||||
/**
|
||||
If @e be_order is @true, all data will be read in big-endian
|
||||
order, such as written by programs on a big endian architecture
|
||||
(e.g. Sparc) or written by Java-Streams (which always use
|
||||
order, such as written by programs on a big endian architecture
|
||||
(e.g. Sparc) or written by Java-Streams (which always use
|
||||
big-endian order).
|
||||
*/
|
||||
void BigEndianOrdered(bool be_order);
|
||||
@@ -205,7 +205,7 @@ public:
|
||||
amount of 16 bit unsigned integer to read is specified by the @e size variable.
|
||||
*/
|
||||
wxUint16 Read16();
|
||||
void Read16(wxUint16 * buffer, size_t size);
|
||||
void Read16(wxUint16 * buffer, size_t size);
|
||||
//@}
|
||||
|
||||
//@{
|
||||
@@ -215,7 +215,7 @@ public:
|
||||
32 bit unsigned integer to read is specified by the @e size variable.
|
||||
*/
|
||||
wxUint32 Read32();
|
||||
void Read32(wxUint32 * buffer, size_t size);
|
||||
void Read32(wxUint32 * buffer, size_t size);
|
||||
//@}
|
||||
|
||||
//@{
|
||||
@@ -225,7 +225,7 @@ public:
|
||||
64 bit unsigned integer to read is specified by the @e size variable.
|
||||
*/
|
||||
wxUint64 Read64();
|
||||
void Read64(wxUint64 * buffer, size_t size);
|
||||
void Read64(wxUint64 * buffer, size_t size);
|
||||
//@}
|
||||
|
||||
//@{
|
||||
@@ -234,7 +234,7 @@ public:
|
||||
bytes to read is specified by the @e size variable.
|
||||
*/
|
||||
wxUint8 Read8();
|
||||
void Read8(wxUint8 * buffer, size_t size);
|
||||
void Read8(wxUint8 * buffer, size_t size);
|
||||
//@}
|
||||
|
||||
//@{
|
||||
@@ -244,12 +244,12 @@ public:
|
||||
double to read is specified by the @e size variable.
|
||||
*/
|
||||
double ReadDouble();
|
||||
void ReadDouble(double * buffer, size_t size);
|
||||
void ReadDouble(double * buffer, size_t size);
|
||||
//@}
|
||||
|
||||
/**
|
||||
Reads a string from a stream. Actually, this function first reads a long
|
||||
integer specifying the length of the string (without the last null character)
|
||||
Reads a string from a stream. Actually, this function first reads a long
|
||||
integer specifying the length of the string (without the last null character)
|
||||
and then reads the string.
|
||||
|
||||
In Unicode build of wxWidgets, the fuction first reads multibyte (char*)
|
||||
|
Reference in New Issue
Block a user