 |
ホーム · 全てのクラス · メインのクラス · 注釈付き · グループ別 · 関数一覧 |  |
QFile クラスはファイルの読み書きのインターフェースを提供します。 詳細...
#include <QFile>・ QtCore モジュールの一部です。
・ QIODeviceを継承しています。
・ QTemporaryFileに継承されています。
ノート: このクラスの全ての関数は reentrantです、ただし setEncodingFunction() と setDecodingFunction() は除きます。
QFile クラスはファイルの読み書きのインターフェースを提供します。
QFile はテキストやバイナリや resourcesを読み書きする為のI/Oデバイスです。 QFile は直接使われるかもしれませんし、 QTextStream や QDataStreamなどを通すともっと便利に扱えます。
ファイル名は普通はコンストラクタに渡しますが、 setFileName()でいつでも変更することができます。 exists() でファイルの存在のチェックができ、 remove() でファイルの削除ができます。 (より高度なファイルシステム関連の操作は QFileInfo や QDirにより提供されます。)
ファイルは open() によって開かれ、 close() によって閉じられ、 flush() によりフラッシュが行われます。 データの読み書きは通常は QDataStream や QTextStreamによって行われますが、 QIODeviceより継承された read(), readLine(), readAll(), write() を呼ぶこともできます。 QFile は一度に１つのキャラクタを操作する getChar(), putChar(), や ungetChar() も継承しています。
ファイルのサイズは size() によって返されます。 現在のファイル上の位置は pos() によって得られ、 ファイル上の位置を移動したり作成したりするのは seek() を使うことができます。 もしファイルの末尾に到達していれば、 atEnd() は true を返します。
以下の例ではテキストファイルを一行ごとに読み込みます:
QFile file("in.txt");
if (!file.open(QIODevice::ReadOnly | QIODevice::Text))
return;
while (!file.atEnd()) {
QByteArray line = in.readLine();
process_line(line);
}
ここで QIODevice::Text （ open() に渡された）は Qt に Windows形式の改行コード ("\r\n") を C++形式の改行コード ("\n") に変換することを伝えます。 デフォルトでは QFile はバイナリとして扱い、ファイル内のバイトコードを変換することはありません。
次の例ではテキストファイルを一行一行読み込むために QTextStream を使います：
QFile file("in.txt");
if (!file.open(QIODevice::ReadOnly | QIODevice::Text))
return;
QTextStream in(&file);
while (!in.atEnd()) {
QString line = in.readLine();
process_line(line);
}
QTextStream はディスクに保存されている８ビットのデータを16ビットのUnicodeの QStringに変換する処理をします。デフォルトではユーザーシステムの local 8-bit エンコーディングが使われます。(例えば, ヨーロッパの多くの文字の為の ISO 8859-1 です。 詳しくは QTextCodec::codecForLocale() を見てください)。これは setCodec() を使うことで変更されます。
To write text, we can use operator<<(), which is overloaded to take a QTextStream on the left and various data types (including QString) on the right:
QFile file("out.txt");
if (!file.open(QIODevice::WriteOnly | QIODevice::Text))
return;
QTextStream out(&file);
out << "The magic number is: " << 49 << "\n";
QDataStream undefined
When you use QFile, QFileInfo, and QDir to access the file system with Qt, you can use Unicode file names. On Unix, these file names are converted to an 8-bit encoding. If you want to use standard C++ APIs (<cstdio> or <iostream>) or platform-specific APIs to access files instead of QFile, you can use the encodeName() and decodeName() functions to convert between Unicode file names and 8-bit file names.
See also QTextStream, QDataStream, QFileInfo, QDir, and The Qt Resource System.
This is a typedef for a pointer to a function with the following signature:
QString myDecoderFunc(const QByteArray &localFileName);
See also setDecodingFunction().
This is a typedef for a pointer to a function with the following signature:
QByteArray myEncoderFunc(const QString &fileName);
See also setEncodingFunction() and encodeName().
This enum describes the errors that may be returned by the error() function.
| Constant | Value | Description |
|---|---|---|
| QFile::NoError | 0 | No error occurred. |
| QFile::ReadError | 1 | An error occurred when reading from the file. |
| QFile::WriteError | 2 | An error occurred when writing to the file. |
| QFile::FatalError | 3 | A fatal error occurred. |
| QFile::ResourceError | 4 | |
| QFile::OpenError | 5 | The file could not be opened. |
| QFile::AbortError | 6 | The operation was aborted. |
| QFile::TimeOutError | 7 | A timeout occurred. |
| QFile::UnspecifiedError | 8 | An unspecified error occurred. |
| QFile::RemoveError | 9 | The file could not be removed. |
| QFile::RenameError | 10 | The file could not be renamed. |
| QFile::PositionError | 11 | The position in the file could not be changed. |
| QFile::ResizeError | 12 | The file could not be resized. |
| QFile::PermissionsError | 13 | The file could not be accessed. |
| QFile::CopyError | 14 | The file could not be copied. |
This enum is used by the permission() function to report the permissions and ownership of a file. The values may be OR-ed together to test multiple permissions and ownership values.
| Constant | Value | Description |
|---|---|---|
| QFile::ReadOwner | 0x4000 | The file is readable by the owner of the file. |
| QFile::WriteOwner | 0x2000 | The file is writable by the owner of the file. |
| QFile::ExeOwner | 0x1000 | The file is executable by the owner of the file. |
| QFile::ReadUser | 0x0400 | The file is readable by the user. |
| QFile::WriteUser | 0x0200 | The file is writable by the user. |
| QFile::ExeUser | 0x0100 | The file is executable by the user. |
| QFile::ReadGroup | 0x0040 | The file is readable by the group. |
| QFile::WriteGroup | 0x0020 | The file is writable by the group. |
| QFile::ExeGroup | 0x0010 | The file is executable by the group. |
| QFile::ReadOther | 0x0004 | The file is readable by anyone. |
| QFile::WriteOther | 0x0002 | The file is writable by anyone. |
| QFile::ExeOther | 0x0001 | The file is executable by anyone. |
Warning: Because of differences in the platforms supported by Qt, the semantics of ReadUser, WriteUser and ExeUser are platform-dependent: On Unix, the rights of the owner of the file are returned and on Windows the rights of the current user are returned. This behavior might change in a future Qt version.
The Permissions type is a typedef for QFlags<Permission>. It stores an OR combination of Permission values.
Use QFile::Permission instead.
Constructs a new file object to represent the file with the given name.
Constructs a new file object with the given parent.
Constructs a new file object with the given parent to represent the file with the specified name.
Destroys the file object, closing it if necessary.
Copies the file currently specified by fileName() to newName. Returns true if successful; otherwise returns false.
The file is closed before it is copied.
See also setFileName().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Copies the file fileName to newName. Returns true if successful; otherwise returns false.
See also rename().
This does the reverse of QFile::encodeName() using localFileName.
See also setDecodingFunction() and encodeName().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Returns the Unicode version of the given localFileName. See encodeName() for details.
By default, this function converts fileName to the local 8-bit encoding determined by the user's locale. This is sufficient for file names that the user chooses. File names hard-coded into the application should only use 7-bit ASCII filename characters.
See also decodeName() and setEncodingFunction().
Returns the file error status.
The I/O device status returns an error code. For example, if open() returns false, or a read/write operation returns -1, this function can be called to find out the reason why the operation failed.
See also unsetError().
Returns true if the file specified by fileName exists; otherwise returns false.
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Returns true if the file specified by fileName() exists; otherwise returns false.
See also fileName() and setFileName().
Returns the name set by setFileName().
See also setFileName() and QFileInfo::fileName().
Flushes any buffered data to the file.
Returns the file handle of the file.
This is a small positive integer, suitable for use with C library functions such as fdopen() and fcntl(). On systems that use file descriptors for sockets (i.e. Unix systems, but not Windows) the handle can be used with QSocketNotifier as well.
If the file is not open, or there is an error, handle() returns -1.
See also QSocketNotifier.
Returns true if the file can only be manipulated sequentially; otherwise returns false.
Most files support random-access, but some special files may not.
Reimplemented from QIODevice.
See also QIODevice::isSequential().
Creates a link from the file currently specified by fileName() to newName. What a link is depends on the underlying filesystem (be it a shortcut on Windows or a symbolic link on Unix). Returns true if successful; otherwise returns false.
See also setFileName().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Creates a link from oldName to newName. What a link is depends on the underlying filesystem (be it a shortcut on Windows or a symbolic link on Unix). Returns true if successful; otherwise returns false.
See also link().
Opens the file using OpenMode mode.
The mode must be QIODevice::ReadOnly, QIODevice::WriteOnly, or QIODevice::ReadWrite. It may also have additional flags, such as QIODevice::Text and QIODevice::Unbuffered.
Reimplemented from QIODevice.
See also QIODevice::OpenMode.
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Opens the existing file handle fh in the given mode. Returns true if successful; otherwise returns false.
Example:
#include <stdio.h>
void printError(const char* msg)
{
QFile file;
file.open(stderr, QIODevice::WriteOnly);
file.write(msg, qstrlen(msg)); // write to stderr
file.close();
}
When a QFile is opened using this function, close() does not actually close the file, but only flushes it.
Warning: If fh is stdin, stdout, or stderr, you may not be able to seek(). See QIODevice::isSequentialAccess() for more information.
See also close().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Opens the existing file descripter fd in the given mode. Returns true if successful; otherwise returns false.
When a QFile is opened using this function, close() does not actually close the file.
The QFile that is opened using this function is automatically set to be in raw mode; this means that the file input/output functions are slow. If you run into performance issues, you should try to use one of the other open functions.
Warning: If fd is 0 (stdin), 1 (stdout), or 2 (stderr), you may not be able to seek(). size() is set to LLONG_MAX (in <climits>).
See also close().
Returns the complete OR-ed together combination of QFile::Permission for the file.
See also setPermissions() and setFileName().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Returns the complete OR-ed together combination of QFile::Permission for fileName.
Returns the filename referred to by the symlink (or shortcut on Windows) specified by fileName, or returns an empty string if the fileName does not correspond to a symbolic link.
This name may not represent an existing file; it is only a string. QFile::exists() returns true if the symlink points to an existing file.
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Returns the name a symlink (or shortcut on Windows) points to, or a an empty string if the object isn't a symbolic link.
This name may not represent an existing file; it is only a string. QFie::exists() returns true if the symlink points to an existing file.
See also fileName() and setFileName().
Removes the file specified by fileName(). Returns true if successful; otherwise returns false.
The file is closed before it is removed.
See also setFileName().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Removes the file specified by the fileName given.
Returns true if successful; otherwise returns false.
See also remove().
Renames the file currently specified by fileName() to newName. Returns true if successful; otherwise returns false.
The file is closed before it is renamed.
See also setFileName().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Renames the file oldName to newName. Returns true if successful; otherwise returns false.
See also rename().
Sets the file size (in bytes) sz. Returns true if the file if the resize succeeds; false otherwise. If sz is larger than the file currently is the new bytes will be set to 0, if sz is smaller the file is simply truncated.
See also size() and setFileName().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Sets fileName to size (in bytes) sz. Returns true if the file if the resize succeeds; false otherwise. If sz is larger than fileName currently is the new bytes will be set to 0, if sz is smaller the file is simply truncated.
See also resize().
Sets the function for decoding 8-bit file names. The default uses the locale-specific 8-bit encoding.
Warning: This function is not reentrant.
See also setEncodingFunction() and decodeName().
Sets the function for encoding Unicode file names. The default encodes in the locale-specific 8-bit encoding.
Warning: This function is not reentrant.
See also encodeName() and setDecodingFunction().
Sets the name of the file. The name can have no path, a relative path, or an absolute absolute path.
Do not call this function if the file has already been opened.
If the file name has no path or a relative path, the path used will be the application's current directory path at the time of the open() call.
Example:
QFile file;
QDir::setCurrent("/tmp");
file.setFileName("readme.txt");
QDir::setCurrent("/home");
file.open(QIODevice::ReadOnly); // opens "/home/readme.txt" under Unix
Note that the directory separator "/" works for all operating systems supported by Qt.
See also fileName(), QFileInfo, and QDir.
Sets the permissions for the file to permissions.
See also permissions() and setFileName().
This is an overloaded member function, provided for convenience. It behaves essentially like the above function.
Sets the permissions for fileName file to permissions.
Sets the file's error to QFile::NoError.
See also error().
| Copyright © 2005 Trolltech | Trademarks | Qt 4.0.0 |