QSaveFile Class

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

[explicit] QSaveFile::QSaveFile(QObject *parent = nullptr)

指定されたparent を使用して、新しいファイルオブジェクトを作成します。open()を呼び出す前に、setFileName()を呼び出す必要があります。

[explicit] QSaveFile::QSaveFile(const QString &name, QObject *parent = nullptr)

指定されたparent を使用して、指定されたname を持つファイルを表す新しいファイルオブジェクトを作成します。

[since 6.11] QSaveFile::QSaveFile(const std::filesystem::path &path, QObject *parent = nullptr)

指定されたparent を使用して、指定されたpath を持つファイルを表す新しいファイルオブジェクトを作成します。

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

[virtual noexcept] QSaveFile::~QSaveFile()

commit() が呼び出されていない限り、ファイルオブジェクトを破棄し、保存されていた内容を破棄します。

void QSaveFile::cancelWriting()

新しいファイルへの書き込みをキャンセルします。

保存中にアプリケーションが考えを変えた場合は、cancelWriting() を呼び出すことができます。これによりエラーコードが設定され、commit() が一時ファイルを破棄するようになります。

あるいは、単にcommit()を呼び出さないようにすればよい。

このメソッドを呼び出した後も書き込み操作は可能ですが、いずれも効果はなく、書き込まれたファイルは破棄されます。

このメソッドは、ダイレクト書き込みのフォールバックが使用されている場合は効果がありません。これは、読み取り専用ディレクトリ内の既存のファイルの上書き保存を行う場合です。一時ファイルを作成できないため、どのような場合でも既存のファイルが上書きされ、cancelWriting() ではこれを防ぐことはできず、既存のファイルの内容は失われてしまいます。

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

bool QSaveFile::commit()

それまでのすべての書き込みが成功した場合、変更内容をディスクに書き込みます。

保存処理の最後にこの関数を呼び出すことが必須です。そうしないと、ファイルは破棄されます。

書き込み中にエラーが発生した場合は、一時ファイルを削除し、false を返します。 それ以外の場合は、ファイル名を最終的なfileName に変更し、成功した場合はtrue を返します。 最後に、デバイスを閉じます。

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

bool QSaveFile::directWriteFallback() const

読み取り専用ディレクトリへのファイル保存に関するフォールバック処理が有効になっている場合、true を返します。

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

[override virtual] QString QSaveFile::fileName() const

QFileDevice::fileName() const を再実装します。

setFileName() または `QSaveFile ` コンストラクタで設定された名前を返します。

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

[since 6.11] std::filesystem::path QSaveFile::filesystemFileName() const

fileName() をstd::filesystem::path として返します。

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

[override virtual] bool QSaveFile::open(QIODeviceBase::OpenMode mode)

QIODevice::open （QIODeviceBase::OpenMode mode）を再実装します。

指定されたmode フラグを使用してファイルを開きます。

成功した場合はtrue を返し、失敗した場合はfalse を返します。

重要:mode のフラグには、QIODeviceBase::WriteOnly を含める必要があります。その他、使用可能な一般的なフラグには、Text およびUnbuffered があります。現時点でサポートされていないフラグは、ReadOnly (したがってReadWrite も)、Append 、NewOnly 、およびExistingOnly です。これらのフラグを指定すると、実行時に警告が発生します。

setFileName() およびQT_USE_NODISCARD_FILE_OPENも参照してください 。

[override virtual, since 6.12] QFileDevice::Permissions QSaveFile::permissions() const

QFileDevice::permissions() const を再実装します。

commit() が正常に実行された場合、そのファイルに付与される権限を報告します。

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

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

void QSaveFile::setDirectWriteFallback(bool enabled)

必要に応じて、既存のファイルの上書きを許可します。

QSaveFile 最終ファイルと同じディレクトリに一時ファイルを作成し、アトミックにファイル名を変更します。ただし、ディレクトリの権限により新規ファイルの作成が許可されていない場合は、この処理は実行できません。アトミック性の保証を維持するため、open() は一時ファイルを作成できない場合、失敗します。

権限が制限されたディレクトリ内で、書き込み権限を持つファイルをユーザーが編集できるようにするには、enabled をtrueに設定してsetDirectWriteFallback()を呼び出してください。そうすることで、その後のopen()の呼び出しは、一時ファイルを使用せずに、既存のファイルを直接開いて書き込みを行うフォールバック処理に切り替わります。 ただし、この方法では原子性が保証されません。つまり、アプリケーションのクラッシュや停電などが発生すると、ディスク上に書き込みが中途半端なファイルが残ってしまう可能性があります。また、このような場合、cancelWriting() は効果を発揮しません。

通常、ユーザーが編集したドキュメントを保存するには setDirectWriteFallback(true) を呼び出し、アプリケーション内部のファイル（設定ファイル、データファイルなど）を保存するには、原子性を保証するデフォルト設定を維持します。

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

void QSaveFile::setFileName(const QString &name)

ファイルのname を設定します。名前には、パスを含まないもの、相対パス、または絶対パスを指定できます。

QFile::setFileName() およびfileName()も参照してください 。

[since 6.11] void QSaveFile::setFileName(const std::filesystem::path &name)

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

[override virtual, since 6.12] bool QSaveFile::setPermissions(QFileDevice::Permissions permissions)

QFileDevice::setPermissions （QFileDevice::Permissions の権限）を再実装しています。

commit() が成功した場合に、ファイルに付与されるpermissions を設定します。

QSaveFile 経由で書き込みが行われる際、ファイルのアクセス権はより制限的になる場合があります。

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

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

[override virtual protected] qint64 QSaveFile::writeData(const char *data, qint64 len)

QFileDevice::writeData （const char *data, qint64 len）を再実装します。