📄 qfile.html
字号:
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<!-- /home/reggie/tmp/qt-3.0-reggie-5401/qt-x11-commercial-3.0.5/src/tools/qfile.cpp:45 -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=gb2312">
<meta name="Translator" content="Cavendish">
<meta name="Qt zh_CN Documents Website" content="http://www.qiliang.net/qt">
<title>QFile类</title>
<style type="text/css"><!--
h3.fn,span.fn { margin-left: 1cm; text-indent: -1cm; }
a:link { color: #004faf; text-decoration: none }
a:visited { color: #672967; text-decoration: none }
body { background: #ffffff; color: black; font-family: "Times New Roman" }
--></style>
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr bgcolor="#E5E5E5">
<td valign=center>
<a href="index.html">
<font color="#004faf">主页</font></a>
| <a href="classes.html">
<font color="#004faf">所有的类</font></a>
| <a href="mainclasses.html">
<font color="#004faf">主要的类</font></a>
| <a href="annotated.html">
<font color="#004faf">注释的类</font></a>
| <a href="groups.html">
<font color="#004faf">分组的类</font></a>
| <a href="functions.html">
<font color="#004faf">函数</font></a>
</td>
<td align="right" valign="center"><img src="logo32.png" align="right" width="64" height="32" border="0"></td></tr></table>
<h1 align=center>QFile类参考</h1>
<p>QFile类是一个操作文件的输入/输出设备。
<a href="#details">详情请见……</a>
<p><tt>#include <<a href="qfile-h.html">qfile.h</a>></tt>
<p>继承了 <a href="qiodevice.html">QIODevice</a>。
<p><a href="qfile-members.html">所有成员函数的列表。</a>
<h2>公有成员</h2>
<ul>
<li><div class=fn><a href="#QFile"><b>QFile</b></a> ()</div></li>
<li><div class=fn><a href="#QFile-2"><b>QFile</b></a> ( const QString & name )</div></li>
<li><div class=fn><a href="#~QFile"><b>~QFile</b></a> ()</div></li>
<li><div class=fn>QString <a href="#name"><b>name</b></a> () const</div></li>
<li><div class=fn>void <a href="#setName"><b>setName</b></a> ( const QString & name )</div></li>
<li><div class=fn>typedef QCString (* <a href="#EncoderFn"><b>EncoderFn</b></a> ) ( const QString & fileName )</div></li>
<li><div class=fn>typedef QString (* <a href="#DecoderFn"><b>DecoderFn</b></a> ) ( const QCString & localfileName )</div></li>
<li><div class=fn>bool <a href="#exists-2"><b>exists</b></a> () const</div></li>
<li><div class=fn>bool <a href="#remove"><b>remove</b></a> ()</div></li>
<li><div class=fn>virtual bool <a href="#open"><b>open</b></a> ( int m )</div></li>
<li><div class=fn>bool <a href="#open-2"><b>open</b></a> ( int m, FILE * f )</div></li>
<li><div class=fn>bool <a href="#open-3"><b>open</b></a> ( int m, int f )</div></li>
<li><div class=fn>virtual void <a href="#close"><b>close</b></a> ()</div></li>
<li><div class=fn>virtual void <a href="#flush"><b>flush</b></a> ()</div></li>
<li><div class=fn>virtual Offset <a href="#size"><b>size</b></a> () const</div></li>
<li><div class=fn>virtual Offset <a href="#at-2"><b>at</b></a> () const</div></li>
<li><div class=fn>virtual bool <a href="#at"><b>at</b></a> ( Offset pos )</div></li>
<li><div class=fn>virtual bool <a href="#atEnd"><b>atEnd</b></a> () const</div></li>
<li><div class=fn>virtual Q_LONG <a href="#readBlock"><b>readBlock</b></a> ( char * p, Q_ULONG len )</div></li>
<li><div class=fn>virtual Q_LONG <a href="#readLine"><b>readLine</b></a> ( char * p, Q_ULONG maxlen )</div></li>
<li><div class=fn>Q_LONG <a href="#readLine-2"><b>readLine</b></a> ( QString & s, Q_ULONG maxlen )</div></li>
<li><div class=fn>virtual int <a href="#getch"><b>getch</b></a> ()</div></li>
<li><div class=fn>virtual int <a href="#putch"><b>putch</b></a> ( int ch )</div></li>
<li><div class=fn>virtual int <a href="#ungetch"><b>ungetch</b></a> ( int ch )</div></li>
<li><div class=fn>int <a href="#handle"><b>handle</b></a> () const</div></li>
</ul>
<h2>静态公有成员</h2>
<ul>
<li><div class=fn>QCString <a href="#encodeName"><b>encodeName</b></a> ( const QString & fileName )</div></li>
<li><div class=fn>QString <a href="#decodeName"><b>decodeName</b></a> ( const QCString & localFileName )</div></li>
<li><div class=fn>void <a href="#setEncodingFunction"><b>setEncodingFunction</b></a> ( EncoderFn f )</div></li>
<li><div class=fn>void <a href="#setDecodingFunction"><b>setDecodingFunction</b></a> ( DecoderFn f )</div></li>
<li><div class=fn>bool <a href="#exists"><b>exists</b></a> ( const QString & fileName )</div></li>
<li><div class=fn>bool <a href="#remove-2"><b>remove</b></a> ( const QString & fileName )</div></li>
</ul>
<h2>重要的继承成员</h2>
<ul>
<li><div class=fn>virtual QByteArray <a href="#readAll"><b>readAll</b></a> ()</div></li>
</ul>
<hr><a name="details"></a><h2>详细描述</h2>
QFile类是一个操作文件的输入/输出设备。
<p>
<p> QFile是用来读写二进制文件和文本文件的输入/输出设备。QFile可以自己单独被使用，但是如果和<a href="qdatastream.html">QDataStream</a>或<a href="qtextstream.html">QTextStream</a>一起使用将更加方便。
<p> 文件名通常可以通过构造函数来传递，但也可以使用<a href="#setName">setName</a>()来设置。你可以通过<a href="#exists">exists</a>()来检查一个文件是否存在并且可以通过<a href="#remove">remove</a>()来移去一个文件。
<p> 文件可以用<a href="#open">open</a>()来打开、用<a href="#close">close</a>()来关闭、用<a href="#flush">flush</a>()来刷新。数据通常可以使用QDataStream或者QTextStream进行读写，但你也可以使用<a href="#readBlock">readBlock</a>()和<a href="#readLine">readLine</a>()来读，使用<a href="qiodevice.html#writeBlock">writeBlock</a>()来写。QFile也支持<a href="#getch">getch</a>()、 <a href="#ungetch">ungetch</a>()和<a href="#putch">putch</a>()。
<p> <a href="#size">size</a>()可以返回文件的大小。你可以通过使用<a href="#at">at</a>()函数得到当前文件位置或者移到一个新的文件位置。如果你到了文件的末尾，<a href="#atEnd">atEnd</a>()返回真。<a href="#handle">handle</a>()返回文件句柄。
<p> 这里是一个使用<a href="qtextstream.html">QTextStream</a>来一行一行地读取一个文本文件的代码段。它会把每一行带上一个行号打印出来。
<pre>
<a href="qstringlist.html">QStringList</a> lines;
QFile file( "file.txt" );
if ( file.<a href="#open">open</a>( IO_ReadOnly ) ) {
<a href="qtextstream.html">QTextStream</a> stream( &file );
<a href="qstring.html">QString</a> line;
int n = 1;
while ( !stream.<a href="qtextstream.html#eof">eof</a>() ) {
line = stream.<a href="qtextstream.html#readLine">readLine</a>(); // 不包括“\n”的一行文本
printf( "%3d: %s\n", n++, line.<a href="qstring.html#latin1">latin1</a>() );
lines += line;
}
file.<a href="#close">close</a>();
}
</pre>
<p> 写文本也很容易（假设我们有一个行的字符串列表要写）：
<pre>
QFile file( "file.txt" );
if ( file.<a href="#open">open</a>( IO_WriteOnly ) ) {
<a href="qtextstream.html">QTextStream</a> stream( &file );
for ( QStringList::Iterator it = lines.begin(); it != lines.end(); ++it )
stream << *it << "\n";
file.<a href="#close">close</a>();
}
</pre>
<p> <a href="qfileinfo.html">QFileInfo</a>类控制文件的详细信息，比如访问权限、文件日期和文件类型。
<p> <a href="qdir.html">QDir</a>类管理目录和文件名列表。
<p> Qt使用Unicode文件名。如果你想在Unix系统上使用你自己的输入/输出，你可以使用<a href="#encodeName">encodeName</a>()（和<a href="#decodeName">decodeName</a>()）来把文件名转换为本地编码。
<p>
<p> <p>也可以参考<a href="qdatastream.html">QDataStream</a>、<a href="qtextstream.html">QTextStream</a>和<a href="io.html">输入/输出和网络</a>。
<hr><h2>成员类型文档</h2>
<h3 class=fn><a name="DecoderFn"></a>QFile::DecoderFn</h3>
<p> 被<a href="#setDecodingFunction">QFile::setDecodingFunction</a>()使用。
<h3 class=fn><a name="EncoderFn"></a>QFile::EncoderFn</h3>
<p> 被<a href="#setEncodingFunction">QFile::setEncodingFunction</a>()使用。
<hr><h2>成员函数文档</h2>
<h3 class=fn><a name="QFile"></a>QFile::QFile ()
</h3>
构造一个没有名称的QFile。
<h3 class=fn><a name="QFile-2"></a>QFile::QFile ( const <a href="qstring.html">QString</a> & name )
</h3>
构造一个文件名为<em>name</em>的QFile。
<p>也可以参考<a href="#setName">setName</a>()。
<h3 class=fn><a name="~QFile"></a>QFile::~QFile ()
</h3>
析构QFile。调用<a href="#close">close</a>()。
<h3 class=fn>bool <a name="at"></a>QFile::at ( <a href="qiodevice.html#Offset">Offset</a> pos )<tt> [虚]</tt>
</h3>
设置文件索引到<em>pos</em>。如果成功，返回真，否则返回假。
<p> 实例：
<pre>
QFile f( "data.bin" );
f.<a href="#open">open</a>( <a href="qfile.html#open">IO_ReadOnly</a> ); // 索引设置为0
f.<a href="#at">at</a>( 100 ); // 设置索引为100
f.<a href="#at">at</a>( f.<a href="#at">at</a>()+50 ); // 设置索引为150
f.<a href="#at">at</a>( f.<a href="#size">size</a>()-80 ); // 设置索引为EOF之前的80
f.<a href="#close">close</a>();
</pre>
<p> 不带参数使用<a href="#at">at</a>()可以重新得到文件的位移。
<p> <b>警告：</b>如果文件是使用<a href="qfile.html#open">IO_Append</a>方式打开（<a href="#open">open</a>()）的话，结果是未定义的。
<p> <p>也可以参考<a href="#size">size</a>()和<a href="#open">open</a>()。
<p>从<a href="qiodevice.html#at-2">QIODevice</a>中重新实现的。
<h3 class=fn><a href="qiodevice.html#Offset">Offset</a> <a name="at-2"></a>QFile::at () const<tt> [虚]</tt>
</h3>
这是一个重载成员函数，提供了方便。它的行为基本上和上面的函数相同。
<p> 返回文件中的位置。
<p>也可以参考<a href="#size">size</a>()。
<p>从<a href="qiodevice.html#at">QIODevice</a>中重新实现的。
<h3 class=fn>bool <a name="atEnd"></a>QFile::atEnd () const<tt> [虚]</tt>
</h3>
如果到达文件的末尾，返回真，否则返回假。
<p>也可以参考<a href="#size">size</a>()。
<p>从<a href="qiodevice.html#atEnd">QIODevice</a>中重新实现的。
<h3 class=fn>void <a name="close"></a>QFile::close ()<tt> [虚]</tt>
</h3>
关闭一个打开的文件。
<p> 如果一个文件是使用一个存在的文件句柄打开的，那么它不是关闭的。如果这个存在的文件句柄是一个<tt>FILE*</tt>，这个文件被刷新。如果这个存在的文件句柄是一个<tt>int</tt>文件描述符，那么对这个文件将没有操作。
<p> 一些“在后面写的”文件系统也许会在关闭文件时报告一个未详细说明的错误。这些错误只表明在上一次打开（<a href="#open">open</a>()）之后也许发生了一些错误。在这种情况下，<a href="qiodevice.html#status">status</a>()会在关闭之后（<a href="#close">close</a>()）报告<a href="qiodevice.html#status">IO_UnspecifiedError</a>，否则是<a href="qiodevice.html#status">IO_Ok</a>。
<p> <p>也可以参考<a href="#open">open</a>()和<a href="#flush">flush</a>()。
<p>实例：<a href="simple-application-example.html#x1510">application/application.cpp</a>、<a href="tutorial2-07.html#x2495">chart/chartform_files.cpp</a>、<a href="helpviewer-example.html#x988">helpviewer/helpwindow.cpp</a>、<a href="mdi-example.html#x2005">mdi/application.cpp</a>、<a href="qdir-example.html#x1807">qdir/qdir.cpp</a>、<a href="qwerty-example.html#x360">qwerty/qwerty.cpp</a>和<a href="outliner-example.html#x1903">xml/outliner/outlinetree.cpp</a>。
<p>从<a href="qiodevice.html#close">QIODevice</a>中重新实现的。
<h3 class=fn><a href="qstring.html">QString</a> <a name="decodeName"></a>QFile::decodeName ( const <a href="qcstring.html">QCString</a> & localFileName )<tt> [静态]</tt>
</h3>
这个将会使用<em>localFileName</em>做与<a href="#encodeName">QFile::encodeName</a>()相反的操作。
<p> <p>也可以参考<a href="#setDecodingFunction">setDecodingFunction</a>()。
<h3 class=fn><a href="qcstring.html">QCString</a> <a name="encodeName"></a>QFile::encodeName ( const <a href="qstring.html">QString</a> & fileName )<tt> [静态]</tt>
</h3>
当你使用QFile时，在Qt中<a href="qfileinfo.html">QFileInfo</a>和<a href="qdir.html">QDir</a>访问文件系统，你可以使用Unicode文件名。在Unix上，这些文件名被转换为8位的编码。如果你想在Unix上使用你自己的文件输入/输出，你应该使用这个函数来转换文件名。在Windows NT上，Unicode文件名在文件系统中是直接被支持的并且这个函数应该避免使用。在Windows 95上，在这时候非Latin1的场所设置是不被支持的。
<p> 默认情况下，这个函数把<em>fileName</em>转换为本地的8位编码，这取决于用户的场所设置。对于用户选择的文件名这足够了。应用程序中的文件名硬编码只是需要使用7位ASCII文件名字符。
<p> 这种转换方案可以使用<a href="#setEncodingFunction">setEncodingFunction</a>()来改变。如果你需要给用户一个存储文件名为utf-8等等情况下，这也许很有用，但是这些文件名可能在这之后对其它应用程序来说是不可识别的。
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -