Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions
Download Patch File Download Diff File Expand all files Collapse all files

79
interface/datstrm.h
View File

@@ -32,20 +32,18 @@ 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
The output stream.
The output stream.
@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
conv before you destroy this wxDataOutputStream instance! It is
recommended to use default value (UTF-8).
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
conv before you destroy this wxDataOutputStream instance! It is
recommended to use default value (UTF-8).
*/
wxDataOutputStream(wxOutputStream& stream);
wxDataOutputStream(wxOutputStream& stream);
@@ -57,7 +55,7 @@ public:
~wxDataOutputStream();
/**
If @e be_order is @true, all data will be written in big-endian
If @a be_order is @true, all data will be written in big-endian
order, e.g. for reading on a Sparc or from Java-Streams (which
always use big-endian order), otherwise data will be written in
little-endian order.
@@ -67,52 +65,51 @@ public:
//@{
/**
Writes an array of 16 bit unsigned integer to the stream. The amount of
16 bit unsigned integer to write is specified with the @e size variable.
16 bit unsigned integer to write is specified with the @a size variable.
*/
void Write16(wxUint16 i16);
void Write16(const wxUint16 * buffer, size_t size);
void Write16(const wxUint16* buffer, size_t size);
//@}
//@{
/**
Writes an array of 32 bit unsigned integer to the stream. The amount of
32 bit unsigned integer to write is specified with the @e size variable.
32 bit unsigned integer to write is specified with the @a size variable.
*/
void Write32(wxUint32 i32);
void Write32(const wxUint32 * buffer, size_t size);
void Write32(const wxUint32* buffer, size_t size);
//@}
//@{
/**
Writes an array of 64 bit unsigned integer to the stream. The amount of
64 bit unsigned integer to write is specified with the @e size variable.
64 bit unsigned integer to write is specified with the @a size variable.
*/
void Write64(wxUint64 i64);
void Write64(const wxUint64 * buffer, size_t size);
void Write64(const wxUint64* buffer, size_t size);
//@}
//@{
/**
Writes an array of bytes to the stream. The amount of bytes to write is
specified with the @e size variable.
specified with the @a size variable.
*/
void Write8(wxUint8 i8);
void Write8(const wxUint8 * buffer, size_t size);
void Write8(const wxUint8* buffer, size_t size);
//@}
//@{
/**
Writes an array of double to the stream. The amount of double to write is
specified with the @e size variable.
specified with the @a size variable.
*/
void WriteDouble(double f);
void WriteDouble(const double * buffer, size_t size);
void WriteDouble(const double* buffer, size_t size);
//@}
/**
Writes @e string to the stream. Actually, this method writes the size of
the string before writing @e string itself.
Writes @a string to the stream. Actually, this method writes the size of
the string before writing @a string itself.
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
@@ -169,18 +166,16 @@ 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
The input stream.
The input stream.
@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!
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);
@@ -192,7 +187,7 @@ public:
~wxDataInputStream();
/**
If @e be_order is @true, all data will be read in big-endian
If @a 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
big-endian order).
@@ -202,61 +197,59 @@ public:
//@{
/**
Reads 16 bit unsigned integers from the stream in a specified buffer. the
amount of 16 bit unsigned integer to read is specified by the @e size variable.
amount of 16 bit unsigned integer to read is specified by the @a size variable.
*/
wxUint16 Read16();
void Read16(wxUint16 * buffer, size_t size);
void Read16(wxUint16* buffer, size_t size);
//@}
//@{
/**
Reads 32 bit unsigned integers from the stream in a specified buffer. the
amount of
32 bit unsigned integer to read is specified by the @e size variable.
32 bit unsigned integer to read is specified by the @a size variable.
*/
wxUint32 Read32();
void Read32(wxUint32 * buffer, size_t size);
void Read32(wxUint32* buffer, size_t size);
//@}
//@{
/**
Reads 64 bit unsigned integers from the stream in a specified buffer. the
amount of
64 bit unsigned integer to read is specified by the @e size variable.
64 bit unsigned integer to read is specified by the @a size variable.
*/
wxUint64 Read64();
void Read64(wxUint64 * buffer, size_t size);
void Read64(wxUint64* buffer, size_t size);
//@}
//@{
/**
Reads bytes from the stream in a specified buffer. The amount of
bytes to read is specified by the @e size variable.
bytes to read is specified by the @a size variable.
*/
wxUint8 Read8();
void Read8(wxUint8 * buffer, size_t size);
void Read8(wxUint8* buffer, size_t size);
//@}
//@{
/**
Reads double data (IEEE encoded) from the stream in a specified buffer. the
amount of
double to read is specified by the @e size variable.
double to read is specified by the @a 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)
and then reads the string.
In Unicode build of wxWidgets, the fuction first reads multibyte (char*)
string from the stream and then converts it to Unicode using the @e conv
object passed to constructor and returns the result as wxString. You are
responsible for using the same convertor as when writing the stream.
See also wxDataOutputStream::WriteString.
*/
wxString ReadString();