主页 | 所有的类 | 主要的类 | 注释的类 | 分组的类 | 函数 |
QIODevice类参考
QIODevice类是输入/输出设备的基类。 详情请见……
#include <qiodevice.h>
被QBuffer、QFile、QSocket和QSocketDevice继承。
公有成员
- typedef off_t Offset
- QIODevice ()
- virtual ~QIODevice ()
- int flags () const
- int mode () const
- int state () const
- bool isDirectAccess () const
- bool isSequentialAccess () const
- bool isCombinedAccess () const
- bool isBuffered () const
- bool isRaw () const
- bool isSynchronous () const
- bool isAsynchronous () const
- bool isTranslated () const
- bool isReadable () const
- bool isWritable () const
- bool isReadWrite () const
- bool isInactive () const
- bool isOpen () const
- int status () const
- void resetStatus ()
- virtual bool open ( int mode ) = 0
- virtual void close () = 0
- virtual void flush () = 0
- virtual Offset size () const = 0
- virtual Offset at () const
- virtual bool at ( Offset pos )
- virtual bool atEnd () const
- bool reset ()
- virtual Q_LONG readBlock ( char * data, Q_ULONG maxlen ) = 0
- virtual Q_LONG writeBlock ( const char * data, Q_ULONG len ) = 0
- virtual Q_LONG readLine ( char * data, Q_ULONG maxlen )
- Q_LONG writeBlock ( const QByteArray & data )
- virtual QByteArray readAll ()
- virtual int getch () = 0
- virtual int putch ( int ch ) = 0
- virtual int ungetch ( int ch ) = 0
详细描述
QIODevice类是输入/输出设备的基类。
一个输入/输出设备代表了一个可从中读取字节和/和向它写字节的一种媒介。QIODevice类是一个所有这样的设备的抽象超类,像QFile、QBuffer和QSocket这些类继承了QIODevice类并且适当地实现了像write()这样地虚函数。
尽管应用程序有时直接使用QIODevice,但通常最好是通过提供了对任何一个QIODevice子类的流操作的QTextStream和QDataStream。QTextStream提供了基于文本的流的功能(比如对于人们是可读的ASCII文件),而QDataStream则可以以完全不依赖平台的方式处理二进制数据。
QIODevice中的公有成员可以粗略地分为两类:操作函数和状态访问函数。最主要的操作函数有:
- open() 打开一个用来读和/或写的设备,依赖于open()所使用的参数。
- close() 关闭设备并且整理好。
- readBlock() 从一个设备中读取一块数据。
- writeBlock() 向一个设备中写入一块数据。
- readLine() reads a line (of text, usually) from the device.
- flush() 确保所有的缓存数据都已经写入到真正的设备中。
这里是其它的一些不太常用的操作函数:
- getch() 读一个单字符。
- ungetch() 如果可能的话,忘记上一次对getch()的调用。
- putch() 写一个单字符。
- size() 如果有这个设备的话,返回它的大小。
- at() 如果这个设备存在一个当前读/写指针,就返回这个指针的位置,否则就移动这个指针。
- atEnd() 如果对于这个设备是有意义的问题的话,就会表示出是否还可以继续读。
- reset() 如果对于这个设备是可能的话,就移动读/写指针到这个设备的开始位置。
状态访问就是所有的“读取”函数。QIODevice子类调用setState()来更新状态,并且简单的访问函数告诉用户这个设备的状态。这里就是设置和与它们相配合的访问函数:
- 访问类型。 一些设备是被随机存取的(它可以在任何地方直接读/写),而其它的设备是顺序存取的。QIODevice提供了访问函数(isDirectAccess()、isSequentialAccess()和isCombinedAccess())来告诉用户一个给定的输入/输出设备所支持的。
- 缓存。 一些设备是以直接的模式被访问,而其它设备则使用缓存模式。缓存可以提供更高的效率,尤其是一些小的读/写操作。isBuffered()告诉用户给定的设备是否被缓存。(这通常可以通过应用程序调用open()来设置。)
- 同步性。 同步设备立即工作(比如文件)。当你从一个文件中读时,文件立刻传递它的数据。其它类型的设备,比如一个连接到HTTP服务器的套接字,也许在你命令它读取的几秒后才传递数据。isSynchronous()和isAsynchronous()会告诉用户如何操作这个设备的。
- 回车/换行翻译。 简单地说,应用程序通常喜欢看到只有一种单一的回车/换行风格,并且QIODevice子类可以提供这个。如果这个对象把回车/换行翻译成仅仅是换行,isTranslated()返回真。(这通常可以通过应用程序调用open()来设置。)
- 权限。 一些文件不能被写。比如,isReadable()、isWritable()和isReadWrite()告诉应用程序一个给定设备是否可读和可写。(这通常可以通过应用程序调用open()来设置。)
- 最后,如果设备是打开的话,比如在调用open()之后,isOpen()返回真。
QIODevice提供了大量的纯虚函数,你在继承它的时候需要实现这些函数。这里是一个子类的框架,其中包含了你所需要的全部成员和一些你也许需要的成员:
class MyDevice : public QIODevice { public: MyDevice(); ~MyDevice(); bool open( int mode ); void close(); void flush(); uint size() const; int at() const; // 非纯虚 bool at( int ); // 非纯虚 bool atEnd() const; // 非纯虚 int readBlock( char *data, uint maxlen ); int writeBlock( const char *data, uint len ); int readLine( char *data, uint maxlen ); int getch(); int putch( int ); int ungetch( int ); };
这里有三个非纯虚函数,它们对于顺序设备是可以不用实现的。
也可以参考QDataStream、QTextStream和输入/输出和网络。
成员类型文档
QIODevice::Offset
设备中的位移。成员函数文档
QIODevice::QIODevice ()
构造一个输入/输出设备。QIODevice::~QIODevice () [虚]
析构一个输入/输出设备。Offset QIODevice::at () const [虚]
虚函数返回当前输入/输出设备位置。这是输入/输出设备读/写数据的头的位置。
也可以参考size()。
bool QIODevice::at ( Offset pos ) [虚]
这是一个重载成员函数,提供了更多方便。它的行为和上面的函数基本一致。虚函数设置输入/输出位置到pos。如果位置设置成功,返回真,比如pos是在范围之内,否则返回假。
也可以参考size()。
bool QIODevice::atEnd () const [虚]
如果输入/输出设备位置在输入的末尾位置时,虚函数返回真,否则返回假。void QIODevice::close () [纯虚]
关闭输入/输出设备。这个虚函数在所有的子类中必须被重新实现。
也可以参考open()。
int QIODevice::flags () const
返回当前输入/输出设备标记设置。标记由模式标记和状态标记组成。
void QIODevice::flush () [纯虚]
刷新一个打开的输入/输出设备。
这个虚函数在所有的子类中必须被重新实现。
int QIODevice::getch () [纯虚]
从输入/输出设备中读取一个单一的字节/字符。
返回所读取的字节/字符,或者是如果到了输入/输出设备的终点,返回-1。
这个虚函数在所有的子类中必须被重新实现。
bool QIODevice::isAsynchronous () const
如果这个输入/输出设备是一个异步设备,返回真,否则返回假,比如,如果这个设备是一个同步设备。这个模式当前不在使用中。
也可以参考isSynchronous()。
bool QIODevice::isBuffered () const
如果这个输入/输出设备是一个被缓存的设备,返回真,否则返回假,比如,如果这个设备是一个直接的设备。也可以参考isRaw()。
bool QIODevice::isCombinedAccess () const
如果这个输入/输出设备是一个组合存取(既可以随机存取也可以顺序存取)的设备,返回真,否则返回假。这个访问方法当前不在使用中。
bool QIODevice::isDirectAccess () const
如果这个输入/输出设备是一个随机存取的设备,返回真,否则返回假,比如,如果这个设备是一个顺序存取的设备。也可以参考isSequentialAccess()。
bool QIODevice::isInactive () const
如果这个输入/输出设备状态是0,返回真,比如,这个设备没有打开,否则返回假。也可以参考isOpen()。
bool QIODevice::isOpen () const
如果这个输入/输出设备已经被打开,返回真,否则返回假。也可以参考isInactive()。
实例:network/networkprotocol/nntp.cpp。
bool QIODevice::isRaw () const
如果这个输入/输出设备是一个直接设备,返回真,否则返回假,比如,如果这个设备是一个被缓存的设备。也可以参考isBuffered()。
bool QIODevice::isReadWrite () const
如果这个输入/输出设备被使用IO_ReadWrite模式打开,返回真,否则返回假。也可以参考isReadable()和isWritable()。
bool QIODevice::isReadable () const
如果这个输入/输出设备被使用IO_ReadOnly或IO_ReadWrite 模式打开,返回真,否则返回假。也可以参考isWritable()和isReadWrite()。
bool QIODevice::isSequentialAccess () const
如果这个输入/输出设备是一个顺序存取的设备,返回真,否则返回假,比如,如果这个设备是一个随机存取的设备。包括size()和at(int)的操作在顺序存取的设备上都是无效的。
也可以参考isDirectAccess()。
bool QIODevice::isSynchronous () const
如果这个输入/输出设备是一个同步设备,返回真,否则返回假,比如,如果这个设备是一个异步设备。也可以参考isAsynchronous()。
bool QIODevice::isTranslated () const
如果这个输入/输出设备翻译回车/换行,返回真,否则返回假。如果QFile是以IO_Translate模式标记打开的,它就是被翻译的。
bool QIODevice::isWritable () const
如果这个输入/输出设备被使用IO_WriteOnly或IO_ReadWrite模式打开,返回真,否则返回假。也可以参考isReadable()和isReadWrite()。
int QIODevice::mode () const
返回指定的当前操作模式的位或运算的结果。这里是提供给open()函数的标记。
这些标记是IO_ReadOnly、IO_WriteOnly、IO_ReadWrite、IO_Append、IO_Truncate和IO_Translate。
bool QIODevice::open ( int mode ) [纯虚]
使用指定的mode打开输入/输出设备。如果这个设备被成功打开,返回真,否则返回假。模式参数mode必须是下列标记的或的组合。
- IO_Raw 指定直接的(非缓存的)文件访问。
- IO_ReadOnly 以只读模式打开文件。
- IO_WriteOnly 以只写模式打开文件。
- IO_ReadWrite 以读/写模式打开文件。
- IO_Append 设置文件索引到文件的末尾。
- IO_Truncate 截短文件。
- IO_Translate 在MS-DOS、Windows和Macintosh下对文本文件翻译回车和换行。在Unix系统上这个标记无效。使用时请注意,它会把文件中的每一个换行符转换为一组回车换行。如果你写二进制数据的时候,可能会破坏你要写的文件。请不要和IO_Raw组合使用。
这个虚函数在所有的子类中必须被重新实现。
也可以参考close()。
int QIODevice::putch ( int ch ) [纯虚]
向输入/输出设备写入字符ch。
返回ch,或者如果发生错误,返回-1。
这个虚函数在所有的子类中必须被重新实现。
QByteArray QIODevice::readAll () [虚]
这个方便的函数返回这个设备中的所有剩余数据。Q_LONG QIODevice::readBlock ( char * data, Q_ULONG maxlen ) [纯虚]
从这个输入/输出设备中读取最多maxlen字节到data并且返回实际读取的字节数量。如果发生致命错误,这个函数应该返回-1。
这个虚函数在所有的子类中必须被重新实现。
也可以参考writeBlock()。
在QFile、QSocket和QSocketDevice中被重新实现。
Q_LONG QIODevice::readLine ( char * data, Q_ULONG maxlen ) [虚]
读取文本的一行,(或者如果还没有遇到新的一行的情况下,读取maxlen字节)加上一个结束符\0到data。如果这一行后面还有新的一行,就不再做上述的操作了。返回包括终结符\0的所读字节数,或者如果发生错误返回-1。
这个虚函数在绝大多数子类中被重新实现的话能够提供更高的效率。
也可以参考readBlock()和QTextStream::readLine()。
在QFile中被重新实现。
bool QIODevice::reset ()
设置这个设备索引位置为0。也可以参考at()。
void QIODevice::resetStatus ()
设置这个输入/输出设备状态为IO_Ok。
也可以参考status()。
Offset QIODevice::size () const [纯虚]
虚函数返回输入/输出设备的大小。也可以参考at()。
int QIODevice::state () const
返回指定当前状态的位或运算结果。这个标记是:IO_Open。
子类也可以定义另外的标记。
int QIODevice::status () const
返回这个输入/输出设备的状态。这个输入/输出设备状态返回一个错误码。如果open()返回失败或者readBlock()或writeBlock()返回-1,这个函数就可以被调用来发现操作为什么不成功的原因。
状态码是:
- IO_Ok - 操作成功。
- IO_ReadError - 不能从设备中读取。
- IO_WriteError - 不能向设备写入。
- IO_FatalError - 发生了致命的不可恢复的错误。
- IO_OpenError - 不能打开设备。
- IO_ConnectError - 不能连接设备。
- IO_AbortError - 操作出乎意料地失败了。
- IO_TimeOutError - 操作超时。
- IO_UnspecifiedError - 关闭时发生了未指定的错误。
也可以参考resetStatus()。
int QIODevice::ungetch ( int ch ) [纯虚]
把字符ch放回到这个输入/输车设备中并且如果索引位置不是零的话,减一。
这个函数正常地被调用就是“撤销”getch()操作。
返回ch,或者如果发生错误,返回-1。
这个虚函数在所有的子类中必须被重新实现。
Q_LONG QIODevice::writeBlock ( const char * data, Q_ULONG len ) [纯虚]
从data中写len字节到这个输入/输出设备并且返回实际写的字节数。如果发生致命错误,这个函数应该返回-1。
这个虚函数在所有的子类中必须被重新实现。
也可以参考readBlock()。
在QBuffer、QSocket和QSocketDevice中被重新实现。
Q_LONG QIODevice::writeBlock ( const QByteArray & data )
这是一个重载成员函数,提供了方便。它的行为和上面的函数基本一致。这个方便的函数与调用writeBlock( data.data(), data.size() )是一样的。
这个文件是Qt工具包一部分。 版权所有 © 1995-2002 Trolltech。保留所有权利。
Copyright © 2002 Trolltech | Trademarks | 译者:Cavendish | Qt 3.0.5版
|