QTextStream Class

メンバ関数のドキュメント

QTextStream::QTextStream()

QTextStream を作成します。読み取りや書き込みに使用するには、デバイスまたは文字列を割り当てる必要があります。

setDevice() およびsetString()も参照してください 。

[explicit] QTextStream::QTextStream(QIODevice *device)

device を操作する QTextStream を生成します。

[explicit] QTextStream::QTextStream(FILE *fileHandle, QIODeviceBase::OpenMode openMode = ReadWrite)

fileHandle を操作する QTextStream を構築し、openMode を使用してオープンモードを定義します。内部的には、FILE ポインタを処理するためにQFile が作成されます。

このコンストラクタは、stdin、stdout、stderrといった一般的なFILEベースの入出力ストリームを直接扱う際に役立ちます。例：

QString str;
QTextStream in(stdin);
in >> str;

[explicit] QTextStream::QTextStream(QByteArray *array, QIODeviceBase::OpenMode openMode = ReadWrite)

array を操作する QTextStream を構築し、openMode を使用してオープンモードを定義します。内部的には、この配列はQBuffer でラップされています。

[explicit] QTextStream::QTextStream(QString *string, QIODeviceBase::OpenMode openMode = ReadWrite)

string を対象とする QTextStream を生成し、openMode を使用してオープンモードを定義します。

[explicit] QTextStream::QTextStream(const QByteArray &array, QIODeviceBase::OpenMode openMode = ReadOnly)

array を操作する QTextStream を生成します。この際、openMode を使用してオープンモードを定義します。openMode の値にかかわらず、配列へのアクセスは読み取り専用となります。

このコンストラクタは、定数文字列を扱う際に便利です。例：

int main(int argc, char *argv[])
{
    // read numeric arguments (123, 0x20, 4.5...)
    for (int i = 1; i < argc; ++i) {
        int number;
        QTextStream in(argv[i]);
        in >> number;
        //...
    }
}

[virtual noexcept] QTextStream::~QTextStream()

QTextStream を破棄します。

ストリームがデバイス上で動作している場合、flush() が暗黙的に呼び出されます。そうでない場合、デバイスには影響しません。

bool QTextStream::atEnd() const

QTextStream から読み取るデータがなくなると、true を返します。それ以外の場合は、false を返します。これはQIODevice::atEnd()を呼び出すことと似ていますが、まったく同じではありません。QTextStream は、その内部のUnicodeバッファも考慮に入れるためです。

bool QTextStream::autoDetectUnicode() const

自動Unicode検出が有効になっている場合は `true ` を返し、そうでない場合は `false` を返します。自動Unicode検出はデフォルトで有効になっています。

setAutoDetectUnicode() およびsetEncoding()も参照してください 。

QIODevice *QTextStream::device() const

QTextStream に関連付けられている現在のデバイスを返します。デバイスが割り当てられていない場合は、nullptr を返します。

setDevice() およびstring()も参照してください 。

QStringConverter::Encoding QTextStream::encoding() const

そのストリームに現在割り当てられているエンコーディングを返します。

setEncoding()、setAutoDetectUnicode()、およびlocale()も参照してください 。

QTextStream::FieldAlignment QTextStream::fieldAlignment() const

現在のフィールドの配置を返します。

setFieldAlignment() およびfieldWidth()も参照してください 。

int QTextStream::fieldWidth() const

現在のフィールド幅を返します。

setFieldWidth()も参照してください 。

void QTextStream::flush()

デバイスへの書き込みを待機しているバッファ内のデータをすべてフラッシュします。

QTextStream が文字列に対して動作する場合、この関数は何も行いません。

bool QTextStream::generateByteOrderMark() const

UTFエンコーディングを使用する際、QTextStream がUTF BOM（バイト順マーク）を生成するように設定されている場合はtrue を返し、そうでない場合はfalse を返します。UTF BOMの生成は、デフォルトでfalseに設定されています。

setGenerateByteOrderMark()も参照してください 。

int QTextStream::integerBase() const

整数の現在の基数を返します。0 は読み取り時に基数が検出されることを意味し、10（10進数）は数値を生成する際に基数が10であることを意味します。

setIntegerBase()、QString::number()、およびnumberFlags()も参照してください 。

QLocale QTextStream::locale() const

このストリームのロケールを返します。デフォルトのロケールは C です。

setLocale()も参照してください 。

QTextStream::NumberFlags QTextStream::numberFlags() const

現在のフラグの数を返します。

setNumberFlags()、integerBase()、およびrealNumberNotation()も参照してください 。

QChar QTextStream::padChar() const

現在のパッド文字を返します。

setPadChar() およびsetFieldWidth()も参照してください 。

qint64 QTextStream::pos() const

ストリームの現在の位置に対応するデバイスの位置を返します。エラーが発生した場合は -1 を返します（例：デバイスや文字列が存在しない場合、またはデバイスエラーが発生した場合など）。

QTextStream はバッファリングされているため、この関数は有効なデバイス位置を再構築するためにデバイスをシークする必要がある場合があります。この操作は負荷が高くなる可能性があるため、タイトなループ内でのこの関数の呼び出しは避けることをお勧めします。

seek()も参照してください 。

QString QTextStream::read(qint64 maxlen)

ストリームから最大maxlen 文字を読み取り、読み取ったデータをQString として返します。

readAll()、readLine()、およびQIODevice::read()も参照してください 。

QString QTextStream::readAll()

ストリームの内容全体を読み込み、それをQString として返します。この関数は大量のメモリを消費するため、大容量のファイルを扱う場合は使用を避けてください。

利用可能なデータ量が不明な場合は、readLine() を呼び出す方が適しています。

readLine()も参照してください 。

QString QTextStream::readLine(qint64 maxlen = 0)

ストリームからテキストを1行読み取り、それをQString として返します。許可される最大行長はmaxlen に設定されています。ストリームにこの長さを超える行が含まれている場合、maxlen 文字ごとに分割され、部分ごとに返されます。

maxlen が0の場合、行の長さに制限はありません。

返される行には、末尾に行末文字（「\n 」または「\r\n 」）は含まれないため、QString::trimmed() を呼び出す必要はありません。

ストリームがファイルの末尾まで読み込んだ場合、readLine() は null のQString を返します。文字列の場合、またはそれをサポートするデバイスの場合は、atEnd() を使用して、ストリームの末尾を明示的に検査することができます。

readAll() およびQIODevice::readLine()も参照してください 。

bool QTextStream::readLineInto(QString *line, qint64 maxlen = 0)

ストリームから1行のテキストを読み取り、line に格納します。line がnullptr に設定されている場合、読み込まれた行は保存されません。

許可される行の長さの最大値はmaxlen に設定されます。ストリームにこの値より長い行が含まれている場合、その行はmaxlen 文字ごとに分割され、部分ごとに返されます。

maxlen が 0 の場合、行の長さは任意です。

結果の行には、末尾に行末文字（「\n 」または「\r\n 」）が含まれないため、QString::trimmed() を呼び出す必要はありません。

line に、これから読み込まれるデータに対して十分な容量がある場合、この関数は新しいメモリを割り当てる必要がない可能性があります。このため、readLine() よりも高速に動作する可能性があります。

ストリームがファイルの末尾まで読み込んだ場合、またはエラーが発生した場合はfalse を返し、それ以外の場合はtrue を返します。いずれの場合も、呼び出し前のline 内の内容は破棄されます。

readAll()、QIODevice::readLine()、およびQIODevice::readLineInto()も参照してください 。

QTextStream::RealNumberNotation QTextStream::realNumberNotation() const

現在の実数表記を返します。

setRealNumberNotation()、realNumberPrecision()、numberFlags()、およびintegerBase()も参照してください 。

int QTextStream::realNumberPrecision() const

現在の実数の精度、あるいはQTextStream が実数を生成する際に書き出す小数桁数（FixedNotation 、ScientificNotation ）、または有効桁数の最大値（SmartNotation ）を返します。

setRealNumberPrecision()、setRealNumberNotation()、realNumberNotation()、numberFlags()、およびintegerBase()も参照してください 。

void QTextStream::reset()

QTextStream の書式設定オプションをリセットし、構築時の状態に戻します。デバイス、文字列、およびバッファに格納されているデータには一切影響しません。

void QTextStream::resetStatus()

テキストストリームの状態をリセットします。

QTextStream::Status 、status()、およびsetStatus()も参照してください 。

bool QTextStream::seek(qint64 pos)

デバイス内のpos の位置を検索します。成功した場合はtrue を返し、失敗した場合はfalse を返します。

void QTextStream::setAutoDetectUnicode(bool enabled)

enabled がtrueの場合、QTextStream は、ストリームデータを調べ、UTF-8、UTF-16、またはUTF-32のバイト順マーク（BOM）が見つかるかどうかを確認することで、Unicodeエンコーディングの検出を試みます。このマークが見つかった場合、QTextStream は現在のエンコーディングをUTFエンコーディングに置き換えます。

この関数は、setEncoding() と組み合わせて使用できます。エンコーディングを UTF-8 に設定し、その後 UTF-16 検出を有効にするのが一般的です。

autoDetectUnicode() およびsetEncoding()も参照してください 。

void QTextStream::setDevice(QIODevice *device)

現在のデバイスをdevice に設定します。すでにデバイスが割り当てられている場合、QTextStream は、古いデバイスが置き換えられる前にflush()を呼び出します。

device() およびsetString()も参照してください 。

[since 6.0] void QTextStream::setEncoding(QStringConverter::Encoding encoding)

このストリームのエンコーディングをencoding に設定します。このエンコーディングは、割り当てられたデバイスから読み込まれるデータの復号化、および書き込まれるデータの符号化に使用されます。デフォルトでは、QStringConverter::Utf8 が使用され、ユニコードの自動検出が有効になっています。

QTextStream が文字列に対して動作する場合、この関数は何もしません。

この関数は Qt 6.0 で導入されました。

関連項目： encoding()、setAutoDetectUnicode()、およびsetLocale()を参照してください 。

void QTextStream::setFieldAlignment(QTextStream::FieldAlignment mode)

フィールドの配置をmode に設定します。setFieldWidth()と組み合わせて使用することで、テキストを左揃え、右揃え、または中央揃えにした書式付き出力を生成することができます。

fieldAlignment() およびsetFieldWidth()も参照してください 。

void QTextStream::setFieldWidth(int width)

現在のフィールド幅をwidth に設定します。width が0（デフォルト）の場合、フィールド幅は生成されたテキストの長さと同じになります。

fieldWidth() およびsetPadChar()も参照してください 。

void QTextStream::setGenerateByteOrderMark(bool generate)

generate がtrueで、かつUTFエンコーディングが使用されている場合、QTextStream は、デバイスへのデータ書き込みが行われる前にBOM（バイト順マーク）を挿入します。generate がfalseの場合、BOMは挿入されません。この関数は、データの書き込みが行われる前に呼び出す必要があります。そうでない場合、何もしません。

generateByteOrderMark() およびbom()も参照してください 。

void QTextStream::setIntegerBase(int base)

整数の基数を、読み取りおよび数値生成の両方において `base` に設定します。`base ` の値は、2（2進数）、8（8進数）、10（10進数）、または16（16進数）のいずれかです。base が0の場合、QTextStream はストリーム上のデータを解析して基数を検出しようとします。数値を生成する際、QTextStream は、基数が明示的に設定されていない限り、基数が10であると仮定します。

integerBase()、QString::number()、およびsetNumberFlags()も参照してください 。

void QTextStream::setLocale(const QLocale &locale)

このストリームのロケールを `locale` に設定します。指定されたロケールは、数値とその文字列表現間の変換に使用されます。

デフォルトのロケールは C ですが、これは特殊なケースであり、下位互換性を維持するため、千の位区切り記号は使用されません。

locale()も参照してください 。

void QTextStream::setNumberFlags(QTextStream::NumberFlags flags)

現在の数値フラグを `flags` に設定します。`flags ` は、NumberFlag 列挙型のフラグのセットであり、生成されるコードの書式設定に関するオプション（例：数値の基数や符号を常に記述するかどうかなど）を定義しています。

numberFlags()、setIntegerBase()、およびsetRealNumberNotation()も参照してください 。

void QTextStream::setPadChar(QChar ch)

パッド文字をch に設定します。デフォルト値はASCIIのスペース文字（' '）またはQChar （0x20）です。この文字は、テキストを生成する際にフィールドの空白を埋めるために使用されます。

例：

QString s;
QTextStream out(&s);
out.setFieldWidth(10);
out.setFieldAlignment(QTextStream::AlignCenter);
out.setPadChar('-');
out << "Qt" << "rocks!";

文字列「s 」には以下が含まれます：

----Qt------rocks!--

padChar() およびsetFieldWidth()も参照してください 。

void QTextStream::setRealNumberNotation(QTextStream::RealNumberNotation notation)

実数の表記をnotation (SmartNotation,FixedNotation,ScientificNotation) に設定します。QTextStream は、数値の読み取りや生成を行う際、この値を使用して実数の書式を判別します。

realNumberNotation()、setRealNumberPrecision()、setNumberFlags()、およびsetIntegerBase()も参照してください 。

void QTextStream::setRealNumberPrecision(int precision)

実数の精度をprecision に設定します。この値は、QTextStream が実数を生成する際（FixedNotation 、ScientificNotation ）に出力する小数点以下の桁数、あるいは有効桁数の最大数（SmartNotation ）を表します。

精度に負の値を指定することはできません。デフォルト値は 6 です。

realNumberPrecision() およびsetRealNumberNotation()も参照してください 。

void QTextStream::setStatus(QTextStream::Status status)

テキストストリームのステータスを、指定されたstatus に設定します。

resetStatus() が呼び出されるまで、その後の setStatus() への呼び出しは無視されます。

Status 、status()、およびresetStatus()も参照してください 。

void QTextStream::setString(QString *string, QIODeviceBase::OpenMode openMode = ReadWrite)

指定されたopenMode を使用して、現在の文字列をstring に設定します。すでにデバイスが割り当てられている場合、QTextStream は、それを置き換える前にflush()を呼び出します。

string() およびsetDevice()も参照してください 。

void QTextStream::skipWhiteSpace()

ストリームから空白文字を読み取り、非空白文字が検出されるか、atEnd() が true を返すまで、空白文字を破棄します。この関数は、ストリームを 1 文字ずつ読み取る際に役立ちます。

空白文字とは、QChar::isSpace() がtrue を返すすべての文字を指します。

operator>>()も参照してください 。

QTextStream::Status QTextStream::status() const

テキストストリームのステータスを返します。

QTextStream::Status 、setStatus()、およびresetStatus()も参照してください 。

QString *QTextStream::string() const

QTextStream に割り当てられている現在の文字列を返します。文字列が割り当てられていない場合は、nullptr を返します。

setString() およびdevice()も参照してください 。

[explicit noexcept, since 6.10] QTextStream::operator bool() const

このストリームにエラーがないかどうかを返します（status() はOk を返します）。

この関数は Qt 6.10 で導入されました。

QTextStream &QTextStream::operator<<(QChar c)

文字列 `c ` をストリームに書き込み、その後、QTextStream への参照を返します。

setFieldWidth()も参照してください 。

QTextStream &QTextStream::operator<<(const QString &string)

文字列「string 」をストリームに書き込み、QTextStream への参照を返します。文字列は、ストリームに書き込まれる前に、指定されたエンコーディング（デフォルトはUTF-8）を使用してエンコードされます。

setFieldWidth() およびsetEncoding()も参照してください 。

QTextStream &QTextStream::operator<<(float f)

実数 `f ` をストリームに書き込み、その後 `QTextStream` への参照を返します。デフォルトでは、QTextStream は `SmartNotation` を使用して、最大 6 桁の精度で格納します。実数に対して `QTextStream ` が使用する文字列表現は、setRealNumberNotation()、setRealNumberPrecision()、およびsetNumberFlags() を呼び出すことで変更できます。

setFieldWidth()、setRealNumberNotation()、setRealNumberPrecision()、およびsetNumberFlags()も参照してください 。

QTextStream &QTextStream::operator<<(short i)

整数i をストリームに書き込み、QTextStream への参照を返します。デフォルトでは、数値は10進数形式で格納されますが、setIntegerBase()を呼び出すことで基数を設定することもできます。

setFieldWidth() およびsetNumberFlags()も参照してください 。

QTextStream &QTextStream::operator<<(QLatin1StringView string)

ストリームに `string ` を書き込み、QTextStream への参照を返します。

QTextStream &QTextStream::operator<<(QStringView string)

ストリームに `string ` を書き込み、QTextStream への参照を返します。

QTextStream &QTextStream::operator<<(char c)

c をASCIIからQChar に変換し、それをストリームに書き込みます。

[since 6.3.1] QTextStream &QTextStream::operator<<(char16_t c)

Unicode文字「c 」をストリームに書き込み、QTextStream への参照を返します。

この関数は Qt 6.3.1 で導入されました。

QTextStream &QTextStream::operator<<(const QByteArray &array)

ストリームに `array ` を書き込みます。array の内容は、QString::fromUtf8() によって変換されます。

QTextStream &QTextStream::operator<<(const char *string)

string が指す定数文字列をストリームに書き込みます。string は UTF-8 エンコーディングであるとみなされます。この演算子は、定数文字列データを扱う際に便利です。例：

QTextStream out(stdout);
out << "Qt rocks!" << Qt::endl;

警告:QTextStream は、string が '\0' 文字で終了する文字列を指していると想定しています。終了文字 '\0' がない場合、アプリケーションがクラッシュする可能性があります。

QTextStream &QTextStream::operator<<(const void *ptr)

ptr を、基数を指定した16進数としてストリームに書き込みます。

QTextStream &QTextStream::operator<<(double f)

double型のf をストリームに書き込みます。

QTextStream &QTextStream::operator<<(int i)

符号付き整数 `i ` をストリームに書き込みます。

QTextStream &QTextStream::operator<<(long i)

符号付きlong型のi をストリームに書き込みます。

QTextStream &QTextStream::operator<<(qlonglong i)

qlonglong型のi をストリームに書き込みます。

QTextStream &QTextStream::operator<<(qulonglong i)

qulonglong型のi をストリームに書き込みます。

QTextStream &QTextStream::operator<<(unsigned int i)

unsigned int型のi をストリームに書き込みます。

QTextStream &QTextStream::operator<<(unsigned long i)

i （符号なしlong型）をストリームに書き込みます。

QTextStream &QTextStream::operator<<(unsigned short i)

unsigned short型のi をストリームに書き込みます。

QTextStream &QTextStream::operator>>(QChar &c)

ストリームから 1 文字を読み取り、それを `c` に格納します。`QTextStream` への参照を返すため、複数の演算子をネストして使用することができます。例：

QTextStream in(file);
QChar ch1, ch2, ch3;
in >> ch1 >> ch2 >> ch3;

空白文字はスキップされません。

QTextStream &QTextStream::operator>>(QString &str)

ストリームから単語を読み取り、それをstr に格納した後、ストリームへの参照を返します。単語は空白文字で区切られています（つまり、QChar::isSpace()がtrue を返すすべての文字で区切られています）。

先頭の空白文字は無視されます。

QTextStream &QTextStream::operator>>(float &f)

ストリームから実数を読み取り、f に格納した後、QTextStream への参照を返します。数値は適切な型にキャストされます。ストリーム上で実数が検出されない場合、f は0.0に設定されます。

特別な例外として、QTextStream は、NANおよびINFのfloat型またはdouble型を表す文字列「nan」および「inf」を許可しています。

先頭の空白は無視されます。

QTextStream &QTextStream::operator>>(short &i)

ストリームから整数を読み取り、i に格納した後、QTextStream への参照を返します。数値は格納される前に適切な型にキャストされます。ストリーム上で数値が検出されなかった場合、i は 0 に設定されます。

デフォルトでは、QTextStream は以下の規則に従って数値の基数を検出しようとします：

setIntegerBase() を呼び出すことで、整数の基数を明示的に指定できます。これにより自動検出が無効になり、QTextStream の処理がわずかに高速化されます。

先頭の空白は無視されます。

QTextStream &QTextStream::operator>>(QByteArray &array)

単語をUTF-8に変換し、array に格納します。

QString::toLatin1()も参照してください 。

QTextStream &QTextStream::operator>>(char &c)

ストリームから1文字を読み取り、c に格納します。ストリームからの文字は、格納される前にISO-8859-1に変換されます。

QChar::toLatin1()も参照してください 。

[since 6.4] QTextStream &QTextStream::operator>>(char16_t &c)

ストリームから1文字を読み取り、c に格納します。

この関数はQt 6.4で導入されました。

QTextStream &QTextStream::operator>>(double &f)

実数を double型の変数f に格納します。

QTextStream &QTextStream::operator>>(int &i)

整数を符号付きint型のi に格納します。

QTextStream &QTextStream::operator>>(long &i)

整数を符号付きlong型のi に格納します。

QTextStream &QTextStream::operator>>(qlonglong &i)

整数を qlonglong 型の変数 `i` に格納します。

QTextStream &QTextStream::operator>>(qulonglong &i)

整数をi 型のqulonglongに格納します。

QTextStream &QTextStream::operator>>(unsigned int &i)

整数を、unsigned int型のi に格納します。

QTextStream &QTextStream::operator>>(unsigned long &i)

整数を、unsigned long型のi に格納します。

QTextStream &QTextStream::operator>>(unsigned short &i)

整数を、符号なしshort型のi に格納します。