diff options
Diffstat (limited to 'doc/man/man3/tqdatastream.3qt')
| -rw-r--r-- | doc/man/man3/tqdatastream.3qt | 212 |
1 files changed, 106 insertions, 106 deletions
diff --git a/doc/man/man3/tqdatastream.3qt b/doc/man/man3/tqdatastream.3qt index 046771aae..cd69ab262 100644 --- a/doc/man/man3/tqdatastream.3qt +++ b/doc/man/man3/tqdatastream.3qt @@ -1,5 +1,5 @@ '\" t -.TH QDataStream 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- +.TH TQDataStream 3qt "2 February 2007" "Trolltech AS" \" -*- nroff -*- .\" Copyright 1992-2007 Trolltech ASA. All rights reserved. See the .\" license file included in the distribution for a complete license .\" statement. @@ -7,25 +7,25 @@ .ad l .nh .SH NAME -QDataStream \- Serialization of binary data to a TQIODevice +TQDataStream \- Serialization of binary data to a TQIODevice .SH SYNOPSIS All the functions in this class are reentrant when TQt is built with thread support.</p> .PP -\fC#include <ntqdatastream.h>\fR +\fC#include <tqdatastream.h>\fR .PP .SS "Public Members" .in +1c .ti -1c -.BI "\fBQDataStream\fR ()" +.BI "\fBTQDataStream\fR ()" .br .ti -1c -.BI "\fBQDataStream\fR ( TQIODevice * d )" +.BI "\fBTQDataStream\fR ( TQIODevice * d )" .br .ti -1c -.BI "\fBQDataStream\fR ( TQByteArray a, int mode )" +.BI "\fBTQDataStream\fR ( TQByteArray a, int mode )" .br .ti -1c -.BI "virtual \fB~QDataStream\fR ()" +.BI "virtual \fB~TQDataStream\fR ()" .br .ti -1c .BI "TQIODevice * \fBdevice\fR () const" @@ -64,116 +64,116 @@ All the functions in this class are reentrant when TQt is built with thread supp .BI "void \fBsetVersion\fR ( int v )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_INT8 & i )" +.BI "TQDataStream & \fBoperator>>\fR ( TQ_INT8 & i )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_UINT8 & i )" +.BI "TQDataStream & \fBoperator>>\fR ( TQ_UINT8 & i )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_INT16 & i )" +.BI "TQDataStream & \fBoperator>>\fR ( TQ_INT16 & i )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_UINT16 & i )" +.BI "TQDataStream & \fBoperator>>\fR ( TQ_UINT16 & i )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_INT32 & i )" +.BI "TQDataStream & \fBoperator>>\fR ( TQ_INT32 & i )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_UINT32 & i )" +.BI "TQDataStream & \fBoperator>>\fR ( TQ_UINT32 & i )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_INT64 & i )" +.BI "TQDataStream & \fBoperator>>\fR ( TQ_INT64 & i )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_UINT64 & i )" +.BI "TQDataStream & \fBoperator>>\fR ( TQ_UINT64 & i )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_LONG & i )" +.BI "TQDataStream & \fBoperator>>\fR ( TQ_LONG & i )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( TQ_ULONG & i )" +.BI "TQDataStream & \fBoperator>>\fR ( TQ_ULONG & i )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( float & f )" +.BI "TQDataStream & \fBoperator>>\fR ( float & f )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( double & f )" +.BI "TQDataStream & \fBoperator>>\fR ( double & f )" .br .ti -1c -.BI "QDataStream & \fBoperator>>\fR ( char *& s )" +.BI "TQDataStream & \fBoperator>>\fR ( char *& s )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_INT8 i )" +.BI "TQDataStream & \fBoperator<<\fR ( TQ_INT8 i )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_UINT8 i )" +.BI "TQDataStream & \fBoperator<<\fR ( TQ_UINT8 i )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_INT16 i )" +.BI "TQDataStream & \fBoperator<<\fR ( TQ_INT16 i )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_UINT16 i )" +.BI "TQDataStream & \fBoperator<<\fR ( TQ_UINT16 i )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_INT32 i )" +.BI "TQDataStream & \fBoperator<<\fR ( TQ_INT32 i )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_UINT32 i )" +.BI "TQDataStream & \fBoperator<<\fR ( TQ_UINT32 i )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_INT64 i )" +.BI "TQDataStream & \fBoperator<<\fR ( TQ_INT64 i )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_UINT64 i )" +.BI "TQDataStream & \fBoperator<<\fR ( TQ_UINT64 i )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_LONG i )" +.BI "TQDataStream & \fBoperator<<\fR ( TQ_LONG i )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( TQ_ULONG i )" +.BI "TQDataStream & \fBoperator<<\fR ( TQ_ULONG i )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( float f )" +.BI "TQDataStream & \fBoperator<<\fR ( float f )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( double f )" +.BI "TQDataStream & \fBoperator<<\fR ( double f )" .br .ti -1c -.BI "QDataStream & \fBoperator<<\fR ( const char * s )" +.BI "TQDataStream & \fBoperator<<\fR ( const char * s )" .br .ti -1c -.BI "QDataStream & \fBreadBytes\fR ( char *& s, uint & l )" +.BI "TQDataStream & \fBreadBytes\fR ( char *& s, uint & l )" .br .ti -1c -.BI "QDataStream & \fBreadRawBytes\fR ( char * s, uint len )" +.BI "TQDataStream & \fBreadRawBytes\fR ( char * s, uint len )" .br .ti -1c -.BI "QDataStream & \fBwriteBytes\fR ( const char * s, uint len )" +.BI "TQDataStream & \fBwriteBytes\fR ( const char * s, uint len )" .br .ti -1c -.BI "QDataStream & \fBwriteRawBytes\fR ( const char * s, uint len )" +.BI "TQDataStream & \fBwriteRawBytes\fR ( const char * s, uint len )" .br .in -1c .SH DESCRIPTION -The QDataStream class provides serialization of binary data to a TQIODevice. +The TQDataStream class provides serialization of binary data to a TQIODevice. .PP A data stream is a binary stream of encoded information which is 100% independent of the host computer's operating system, CPU or byte order. For example, a data stream that is written by a PC under Windows can be read by a Sun SPARC running Solaris. .PP You can also use a data stream to read/write raw unencoded binary data. If you want a "parsing" input stream, see TQTextStream. .PP -The QDataStream class implements the serialization of C++'s basic data types, like \fCchar\fR, \fCshort\fR, \fCint\fR, \fCchar*\fR, etc. Serialization of more complex data is accomplished by breaking up the data into primitive units. +The TQDataStream class implements the serialization of C++'s basic data types, like \fCchar\fR, \fCshort\fR, \fCint\fR, \fCchar*\fR, etc. Serialization of more complex data is accomplished by breaking up the data into primitive units. .PP -A data stream cooperates closely with a TQIODevice. A TQIODevice represents an input/output medium one can read data from and write data to. The QFile class is an example of an IO device. +A data stream cooperates closely with a TQIODevice. A TQIODevice represents an input/output medium one can read data from and write data to. The TQFile class is an example of an IO device. .PP Example (write binary data to a stream): .PP .nf .br - QFile file( "file.dat" ); + TQFile file( "file.dat" ); .br file.open( IO_WriteOnly ); .br - QDataStream stream( &file ); // we will serialize the data into the file + TQDataStream stream( &file ); // we will serialize the data into the file .br stream << "the answer is"; // serialize a string .br @@ -185,11 +185,11 @@ Example (read binary data from a stream): .PP .nf .br - QFile file( "file.dat" ); + TQFile file( "file.dat" ); .br file.open( IO_ReadOnly ); .br - QDataStream stream( &file ); // read the data serialized from the file + TQDataStream stream( &file ); // read the data serialized from the file .br TQString str; .br @@ -199,7 +199,7 @@ Example (read binary data from a stream): .br .fi .PP -Each item written to the stream is written in a predefined binary format that varies depending on the item's type. Supported TQt types include QBrush, TQColor, TQDateTime, QFont, QPixmap, TQString, QVariant and many others. For the complete list of all TQt types supporting data streaming see the Format of the QDataStream operators. +Each item written to the stream is written in a predefined binary format that varies depending on the item's type. Supported TQt types include QBrush, TQColor, TQDateTime, QFont, QPixmap, TQString, QVariant and many others. For the complete list of all TQt types supporting data streaming see the Format of the TQDataStream operators. .PP For integers it is best to always cast to a TQt integer type for writing, and to read back into the same TQt integer type. This ensures that you get integers of the size you want and insulates you from compiler and platform differences. .PP @@ -211,15 +211,15 @@ If you want the data to be compatible with an earlier version of TQt use setVers .PP If you want the data to be human-readable, e.g. for debugging, you can set the data stream into printable data mode with setPrintableData(). The data is then written slower, in a bloated but human readable format. .PP -If you are producing a new binary data format, such as a file format for documents created by your application, you could use a QDataStream to write the data in a portable format. Typically, you would write a brief header containing a magic string and a version number to give yourself room for future expansion. For example: +If you are producing a new binary data format, such as a file format for documents created by your application, you could use a TQDataStream to write the data in a portable format. Typically, you would write a brief header containing a magic string and a version number to give yourself room for future expansion. For example: .PP .nf .br - QFile file( "file.xxx" ); + TQFile file( "file.xxx" ); .br file.open( IO_WriteOnly ); .br - QDataStream stream( &file ); + TQDataStream stream( &file ); .br .br // Write a header with a "magic number" and a version @@ -239,11 +239,11 @@ Then read it in with: .PP .nf .br - QFile file( "file.xxx" ); + TQFile file( "file.xxx" ); .br file.open( IO_ReadOnly ); .br - QDataStream stream( &file ); + TQDataStream stream( &file ); .br .br // Read and check the header @@ -296,25 +296,25 @@ A similar pair of functions is readBytes() and writeBytes(). These differ from t .PP See also TQTextStream, QVariant, and Input/Output and Networking. .SS "Member Type Documentation" -.SH "QDataStream::ByteOrder" +.SH "TQDataStream::ByteOrder" The byte order used for reading/writing the data. .TP -\fCQDataStream::BigEndian\fR - the default +\fCTQDataStream::BigEndian\fR - the default .TP -\fCQDataStream::LittleEndian\fR +\fCTQDataStream::LittleEndian\fR .SH MEMBER FUNCTION DOCUMENTATION -.SH "QDataStream::QDataStream ()" +.SH "TQDataStream::TQDataStream ()" Constructs a data stream that has no IO device. .PP See also setDevice(). -.SH "QDataStream::QDataStream ( TQIODevice * d )" +.SH "TQDataStream::TQDataStream ( TQIODevice * d )" Constructs a data stream that uses the IO device \fId\fR. .PP -\fBWarning:\fR If you use QSocket or QSocketDevice as the IO device \fId\fR for reading data, you must make sure that enough data is available on the socket for the operation to successfully proceed; QDataStream does not have any means to handle or recover from short-reads. +\fBWarning:\fR If you use TQSocket or TQSocketDevice as the IO device \fId\fR for reading data, you must make sure that enough data is available on the socket for the operation to successfully proceed; TQDataStream does not have any means to handle or recover from short-reads. .PP See also setDevice() and device(). -.SH "QDataStream::QDataStream ( TQByteArray a, int mode )" -Constructs a data stream that operates on a byte array, \fIa\fR, through an internal QBuffer device. The \fImode\fR is a TQIODevice::mode(), usually either IO_ReadOnly or IO_WriteOnly. +.SH "TQDataStream::TQDataStream ( TQByteArray a, int mode )" +Constructs a data stream that operates on a byte array, \fIa\fR, through an internal TQBuffer device. The \fImode\fR is a TQIODevice::mode(), usually either IO_ReadOnly or IO_WriteOnly. .PP Example: .PP @@ -326,7 +326,7 @@ Example: .br a.setRawData( bindata, sizeof(bindata) ); // a points to bindata .br - QDataStream stream( a, IO_ReadOnly ); // open on a's data + TQDataStream stream( a, IO_ReadOnly ); // open on a's data .br stream >> [something]; // read raw bindata .br @@ -335,23 +335,23 @@ Example: .fi .PP The TQByteArray::setRawData() function is not for the inexperienced. -.SH "QDataStream::~QDataStream ()\fC [virtual]\fR" +.SH "TQDataStream::~TQDataStream ()\fC [virtual]\fR" Destroys the data stream. .PP The destructor will not affect the current IO device, unless it is an internal IO device processing a TQByteArray passed in the \fIconstructor\fR, in which case the internal IO device is destroyed. -.SH "bool QDataStream::atEnd () const" +.SH "bool TQDataStream::atEnd () const" Returns TRUE if the IO device has reached the end position (end of the stream or file) or if there is no IO device set; otherwise returns FALSE, i.e. if the current position of the IO device is before the end position. .PP See also TQIODevice::atEnd(). -.SH "int QDataStream::byteOrder () const" +.SH "int TQDataStream::byteOrder () const" Returns the current byte order setting -- either BigEndian or LittleEndian. .PP See also setByteOrder(). -.SH "TQIODevice * QDataStream::device () const" +.SH "TQIODevice * TQDataStream::device () const" Returns the IO device currently set. .PP See also setDevice() and unsetDevice(). -.SH "bool QDataStream::eof () const" +.SH "bool TQDataStream::eof () const" \fBThis function is obsolete.\fR It is provided to keep old source working. We strongly advise against using it in new code. .PP Returns TRUE if the IO device has reached the end position (end of stream or file) or if there is no IO device set. @@ -359,115 +359,115 @@ Returns TRUE if the IO device has reached the end position (end of stream or fil Returns FALSE if the current position of the read/write head of the IO device is somewhere before the end position. .PP See also TQIODevice::atEnd(). -.SH "bool QDataStream::isPrintableData () const" +.SH "bool TQDataStream::isPrintableData () const" Returns TRUE if the printable data flag has been set; otherwise returns FALSE. .PP See also setPrintableData(). -.SH "QDataStream & QDataStream::operator<< ( TQ_INT8 i )" +.SH "TQDataStream & TQDataStream::operator<< ( TQ_INT8 i )" Writes a signed byte, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_UINT8 i )" +.SH "TQDataStream & TQDataStream::operator<< ( TQ_UINT8 i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Writes an unsigned byte, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_INT16 i )" +.SH "TQDataStream & TQDataStream::operator<< ( TQ_INT16 i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Writes a signed 16-bit integer, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_UINT16 i )" +.SH "TQDataStream & TQDataStream::operator<< ( TQ_UINT16 i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Writes an unsigned 16-bit integer, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_INT32 i )" +.SH "TQDataStream & TQDataStream::operator<< ( TQ_INT32 i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Writes a signed 32-bit integer, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_UINT32 i )" +.SH "TQDataStream & TQDataStream::operator<< ( TQ_UINT32 i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Writes an unsigned integer, \fIi\fR, to the stream as a 32-bit unsigned integer (TQ_UINT32). Returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_INT64 i )" +.SH "TQDataStream & TQDataStream::operator<< ( TQ_INT64 i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Writes a signed 64-bit integer, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_UINT64 i )" +.SH "TQDataStream & TQDataStream::operator<< ( TQ_UINT64 i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Writes an unsigned 64-bit integer, \fIi\fR, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_LONG i )" +.SH "TQDataStream & TQDataStream::operator<< ( TQ_LONG i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Writes a signed integer \fIi\fR, of the system's word length, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( TQ_ULONG i )" +.SH "TQDataStream & TQDataStream::operator<< ( TQ_ULONG i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Writes an unsigned integer \fIi\fR, of the system's word length, to the stream and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( float f )" +.SH "TQDataStream & TQDataStream::operator<< ( float f )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Writes a 32-bit floating point number, \fIf\fR, to the stream using the standard IEEE754 format. Returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( double f )" +.SH "TQDataStream & TQDataStream::operator<< ( double f )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Writes a 64-bit floating point number, \fIf\fR, to the stream using the standard IEEE754 format. Returns a reference to the stream. -.SH "QDataStream & QDataStream::operator<< ( const char * s )" +.SH "TQDataStream & TQDataStream::operator<< ( const char * s )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Writes the '\0'-terminated string \fIs\fR to the stream and returns a reference to the stream. .PP The string is serialized using writeBytes(). -.SH "QDataStream & QDataStream::operator>> ( TQ_INT8 & i )" +.SH "TQDataStream & TQDataStream::operator>> ( TQ_INT8 & i )" Reads a signed byte from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_UINT8 & i )" +.SH "TQDataStream & TQDataStream::operator>> ( TQ_UINT8 & i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Reads an unsigned byte from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_INT16 & i )" +.SH "TQDataStream & TQDataStream::operator>> ( TQ_INT16 & i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Reads a signed 16-bit integer from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_UINT16 & i )" +.SH "TQDataStream & TQDataStream::operator>> ( TQ_UINT16 & i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Reads an unsigned 16-bit integer from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_INT32 & i )" +.SH "TQDataStream & TQDataStream::operator>> ( TQ_INT32 & i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Reads a signed 32-bit integer from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_UINT32 & i )" +.SH "TQDataStream & TQDataStream::operator>> ( TQ_UINT32 & i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Reads an unsigned 32-bit integer from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_INT64 & i )" +.SH "TQDataStream & TQDataStream::operator>> ( TQ_INT64 & i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Reads a signed 64-bit integer from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_UINT64 & i )" +.SH "TQDataStream & TQDataStream::operator>> ( TQ_UINT64 & i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Reads an unsigned 64-bit integer from the stream, into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_LONG & i )" +.SH "TQDataStream & TQDataStream::operator>> ( TQ_LONG & i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Reads a signed integer of the system's word length from the stream into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( TQ_ULONG & i )" +.SH "TQDataStream & TQDataStream::operator>> ( TQ_ULONG & i )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Reads an unsigned integer of the system's word length from the stream, into \fIi\fR, and returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( float & f )" +.SH "TQDataStream & TQDataStream::operator>> ( float & f )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Reads a 32-bit floating point number from the stream into \fIf\fR, using the standard IEEE754 format. Returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( double & f )" +.SH "TQDataStream & TQDataStream::operator>> ( double & f )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Reads a 64-bit floating point number from the stream into \fIf\fR, using the standard IEEE754 format. Returns a reference to the stream. -.SH "QDataStream & QDataStream::operator>> ( char *& s )" +.SH "TQDataStream & TQDataStream::operator>> ( char *& s )" This is an overloaded member function, provided for convenience. It behaves essentially like the above function. .PP Reads the '\0'-terminated string \fIs\fR from the stream and returns a reference to the stream. .PP Space for the string is allocated using \fCnew\fR -- the caller must destroy it with delete[]. -.SH "QDataStream & QDataStream::readBytes ( char *& s, uint & l )" +.SH "TQDataStream & TQDataStream::readBytes ( char *& s, uint & l )" Reads the buffer \fIs\fR from the stream and returns a reference to the stream. .PP The buffer \fIs\fR is allocated using \fCnew\fR. Destroy it with the \fCdelete[]\fR operator. If the length is zero or \fIs\fR cannot be allocated, \fIs\fR is set to 0. @@ -477,68 +477,68 @@ The \fIl\fR parameter will be set to the length of the buffer. The serialization format is a TQ_UINT32 length specifier first, then \fIl\fR bytes of data. Note that the data is \fInot\fR encoded. .PP See also readRawBytes() and writeBytes(). -.SH "QDataStream & QDataStream::readRawBytes ( char * s, uint len )" +.SH "TQDataStream & TQDataStream::readRawBytes ( char * s, uint len )" Reads \fIlen\fR bytes from the stream into \fIs\fR and returns a reference to the stream. .PP The buffer \fIs\fR must be preallocated. The data is \fInot\fR encoded. .PP See also readBytes(), TQIODevice::readBlock(), and writeRawBytes(). -.SH "void QDataStream::setByteOrder ( int bo )" +.SH "void TQDataStream::setByteOrder ( int bo )" Sets the serialization byte order to \fIbo\fR. .PP -The \fIbo\fR parameter can be QDataStream::BigEndian or QDataStream::LittleEndian. +The \fIbo\fR parameter can be TQDataStream::BigEndian or TQDataStream::LittleEndian. .PP The default setting is big endian. We recommend leaving this setting unless you have special requirements. .PP See also byteOrder(). -.SH "void QDataStream::setDevice ( TQIODevice * d )" -void QDataStream::setDevice(TQIODevice *d ) +.SH "void TQDataStream::setDevice ( TQIODevice * d )" +void TQDataStream::setDevice(TQIODevice *d ) .PP Sets the IO device to \fId\fR. .PP See also device() and unsetDevice(). -.SH "void QDataStream::setPrintableData ( bool enable )" +.SH "void TQDataStream::setPrintableData ( bool enable )" If \fIenable\fR is TRUE, data will be output in a human readable format. If \fIenable\fR is FALSE, data will be output in a binary format. .PP If \fIenable\fR is TRUE, the write functions will generate output that consists of printable characters (7 bit ASCII). This output will typically be a lot larger than the default binary output, and consequently slower to write. .PP We recommend only enabling printable data for debugging purposes. -.SH "void QDataStream::setVersion ( int v )" +.SH "void TQDataStream::setVersion ( int v )" Sets the version number of the data serialization format to \fIv\fR. .PP You don't need to set a version if you are using the current version of Qt. .PP -In order to accommodate new functionality, the datastream serialization format of some TQt classes has changed in some versions of Qt. If you want to read data that was created by an earlier version of Qt, or write data that can be read by a program that was compiled with an earlier version of Qt, use this function to modify the serialization format of QDataStream. +In order to accommodate new functionality, the datastream serialization format of some TQt classes has changed in some versions of Qt. If you want to read data that was created by an earlier version of Qt, or write data that can be read by a program that was compiled with an earlier version of Qt, use this function to modify the serialization format of TQDataStream. .PP <center>.nf .TS -l - l. TQt Version QDataStream Version TQt 3.3 6 TQt 3.2 5 TQt 3.1 5 TQt 3.0 4 TQt 2.1.x and TQt 2.2.x 3 TQt 2.0.x 2 TQt 1.x +l - l. TQt Version TQDataStream Version TQt 3.3 6 TQt 3.2 5 TQt 3.1 5 TQt 3.0 4 TQt 2.1.x and TQt 2.2.x 3 TQt 2.0.x 2 TQt 1.x .TE .fi </center> .PP See also version(). -.SH "void QDataStream::unsetDevice ()" +.SH "void TQDataStream::unsetDevice ()" Unsets the IO device. This is the same as calling setDevice( 0 ). .PP See also device() and setDevice(). -.SH "int QDataStream::version () const" +.SH "int TQDataStream::version () const" Returns the version number of the data serialization format. In TQt 3.1, this number is 5. .PP See also setVersion(). -.SH "QDataStream & QDataStream::writeBytes ( const char * s, uint len )" +.SH "TQDataStream & TQDataStream::writeBytes ( const char * s, uint len )" Writes the length specifier \fIlen\fR and the buffer \fIs\fR to the stream and returns a reference to the stream. .PP The \fIlen\fR is serialized as a TQ_UINT32, followed by \fIlen\fR bytes from \fIs\fR. Note that the data is \fInot\fR encoded. .PP See also writeRawBytes() and readBytes(). -.SH "QDataStream & QDataStream::writeRawBytes ( const char * s, uint len )" +.SH "TQDataStream & TQDataStream::writeRawBytes ( const char * s, uint len )" Writes \fIlen\fR bytes from \fIs\fR to the stream and returns a reference to the stream. The data is \fInot\fR encoded. .PP See also writeBytes(), TQIODevice::writeBlock(), and readRawBytes(). .SH "SEE ALSO" -.BR http://doc.trolltech.com/ntqdatastream.html +.BR http://doc.trolltech.com/tqdatastream.html .BR http://www.trolltech.com/faq/tech.html .SH COPYRIGHT Copyright 1992-2007 Trolltech ASA, http://www.trolltech.com. See the |